`@ckb-lumos/helpers`

Helper utilities for working with CKB transactions from lumos.

The difference between this and @ckb-lumos/base, is that @ckb-lumos/base contains only core definitions, while this module contains utilities used in a framework sense. One example is: you can pretty much use @ckb-lumos/base as a standalone library, while this library integrates more with config module so it knows whether the framework is running under testnet, or mainnet environment.

Usage

const { minimalCellCapacity, generateAddress, parseAddress } = require("@ckb-lumos/helpers")

// Get cell minimal capacity.
const result = minimalCellCapacity({
  cellOutput: {
    capacity: "0x174876e800",
    lock: {
      args: "0x36c329ed630d6ce750712a477543672adab57f4c",
      codeHash:
        "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8",
      hashType: "type",
    },
    type: null,
  },
  data: "0x",
  blockHash: null,
  blockNumber: null,
  outPoint: null,
})

// result will be 6100000000n shannons.

// Use `generateAddress` to get address from lock script.
const address = generateAddress({
  codeHash:
    "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8",
  hashType: "type",
  args: "0x36c329ed630d6ce750712a477543672adab57f4c",
})

// Then you will get mainnet address "ckb1qyqrdsefa43s6m882pcj53m4gdnj4k440axqdt9rtd", or you can generate testnet address by
const { predefined } = require("@ckb-lumos/config-manager")

const address = generateAddress({
  codeHash:
    "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8",
  hashType: "type",
  args: "0x36c329ed630d6ce750712a477543672adab57f4c",
}, { config: predefined.AGGRON4 })

// Will get testnet address "ckt1qyqrdsefa43s6m882pcj53m4gdnj4k440axqswmu83".

// Use `parseAddress` to get lock script from an address.
const script = parseAddress("ckb1qyqrdsefa43s6m882pcj53m4gdnj4k440axqdt9rtd")

// TransactionSkeleton <=> Object

// Convert TransactionSkeleton to js object
const obj = transactionSkeletonToObject(txSkeleton)
// then your can write to json file
fs.writeFileSync("your file", JSON.stringify(obj))

// Or convert js object to TransactionSkeleton
// If your object is from json file, make sure `cellProvider` is working properly.
const txSkeleton = objectToTransactionSkeleton(obj)

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

HashAlgorithm

HashAlgorithm: "ckb-blake2b-256" | "ckb-blake2b-160"

HashAlgorithm

HashAlgorithm: "ckb-blake2b-256" | "ckb-blake2b-160"

LiveCellFetcher

LiveCellFetcher: (outPoint: OutPoint) => Promisable<Cell>

Type declaration

- (outPoint: OutPoint): Promisable<Cell>
- Parameters
  - outPoint: OutPoint
  Returns Promisable<Cell>

LiveCellFetcher

LiveCellFetcher: (outPoint: OutPoint) => Promisable<Cell>

Type declaration

- (outPoint: OutPoint): Promisable<Cell>
- Parameters
  - outPoint: OutPoint
  Returns Promisable<Cell>

PredefinedScriptName

PredefinedScriptName: keyof typeof SCRIPTS

PredefinedScriptName

PredefinedScriptName: keyof typeof SCRIPTS

Promisable

Promisable<T>: Promise<T> | T

Type parameters

Promisable

Promisable<T>: Promise<T> | T

Type parameters

TransactionSkeletonType

TransactionSkeletonType: Record<TransactionSkeletonInterface> & Readonly<TransactionSkeletonInterface>

TransactionSkeletonType

TransactionSkeletonType: Record<TransactionSkeletonInterface> & Readonly<TransactionSkeletonInterface>

Variables

Const ADDRESS_FORMAT_FULL

ADDRESS_FORMAT_FULL: 0 = 0

full version identifies the hashType

Const ADDRESS_FORMAT_FULL

ADDRESS_FORMAT_FULL: 0 = 0

full version identifies the hashType

Const ADDRESS_FORMAT_FULLDATA

ADDRESS_FORMAT_FULLDATA: 2 = 2

deprecated: full version with hashType = "Data", deprecated

Const ADDRESS_FORMAT_FULLDATA

ADDRESS_FORMAT_FULLDATA: 2 = 2

deprecated: full version with hashType = "Data", deprecated

Const ADDRESS_FORMAT_FULLTYPE

ADDRESS_FORMAT_FULLTYPE: 4 = 4

deprecated: full version with hashType = "Type", deprecated

Const ADDRESS_FORMAT_FULLTYPE

ADDRESS_FORMAT_FULLTYPE: 4 = 4

deprecated: full version with hashType = "Type", deprecated

Const ADDRESS_FORMAT_SHORT

ADDRESS_FORMAT_SHORT: 1 = 1

deprecated: short version for locks with popular codeHash, deprecated

Const ADDRESS_FORMAT_SHORT

ADDRESS_FORMAT_SHORT: 1 = 1

deprecated: short version for locks with popular codeHash, deprecated

Const BECH32_LIMIT

BECH32_LIMIT: 1023 = 1023

Const BECH32_LIMIT

BECH32_LIMIT: 1023 = 1023

Let HAS_WARNED_FOR_DEPRECATED_ADDRESS

HAS_WARNED_FOR_DEPRECATED_ADDRESS: boolean = false

Const TransactionSkeleton

TransactionSkeleton: Factory<TransactionSkeletonInterface>

Const TransactionSkeleton

TransactionSkeleton: Factory<TransactionSkeletonInterface> = Record<TransactionSkeletonInterface>({cellProvider: null,cellDeps: List(),headerDeps: List(),inputs: List(),outputs: List(),witnesses: List(),fixedEntries: List(),signingEntries: List(),inputSinces: ImmutableMap(),})

Const addressToScript

addressToScript: typeof parseAddress

Const addressToScript

addressToScript: parseAddress = parseAddress

bytify

bytify: bytify

hexify

hexify: hexify

Const scriptToAddress

scriptToAddress: typeof generateAddress

deprecated: please migrate to encodeToAddress, the short format address will be removed in the future

Const scriptToAddress

scriptToAddress: generateAddress = generateAddress

deprecated: please migrate to encodeToAddress, the short format address will be removed in the future

Functions

byteArrayToHex

byteArrayToHex(a: number[]): HexString

- Defined in packages/helpers/lib/utils.d.ts:3
Parameters
- a: number[]
Returns HexString

byteArrayToHex

byteArrayToHex(a: number[]): HexString

- Defined in packages/helpers/src/utils.ts:18
Parameters
- a: number[]
Returns HexString

createHasher

createHasher(algorithm: HashAlgorithm): Hasher

- Defined in packages/helpers/src/validate.ts:12
Parameters
- algorithm: HashAlgorithm
Returns Hasher

createTransactionFromSkeleton

createTransactionFromSkeleton(txSkeleton: TransactionSkeletonType, __namedParameters?: { validate: undefined | false | true }): Transaction

- Defined in packages/helpers/lib/index.d.ts:77
Parameters
- txSkeleton: TransactionSkeletonType
- Optional __namedParameters: { validate: undefined | false | true }
  - validate: undefined | false | true
Returns Transaction

createTransactionFromSkeleton

createTransactionFromSkeleton(txSkeleton: TransactionSkeletonType, __namedParameters?: { validate: boolean }): Transaction

- Defined in packages/helpers/src/index.ts:341
Parameters
- txSkeleton: TransactionSkeletonType
- Default value __namedParameters: { validate: boolean } = {}
  - validate: boolean
Returns Transaction

createTransactionSkeleton

createTransactionSkeleton(transaction: Transaction, fetcher: LiveCellFetcher): Promise<TransactionSkeletonType>

- Defined in packages/helpers/lib/index.d.ts:91
create a TransactionSkeleton from a Transaction
example
```
const rpc = new RPC('localhost:8114')
const fetcher = (outPoint: OutPoint) => rpc.getLiveCell(outPoint)
const skeleton = await createTransactionSkeleton({ transaction, fetcher });
```
Parameters
- transaction: Transaction
- fetcher: LiveCellFetcher
Returns Promise<TransactionSkeletonType>

createTransactionSkeleton

createTransactionSkeleton(transaction: Transaction, fetcher: LiveCellFetcher): Promise<TransactionSkeletonType>

create a TransactionSkeleton from a Transaction

example

const rpc = new RPC('localhost:8114')
const fetcher = (outPoint: OutPoint) => rpc.getLiveCell(outPoint)
const skeleton = await createTransactionSkeleton({ transaction, fetcher });

Parameters

transaction: Transaction
fetcher: LiveCellFetcher

Returns Promise<TransactionSkeletonType>

encodeToAddress

encodeToAddress(script: Script, __namedParameters?: { config: undefined | Config }): Address

- Defined in packages/helpers/lib/index.d.ts:51
parse a lock script to an address

Parameters
- script: Script
- Optional __namedParameters: { config: undefined | Config }
  - config: undefined | Config
Returns Address

encodeToAddress

encodeToAddress(script: Script, __namedParameters?: { config: undefined | Config }): Address

- Defined in packages/helpers/src/index.ts:234
parse a lock script to an address

Parameters
- script: Script
- Default value __namedParameters: { config: undefined | Config } = {}
  - config: undefined | Config
Returns Address

encodeToConfigAddress

encodeToConfigAddress(args: HexString, scriptType: PredefinedScriptName): string
encodeToConfigAddress<C>(args: HexString, scriptType: keyof C["SCRIPTS"], options: { config?: C }): string

- Defined in packages/helpers/lib/index.d.ts:53
Parameters
- args: HexString
- scriptType: PredefinedScriptName
Returns string
- Defined in packages/helpers/lib/index.d.ts:54
Type parameters
- C: Config
Parameters
- args: HexString
- scriptType: keyof C["SCRIPTS"]
- options: { config?: C }
  - Optional config?: C
Returns string

encodeToConfigAddress

encodeToConfigAddress(args: HexString, scriptType: PredefinedScriptName): string
encodeToConfigAddress<C>(args: HexString, scriptType: keyof C["SCRIPTS"], options: { config?: C }): string

encode a script to an address with args and a key of config

example

// parse a predefined lock to an address
encodeToConfigAddress('0x12345678123456781234567812345678', 'SECP256K1_BLAKE160');
// parse a custom lock to an address
encodeToConfigAddress('0x12345678123456781234567812345678', 'MY_CUSTOM_LOCK', {
  SCRIPTS: {
    MY_CUSTOM_LOCK: {...}
  }
})

Parameters

args: HexString

script args
scriptType: PredefinedScriptName

a key of config.SCRIPTS

Returns string

encode a script to an address with args and a key of config

example

// parse a predefined lock to an address
encodeToConfigAddress('0x12345678123456781234567812345678', 'SECP256K1_BLAKE160');
// parse a custom lock to an address
encodeToConfigAddress('0x12345678123456781234567812345678', 'MY_CUSTOM_LOCK', {
  SCRIPTS: {
    MY_CUSTOM_LOCK: {...}
  }
})

Type parameters

C: Config

Parameters

args: HexString
scriptType: keyof C["SCRIPTS"]
options: { config?: C }
- Optional config?: C

Returns string

generateAddress

generateAddress(script: Script, __namedParameters?: { config: undefined | Config }): Address

- Defined in packages/helpers/lib/index.d.ts:27
deprecated

please migrate to encodeToAddress, the short format address will be removed in the future

Parameters
- script: Script
- Optional __namedParameters: { config: undefined | Config }
  - config: undefined | Config
Returns Address

generateAddress

generateAddress(script: Script, __namedParameters?: { config: undefined | Config }): Address

- Defined in packages/helpers/src/index.ts:121
deprecated

please migrate to encodeToAddress, the short format address will be removed in the future

Parameters
- script: Script
- Default value __namedParameters: { config: undefined | Config } = {}
  - config: undefined | Config
Returns Address

generatePredefinedAddress

generatePredefinedAddress(args: HexString, scriptType: string, __namedParameters?: { config: undefined | Config }): Address

- Defined in packages/helpers/src/index.ts:165
deprecated

please migrate to encodeToConfigAddress

Parameters
- args: HexString
- scriptType: string
- Default value __namedParameters: { config: undefined | Config } = {}
  - config: undefined | Config
Returns Address

generateSecp256k1Blake160Address

generateSecp256k1Blake160Address(args: HexString, __namedParameters?: { config: undefined | Config }): Address

- Defined in packages/helpers/lib/index.d.ts:37
deprecated

please migrate to encodeToConfigAddress

Parameters
- args: HexString
- Optional __namedParameters: { config: undefined | Config }
  - config: undefined | Config
Returns Address

generateSecp256k1Blake160Address

generateSecp256k1Blake160Address(args: HexString, __namedParameters?: { config: undefined | Config }): Address

- Defined in packages/helpers/src/index.ts:193
deprecated

please migrate to encodeToConfigAddress

Parameters
- args: HexString
- Default value __namedParameters: { config: undefined | Config } = {}
  - config: undefined | Config
Returns Address

generateSecp256k1Blake160MultisigAddress

generateSecp256k1Blake160MultisigAddress(args: HexString, __namedParameters?: { config: undefined | Config }): Address

- Defined in packages/helpers/lib/index.d.ts:43
deprecated

please migrate to encodeToConfigAddress

Parameters
- args: HexString
- Optional __namedParameters: { config: undefined | Config }
  - config: undefined | Config
Returns Address

generateSecp256k1Blake160MultisigAddress

generateSecp256k1Blake160MultisigAddress(args: HexString, __namedParameters?: { config: undefined | Config }): Address

- Defined in packages/helpers/src/index.ts:205
deprecated

please migrate to encodeToConfigAddress

Parameters
- args: HexString
- Default value __namedParameters: { config: undefined | Config } = {}
  - config: undefined | Config
Returns Address

hexToByteArray

hexToByteArray(h: HexString): number[]

- Defined in packages/helpers/lib/utils.d.ts:2
Parameters
- h: HexString
Returns number[]

hexToByteArray

hexToByteArray(h: HexString): number[]

- Defined in packages/helpers/src/utils.ts:3
Parameters
- h: HexString
Returns number[]

locateCellDep

locateCellDep(script: Script, __namedParameters?: { config: undefined | Config }): CellDep | null

- Defined in packages/helpers/lib/index.d.ts:20
Parameters
- script: Script
- Optional __namedParameters: { config: undefined | Config }
  - config: undefined | Config
Returns CellDep | null

locateCellDep

locateCellDep(script: Script, __namedParameters?: { config: undefined | Config }): CellDep | null

- Defined in packages/helpers/src/index.ts:91
Parameters
- script: Script
- Default value __namedParameters: { config: undefined | Config } = {}
  - config: undefined | Config
Returns CellDep | null

minimalCellCapacity

minimalCellCapacity(fullCell: Cell, __namedParameters?: { validate: undefined | false | true }): bigint

- Defined in packages/helpers/lib/index.d.ts:14
Parameters
- fullCell: Cell
- Optional __namedParameters: { validate: undefined | false | true }
  - validate: undefined | false | true
Returns bigint

minimalCellCapacity

minimalCellCapacity(fullCell: Cell, __namedParameters?: { validate: boolean }): bigint

- Defined in packages/helpers/src/index.ts:59
Parameters
- fullCell: Cell
- Default value __namedParameters: { validate: boolean } = {}
  - validate: boolean
Returns bigint

minimalCellCapacityCompatible

minimalCellCapacityCompatible(fullCell: Cell, __namedParameters?: { validate: undefined | false | true }): BI

- Defined in packages/helpers/lib/index.d.ts:17
Parameters
- fullCell: Cell
- Optional __namedParameters: { validate: undefined | false | true }
  - validate: undefined | false | true
Returns BI

minimalCellCapacityCompatible

minimalCellCapacityCompatible(fullCell: Cell, __namedParameters?: { validate: boolean }): BI

- Defined in packages/helpers/src/index.ts:67
Parameters
- fullCell: Cell
- Default value __namedParameters: { validate: boolean } = {}
  - validate: boolean
Returns BI

minimalScriptCapacity

minimalScriptCapacity(script: Script, __namedParameters?: { validate: undefined | false | true }): bigint

- Defined in packages/helpers/lib/index.d.ts:8
Parameters
- script: Script
- Optional __namedParameters: { validate: undefined | false | true }
  - validate: undefined | false | true
Returns bigint

minimalScriptCapacity

minimalScriptCapacity(script: Script, __namedParameters?: { validate: boolean }): bigint

- Defined in packages/helpers/src/index.ts:34
Parameters
- script: Script
- Default value __namedParameters: { validate: boolean } = {}
  - validate: boolean
Returns bigint

minimalScriptCapacityCompatible

minimalScriptCapacityCompatible(script: Script, __namedParameters?: { validate: undefined | false | true }): BI

- Defined in packages/helpers/lib/index.d.ts:11
Parameters
- script: Script
- Optional __namedParameters: { validate: undefined | false | true }
  - validate: undefined | false | true
Returns BI

minimalScriptCapacityCompatible

minimalScriptCapacityCompatible(script: Script, __namedParameters?: { validate: boolean }): BI

- Defined in packages/helpers/src/index.ts:42
Parameters
- script: Script
- Default value __namedParameters: { validate: boolean } = {}
  - validate: boolean
Returns BI

objectToTransactionSkeleton

objectToTransactionSkeleton(obj: TransactionSkeletonObject): TransactionSkeletonType

- Defined in packages/helpers/lib/index.d.ts:122
Convert js object to TransactionSkeleton

Parameters
- obj: TransactionSkeletonObject
Returns TransactionSkeletonType

objectToTransactionSkeleton

objectToTransactionSkeleton(obj: TransactionSkeletonObject): TransactionSkeletonType

- Defined in packages/helpers/src/index.ts:502
Convert js object to TransactionSkeleton

Parameters
- obj: TransactionSkeletonObject
Returns TransactionSkeletonType

parseAddress

parseAddress(address: Address, __namedParameters?: { config: undefined | Config }): Script

- Defined in packages/helpers/lib/index.d.ts:44
Parameters
- address: Address
- Optional __namedParameters: { config: undefined | Config }
  - config: undefined | Config
Returns Script

parseAddress

parseAddress(address: Address, __namedParameters?: { config: undefined | Config }): Script

- Defined in packages/helpers/src/index.ts:214
Parameters
- address: Address
- Default value __namedParameters: { config: undefined | Config } = {}
  - config: undefined | Config
Returns Script

parseDeprecatedCkb2019Address

parseDeprecatedCkb2019Address(address: string, __namedParameters: { config: undefined | Config }): Script

- Defined in packages/helpers/lib/address-to-script.d.ts:23
Parameters
- address: string
- __namedParameters: { config: undefined | Config }
  - config: undefined | Config
Returns Script

parseDeprecatedCkb2019Address

parseDeprecatedCkb2019Address(address: string, __namedParameters: { config: undefined | Config }): Script

- Defined in packages/helpers/src/address-to-script.ts:80
Parameters
- address: string
- __namedParameters: { config: undefined | Config }
  - config: undefined | Config
Returns Script

parseFullFormatAddress

parseFullFormatAddress(address: Address, __namedParameters: { config: undefined | Config }): Script

- Defined in packages/helpers/lib/address-to-script.d.ts:22
Parameters
- address: Address
- __namedParameters: { config: undefined | Config }
  - config: undefined | Config
Returns Script

parseFullFormatAddress

parseFullFormatAddress(address: Address, __namedParameters: { config: undefined | Config }): Script

- Defined in packages/helpers/src/address-to-script.ts:39
Parameters
- address: Address
- __namedParameters: { config: undefined | Config }
  - config: undefined | Config
Returns Script

sealTransaction

sealTransaction(txSkeleton: TransactionSkeletonType, sealingContents: HexString[]): Transaction

- Defined in packages/helpers/lib/index.d.ts:92
Parameters
- txSkeleton: TransactionSkeletonType
- sealingContents: HexString[]
Returns Transaction

sealTransaction

sealTransaction(txSkeleton: TransactionSkeletonType, sealingContents: HexString[]): Transaction

- Defined in packages/helpers/src/index.ts:433
Parameters
- txSkeleton: TransactionSkeletonType
- sealingContents: HexString[]
Returns Transaction

transactionSkeletonToObject

transactionSkeletonToObject(txSkelton: TransactionSkeletonType): TransactionSkeletonObject

- Defined in packages/helpers/lib/index.d.ts:116
Convert TransactionSkeleton to js object

Parameters
- txSkelton: TransactionSkeletonType
Returns TransactionSkeletonObject

transactionSkeletonToObject

transactionSkeletonToObject(txSkelton: TransactionSkeletonType): TransactionSkeletonObject

- Defined in packages/helpers/src/index.ts:491
Convert TransactionSkeleton to js object

Parameters
- txSkelton: TransactionSkeletonType
Returns TransactionSkeletonObject

validateP2PKHMessage

validateP2PKHMessage(messagesForSigning: BytesLike, rawTransaction: RawTransaction, hashContentExceptRawTx: BytesLike, hashAlgorithm?: HashAlgorithm): boolean

- Defined in packages/helpers/lib/validate.d.ts:12
Validate a P2PKH(Pay to public key hash) message

Parameters
- messagesForSigning: BytesLike
  
  the message digest for signing. means hash(rawTransaction | extraData).
- rawTransaction: RawTransaction
  
  raw transaction object
- hashContentExceptRawTx: BytesLike
  
  content to be hashed other than rawTransaction, is generally processed witness
- Optional hashAlgorithm: HashAlgorithm
  
  hash algorithm for signing. Default is "ckb-blake2b-256"
Returns boolean

the validate result. unless all messages equals, it will return false.

validateP2PKHMessage

validateP2PKHMessage(messagesForSigning: BytesLike, rawTransaction: RawTransaction, hashContentExceptRawTx: BytesLike, hashAlgorithm?: HashAlgorithm): boolean

- Defined in packages/helpers/src/validate.ts:32
Validate a P2PKH(Pay to public key hash) message

Parameters
- messagesForSigning: BytesLike
  
  the message digest for signing. means hash(rawTransaction | extraData).
- rawTransaction: RawTransaction
  
  raw transaction object
- hashContentExceptRawTx: BytesLike
  
  content to be hashed other than rawTransaction, is generally processed witness
- Default value hashAlgorithm: HashAlgorithm = "ckb-blake2b-256"
  
  hash algorithm for signing. Default is "ckb-blake2b-256"
Returns boolean

the validate result. unless all messages equals, it will return false.

@ckb-lumos/helpers

Usage

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

HashAlgorithm

HashAlgorithm

LiveCellFetcher

Type declaration

Parameters

outPoint: OutPoint

Returns Promisable<Cell>

LiveCellFetcher

Type declaration

Parameters

outPoint: OutPoint

Returns Promisable<Cell>

PredefinedScriptName

PredefinedScriptName

Promisable

Type parameters

T

Promisable

Type parameters

T

TransactionSkeletonType

TransactionSkeletonType

Variables

Const ADDRESS_FORMAT_FULL

Const ADDRESS_FORMAT_FULL

Const ADDRESS_FORMAT_FULLDATA

Const ADDRESS_FORMAT_FULLDATA

Const ADDRESS_FORMAT_FULLTYPE

Const ADDRESS_FORMAT_FULLTYPE

Const ADDRESS_FORMAT_SHORT

Const ADDRESS_FORMAT_SHORT

Const BECH32_LIMIT

Const BECH32_LIMIT

Let HAS_WARNED_FOR_DEPRECATED_ADDRESS

Const TransactionSkeleton

Const TransactionSkeleton

Const addressToScript

Const addressToScript

bytify

hexify

Const scriptToAddress

Const scriptToAddress

Functions

byteArrayToHex

Parameters

a: number[]

Returns HexString

byteArrayToHex

Parameters

a: number[]

Returns HexString

createHasher

Parameters

algorithm: HashAlgorithm

Returns Hasher

createTransactionFromSkeleton

Parameters

txSkeleton: TransactionSkeletonType

Optional __namedParameters: { validate: undefined | false | true }

validate: undefined | false | true

Returns Transaction

createTransactionFromSkeleton

Parameters

txSkeleton: TransactionSkeletonType

Default value __namedParameters: { validate: boolean } = {}

validate: boolean

Returns Transaction

createTransactionSkeleton

Parameters

transaction: Transaction

fetcher: LiveCellFetcher

Returns Promise<TransactionSkeletonType>

`@ckb-lumos/helpers`