@spore-sdk/core

Features

• ⚡ Composed APIs for efficient spores/clusters interactions with minimal time overhead
• 🧩 Joint APIs for building advanced transactions as a fun block-building process
• 🛠️ Utilities for encoding/decoding data of spores/clusters
• 🎹 Fully written in TypeScript

Installation

Install @spore-sdk/core as a dependency using any package manager, such as npm:

npm install @spore-sdk/core

Getting started

Create your first spore in Node.js

Follow the step-by-step tutorial to create your first spore: Creating your first Spore.

Or you can run and play with the spore-first-example on StackBlitz.

Follow the recipes

Explore the categorized recipes section in the Spore Docs for detailed instructions: How-to recipes.

Or study the following recipes to explore the usage of the SDK:

• Construct transactions with Spore SDK

• Create immortal spores on-chain

• Pay fee with capacity margin

• Handle spore/cluster data

• Configure Spore SDK

Building browser env dapps

The Spore SDK is built on top of Lumos, an open-source dapp framework for Nervos CKB. Lumos incorporates certain Node-polyfills into its implementation, such as crypto-browserify and buffer, to provide specific functionalities.

If you intend to use the Spore SDK in a browser environment, it's important to note that you may need to manually add Node-polyfills to your application. This ensures that the Spore SDK functions properly in the browser. For detailed instructions on how to add these polyfills, refer to the Lumos documentation: CRA, Vite, Webpack or Other.

Resources

• Examples - Code block examples for implementing basic and specific features.
• Demos - Demo applications with full functionality, including seamless integration with wallets.

API

• Composed APIs - APIs for efficient spores/clusters. interactions with minimal time overhead
• Joint APIs (WIP) - APIs for building advanced transactions as a fun block-building process.

License

MIT License