example

README

Example

CKB Go SDK examples

Introduction

The example.go provides some examples shows how to use this sdk to interact with CKB's RPC, transaction, and Nervos DAO(deposit and withdraw).

Transaction Examples

These examples show how to transfer CKB, in different situations.

• SendCkbExample: sign and send CKB from single-sig address.
• SendCkbByLightClientExample: similiar to SendCkbExample but interact with ckb-light-client
• SendCkbFromMultisigAddressExample: sign and send CKB from multi-sig address with multiple private keys.
• SendChainedTransactionExample: sign and send offchain transaction

SUDT Examples

SUDT (Simple User Defined Tokens) is a token specification on CKB. You can think SUDT is an analog of ERC20 on Ethereum.

Anyone can issue his own SUDT, or transfer a specific kind of SUDT if he has enough SUDT amount. SUDT smart contract should be used in type script in these transactions.

• IssueSudtExample: shows how to issue SUDT
• SendSudtExample: shows how to send issued SUDT

Nervos DAO Examples

Nervos DAO is a smart contract, with which users can interact the same way as any smart contracts on CKB. Nervos DAO has deposit and withdraw (phase1 and phase2).

• Deposit: Users can send a transaction to deposit CKB into Nervos DAO at any time. CKB includes a special Nervos DAO type script in the genesis block.
• Withdraw: Users can send a transaction to withdraw deposited CKB from Nervos DAO at any time (but a locking period will be applied to determine when exactly the tokens can be withdrawn).

Check Nervos DAO RFC for more details

• DepositDaoExample: shows how to deposit DAO
• WithdrawDaoExample: shows how to withdraw deposited CKB from Nervos DAO

OmniLock Examples

Omnilock is a new lock script designed for interoperability. Check https://blog.cryptape.com/omnilock-a-universal-lock-that-powers-interoperability-1 for more details

• SendCkbOmnilockExample: similar to SendCkbExample, but use Omnilock to sign.
• SendCkbMultisigOmnilockExample: similar to SendCkbFromMultisigAddressExample, but use Omnilock to sign.

Documentation

Index

• func ClaimDaoExample() error
• func DepositDaoExample() error
• func IssueSudtExample() error
• func SendChainedTransactionExample() error
• func SendCkbByLightClientExample() error
• func SendCkbExample() error
• func SendCkbFromMultisigAddressExample() error
• func SendCkbMultisigOmnilockExample() error
• func SendCkbOmnilockExample() error
• func SendSudtExample() error
• func WithdrawDaoExample() error

Functions

func ClaimDaoExample

func ClaimDaoExample() error

func DepositDaoExample

func DepositDaoExample() error

func IssueSudtExample

func IssueSudtExample() error

func SendChainedTransactionExample

func SendChainedTransactionExample() error

func SendCkbByLightClientExample

func SendCkbByLightClientExample() error

func SendCkbExample

func SendCkbExample() error

func SendCkbFromMultisigAddressExample

func SendCkbFromMultisigAddressExample() error

func SendCkbMultisigOmnilockExample

func SendCkbMultisigOmnilockExample() error

func SendCkbOmnilockExample

func SendCkbOmnilockExample() error

func SendSudtExample

func SendSudtExample() error

func WithdrawDaoExample

func WithdrawDaoExample() error