Skip to content

Latest commit

 

History

History

core

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
CHANGELOG.md
CHANGELOG.md
 
 
README.md
README.md
 
 
package.json
package.json
 
 
tsconfig.build.json
tsconfig.build.json
 
 
tsconfig.json
tsconfig.json
 
 
vitest.config.mts
vitest.config.mts
 
 

README.md

@spore-sdk/core

About

Version MIT License Downloads per month

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

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

Getting started

Installation

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

npm install @spore-sdk/core

Browser environment

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

  • crypto-browserify
  • buffer

If you wish to use the Spore SDK in a browser environment, it's important to manually add Node-polyfills to your application. This ensures that the Spore SDK functions properly in the browser. Visit: CRA, Vite, Webpack or Other.

About the project

This package is a part of the Spore SDK monorepo.

For complete descriptions and instructions, visit: Spore SDK.

License

MIT License