JoyID JavaScript SDK

This is monorepo for JoyID JavaScript SDK.

Overview

In order to interact with JoyID App we provide different packages to meet different requirements.

@joyid/ckb: SDK for manipulating Nervos CKB assets, including transferring CKB/mNFT/CoTA NFT, signing Raw Transaction, etc.
@joyid/bitcoin: UniSat Wallet compatible SDK for manipulating Bitcoin assets.
@joyid/evm: SDK for manipulating EVM-compatible blockchains assets.
@joyid/nostr: NIP-07 implementation for Nostr protocol.
@joyid/ethers: Ethers.js implementation for JoyID EVM SDK.
@joyid/wagmi: Wagmi implementation for JoyID EVM SDK.
@joyid/rainbowkit: RainbowKit implementation for JoyID EVM SDK.
@joyid/ethereum-provider: EIP-1193 implementation for JoyID EVM SDK.
@joyid/miniapp: SDK for Telegram MiniApp.

You can choose the appropriate SDK package according to your application scenario and follow the instructions in the documentation for installation and use. If you need technical support, feel free to contact us in Discord.

Examples

We provide examples for each package in the examples directory. Every example is a standalone project that demonstrates how to use the SDK in a specific scenario. You can run the examples by running the following commands:

pnpm run dev

There are six examples in the examples directory:

CKB Demo: Example for @joyid/ckb SDK. Preview
Bitcoin Demo: Example for @joyid/bitcoin SDK. Preview
EVM Demo: Example for @joyid/evm SDK. Preview
Wagmi Demo: Example for @joyid/wagmi SDK. Preview
RainbowKit Demo: Example for @joyid/rainbowkit SDK. Preview
nostr Demo: Example for @joyid/nostr SDK. Preview

Development

Installation

npm i -g pnpm
pnpm install

Build

pnpm build

Contributing

We welcome contributions from the community. If you want to contribute to JoyID JavaScript SDK, please read the Contributing Guide first.