Skip to content

MyceliumSDK/mycelium-sdk

Repository files navigation

MyceliumSDK

The open-source SDK for simple DeFi integration

Create your own products without worry about DeFi and Web3 complexity

NPM Version Documentation License CI Status

What is MyceliumSDK?

A TypeScript-based monorepo that contains:

  • SDK to access yield opportunities using abstract high-level methods
  • Services for local development and testing the SDK

To get more about the Mycelium SDK itself, check the SDK README.md file

Project structure

This monorepo is organized into three main packages:

  • packages/sdk - source code of Mycelium SDK
  • packages/cli - command-line interface for interacting with the Mycelium SDK
  • packages/blockchain - local blockchain service with faucet functionality and an ability to access fork RPC and Bundler (Alto). Can be used with packages/cli

!IMPORTANT: SDK can be used via npm registry, the repo contains purely the source code and additional services (cli and blockchain) for further development

For each separate installation guide, please check each package separately:

Prerequisites

  • pnpm >= 10.9.0
  • node >= 22.11.0

Local development

For local development, please take a look at separate projects README.md files:

Contributing

Check the CONTRIBUTION.md

License

This project is licensed under the dual license - Apache 2.0 + Commercial - see the LICENSE

About

Plug-and-play SDK gateway to access Web3 yield opportunities

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors