sporeprotocol / spore-sdk

The Ultimate TypeScript SDK for Spore Protocol

Spore SDK

「The Ultimate TypeScript SDK for Spore Protocol」

Spore SDK is a comprehensive web development kit specifically designed for seamless integration with Spore, an on-chain asset protocol to power digital asset ownership, distribution, and value capture, built on top of CKB.

With Spore SDK, developers gain access to powerful tools and resources that enable them to effortlessly create spore-related dapps, fully leveraging the immense potential of Spore Protocol.

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

Documentation

Full documentation and instructions, visit: Spore Docs.

Getting started

Installation

Go through the recipe Start using Spore SDK for installation.

Running in Node.js

• Follow the tutorial to learn about spore creation: Create your first Spore
• Refer to specific code snippets: Spore Examples

Running in browsers

• Follow the tutorial to build a dapp from scratch: Create simple on-chain blog
• Explore all featured dapp demos: Spore Demos

Development

Toolchain & utilities

• @spore-sdk/core - Provides essential tools for constructing basic and advanced transactions on spores and clusters. Additionally, it offers convenient utilities for handling serialization of spores/clusters

Reference

• Examples - Code block examples for implementing basic and specific features

• Demos - Demo applications with full functionality, including seamless integration with wallets

API

• Composed APIs - Efficient APIs to build Spore transactions with minimal time overhead

• Utilities - Handy helper functions to save developers' time and effort

Community

Chat everything about Spore here:

• Join our discord channel: HaCKBee
• Contact via email: [email protected]

Contributing

To submit pull requests, make sure:

• Please submit pull requests based on the beta branch
• Please ensure your commit styling won't conflict with the existing commits
• Please provide a clear and descriptive title and description for your pull requests

License

MIT License