Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ckb-js/ckb-sdk-js
JavaScript SDK for CKB
https://github.com/ckb-js/ckb-sdk-js
blockchain ckb javascript nervos
Last synced: 15 days ago
JSON representation
JavaScript SDK for CKB
- Host: GitHub
- URL: https://github.com/ckb-js/ckb-sdk-js
- Owner: ckb-js
- License: mit
- Created: 2019-01-07T05:52:58.000Z (almost 6 years ago)
- Default Branch: develop
- Last Pushed: 2024-10-11T18:33:39.000Z (about 1 month ago)
- Last Synced: 2024-10-25T02:15:21.607Z (17 days ago)
- Topics: blockchain, ckb, javascript, nervos
- Language: JavaScript
- Homepage: https://www.nervos.org
- Size: 5.11 MB
- Stars: 42
- Watchers: 8
- Forks: 30
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nervos-ckb - JavaScript SDK
README
⚠️ **This SDK is obsolete and maintained passively.**
## Recommended SDK: CCC
It’s highly recommended to use the [CCC SDK](https://github.com/ckb-ecofund/ccc) as your primary development tool within the CKB ecosystem. [CCC](https://github.com/ckb-ecofund/ccc) is the latest and most robust JavaScript SDK designed to streamline and enhance your development process. By choosing [CCC](https://github.com/ckb-ecofund/ccc), you'll be leveraging the best practices and most up-to-date features available for CKB development.
To get started with [CCC](https://github.com/ckb-ecofund/ccc), follow the [installation guide](https://github.com/ckb-ecofund/ccc#installing) and explore the [documentation](https://docs.ckbccc.com/) to integrate it seamlessly into your projects.
---
# CKB SDK JavaScript
| Service | Master | Develop |
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Unit Tests | [](https://github.com/ckb-js/ckb-sdk-js/actions?query=branch%3Amaster+workflow%3A%22Unit+Tests%22) | [](https://github.com/ckb-js/ckb-sdk-js/actions?query=branch%3Adevelop+workflow%3A%22Unit+Tests%22) |
| Coverage | [](https://codecov.io/gh/ckb-js/ckb-sdk-js/branch/master) | [](https://codecov.io/gh/ckb-js/ckb-sdk-js/branch/develop) |
[](https://www.npmjs.com/package/@nervosnetwork/ckb-sdk-core)
[](https://packagequality.com/#?package=@nervosnetwork/ckb-sdk-core)
[](./LICENSE)
[](https://t.me/nervos_ckb_dev)
[](https://github.com/ckb-js/ckb-sdk-js/actions?query=workflow%3ASNYK)
[](https://nervosnetwork.github.io/ckb-sdk-js/classes/_nervosnetwork_ckb_sdk_core.default.html)
JavaScript SDK for Nervos [CKB](https://github.com/nervosnetwork/ckb).
The ckb-sdk-js is still under development and aim for providing low-level APIs of data construction. You should get familiar with CKB transaction structure and RPCs before using it and design your own DApp SDK based on this one.
ToC
- [Type Doc](#typedoc)
- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Modules](#modules)
- [CORE](#core)
- [RPC](#rpc)
- [Utils](#utils)
- [Errors](#errors)
- [Examples](#examples)
- [Troubleshooting](#troubleshooting)
- [Development Process](#development-process)
---
# TypeDoc
- [Global](https://nervosnetwork.github.io/ckb-sdk-js/index.html)
- [Core](https://nervosnetwork.github.io/ckb-sdk-js/classes/_nervosnetwork_ckb_sdk_core.default.html)
- [RPC](https://nervosnetwork.github.io/ckb-sdk-js/classes/_nervosnetwork_ckb_sdk_rpc.default.html)
- [Types](https://nervosnetwork.github.io/ckb-sdk-js/modules/_nervosnetwork_ckb_types.CKBComponents.html)
# Introduction
`@nervosnetwork/ckb-sdk-core` is the SDK used to interact with [Nervos CKB](https://github.com/nervosnetwork/ckb), which is an open source project of public blockchain.
## Before everything
Due to safety concern, the SDK won’t generate private keys for you. You can use `openssl` to generate a private key:
```sh
$ openssl rand -hex 32
```
For other cases, say, you're going to generate it in a JavaScript Project(Please don't), [Elliptic](https://github.com/indutny/elliptic/) may be the one you can use.
## About Nervos CKB
> Nervos CKB is the layer 1 of Nervos Network, a public blockchain with PoW and cell model.
> Nervos project defines a suite of scalable and interoperable blockchain protocols. Nervos CKB uses those protocols to create a self-evolving distributed network with a novel economic model, data model and more.
> _Notice:_ The ckb process will send stack trace to sentry on Rust panics. This is enabled by default before mainnet, which can be opted out by setting the option dsn to empty in the config file.
## About @nervosnetwork/ckb-sdk-core
`@nervosnetwork/ckb-sdk-core` is an SDK implemented by JavaScript, and published in [NPM Registry](https://www.npmjs.com/package/@nervosnetwork/ckb-sdk-core/), which provides APIs for developers to send requests to the CKB blockchain.
This SDK can be used both in Browsers and [Node.js](https://nodejs.org) as it's source code is implemented by TypeScript, which is a superset of JavaScript and compiled into ES6. For some browsers that have old versions, some polyfills might be injected.
# Prerequisites
We are going to use [yarn](https://yarnpkg.com/) for the next steps, which is similar to [npm](https://npmjs.com), so feel free to pick one.
For the developers who are interested in contribution.
# Installation
```sh
$ yarn add @nervosnetwork/ckb-sdk-core # install the SDK into your project
```
# Modules
This SDK includes several modules:
RPC Code
Used to send RPC request to the CKB, the list could be found in [CKB Project](https://github.com/nervosnetwork/ckb/blob/develop/util/jsonrpc-types/src/blockchain.rs)
Interfaces could be found in `DefaultRPC` class in this module.
Utils Code
The Utils module provides useful methods for other modules.
Types Code
The Types module used to provide the type definition of CKB Components according to the [CKB Project](https://github.com/nervosnetwork/ckb/blob/develop/util/jsonrpc-types/src/blockchain.rs).
CKB Project compiles to the snake case convetion, which listed in the types/CKB_RPC in the RPC module.
TypeScript compiles to the PascalCase convention, which listed in this module.
# CORE
All the modules above are integrated into the core module. You can find `rpc` and `utils` in the core instance.
To use the core module, you need to import it in your project and instantiate it with a node object. For now, the node object only contains one field named `url`, the URI of the blockchain node your are going to communicate with.
```javascript
const CKB = require('@nervosnetwork/ckb-sdk-core').default
const nodeUrl = 'http://localhost:8114'
const ckb = new CKB(nodeUrl)
```
After that you can use the `ckb` object to generate addresses, send requests, etc.
# RPC
## Basic RPC
Please see [Basic RPC](https://github.com/ckb-js/ckb-sdk-js/blob/develop/packages/ckb-sdk-rpc/src/Base/index.ts#L23)
## Batch Request
```javascript
/**
* The following batch includes two requests
* 1. getBlock('0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee')
* 2. getTransactionsByLockHash('0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee', '0x0', '0x1)
*/
const batch = rpc.createBatchRequest([
['getBlock', '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee'],
['getTransactionsByLockHash', '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee', '0x0', '0x1'],
])
/**
* Add a request and the batch should include three requests
* 1. getBlock('0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee')
* 2. getTransactionsByLockHash('0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee', '0x0', '0x1)
* 3. getTransactionsByLockHash('0xcccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc', '0x0', '0x1)
*/
batch.add(
'getTransactionsByLockHash',
'0xcccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc',
'0x0',
'0x1',
)
/**
* Remove a request by index and the batch should include two requests
* 1. getBlock('0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee')
* 2. getTransactionsByLockHash('0xcccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc', '0x0', '0x1)
*/
batch.remove(1)
/**
* Send the batch request
*/
batch.exec().then(console.log)
// [
// { "header": { }, "uncles": [], "transactions": [], "proposals": [] },
// [ { "consumedBy": { }, "createdBy": { } } ]
// ]
// chaning usage
batch.add().remove().exec()
```
## Persistent Connection
Please add `httpAgent` or `httpsAgent` to enable the persistent connection.
If the SDK is running in Node.js, the following steps make the persistent connection available.
```javascript
// HTTP Agent
const http = require('http')
const httpAgent = new http.Agent({ keepAlive: true })
ckb.rpc.setNode({ httpAgent })
// HTTPS Agent
const https = require('https')
const httpsAgent = new https.Agent({ keepAlive: true })
ckb.rpc.setNode({ httpsAgent })
```
# Utils
[Most used utilities](https://github.com/ckb-js/ckb-sdk-js/blob/develop/packages/ckb-sdk-utils/README.md)
# Errors
1. RPC Errors
The rpc module will throw an error when the result contains an error field, you need to handle it manually.
# Examples
1. [Send Simple Transaction](https://github.com/ckb-js/ckb-sdk-js/blob/develop/packages/ckb-sdk-core/examples/sendSimpleTransaction.js)
2. [Send All Balance](https://github.com/ckb-js/ckb-sdk-js/blob/develop/packages/ckb-sdk-core/examples/sendAllBalance.js)
3. [Send Transaction with multiple private key](https://github.com/ckb-js/ckb-sdk-js/blob/develop/packages/ckb-sdk-core/examples/sendTransactionWithMultiplePrivateKey.js)
4. [Deposit to and withdraw from Nervos DAO](https://github.com/ckb-js/ckb-sdk-js/blob/develop/packages/ckb-sdk-core/examples/nervosDAO.js)
5. [Send Transaction with Lumos Collector](https://github.com/ckb-js/ckb-sdk-js/blob/develop/packages/ckb-sdk-core/examples/sendTransactionWithLumosCollector.js)
6. [SUDT](https://github.com/ckb-js/ckb-sdk-js/blob/develop/packages/ckb-sdk-core/examples/sudt.js)
# Troubleshooting
## Indexer Module
The Indexer Module in CKB has been deprecated since [v0.36.0](https://github.com/nervosnetwork/ckb/releases/tag/v0.36.0), please use [ckb-indexer](https://github.com/nervosnetwork/ckb-indexer) or [lumos-indexer](https://github.com/nervosnetwork/lumos/tree/develop/packages/indexer) instead.
A simple example [sendTransactionWithLumosCollector](https://github.com/ckb-js/ckb-sdk-js/blob/develop/packages/ckb-sdk-core/examples/sendTransactionWithLumosCollector.js) of wokring with lumos has beed added.
# Development Process
This project used [lerna](https://github.com/lerna/lerna/) for packages management, which needs to be bootstrapped by the following steps:
```sh
$ yarn add lerna --exact --ignore-workspace-root-check # to install the lerna package in this project, could be skipped if the lerna has been installed globally
$ npx lerna bootstrap # install the depedencies and link the packages in the project
$ yarn run tsc # build packages with tsc command
```
After the second step, namely the bootstrap, all module packages are linked together, and used as in one package.