`@ckb-lumos/base`

Base data structures and utilities used in lumos.

Index

References

Interfaces

Type aliases

Variables

indexer

Functions

References

Address

Re-exports Address

Alert

Re-exports Alert

AlertMessage

Re-exports AlertMessage

BannedAddr

Re-exports BannedAddr

BaseCellCollector

Re-exports BaseCellCollector

Block

Re-exports Block

BlockEconomicState

Re-exports BlockEconomicState

Cell

Re-exports Cell

CellCollector

Re-exports CellCollector

CellCollectorResults

Re-exports CellCollectorResults

CellDep

Re-exports CellDep

CellProvider

Re-exports CellProvider

CellWithStatus

Re-exports CellWithStatus

ChainInfo

Re-exports ChainInfo

Consensus

Re-exports Consensus

DepType

Re-exports DepType

DryRunResult

Re-exports DryRunResult

Epoch

Re-exports Epoch

Hash

Re-exports Hash

HashType

Re-exports HashType

Header

Re-exports Header

HexNumber

Re-exports HexNumber

HexString

Re-exports HexString

Hexadecimal

Re-exports Hexadecimal

HexadecimalRange

Re-exports HexadecimalRange

Indexer

Re-exports Indexer

IndexerOptions

Re-exports IndexerOptions

Input

Re-exports Input

LocalNode

Re-exports LocalNode

LocalNodeProtocol

Re-exports LocalNodeProtocol

MerkleProof

Re-exports MerkleProof

NodeAddress

Re-exports NodeAddress

OutPoint

Re-exports OutPoint

Output

Re-exports Output

PackedDao

Re-exports PackedDao

PackedSince

Re-exports PackedSince

PeerSyncState

Re-exports PeerSyncState

ProposalWindow

Re-exports ProposalWindow

QueryOptions

Re-exports QueryOptions

Rational

Re-exports Rational

RawTransaction

Re-exports RawTransaction

RawTxPool

Re-exports RawTxPool

RemoteNode

Re-exports RemoteNode

RemoteNodeProtocol

Re-exports RemoteNodeProtocol

Script

Re-exports Script

ScriptWrapper

Re-exports ScriptWrapper

SinceValidationInfo

Re-exports SinceValidationInfo

SyncState

Re-exports SyncState

Tip

Re-exports Tip

Transaction

Re-exports Transaction

TransactionCollector

Re-exports TransactionCollector

TransactionCollectorOptions

Re-exports TransactionCollectorOptions

TransactionCollectorResults

Re-exports TransactionCollectorResults

TransactionProof

Re-exports TransactionProof

TransactionWithStatus

Re-exports TransactionWithStatus

TxPoolIds

Re-exports TxPoolIds

TxPoolInfo

Re-exports TxPoolInfo

TxPoolVerbosity

Re-exports TxPoolVerbosity

TxStatus

Re-exports TxStatus

TxVerbosity

Re-exports TxVerbosity

UncleBlock

Re-exports UncleBlock

WitnessArgs

Re-exports WitnessArgs

indexer

Re-exports indexer

Type aliases

Address

Address: string

CanCastToArrayBuffer

CanCastToArrayBuffer: ArrayBuffer | CastToArrayBuffer

DepType

DepType: "dep_group" | "code"

Hash

Hash: HexString

HashType

HashType: "type" | "data" | "data1"

HexNumber

HexNumber: Hexadecimal

HexString

HexString: string

HexString represents string starts with "0x" and followed by even number(including empty) of [0-9a-fA-F] characters.

Hexadecimal

Hexadecimal: string

Hexadecimal represents string starts with "0x" and followed by any number(excluding empty) of [0-9a-fA-F] characters.

HexadecimalRange

HexadecimalRange: [Hexadecimal, Hexadecimal]

Log

Log: (message: string) => void

Type declaration

- (message: string): void
- Parameters
  - message: string
  Returns void

LogLevel

LogLevel: "warn" | "error" | string

Logger

Logger: (level: LogLevel, message: string) => void

Type declaration

- (level: LogLevel, message: string): void
- Parameters
  - level: LogLevel
  - message: string
  Returns void

PackedDao

PackedDao: string

PackedSince

PackedSince: string

RawTxPool

RawTxPool: TxPoolIds | TxPoolVerbosity

SinceType

SinceType: "epochNumber" | "blockNumber" | "blockTimestamp"

Variables

Const indexer

indexer: { TransactionCollector: typeof TransactionCollector }

Type declaration

TransactionCollector: typeof TransactionCollector

Functions

DenormalizeOutPoint

DenormalizeOutPoint(outPoint: OutPoint): OutPoint

- Defined in packages/base/lib/denormalizers.d.ts:4
Parameters
- outPoint: OutPoint
Returns OutPoint

DenormalizeScript

DenormalizeScript(script: Script): Script

- Defined in packages/base/lib/denormalizers.d.ts:6
Parameters
- script: Script
Returns Script

SerializeBlock

SerializeBlock(value: object): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:262
Parameters
- value: object
Returns ArrayBuffer

SerializeBlockV1

SerializeBlockV1(value: object): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:272
Parameters
- value: object
Returns ArrayBuffer

SerializeByte32

SerializeByte32(value: CanCastToArrayBuffer): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:47
Parameters
- value: CanCastToArrayBuffer
Returns ArrayBuffer

SerializeByte32Vec

SerializeByte32Vec(value: Array<CanCastToArrayBuffer>): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:90
Parameters
- value: Array<CanCastToArrayBuffer>
Returns ArrayBuffer

SerializeBytes

SerializeBytes(value: CanCastToArrayBuffer): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:65
Parameters
- value: CanCastToArrayBuffer
Returns ArrayBuffer

SerializeBytesOpt

SerializeBytesOpt(value: CanCastToArrayBuffer | null): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:74
Parameters
- value: CanCastToArrayBuffer | null
Returns ArrayBuffer

SerializeBytesVec

SerializeBytesVec(value: Array<CanCastToArrayBuffer>): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:82
Parameters
- value: Array<CanCastToArrayBuffer>
Returns ArrayBuffer

SerializeCellDep

SerializeCellDep(value: object): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:199
Parameters
- value: object
Returns ArrayBuffer

SerializeCellDepVec

SerializeCellDepVec(value: Array<object>): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:139
Parameters
- value: Array<object>
Returns ArrayBuffer

SerializeCellInput

SerializeCellInput(value: object): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:181
Parameters
- value: object
Returns ArrayBuffer

SerializeCellInputVec

SerializeCellInputVec(value: Array<object>): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:147
Parameters
- value: Array<object>
Returns ArrayBuffer

SerializeCellOutput

SerializeCellOutput(value: object): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:190
Parameters
- value: object
Returns ArrayBuffer

SerializeCellOutputVec

SerializeCellOutputVec(value: Array<object>): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:155
Parameters
- value: Array<object>
Returns ArrayBuffer

SerializeCellbaseWitness

SerializeCellbaseWitness(value: object): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:283
Parameters
- value: object
Returns ArrayBuffer

SerializeHeader

SerializeHeader(value: object): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:245
Parameters
- value: object
Returns ArrayBuffer

SerializeOutPoint

SerializeOutPoint(value: object): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:172
Parameters
- value: object
Returns ArrayBuffer

SerializeProposalShortId

SerializeProposalShortId(value: CanCastToArrayBuffer): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:106
Parameters
- value: CanCastToArrayBuffer
Returns ArrayBuffer

SerializeProposalShortIdVec

SerializeProposalShortIdVec(value: Array<CanCastToArrayBuffer>): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:131
Parameters
- value: Array<CanCastToArrayBuffer>
Returns ArrayBuffer

SerializeRawHeader

SerializeRawHeader(value: object): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:228
Parameters
- value: object
Returns ArrayBuffer

SerializeRawTransaction

SerializeRawTransaction(value: object): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:208
Parameters
- value: object
Returns ArrayBuffer

SerializeScript

SerializeScript(value: object): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:163
Parameters
- value: object
Returns ArrayBuffer

SerializeScriptOpt

SerializeScriptOpt(value: object | null): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:98
Parameters
- value: object | null
Returns ArrayBuffer

SerializeTransaction

SerializeTransaction(value: object): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:220
Parameters
- value: object
Returns ArrayBuffer

SerializeTransactionVec

SerializeTransactionVec(value: Array<object>): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:123
Parameters
- value: Array<object>
Returns ArrayBuffer

SerializeUint128

SerializeUint128(value: CanCastToArrayBuffer): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:38
Parameters
- value: CanCastToArrayBuffer
Returns ArrayBuffer

SerializeUint256

SerializeUint256(value: CanCastToArrayBuffer): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:56
Parameters
- value: CanCastToArrayBuffer
Returns ArrayBuffer

SerializeUint32

SerializeUint32(value: CanCastToArrayBuffer): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:16
Parameters
- value: CanCastToArrayBuffer
Returns ArrayBuffer

SerializeUint64

SerializeUint64(value: CanCastToArrayBuffer): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:27
Parameters
- value: CanCastToArrayBuffer
Returns ArrayBuffer

SerializeUncleBlock

SerializeUncleBlock(value: object): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:254
Parameters
- value: object
Returns ArrayBuffer

SerializeUncleBlockVec

SerializeUncleBlockVec(value: Array<object>): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:115
Parameters
- value: Array<object>
Returns ArrayBuffer

SerializeWitnessArgs

SerializeWitnessArgs(value: object): ArrayBuffer

- Defined in packages/base/lib/core.d.ts:291
Parameters
- value: object
Returns ArrayBuffer

assertHexString

assertHexString(debugPath: string, str: string): void

- Defined in packages/base/lib/utils.d.ts:60
Parameters
- debugPath: string
- str: string
Returns void

assertHexadecimal

assertHexadecimal(debugPath: string, str: string): void

- Defined in packages/base/lib/utils.d.ts:62
Parameters
- debugPath: string
- str: string
Returns void

ckbHash

ckbHash(buffer: ArrayBuffer): Reader

- Defined in packages/base/lib/utils.d.ts:15
Parameters
- buffer: ArrayBuffer
Returns Reader

computeScriptHash

computeScriptHash(script: Script, options?: undefined | { validate?: undefined | false | true }): Hash

- Defined in packages/base/lib/utils.d.ts:53
compute lock/type hash

Parameters
- script: Script
- Optional options: undefined | { validate?: undefined | false | true }
Returns Hash

deprecated

deprecated(message: string): void

- Defined in packages/base/lib/logger.d.ts:5
Parameters
- message: string
Returns void

generateAbsoluteEpochSince

generateAbsoluteEpochSince(params: EpochSinceValue): PackedSince

- Defined in packages/base/lib/since.d.ts:70
generate absolute-epoch-number format since

Parameters
- params: EpochSinceValue
Returns PackedSince

generateHeaderEpoch

generateHeaderEpoch(params: EpochSinceValue): HexString

- Defined in packages/base/lib/since.d.ts:128
generate header epoch from epoch since value

Parameters
- params: EpochSinceValue
Returns HexString

generateSince

generateSince(params: { relative: boolean; type: SinceType; value: BIish } | { relative: boolean; type: "epochNumber"; value: EpochSinceValue }): PackedSince

- Defined in packages/base/lib/since.d.ts:109
Parameters
- params: { relative: boolean; type: SinceType; value: BIish } | { relative: boolean; type: "epochNumber"; value: EpochSinceValue }
Returns PackedSince

generateTypeIdScript

generateTypeIdScript(input: Input, outputIndex?: HexNumber): Script

- Defined in packages/base/lib/utils.d.ts:65
Parameters
- input: Input
- Optional outputIndex: HexNumber
Returns Script

hashCode

hashCode(buffer: Buffer): number

- Defined in packages/base/lib/utils.d.ts:58
Parameters
- buffer: Buffer
Returns number

isCellMatchQueryOptions

isCellMatchQueryOptions(cell: Cell, queryOptions: QueryOptions): boolean

- Defined in packages/base/lib/helpers.d.ts:4
Parameters
- cell: Cell
- queryOptions: QueryOptions
Returns boolean

isDeepEqual

isDeepEqual(a: unknown, b: unknown): boolean

- Defined in packages/base/lib/utils.d.ts:64
Parameters
- a: unknown
- b: unknown
Returns boolean

maximumAbsoluteEpochSince

maximumAbsoluteEpochSince(...args: PackedSince[]): PackedSince

- Defined in packages/base/lib/since.d.ts:63
return maximum since of args

Parameters
- Rest ...args: PackedSince[]
  
  sinces in absolute-epoch-number format
Returns PackedSince

parseAbsoluteEpochSince

parseAbsoluteEpochSince(since: PackedSince): EpochSinceValue

- Defined in packages/base/lib/since.d.ts:79
Will throw an error if since not in absolute-epoch-number format

Parameters
- since: PackedSince
Returns EpochSinceValue

parseEpoch

parseEpoch(epoch: HexString): EpochSinceValue

- Defined in packages/base/lib/since.d.ts:56
parse epoch from blockHeader.epoch

Parameters
- epoch: HexString
Returns EpochSinceValue

parseSince

parseSince(since: PackedSince): { relative: boolean; type: "epochNumber"; value: EpochSinceValue } | { relative: boolean; type: "blockNumber" | "blockTimestamp"; value: bigint }

- Defined in packages/base/lib/since.d.ts:23
Parse since and get relative or not, type, and value of since

Parameters
- since: PackedSince
Returns { relative: boolean; type: "epochNumber"; value: EpochSinceValue } | { relative: boolean; type: "blockNumber" | "blockTimestamp"; value: bigint }

parseSinceCompatible

parseSinceCompatible(since: PackedSince): { relative: boolean; type: "epochNumber"; value: EpochSinceValue } | { relative: boolean; type: "blockNumber" | "blockTimestamp"; value: BI }

- Defined in packages/base/lib/since.d.ts:37
Parameters
- since: PackedSince
Returns { relative: boolean; type: "epochNumber"; value: EpochSinceValue } | { relative: boolean; type: "blockNumber" | "blockTimestamp"; value: BI }

readBigUInt128LE

readBigUInt128LE(leHex: HexString): bigint

- Defined in packages/base/lib/utils.d.ts:44
convert BigUInt64 little-endian hex string to bigint

Parameters
- leHex: HexString
  
  BigUInt128 little-endian hex string
Returns bigint

readBigUInt128LECompatible

readBigUInt128LECompatible(leHex: HexString): BI

- Defined in packages/base/lib/utils.d.ts:45
Parameters
- leHex: HexString
Returns BI

readBigUInt64LE

readBigUInt64LE(hex: HexString): bigint

- Defined in packages/base/lib/utils.d.ts:29
convert BigUInt64 little-endian hex string to bigint

Parameters
- hex: HexString
  
  BigUInt64 little-endian hex string
Returns bigint

readBigUInt64LECompatible

readBigUInt64LECompatible(hex: HexString): BI

- Defined in packages/base/lib/utils.d.ts:30
Parameters
- hex: HexString
Returns BI

toBigUInt128LE

toBigUInt128LE(u128: BIish): string

- Defined in packages/base/lib/utils.d.ts:37
convert bigint to BigUInt128 little-endian hex string

Parameters
- u128: BIish
Returns string

toBigUInt64LE

toBigUInt64LE(num: BIish): HexString

- Defined in packages/base/lib/utils.d.ts:22
convert bigint to BigUInt64 little-endian hex string

Parameters
- num: BIish
Returns HexString

validateAbsoluteEpochSince

validateAbsoluteEpochSince(since: PackedSince, tipHeaderEpoch: HexString): boolean

- Defined in packages/base/lib/since.d.ts:87
Will throw an error if since not in absolute-epoch-number format

Parameters
- since: PackedSince
- tipHeaderEpoch: HexString
Returns boolean

validateSince

validateSince(since: PackedSince, tipSinceValidationInfo: SinceValidationInfo, cellSinceValidationInfo?: SinceValidationInfo): boolean

- Defined in packages/base/lib/since.d.ts:99
Compare since with tipHeader, check since is valid or not.

Parameters
- since: PackedSince
- tipSinceValidationInfo: SinceValidationInfo
- Optional cellSinceValidationInfo: SinceValidationInfo
Returns boolean

@ckb-lumos/base

Index

References

Classes

Interfaces

Type aliases

Variables

Functions

References

Address

Alert

AlertMessage

BannedAddr

BaseCellCollector

Block

BlockEconomicState

Cell

CellCollector

CellCollectorResults

CellDep

CellProvider

CellWithStatus

ChainInfo

Consensus

DepType

DryRunResult

Epoch

Hash

HashType

Header

HexNumber

HexString

Hexadecimal

HexadecimalRange

Indexer

IndexerOptions

Input

LocalNode

LocalNodeProtocol

MerkleProof

NodeAddress

OutPoint

Output

PackedDao

PackedSince

PeerSyncState

ProposalWindow

QueryOptions

Rational

RawTransaction

RawTxPool

RemoteNode

RemoteNodeProtocol

Script

ScriptWrapper

SinceValidationInfo

SyncState

Tip

Transaction

TransactionCollector

TransactionCollectorOptions

TransactionCollectorResults

TransactionProof

TransactionWithStatus

TxPoolIds

TxPoolInfo

TxPoolVerbosity

TxStatus

TxVerbosity

UncleBlock

WitnessArgs

indexer

Type aliases

Address

CanCastToArrayBuffer

DepType

Hash

HashType

HexNumber

HexString

`@ckb-lumos/base`