Class ClientPublicMainnet

An abstract class implementing JSON-RPC client functionality for a specific URL and timeout. Provides methods for sending transactions and building JSON-RPC payloads.

Hierarchy (view full)

ClientJsonRpc
- ClientPublicMainnet

Constructors

constructor

new ClientPublicMainnet(config?): ClientPublicMainnet
Parameters
- Optionalconfig: {
      url?: string;
      timeout?: number;
      scripts?: Record<KnownScript, undefined | ScriptInfoLike>;
      cache?: ClientCache;
  }
  - Optionalurl?: string
  - Optionaltimeout?: number
  - Optionalscripts?: Record<KnownScript, undefined | ScriptInfoLike>
  - Optionalcache?: ClientCache
Returns ClientPublicMainnet
Overrides ClientJsonRpc.constructor
- Defined in client/clientPublicMainnet.ts:11

Properties

cache

cache: ClientCache

getFeeRateStatistics

getFeeRateStatistics: ((blockRange?: NumLike) => Promise<{
mean: bigint;
median: bigint;
}>) = ...

Get fee rate statistics

Type declaration

- (blockRange?): Promise<{
  mean: bigint;
  median: bigint;
  }>
- Parameters
  - OptionalblockRange: NumLike
  Returns Promise<{
  mean: bigint;
  median: bigint;
  }>
  Fee rate statistics

getTip

getTip: (() => Promise<bigint>) = ...

Get tip block number

Type declaration

- (): Promise<bigint>
- Returns Promise<bigint>
  Tip block number

getTipHeader

getTipHeader: ((verbosity?: null | number) => Promise<ClientBlockHeader>) = ...

Get tip block header

Type declaration

- (verbosity?): Promise<ClientBlockHeader>
- Parameters
  - Optionalverbosity: null | number
    result format which allows 0 and 1. (Optional, the default is 1.)
  Returns Promise<ClientBlockHeader>
  BlockHeader

getBlockByNumber

getBlockByNumber: ((blockNumber: NumLike, verbosity?: null | number, withCycles?: null | boolean) => Promise<undefined | ClientBlock>) = ...

Get block by block number

Type declaration

- (blockNumber, verbosity?, withCycles?): Promise<undefined | ClientBlock>
- Parameters
  - blockNumber: NumLike
    The block number.
  - Optionalverbosity: null | number
    result format which allows 0 and 2. (Optional, the default is 2.)
  - OptionalwithCycles: null | boolean
    whether the return cycles of block transactions. (Optional, default false.)
  Returns Promise<undefined | ClientBlock>
  Block

getBlockByHash

getBlockByHash: ((blockHash: BytesLike, verbosity?: null | number, withCycles?: null | boolean) => Promise<undefined | ClientBlock>) = ...

Get block by block hash

Type declaration

- (blockHash, verbosity?, withCycles?): Promise<undefined | ClientBlock>
- Parameters
  - blockHash: BytesLike
    The block hash.
  - Optionalverbosity: null | number
    result format which allows 0 and 2. (Optional, the default is 2.)
  - OptionalwithCycles: null | boolean
    whether the return cycles of block transactions. (Optional, default false.)
  Returns Promise<undefined | ClientBlock>
  Block

getHeaderByNumber

getHeaderByNumber: ((blockNumber: NumLike, verbosity?: null | number) => Promise<undefined | ClientBlockHeader>) = ...

Get header by block number

Type declaration

- (blockNumber, verbosity?): Promise<undefined | ClientBlockHeader>
- Parameters
  - blockNumber: NumLike
    The block number.
  - Optionalverbosity: null | number
    result format which allows 0 and 1. (Optional, the default is 1.)
  Returns Promise<undefined | ClientBlockHeader>
  BlockHeader

getHeaderByHash

getHeaderByHash: ((blockHash: BytesLike, verbosity?: null | number) => Promise<undefined | ClientBlockHeader>) = ...

Get header by block hash

Type declaration

- (blockHash, verbosity?): Promise<undefined | ClientBlockHeader>
- Parameters
  - blockHash: BytesLike
    The block hash.
  - Optionalverbosity: null | number
    result format which allows 0 and 1. (Optional, the default is 1.)
  Returns Promise<undefined | ClientBlockHeader>
  BlockHeader

estimateCycles

estimateCycles: ((transaction: TransactionLike) => Promise<bigint>) = ...

Estimate cycles of a transaction.

Type declaration

- (transaction): Promise<bigint>
- Parameters
  - transaction: TransactionLike
    The transaction to estimate.
  Returns Promise<bigint>
  Consumed cycles

sendTransactionDry

sendTransactionDry: ((transaction: TransactionLike, validator?: OutputsValidator) => Promise<bigint>) = ...

Test a transaction.

Type declaration

- (transaction, validator?): Promise<bigint>
- Parameters
  - transaction: TransactionLike
    The transaction to test.
  - Optionalvalidator: OutputsValidator
    "passthrough": Disable validation. "well_known_scripts_only": Only accept well known scripts in the transaction.
  Returns Promise<bigint>
  Consumed cycles

sendTransactionNoCache

sendTransactionNoCache: ((transaction: TransactionLike, validator?: OutputsValidator) => Promise<`0x${string}`>) = ...

Send a transaction to node.

Type declaration

- (transaction, validator?): Promise<`0x${string}`>
- Parameters
  - transaction: TransactionLike
    The transaction to send.
  - Optionalvalidator: OutputsValidator
    "passthrough": Disable validation. "well_known_scripts_only": Only accept well known scripts in the transaction.
  Returns Promise<`0x${string}`>
  Transaction hash.

getTransactionNoCache

getTransactionNoCache: ((txHash: BytesLike) => Promise<undefined | ClientTransactionResponse>) = ...

Get a transaction from node.

Type declaration

- (txHash): Promise<undefined | ClientTransactionResponse>
- Parameters
  - txHash: BytesLike
    The hash of the transaction.
  Returns Promise<undefined | ClientTransactionResponse>
  The transaction with status.

findCellsPagedNoCache

findCellsPagedNoCache: ((key: ClientIndexerSearchKeyLike, order?: "asc" | "desc", limit?: NumLike, after?: string) => Promise<ClientFindCellsResponse>) = ...

find cells from node.

Type declaration

- (key, order?, limit?, after?): Promise<ClientFindCellsResponse>
- Parameters
  - key: ClientIndexerSearchKeyLike
    The search key of cells.
  - Optionalorder: "asc" | "desc"
    The order of cells.
  - Optionallimit: NumLike
    The max return size of cells.
  - Optionalafter: string
    Pagination parameter.
  Returns Promise<ClientFindCellsResponse>
  The found cells.

findTransactionsPaged

findTransactionsPaged: {
    (key: Omit<ClientIndexerSearchKeyTransactionLike, "groupByTransaction"> & {
        groupByTransaction: true;
    }, order?: "asc" | "desc", limit?: NumLike, after?: string): Promise<ClientFindTransactionsGroupedResponse>;
    (key: Omit<ClientIndexerSearchKeyTransactionLike, "groupByTransaction"> & {
        groupByTransaction?: null | false;
    }, order?: "asc" | "desc", limit?: NumLike, after?: string): Promise<ClientFindTransactionsResponse>;
    (key: ClientIndexerSearchKeyTransactionLike, order?: "asc" | "desc", limit?: NumLike, after?: string): Promise<ClientFindTransactionsResponse | ClientFindTransactionsGroupedResponse>;
} = ...

find transactions from node.

Param: key

The search key of transactions.

Param: order

The order of transactions.

Param: limit

The max return size of transactions.

Param: after

Pagination parameter.

Returns

The found transactions.

getCellsCapacity

getCellsCapacity: ((key: ClientIndexerSearchKeyLike) => Promise<bigint>) = ...

get cells capacity from node.

Type declaration

- (key): Promise<bigint>
- Parameters
  - key: ClientIndexerSearchKeyLike
    The search key of cells.
  Returns Promise<bigint>
  The sum of cells capacity.

Accessors

scripts

get scripts(): Record<KnownScript, undefined | ScriptInfoLike>
Returns Record<KnownScript, undefined | ScriptInfoLike>
- Defined in client/clientPublicMainnet.ts:28

addressPrefix

get addressPrefix(): string
Returns string
Overrides ClientJsonRpc.addressPrefix
- Defined in client/clientPublicMainnet.ts:32

url

get url(): string
Returns the URL of the JSON-RPC server.

Returns string
The URL of the JSON-RPC server.
Inherited from ClientJsonRpc.url
- Defined in client/jsonRpc/index.ts:123

Methods

getFeeRate

getFeeRate(blockRange?): Promise<bigint>
Parameters
- OptionalblockRange: NumLike
Returns Promise<bigint>
Inherited from ClientJsonRpc.getFeeRate
- Defined in client/client.ts:53

getCell

getCell(outPointLike): Promise<undefined | Cell>
Parameters
- outPointLike: OutPointLike
Returns Promise<undefined | Cell>
Inherited from ClientJsonRpc.getCell
- Defined in client/client.ts:92

getCellLive

getCellLive(outPointLike, withData?, includeTxPool?): Promise<undefined | Cell>
Parameters
- outPointLike: OutPointLike
- OptionalwithData: null | boolean
- OptionalincludeTxPool: null | boolean
Returns Promise<undefined | Cell>
Inherited from ClientJsonRpc.getCellLive
- Defined in client/client.ts:124

findCellsPaged

findCellsPaged(key, order?, limit?, after?): Promise<ClientFindCellsResponse>
Parameters
- key: ClientIndexerSearchKeyLike
- Optionalorder: "asc" | "desc"
- Optionallimit: NumLike
- Optionalafter: string
Returns Promise<ClientFindCellsResponse>
Inherited from ClientJsonRpc.findCellsPaged
- Defined in client/client.ts:146

findCellsOnChain

findCellsOnChain(key, order?, limit?): AsyncGenerator<Cell, any, unknown>
Parameters
- key: ClientIndexerSearchKeyLike
- Optionalorder: "asc" | "desc"
- limit: number = 10
Returns AsyncGenerator<Cell, any, unknown>
Inherited from ClientJsonRpc.findCellsOnChain
- Defined in client/client.ts:157

findCells

findCells(keyLike, order?, limit?): AsyncGenerator<Cell, any, unknown>
Find cells by search key designed for collectable cells.
Parameters
- keyLike: ClientCollectableSearchKeyLike
  The search key.
- Optionalorder: "asc" | "desc"
- limit: number = 10
Returns AsyncGenerator<Cell, any, unknown>
A async generator for yielding cells.
Inherited from ClientJsonRpc.findCells
- Defined in client/client.ts:187

findCellsByLock

findCellsByLock(lock, type?, withData?, order?, limit?): AsyncGenerator<Cell, any, unknown>
Parameters
- lock: ScriptLike
- Optionaltype: null | ScriptLike
- withData: boolean = true
- Optionalorder: "asc" | "desc"
- limit: number = 10
Returns AsyncGenerator<Cell, any, unknown>
Inherited from ClientJsonRpc.findCellsByLock
- Defined in client/client.ts:212

findCellsByType

findCellsByType(type, withData?, order?, limit?): AsyncGenerator<Cell, any, unknown>
Parameters
- type: ScriptLike
- withData: boolean = true
- Optionalorder: "asc" | "desc"
- limit: number = 10
Returns AsyncGenerator<Cell, any, unknown>
Inherited from ClientJsonRpc.findCellsByType
- Defined in client/client.ts:234

findSingletonCellByType

findSingletonCellByType(type, withData?): Promise<undefined | Cell>
Parameters
- type: ScriptLike
- withData: boolean = false
Returns Promise<undefined | Cell>
Inherited from ClientJsonRpc.findSingletonCellByType
- Defined in client/client.ts:252

getCellDeps

getCellDeps(...cellDepsInfoLike): Promise<ccc.CellDep[]>
Parameters
- Rest...cellDepsInfoLike: (CellDepInfoLike | CellDepInfoLike[])[]
Returns Promise<ccc.CellDep[]>
Inherited from ClientJsonRpc.getCellDeps
- Defined in client/client.ts:266

findTransactions

findTransactions(key, order?, limit?): AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    cells: {
        isInput: boolean;
        cellIndex: bigint;
    }[];
}, any, unknown>
Parameters
- key: Omit<ClientIndexerSearchKeyTransactionLike, "groupByTransaction"> & {
  groupByTransaction: true;
  }
- Optionalorder: "asc" | "desc"
- Optionallimit: number
Returns AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    cells: {
        isInput: boolean;
        cellIndex: bigint;
    }[];
}, any, unknown>
Inherited from ClientJsonRpc.findTransactions
- Defined in client/client.ts:313
findTransactions(key, order?, limit?): AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    isInput: boolean;
    cellIndex: bigint;
}, any, unknown>
Parameters
- key: Omit<ClientIndexerSearchKeyTransactionLike, "groupByTransaction"> & {
  groupByTransaction?: null | false;
  }
- Optionalorder: "asc" | "desc"
- Optionallimit: number
Returns AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    isInput: boolean;
    cellIndex: bigint;
}, any, unknown>
Inherited from ClientJsonRpc.findTransactions
- Defined in client/client.ts:320
findTransactions(key, order?, limit?): AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    isInput: boolean;
    cellIndex: bigint;
} | {
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    cells: {
        isInput: boolean;
        cellIndex: bigint;
    }[];
}, any, unknown>
Parameters
- key: ClientIndexerSearchKeyTransactionLike
- Optionalorder: "asc" | "desc"
- Optionallimit: number
Returns AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    isInput: boolean;
    cellIndex: bigint;
} | {
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    cells: {
        isInput: boolean;
        cellIndex: bigint;
    }[];
}, any, unknown>
Inherited from ClientJsonRpc.findTransactions
- Defined in client/client.ts:327

findTransactionsByLock

findTransactionsByLock(lock, type, groupByTransaction, order?, limit?): AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    cells: {
        isInput: boolean;
        cellIndex: bigint;
    }[];
}, any, unknown>
Parameters
- lock: ScriptLike
- type: undefined | null | ScriptLike
- groupByTransaction: true
- Optionalorder: "asc" | "desc"
- Optionallimit: number
Returns AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    cells: {
        isInput: boolean;
        cellIndex: bigint;
    }[];
}, any, unknown>
Inherited from ClientJsonRpc.findTransactionsByLock
- Defined in client/client.ts:363
findTransactionsByLock(lock, type?, groupByTransaction?, order?, limit?): AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    isInput: boolean;
    cellIndex: bigint;
}, any, unknown>
Parameters
- lock: ScriptLike
- Optionaltype: null | ScriptLike
- OptionalgroupByTransaction: null | false
- Optionalorder: "asc" | "desc"
- Optionallimit: number
Returns AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    isInput: boolean;
    cellIndex: bigint;
}, any, unknown>
Inherited from ClientJsonRpc.findTransactionsByLock
- Defined in client/client.ts:370
findTransactionsByLock(lock, type?, groupByTransaction?, order?, limit?): AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    isInput: boolean;
    cellIndex: bigint;
} | {
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    cells: {
        isInput: boolean;
        cellIndex: bigint;
    }[];
}, any, unknown>
Parameters
- lock: ScriptLike
- Optionaltype: null | ScriptLike
- OptionalgroupByTransaction: null | boolean
- Optionalorder: "asc" | "desc"
- Optionallimit: number
Returns AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    isInput: boolean;
    cellIndex: bigint;
} | {
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    cells: {
        isInput: boolean;
        cellIndex: bigint;
    }[];
}, any, unknown>
Inherited from ClientJsonRpc.findTransactionsByLock
- Defined in client/client.ts:377

findTransactionsByType

findTransactionsByType(type, groupByTransaction, order?, limit?): AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    cells: {
        isInput: boolean;
        cellIndex: bigint;
    }[];
}, any, unknown>
Parameters
- type: ScriptLike
- groupByTransaction: true
- Optionalorder: "asc" | "desc"
- Optionallimit: number
Returns AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    cells: {
        isInput: boolean;
        cellIndex: bigint;
    }[];
}, any, unknown>
Inherited from ClientJsonRpc.findTransactionsByType
- Defined in client/client.ts:412
findTransactionsByType(type, groupByTransaction?, order?, limit?): AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    isInput: boolean;
    cellIndex: bigint;
}, any, unknown>
Parameters
- type: ScriptLike
- OptionalgroupByTransaction: null | false
- Optionalorder: "asc" | "desc"
- Optionallimit: number
Returns AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    isInput: boolean;
    cellIndex: bigint;
}, any, unknown>
Inherited from ClientJsonRpc.findTransactionsByType
- Defined in client/client.ts:418
findTransactionsByType(type, groupByTransaction?, order?, limit?): AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    isInput: boolean;
    cellIndex: bigint;
} | {
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    cells: {
        isInput: boolean;
        cellIndex: bigint;
    }[];
}, any, unknown>
Parameters
- type: ScriptLike
- OptionalgroupByTransaction: null | boolean
- Optionalorder: "asc" | "desc"
- Optionallimit: number
Returns AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    isInput: boolean;
    cellIndex: bigint;
} | {
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    cells: {
        isInput: boolean;
        cellIndex: bigint;
    }[];
}, any, unknown>
Inherited from ClientJsonRpc.findTransactionsByType
- Defined in client/client.ts:424

getBalanceSingle

getBalanceSingle(lock): Promise<bigint>
Parameters
- lock: ScriptLike
Returns Promise<bigint>
Inherited from ClientJsonRpc.getBalanceSingle
- Defined in client/client.ts:456

getBalance

getBalance(locks): Promise<bigint>
Parameters
- locks: ScriptLike[]
Returns Promise<bigint>
Inherited from ClientJsonRpc.getBalance
- Defined in client/client.ts:468

sendTransaction

sendTransaction(transaction, validator?): Promise<`0x${string}`>
Parameters
- transaction: TransactionLike
- Optionalvalidator: OutputsValidator
Returns Promise<`0x${string}`>
Inherited from ClientJsonRpc.sendTransaction
- Defined in client/client.ts:476

getTransaction

getTransaction(txHashLike): Promise<undefined | ClientTransactionResponse>
Parameters
- txHashLike: BytesLike
Returns Promise<undefined | ClientTransactionResponse>
Inherited from ClientJsonRpc.getTransaction
- Defined in client/client.ts:490

waitTransaction

waitTransaction(txHash, confirmations?, timeout?, interval?): Promise<undefined | ClientTransactionResponse>
Parameters
- txHash: BytesLike
- confirmations: number = 0
- timeout: number = 30000
- interval: number = 2000
Returns Promise<undefined | ClientTransactionResponse>
Inherited from ClientJsonRpc.waitTransaction
- Defined in client/client.ts:517

getKnownScript

getKnownScript(script): Promise<ccc.ScriptInfo>
Parameters
- script: KnownScript
Returns Promise<ccc.ScriptInfo>
Overrides ClientJsonRpc.getKnownScript
- Defined in client/clientPublicMainnet.ts:36

getCellLiveNoCache

getCellLiveNoCache(outPoint, withData?, includeTxPool?): Promise<undefined | Cell>
Get a live cell from node.
Parameters
- outPoint: OutPointLike
  The out point of the cell.
- OptionalwithData: null | boolean
  Include data in the response.
- OptionalincludeTxPool: null | boolean
  Include cells in the tx pool.
Returns Promise<undefined | Cell>
The cell
Inherited from ClientJsonRpc.getCellLiveNoCache
- Defined in client/jsonRpc/index.ts:282

buildSender

buildSender(rpcMethod, inTransformers, outTransformer?): ((...req: unknown[]) => Promise<unknown>)
Builds a sender function for a JSON-RPC method.
Parameters
- rpcMethod: string
  The JSON-RPC method.
- inTransformers: (undefined | ((_: any) => unknown))[]
  An array of input transformers.
- OptionaloutTransformer: ((_: any) => unknown)
  An output transformer function.
  - - (_): unknown
    - Parameters
      _: any
      Returns unknown
Returns ((...req: unknown[]) => Promise<unknown>)
A function that sends a JSON-RPC request with the given method and transformed parameters.
- - (...req): Promise<unknown>
  - Parameters
    - Rest...req: unknown[]
    Returns Promise<unknown>
Inherited from ClientJsonRpc.buildSender
- Defined in client/jsonRpc/index.ts:383

send

send(payload): Promise<unknown>
Sends a JSON-RPC request to the server.
Parameters
- payload: JsonRpcPayload
  The JSON-RPC payload to send.
Returns Promise<unknown>
The result of the JSON-RPC request.

Throws
Will throw an error if the response ID does not match the request ID, or if the response contains an error.
Inherited from ClientJsonRpc.send
- Defined in client/jsonRpc/index.ts:435

buildPayload

buildPayload(method, req): JsonRpcPayload
Builds a JSON-RPC payload for the given method and parameters.
Parameters
- method: string
  The JSON-RPC method name.
- req: unknown[]
  The parameters for the JSON-RPC method.
Returns JsonRpcPayload
The JSON-RPC payload.
Inherited from ClientJsonRpc.buildPayload
- Defined in client/jsonRpc/index.ts:458

Class ClientPublicMainnet

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optionalurl?: string

Optionaltimeout?: number

Optionalscripts?: Record<KnownScript, undefined | ScriptInfoLike>

Optionalcache?: ClientCache

Returns ClientPublicMainnet

Properties

cache

getFeeRateStatistics

Type declaration

Parameters

Returns Promise<{ mean: bigint; median: bigint; }>

getTip

Type declaration

Returns Promise<bigint>

getTipHeader

Type declaration

Parameters

Returns Promise<ClientBlockHeader>

getBlockByNumber

Type declaration

Parameters

Returns Promise<undefined | ClientBlock>

getBlockByHash

Type declaration

Parameters

Returns Promise<undefined | ClientBlock>

getHeaderByNumber

Type declaration

Parameters

Returns Promise<undefined | ClientBlockHeader>

getHeaderByHash

Type declaration

Parameters

Returns Promise<undefined | ClientBlockHeader>

estimateCycles

Type declaration

Parameters

Returns Promise<bigint>

sendTransactionDry

Type declaration

Parameters

Returns Promise<bigint>

sendTransactionNoCache

Type declaration

Parameters

Returns Promise<`0x${string}`>

getTransactionNoCache

Type declaration

Parameters

Returns Promise<undefined | ClientTransactionResponse>

findCellsPagedNoCache

Type declaration

Parameters

Returns Promise<ClientFindCellsResponse>

findTransactionsPaged

Param: key

Param: order

Param: limit

Param: after

Returns

getCellsCapacity

Type declaration

Parameters

Returns Promise<bigint>

Accessors

scripts

Returns Record<KnownScript, undefined | ScriptInfoLike>

addressPrefix

Returns string

url

`Optional`url?: string

`Optional`timeout?: number

`Optional`scripts?: Record<KnownScript, undefined | ScriptInfoLike>

`Optional`cache?: ClientCache

Returns Promise<{
mean: bigint;
median: bigint;
}>

Returns AsyncGenerator<{
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
cells: {
isInput: boolean;
cellIndex: bigint;
}[];
}, any, unknown>

Returns AsyncGenerator<{
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
isInput: boolean;
cellIndex: bigint;
}, any, unknown>

Returns AsyncGenerator<{
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
isInput: boolean;
cellIndex: bigint;
} | {
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
cells: {
isInput: boolean;
cellIndex: bigint;
}[];
}, any, unknown>

Returns AsyncGenerator<{
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
cells: {
isInput: boolean;
cellIndex: bigint;
}[];
}, any, unknown>

Returns AsyncGenerator<{
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
isInput: boolean;
cellIndex: bigint;
}, any, unknown>

Returns AsyncGenerator<{
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
isInput: boolean;
cellIndex: bigint;
} | {
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
cells: {
isInput: boolean;
cellIndex: bigint;
}[];
}, any, unknown>

Returns AsyncGenerator<{
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
cells: {
isInput: boolean;
cellIndex: bigint;
}[];
}, any, unknown>

Returns AsyncGenerator<{
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
isInput: boolean;
cellIndex: bigint;
}, any, unknown>

Returns AsyncGenerator<{
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
isInput: boolean;
cellIndex: bigint;
} | {
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
cells: {
isInput: boolean;
cellIndex: bigint;
}[];
}, any, unknown>