open-index/open-npm huggingface dataset:
npm package: @flarelabs/fasset
Description: Smart contracts implementing FAsset system.
Author: Flare Labs
Latest version: 1.0.0

# FAsset contracts

Solidity contracts for *Flare Labs* FAsset system.

## Overview

The FAsset contracts are used to mint assets on top of Flare (or Songbird). The system is designed to handle chains which don’t have (full) smart contract capabilities, although it can also work for smart contract chains. Initially, FAsset system will support assets XRP, BTC, DOGE, and LTC. Later we might add other blockchains.

The minted FAssets are secured by collateral, which is in the form of ERC20 tokens on Flare/Songbird chain and native tokens (FLR/SGB). The collateral is locked in contracts that guarantee that minted tokens can always be redeemed for underlying assets or compensated by collateral.

Two novel protocols, available on Flare and Songbird blockchains, enable the FAsset system to operate:

- **FTSO** contracts which provide decentralised price feeds for multiple tokens.
- Flare’s **FDC**, which bridges payment data from any connected chain.

## Development

### Getting started

1. Clone this repository.
2. Run `yarn`.
3. Compile the solidity code: `yarn c`.
4. Run basic tests `yarn testHH`.

#### Flare-smart-contracts dependency

Currently, `flare-smart-contracts` dependency is obtained directly from git repository from a tag that supports the required functionality.

For development, it might be beneficial to directly use checked-out code of `flare-smart-contracts`. This can be done with `yarn link`:

1. In `flare-smart-contracts` project folder run `yarn link`
2. In `fasset` project folder run `yarn link flare-smart-contracts`

This creates softlink from `node_modules/flare-smart-contracts` to the flare-smart-contracts project folder.

For development in *VSCode* you might also find VSCode *Workspace* feature useful - it allows you to have multiple projects open in the same window (e.g. both fasset and flare-smart-contracts).

### Testing

Note: be sure to compile (`yarn c`) after any solidity code changes or if starting a clean project as Typescript stubs need to be generated as part of the compilation.

Then one can run different types of tests.

- `yarn testHH` - all tests in hardhat environment (includes following two types of tests).
- `yarn test_unit_hh` - only unit tests in hardhat environment.
- `test_integration_hh` - only integration tests in hardhat environment.

To check test coverage run `yarn cov`.
npm package: @flarelane/liquid
Description: FlareLane Liquid is a library for parsing and rendering Liquid templates.
Author: FlareLane
Latest version: 1.1.1

# FlareLane Liquid

A lightweight wrapper around LiquidJS for safe and controlled template interpolation.

## Overview

FlareLane Liquid is a library for parsing and rendering Liquid templates with an emphasis on safety and control. It provides a simplified API for LiquidJS with added features like whitelisted filters and tags, custom filters, and template preprocessing.

## Installation

```bash
npm install @flarelane/liquid
```

or

```bash
yarn add @flarelane/liquid
```

## Usage

### Basic Usage

```typescript
import { Liquid } from '@flarelane/liquid';

// Use the singleton instance
const liquid = Liquid.shared;

// Interpolate a template with data
const result = liquid.interpolate('Hello {{ name }}!', { name: 'World' });
// result: "Hello World!"

// Parse variables from a template
const variables = liquid.parse('Hello {{ name }}, today is {{ date }}');
// variables: ['name', 'date']
```

### Custom Configuration

You can create a custom instance with your own configuration:

```typescript
const customLiquid = new Liquid({
  supportedFilters: ['escape', 'default', 'upcase'],
  supportedTags: ['if'],
});
```

## Features

### Whitelisted Filters and Tags

By default, FlareLane Liquid only allows a safe subset of LiquidJS filters and tags. Attempts to use unsupported filters or tags will throw an error.

Default supported filters:

- Basic filters: `escape`, `uri_escape`, `url_encode`, `url_decode`, `strip_html`, `default`
- Text manipulation: `upcase`, `downcase`, `capitalize`, `truncate`, `truncatewords`, `replace`, `replace_first`
- Date: `date`
- Math: `plus`, `minus`, `times`, `divided_by`, `round`, `floor`, `ceil`

Default supported tags:

- `if`, `unless`

### Custom Filters

FlareLane Liquid includes additional custom filters:

- `number_with_delimiter`: Formats numbers with thousand separators (e.g., 1,000,000)
- `printable`: Ensures output is a primitive type (string, number, boolean)

### Template Preprocessing

FlareLane Liquid includes a template preprocessor that supports shortened syntax for the default filter:

```
{{ variable || default_value }}
```

This is automatically converted to:

```
{{ variable | default: "default_value" }}
```

## License

MIT
npm package: @flarenetwork/eslint-config-flare
Description: General eslint config for all flare ts projects
Author: Flare Network
Latest version: 0.0.2

<p align="left">
  <a href="https://flare.network/" target="blank"><img src="https://content.flare.network/Flare-2.svg" width="410" height="106" alt="Flare Logo" /></a>
</p>

# ESLint Configuration for Flare

This repository contains the ESLint configuration used across Flare projects to ensure consistent code quality and style.

## Overview

Use this ESLint configuration in all typescript projects developed by Flare.

## Installation

Install the ESLint configuration package:

```bash
pnpm add --save-dev eslint @eslint/compat @flarenetwork/eslint-config-flare
```

if you are using prettier also add

```bash
pnpm add --save-dev eslint-config-prettier
```

```bash
pnpm add --save-dev eslint @eslint/compat @flarenetwork/eslint-config-flare eslint-config-prettier
```

Create a `eslint.config.mjs` file in the root of your project with the following content:

```javascript
// @ts-check
import { includeIgnoreFile } from "@eslint/compat";
import { defaultConfig } from "@flarenetwork/eslint-config-flare";
import prettier from "eslint-config-prettier";
import path from "node:path";
import { fileURLToPath } from "node:url";

const gitignorePath = path.resolve(
  path.dirname(fileURLToPath(import.meta.url)),
  ".gitignore",
);

export default [includeIgnoreFile(gitignorePath), ...defaultConfig, prettier];
```

## Usage

You can run ESLint using the following command:

Configure linter in package.json:

```json
{
  ...
  "scripts": {
    ...
    "lint:fix": "eslint \"{src,test}/**/*.ts\" --fix",
    "lint:check": "eslint \"{src,test}/**/*.ts\"",
    ...
  },
  ...
}
```
npm package: @flarenetwork/prettier-config-flare
Description: General prettier config for all flare ts projects
Author: Flare Network
Latest version: 0.0.3

<p align="left">
  <a href="https://flare.network/" target="blank"><img src="https://content.flare.network/Flare-2.svg" width="410" height="106" alt="Flare Logo" /></a>
</p>

# Prettier Configuration for Flare

This repository contains the Prettier configuration used across Flare projects to ensure consistent code formatting.

## Overview

Use this Prettier configuration in all typescript projects developed by Flare.

## Installation

Install the Prettier configuration package:

```bash
pnpm add ----save-dev prettier @flarenetwork/prettier-config-flare prettier prettier-plugin-solidity
```

Configure prettier in package.json:

```json
{
  ...
  "prettier": "@flarenetwork/prettier-config-flare",
  ...
}
```
npm package: @flareone/common
Description: Common utilities for Flareone framework
Author: Flareone Contributors
Latest version: 0.1.1

# @flareone/common

Common utilities, guards, pipes, and interceptors for Flareone framework.

## Installation

```bash
npm install @flareone/common
```

## Features

- **Guards**: `AuthGuard` base class
- **Interceptors**: `LoggingInterceptor`, `TimeoutInterceptor`
- **Pipes**: `ValidationPipe`, `ParseIntPipe`, `ParseBoolPipe`
- **Exceptions**: Standard HTTP exceptions
- **Decorators**: Helper decorators

## Usage

```typescript
import { UseGuards, UsePipes } from '@flareone/core';
import { AuthGuard, ValidationPipe } from '@flareone/common';

@Controller('cats')
@UseGuards(AuthGuard)
export class CatsController {
    @Post()
    @UsePipes(ValidationPipe)
    create(@Body() createCatDto: CreateCatDto) {
        return 'This action adds a new cat';
    }
}
```

See [main repository](https://github.com/flareonejs/flareone) for full documentation.
npm package: @flareone/core
Description: Core package for Flareone - Ultra-performance framework for Cloudflare Workers
Author: Flareone Contributors
Latest version: 0.1.1

# @flareone/core

The core framework for Flareone - NestJS-like framework for Cloudflare Workers.

## Installation

```bash
npm install @flareone/core
```

## Features

- **Dependency Injection**: Lightweight DI container without reflect-metadata
- **Decorators**: `@Controller`, `@Module`, `@Injectable`, `@Inject`
- **Routing**: Efficient radix-tree based router
- **Cloudflare Native**: Designed specifically for Workers environment

## Usage

```typescript
import { 
  FlareoneFactory, 
  Module, 
  Controller, 
  Get, 
  Injectable, 
  Inject 
} from '@flareone/core';

@Injectable()
class AppService {
    getHello() { return 'Hello World!'; }
}

@Controller()
class AppController {
    constructor(@Inject(AppService) private appService: AppService) {}

    @Get('/')
    getHello() {
        return this.appService.getHello();
    }
}

@Module({
    controllers: [AppController],
    providers: [AppService]
})
class AppModule {}

const app = await FlareoneFactory.create(AppModule);
export default app.getHandler();
```

See [main repository](https://github.com/flareonejs/flareone) for full documentation.
npm package: @flareone/d1
Description: D1 Database integration for Flareone framework
Author: Flareone Contributors
Latest version: 0.1.1

# @flareone/d1

D1 Database integration for Flareone framework.

## Installation

```bash
npm install @flareone/d1
```

## Features

- **Type-Safe**: Fluent Query Builder with full TypeScript support
- **Repository Pattern**: Built-in `D1Repository` for clean architecture
- **Zero Dependencies**: Lightweight wrapper around Cloudflare D1
- **Performance**: Optimized batch operations and transactions
- **Aggregations**: Support for `count`, `sum`, `avg`, `min`, `max`

## Usage

```typescript
import { Module, Injectable, Inject } from '@flareone/core';
import { D1Module, D1Service, D1Repository, table } from '@flareone/d1';

// 1. Register Module
@Module({
  imports: [
    D1Module.forRoot({ binding: 'DB' })
  ],
})
class AppModule {}

// 2. Define Entity & Repository
interface User {
  id: number;
  name: string;
  email: string;
}

@Injectable()
class UserRepository extends D1Repository<User> {
  constructor(@Inject(D1Service) d1: D1Service) {
    super(d1, 'users');
  }

  async findActive() {
    return this.find([{ column: 'active', operator: '=', value: true }]);
  }
}

// 3. Use in Service
@Injectable()
class UserService {
  constructor(
    @Inject(D1Service) private d1: D1Service,
    @Inject(UserRepository) private users: UserRepository
  ) {}

  async databaseOperations() {
    // Repository usage
    await this.users.create({ name: 'Alice', email: 'alice@example.com' });
    const user = await this.users.findById(1);

    // Fluent Query Builder usage
    const results = await table<User>(this.d1, 'users')
      .select('id', 'name')
      .where('email', 'LIKE', '%@example.com')
      .orderBy('id', 'DESC')
      .limit(5)
      .get();
      
    return { user, results };
  }
}
```

See [main repository](https://github.com/flareonejs/flareone) for full documentation.
npm package: @flareone/kv
Description: Workers KV integration for Flareone framework
Author: Flareone Contributors
Latest version: 0.1.1

# @flareone/kv

Workers KV integration for Flareone framework.

## Installation

```bash
npm install @flareone/kv
```

## Features

- **Type-safe Wrapper**: High-level API for `KVNamespace`
- **Caching**: Built-in TTL and caching strategies
- **Repository Pattern**: `KVRepository` base class for entity management
- **Batch Operations**: Efficient `setMany`, `deleteMany`, `list`
- **Metadata Support**: Simple API for storing/retrieving metadata

## Usage

```typescript
import { Module, Injectable, Inject } from '@flareone/core';
import { KVModule, KVService } from '@flareone/kv';

@Injectable()
class CacheService {
  constructor(@Inject(KVService) private kv: KVService) {}

  async saveUser(id: string, data: any) {
    // Automatic JSON serialization + TTL
    await this.kv.set(`user:${id}`, data, { expirationTtl: 3600 });
  }
}

@Module({
  imports: [
    KVModule.forRoot({
      binding: 'MY_KV', // Binding name in wrangler.toml
      keyPrefix: 'app:'
    })
  ]
})
class AppModule {}
```

See [main repository](https://github.com/flareonejs/flareone) for full documentation.
npm package: @flareone/validator
Description: Validation decorators and utilities for Flareone framework
Author: Flareone Contributors
Latest version: 0.1.1

# @flareone/validator

Complete validation decorators for Flareone framework.

## Installation

```bash
npm install @flareone/validator
```

## Features

- **No Reflect Metadata**: Works entirely without `reflect-metadata`
- **Standard Validators**: `IsString`, `IsInt`, `IsEmail`, `IsUUID`, etc.
- **Nested Validation**: Support for nested DTOs via `@Type()`
- **Arrays**: `IsArray`, `IsArrayOf`, `ArrayMinSize`
- **Transformation**: Built-in transformation support

## Usage

```typescript
import { 
  IsString, 
  IsInt, 
  IsEmail, 
  Min,
  ValidateNested, 
  Type,
  IsArrayOf
} from '@flareone/validator';

class TagDto {
  @IsString()
  name: string;
}

class ProfileDto {
  @IsString()
  avatarUrl: string;
}

export class CreateUserDto {
  @IsString()
  name: string;

  @IsEmail()
  email: string;

  @IsInt()
  @Min(18)
  age: number;

  @IsArrayOf(() => TagDto)
  tags: TagDto[];

  @ValidateNested()
  @Type(() => ProfileDto)
  profile: ProfileDto;
}
```

See [main repository](https://github.com/flareonejs/flareone) for full documentation.
npm package: @flares/core
Description: TODO
Author: Mykyta Smirnov
Latest version: 1.0.0-beta.32

# 🧨🔥 Flares  - Typescript friendly status code library 


## Integrations
- express 

## Installation
Available at yarn and npm
```bash
$ npm install @flares/core
$ yarn add @flares/core
```

## Basic Flare Usage

```ts
const message = 'My message'
const data = { extra: 1 }
const cause = new Error('This is the cause')

throw new Flare(403, 'Forbidden', message, data, cause)
throw Flare(403, 'Forbidden', message, data, cause)
```

<details>
    <summary>Flare</summary>

```ts

const message = 'My message'
const data = { extra: 1 }
const cause = new Error('This error is the cause')

// Everything below is correct

throw new Flare(403, 'Forbidden', message)
throw new Flare(403, 'Forbidden', message, data)
throw new Flare(403, 'Forbidden', message, cause)
throw new Flare(403, 'Forbidden', message, data, cause)
throw new Flare(403, 'Forbidden', message, cause, data)

throw new Flare(403, 'Forbidden', data)
throw new Flare(403, 'Forbidden', data, message)
throw new Flare(403, 'Forbidden', data, cause)
throw new Flare(403, 'Forbidden', data, message, cause)
throw new Flare(403, 'Forbidden', data, cause, message)

throw new Flare(403, 'Forbidden', cause)
throw new Flare(403, 'Forbidden', cause, message)
throw new Flare(403, 'Forbidden', cause, data)
throw new Flare(403, 'Forbidden', cause, message, data)
throw new Flare(403, 'Forbidden', cause, data, message)

throw Flare(403, 'Forbidden', message)
throw Flare(403, 'Forbidden', message, data)
throw Flare(403, 'Forbidden', message, cause)
throw Flare(403, 'Forbidden', message, data, cause)
throw Flare(403, 'Forbidden', message, cause, data)

throw Flare(403, 'Forbidden', data)
throw Flare(403, 'Forbidden', data, message)
throw Flare(403, 'Forbidden', data, cause)
throw Flare(403, 'Forbidden', data, message, cause)
throw Flare(403, 'Forbidden', data, cause, message)

throw Flare(403, 'Forbidden', cause)
throw Flare(403, 'Forbidden', cause, message)
throw Flare(403, 'Forbidden', cause, data)
throw Flare(403, 'Forbidden', cause, message, data)
throw Flare(403, 'Forbidden', cause, data, message)

```
</details>
npm package: @flares/express
Description: TODO
Author: Mykyta Smirnov
Latest version: 1.0.0-beta.32

# @flares/express

This package is intended to use with packages that are compatible with `@flares/core` like:

* [```@flares/camel-case-flares```](https://www.npmjs.com/package/@flares/camel-case-flares)
* [```@flares/camel-case-code-flares```](https://www.npmjs.com/package/@flares/camel-case-code-flares)
* [```@flares/pascal-case-flares```](https://www.npmjs.com/package/@flares/pascal-case-flares)
* [```@flares/pascal-case-code-flares```](https://www.npmjs.com/package/@flares/pascal-case-code-flares)

## Basic Usage

```ts
import express from 'express'
import { FlareErrorRequestHandler, ThrowErrorRequestHandler } from '@flare/express'

// You can use any cased package to meet your code style in project
import { NotFound404, Internal500, Fls } from '@flares/pascal-case-code-flares'

const app = express()

app.get('/not-found', ThrowErrorRequestHandler(NotFound404()))

app.get('/forbidden', (req, res, next) => {
    throw Fls.Forbidden403('My message')
})

app.get('/forbidden', (req, res, next) => {
    try {
        throw new Error('Cause')
    } catch (e) {
        throw new Internal500('My custom message', e, { timestamp: Date.now() })
    }
})

app.get('/wrap-non-flare', () => {
    throw new Error('Not flare error')
})

app.use(FlareErrorRequestHandler({
    onServerFlare: console.error,
    wrapNonFlare: Internal500
}))


app.listen(8000)

```
npm package: @flaresocial/api
Description: API wrapper for the Flare Social API
Author: Flare Contributors
Latest version: 0.0.25

# @flaresocial/api

Flare Social API wrapper for javascript.


## Installation

```bash
npm install --save @flaresocial/api
# or
yarn add @flaresocial/api
# or
pnpm add @flaresocial/api
# or
bun add @flaresocial/api
```

## Usage

```ts
// Import the module
import FlareApi from "@flaresocial/api";

// get your token by creating an app, when for calling the api as a user account
// you can get it by logging in or registering
const token = FlareApi.login("usernameOrEmail", "password" /* baseUrl: string */);
// or
const _token = FlareApi.register("username", "email", "password", "Display Name", /* baseUrl: string */); // Display Name is optional

// create a new FlareApi instance:
const flare = new FlareApi(() => token /* baseUrl: string */);

// get the user's profile
const me = await flare.users.getMe();

// get all users
const users = await flare.users.getAll();

// get a user by id
const user = await flare.users.getById(me.id); // or any other user id
```

## License
This project is licensed under the [MIT License](LICENSE)
npm package: @flarestudio/flare-sdk
Description: Official TypeScript/JavaScript SDK for Flare blockchain - Access FTSO, FDC, fAssets, Staking, and more
Author: FlareStudio
Latest version: 0.1.8

# @flarestudio/flare-sdk

> Official TypeScript/JavaScript SDK for Flare blockchain

[![npm version](https://img.shields.io/npm/v/@flarestudio/flare-sdk.svg)](https://www.npmjs.com/package/@flarestudio/flare-sdk)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## 🚀 Features

- **FTSO (Price Feeds)**: Access real-time and historical price data
- **FDC (Attestations)**: Verify cross-chain events and data
- **fAssets (Bridging)**: Mint and redeem synthetic assets
- **Wallet**: Connect and interact with wallets
- **Staking**: Delegate and claim rewards
- **State Connector**: Verify blockchain state
- **Utils**: Helper functions for common operations

## 📦 Installation

```bash
npm install @flarestudio/flare-sdk
```

or

```bash
yarn add @flarestudio/flare-sdk
```

## 🎯 Quick Start

```typescript
import { FlareSDK } from '@flarestudio/flare-sdk';

// Initialize SDK
const sdk = new FlareSDK({
  network: 'flare', // or 'coston2', 'songbird', 'coston'
});

// Coming soon: Module examples
// const price = await sdk.ftso.getPrice('BTC/USD');
// const balance = await sdk.wallet.getBalance();
```

## 🏗️ Development Status

**Current Version**: 0.1.0 (Alpha)

This SDK is currently under active development. Core infrastructure is complete:

- ✅ Core SDK class
- ✅ Error handling system
- ✅ Network management
- ✅ TypeScript types
- 🚧 FTSO Module (Coming soon)
- 🚧 FDC Module (Coming soon)
- 🚧 fAssets Module (Coming soon)
- 🚧 Wallet Module (Coming soon)
- 🚧 Staking Module (Coming soon)
- 🚧 State Connector Module (Coming soon)
- 🚧 Utils Module (Coming soon)

## 📚 Documentation

Full documentation will be available at: https://flarestudio.xyz/sdk

## 🤝 Contributing

Contributions are welcome! Please read our contributing guidelines before submitting PRs.

## 📄 License

MIT © FlareStudio

## 🔗 Links

- [Website](https://flarestudio.xyz)
- [GitHub](https://github.com/Elite-tch/flarestudio)
- [npm](https://www.npmjs.com/package/@flarestudio/flare-sdk)

---

**Note**: This SDK is in early development. APIs may change before v1.0.0 release.
npm package: @flareswap/coston-polydex-sdk
Description: 🛠 An SDK for building applications on top of dex.
Author: polytea
Latest version: 5.0.0

# Polydex SDK

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![Actions Status](https://github.com/polydex/polydex-sdk/workflows/CI/badge.svg)](https://github.com/polydex/polydex-sdk)
[![npm version](https://img.shields.io/npm/v/@polydex-lib/sdk/latest.svg)](https://www.npmjs.com/package/@polydex-lib/sdk/v/latest)

## Running tests

To run the tests, follow these steps. You must have at least node v10 and [yarn](https://yarnpkg.com/) installed.

First clone the repository:

```sh
git clone https://github.com/polydex-fi/polydex-sdk.git
```

Move into the polydex-sdk working directory

```sh
cd polydex-sdk/
```

Install dependencies

```sh
yarn install
```

Run tests

```sh
yarn test
```

You should see output like the following:

```sh
yarn run v1.22.4
$ tsdx test
 PASS  test/constants.test.ts
 PASS  test/pair.test.ts
 PASS  test/fraction.test.ts
 PASS  test/miscellaneous.test.ts
 PASS  test/entities.test.ts
 PASS  test/trade.test.ts

Test Suites: 1 skipped, 6 passed, 6 of 7 total
Tests:       3 skipped, 82 passed, 85 total
Snapshots:   0 total
Time:        5.091s
Ran all test suites.
✨  Done in 6.61s.
```
npm package: @flareswap/dex-sdk
Description: 🛠 An SDK for building applications on top of dex.
Author: polytea
Latest version: 3.0.0

# Polydex SDK

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![Actions Status](https://github.com/polydex/polydex-sdk/workflows/CI/badge.svg)](https://github.com/polydex/polydex-sdk)
[![npm version](https://img.shields.io/npm/v/@polydex-lib/sdk/latest.svg)](https://www.npmjs.com/package/@polydex-lib/sdk/v/latest)

## Running tests

To run the tests, follow these steps. You must have at least node v10 and [yarn](https://yarnpkg.com/) installed.

First clone the repository:

```sh
git clone https://github.com/polydex-fi/polydex-sdk.git
```

Move into the polydex-sdk working directory

```sh
cd polydex-sdk/
```

Install dependencies

```sh
yarn install
```

Run tests

```sh
yarn test
```

You should see output like the following:

```sh
yarn run v1.22.4
$ tsdx test
 PASS  test/constants.test.ts
 PASS  test/pair.test.ts
 PASS  test/fraction.test.ts
 PASS  test/miscellaneous.test.ts
 PASS  test/entities.test.ts
 PASS  test/trade.test.ts

Test Suites: 1 skipped, 6 passed, 6 of 7 total
Tests:       3 skipped, 82 passed, 85 total
Snapshots:   0 total
Time:        5.091s
Ran all test suites.
✨  Done in 6.61s.
```
npm package: @flareswap/pancakeswap-libs-sdk
Description: 🛠 An SDK for building applications on top of pancakeswap.
Latest version: 1.0.1

# Pancakeswap SDK

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![Actions Status](https://github.com/pancakeswap/pancakeswap-sdk/workflows/CI/badge.svg)](https://github.com/pancakeswap/pancakeswap-sdk)
[![npm version](https://img.shields.io/npm/v/@pancakeswap-lib/sdk/latest.svg)](https://www.npmjs.com/package/@pancakeswap-lib/sdk/v/latest)

## Running tests

To run the tests, follow these steps. You must have at least node v10 and [yarn](https://yarnpkg.com/) installed.

First clone the repository:

```sh
git clone https://github.com/pancakeswap/pancakeswap-sdk.git
```

Move into the pancakeswap-sdk working directory

```sh
cd pancakeswap-sdk/
```

Install dependencies

```sh
yarn install
```

Run tests

```sh
yarn test
```

You should see output like the following:

```sh
yarn run v1.22.4
$ tsdx test
 PASS  test/constants.test.ts
 PASS  test/pair.test.ts
 PASS  test/fraction.test.ts
 PASS  test/miscellaneous.test.ts
 PASS  test/entities.test.ts
 PASS  test/trade.test.ts

Test Suites: 1 skipped, 6 passed, 6 of 7 total
Tests:       3 skipped, 82 passed, 85 total
Snapshots:   0 total
Time:        5.091s
Ran all test suites.
✨  Done in 6.61s.
```
npm package: @flareswap/sdk-core
Description: ⚒️ An SDK for building applications on top of Uniswap V3
Latest version: 2.0.0

# Uniswap SDK Core

[![Unit Tests](https://github.com/Uniswap/uniswap-sdk-core/workflows/Unit%20Tests/badge.svg)](https://github.com/Uniswap/uniswap-sdk-core/actions?query=workflow%3A%22Unit+Tests%22)
[![Lint](https://github.com/Uniswap/uniswap-sdk-core/workflows/Lint/badge.svg)](https://github.com/Uniswap/uniswap-sdk-core/actions?query=workflow%3ALint)
[![npm version](https://img.shields.io/npm/v/@uniswap/sdk-core/latest.svg)](https://www.npmjs.com/package/@uniswap/sdk-core/v/latest)
[![npm bundle size (scoped version)](https://img.shields.io/bundlephobia/minzip/@uniswap/sdk-core/latest.svg)](https://bundlephobia.com/result?p=@uniswap/sdk-core@latest)

This code is shared across Uniswap TypeScript SDKs.
npm package: @flareswap/v2-sdk
Description: 🛠 An SDK for building applications on top of Uniswap.
Latest version: 5.0.0

# Uniswap SDK

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![Actions Status](https://github.com/Uniswap/uniswap-sdk/workflows/CI/badge.svg)](https://github.com/Uniswap/uniswap-sdk)
[![npm version](https://img.shields.io/npm/v/@uniswap/sdk/latest.svg)](https://www.npmjs.com/package/@uniswap/sdk/v/latest)
[![npm bundle size (scoped version)](https://img.shields.io/bundlephobia/minzip/@uniswap/sdk/latest.svg)](https://bundlephobia.com/result?p=@uniswap/sdk@latest)

In-depth documentation on this SDK is available at [uniswap.org](https://uniswap.org/docs/v2/SDK/getting-started/).

## Running tests

To run the tests, follow these steps. You must have at least node v10 and [yarn](https://yarnpkg.com/) installed.

First clone the repository:

```sh
git clone https://github.com/Uniswap/uniswap-sdk.git
```

Move into the uniswap-sdk working directory

```sh
cd uniswap-sdk/
```

Install dependencies

```sh
yarn install
```

Run tests

```sh
yarn test
```

You should see output like the following:

```sh
yarn run v1.22.4
$ tsdx test
 PASS  test/constants.test.ts
 PASS  test/pair.test.ts
 PASS  test/fraction.test.ts
 PASS  test/miscellaneous.test.ts
 PASS  test/entities.test.ts
 PASS  test/trade.test.ts

Test Suites: 1 skipped, 6 passed, 6 of 7 total
Tests:       3 skipped, 82 passed, 85 total
Snapshots:   0 total
Time:        5.091s
Ran all test suites.
✨  Done in 6.61s.
```
npm package: @flareumxyz/sdk
Description: An SDK for building applications on top of Flareum.
Latest version: 1.0.4

# Flareum SDK
This repo contains tools for developing with [Flareum](https://flareum.xyz).

## Running
This project uses standard npm and yarn workflows.

Install dependencies

```sh
yarn
```

Compile
```sh
yarn build
```

## Installation
This project is available as an npm package. Add to your project with `npm install @flareum-xyz/sdk`

## Attribution
This code was adapted from this Uniswap repo: [uniswap-sdk](https://github.com/Uniswap/sdk).
npm package: @flareumxyz/uikit
Description: Set of UI components for flareum projects
Latest version: 1.0.0

# Flareum UIkit

Flareum UIkit is a set of React components and hooks used to build pages on Flareum's apps. It also contains a theme file for dark and light mode.

## Install

`yarn add @flareumxyz/uikit`

## Setup

### Theme

Before using Flareum UIkit, you need to provide the theme file to styled-component.

```
import { ThemeProvider } from 'styled-components'
import { light, dark } from '@flareumxyz/uikit'
...
<ThemeProvider theme={isDark}>...</ThemeProvider>
```

### Reset

A reset CSS is available as a global styled component.

```
import { ResetCSS } from '@flareumxyz/uikit'
...
<ResetCSS />
```

### Types

This project is built with Typescript and export all the relevant types.