An open API service indexing awesome lists of open source software.

https://github.com/fleet-sdk/fleet

🦾 Simple, powerful, and extensible Ergo Blockchain SDK
https://github.com/fleet-sdk/fleet

blockchain ergo ergoplatform eutxo javascript off-chain sdk typescript utxo

Last synced: about 1 month ago
JSON representation

🦾 Simple, powerful, and extensible Ergo Blockchain SDK

Awesome Lists containing this project

README

        

# Fleet SDK [![Checks](https://img.shields.io/github/actions/workflow/status/fleet-sdk/fleet/ci.yml?logo=githubactions)](https://github.com/fleet-sdk/fleet/actions) [![Coverage](https://img.shields.io/codecov/c/gh/fleet-sdk/fleet?logo=codecov)](https://app.codecov.io/gh/fleet-sdk/fleet)

Fleet (Fluent Ergo Toolset) is a comprehensive TypeScript SDK for the Ergo Platform, designed to provide a seamless, fluent, and flexible approach to writing off-chain and on-chain code.

## Packages

This is a [monorepository](https://monorepo.tools/) which means this contains many sub-packages that composes full Fleet SDK implementation.

| Package | Description | |
| ------------------------------------------------------- | ------------------------------------------------------------------------- | :-----------------------------------------------------------------------------------------------------------------------------------: |
| [core](/packages/core/) | Core library with transaction builder and basic serialization. | [![npm](https://img.shields.io/npm/v/@fleet-sdk/core)](https://www.npmjs.com/package/@fleet-sdk/core) |
| [wallet](/packages/wallet/) | Wallet related library, with mnemonic and keys management. | [![npm](https://img.shields.io/npm/v/@fleet-sdk/wallet)](https://www.npmjs.com/package/@fleet-sdk/wallet) |
| [common](/packages/common/) | Internal types and utility functions shared across `@fleet-sdk` packages. | [![npm](https://img.shields.io/npm/v/@fleet-sdk/common)](https://www.npmjs.com/package/@fleet-sdk/common) |
| [crypto](/packages/crypto/) | Ergo blockchain crypto primitives. | [![npm](https://img.shields.io/npm/v/@fleet-sdk/crypto)](https://www.npmjs.com/package/@fleet-sdk/crypto) |
| [serializer](/packages/serializer/) | Ergo data serializer and parser. | [![npm](https://img.shields.io/npm/v/@fleet-sdk/serializer)](https://www.npmjs.com/package/@fleet-sdk/serializer) |
| [mock-chain](/packages/mock-chain/) | Mock chain and testing utilities for Ergo Smart Contracts. | [![npm](https://img.shields.io/npm/v/@fleet-sdk/mock-chain)](https://www.npmjs.com/package/@fleet-sdk/mock-chain) |
| [compiler](/packages/compiler/) | Sigma.JS powered ErgoScript compiler. | [![npm](https://img.shields.io/npm/v/@fleet-sdk/compiler)](https://www.npmjs.com/package/@fleet-sdk/compiler) |
| [blockchain-providers](/packages/blockchain-providers/) | Blockchain data providers. | [![npm](https://img.shields.io/npm/v/@fleet-sdk/blockchain-providers)](https://www.npmjs.com/package/@fleet-sdk/blockchain-providers) |

## Plugins

| Package | Description | |
| ----------------------------------------- | --------------------------------------------------------------- | :-----------------------------------------------------------------------------------------------------------------------------: |
| [babel-fees-plugin](/plugins/babel-fees/) | Fleet SDK plugin and utility functions for Babel Fees protocol. | [![npm](https://img.shields.io/npm/v/@fleet-sdk/babel-fees-plugin)](https://www.npmjs.com/package/@fleet-sdk/babel-fees-plugin) |
| [ageusd-plugin](/plugins/ageusd/) | Fleet SDK plugin and utility functions for AgeUSD protocol. | [![npm](https://img.shields.io/npm/v/@fleet-sdk/ageusd-plugin)](https://www.npmjs.com/package/@fleet-sdk/ageusd-plugin) |

## Fleet SDK Usage Examples

- [Nautilus' internal transaction builder](https://github.com/capt-nemo429/nautilus-wallet/blob/master/src/api/ergo/transaction/txBuilder.ts#L95)
- [Ergonames SDK](https://github.com/ergonames/sdk/blob/master/tx-lib/index.js)
- [Stealth Address example implementation](https://github.com/ross-weir/ergo-stealth-address-example)
- [SigmaFi UI](https://github.com/capt-nemo429/sigmafi-ui)