ckb-fi-sdk

CKB-FI SDK

The SDK for CKB-FI ecosystem.

Bonding SDK

🎾 Demo

CKB-FI SDK Demo

💊 Usage

1、UMD

<script src="https://cdn.jsdelivr.net/npm/@ckb-fi/bonding@latest/dist/ckb-fi-bonding.umd.js"></script>

<script>
  window.onload = function () {
    const BondingInstance = new CKBFiBonding.Bonding()
    console.log(BondingInstance, 'CKB-FI Bonding SDK initialized')
  }
</script>

2、ES Module

npm i @ckb-fi/bonding -S

import {
  Bonding,
  Enum_Env
} from "@ckb-fi/bonding";

  window.onload = function () {
    const BondingInstance = new Bonding()
    console.log(BondingInstance, 'CKB-FI Bonding SDK initialized')
  }
}

🛠️ Options

🔸 I_BondingOptions

interface I_BondingOptions {
  env?: Enum_Env
}

Field	Description	Type	Default
env	Environment	Enum_Env	Enum_Env.PROD

// Initialize
const BondingInstance = new Bonding(Options:I_BondingOptions)

🧩 Methods

🔹 getTicket: (address: string) => Promise

// Get ticket by address
const ticket = BondingInstance.getTicket('ckb...')
console.log('GetTicket success', ticket)

🔹 signMessage: (params: I_SignMessageParams) => Promise

// Sign ticket using your current provider
const resSign = BondingInstance.signMessage(params)
console.log('SignMessage success', resSign)

🔹 login: (params: I_LoginParams) => Promise

// Login to ckb.fi
const token = BondingInstance.login(params)
console.log('Login success', token)

🔹 launch: (params: I_LaunchParams) => Promise<BondingItem | undefined>

// Launch memecoin
const data = BondingInstance.launch(params: I_LaunchParams)
console.log('Launch success', data)

🛠️ Development

Execute pnpm run dev to start the demo project in the /apps/ckb fi sdk demo directory.

🧿 Turborepo

This project generated from a Turborepo starter. Run the following command to init a new project:

npx create-turbo@latest -e with-vite

And this project includes the following packages and apps:

– Apps

ckb-fi-sdk-demo: used for testing SDK

– Packages

docs: documentation
web: webapps
@ckb-fi/bonding: SDK for handling bondings
@ckb-fi/utils: a stub utility library shared by all applications
@ckb-fi/eslint-config: shared eslint configurations
@ckb-fi/typescript-config: tsconfig.jsons used throughout the monorepo

🦴 Utils

This Turborepo has some additional tools already setup for you:

TypeScript for static type checking
ESLint for code linting
Prettier for code formatting
Purge JSdelivr Cache for clear file cache