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 Summary)

ClientJsonRpc
- ClientPublicMainnet

Constructors

constructor

new ClientPublicMainnet(
    config?: RequestorJsonRpcConfig & {
        cache?: ClientCache;
        requestor?: RequestorJsonRpc;
    } & {
        url?: string;
        scripts?: Record<KnownScript, undefined | ScriptInfoLike>;
    },
): ClientPublicMainnet
Parameters
- Optionalconfig: RequestorJsonRpcConfig & { cache?: ClientCache; requestor?: RequestorJsonRpc } & {
  url?: string;
  scripts?: Record<KnownScript, undefined | ScriptInfoLike>;
  }
Returns ClientPublicMainnet
Overrides ClientJsonRpc.constructor
- Defined in client/clientPublicMainnet.ts:11

Properties

cache

cache: ClientCache

`Readonly`requestor

requestor: RequestorJsonRpc

getFeeRateStatistics

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

Get fee rate statistics

Type declaration

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

getBlockByNumberNoCache

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

Get block by block number

Type declaration

- (
      blockNumber: NumLike,
      verbosity?: null | number,
      withCycles?: null | boolean,
  ): 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

getBlockByHashNoCache

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

Get block by block hash

Type declaration

- (
      blockHash: BytesLike,
      verbosity?: null | number,
      withCycles?: null | boolean,
  ): 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

getHeaderByNumberNoCache

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

Get header by block number

Type declaration

- (
  blockNumber: NumLike,
  verbosity?: null | number,
  ): 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

getHeaderByHashNoCache

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

Get header by block hash

Type declaration

- (
  blockHash: BytesLike,
  verbosity?: null | number,
  ): 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: TransactionLike): 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: TransactionLike, validator?: OutputsValidator): 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?: null | OutputsValidator,
) => Promise<`0x${string}`> = ...

Send a transaction to node.

Type declaration

- (
  transaction: TransactionLike,
  validator?: null | OutputsValidator,
  ): Promise<`0x${string}`>
- Parameters
  - transaction: TransactionLike
    The transaction to send.
  - Optionalvalidator: null | 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: BytesLike): 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: ClientIndexerSearchKeyLike,
      order?: "asc" | "desc",
      limit?: NumLike,
      after?: string,
  ): 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: ClientIndexerSearchKeyLike): Promise<bigint>
- Parameters
  - key: ClientIndexerSearchKeyLike
    The search key of cells.
  Returns Promise<bigint>
  The sum of cells capacity.

Accessors

scripts

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

addressPrefix

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

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/client.ts:121

Methods

getFeeRate

getFeeRate(
blockRange?: NumLike,
options?: { maxFeeRate?: NumLike },
): Promise<bigint>
Parameters
- OptionalblockRange: NumLike
- Optionaloptions: { maxFeeRate?: NumLike }
Returns Promise<bigint>
Inherited from ClientJsonRpc.getFeeRate
- Defined in client/client.ts:58

getBlockByNumber

getBlockByNumber(
    blockNumber: NumLike,
    verbosity?: null | number,
    withCycles?: null | boolean,
): Promise<undefined | ClientBlock>
Parameters
- blockNumber: NumLike
- Optionalverbosity: null | number
- OptionalwithCycles: null | boolean
Returns Promise<undefined | ClientBlock>
Inherited from ClientJsonRpc.getBlockByNumber
- Defined in client/client.ts:95

getBlockByHash

getBlockByHash(
    blockHash: BytesLike,
    verbosity?: null | number,
    withCycles?: null | boolean,
): Promise<undefined | ClientBlock>
Parameters
- blockHash: BytesLike
- Optionalverbosity: null | number
- OptionalwithCycles: null | boolean
Returns Promise<undefined | ClientBlock>
Inherited from ClientJsonRpc.getBlockByHash
- Defined in client/client.ts:115

getHeaderByNumber

getHeaderByNumber(
blockNumber: NumLike,
verbosity?: null | number,
): Promise<undefined | ClientBlockHeader>
Parameters
- blockNumber: NumLike
- Optionalverbosity: null | number
Returns Promise<undefined | ClientBlockHeader>
Inherited from ClientJsonRpc.getHeaderByNumber
- Defined in client/client.ts:135

getHeaderByHash

getHeaderByHash(
blockHash: BytesLike,
verbosity?: null | number,
): Promise<undefined | ClientBlockHeader>
Parameters
- blockHash: BytesLike
- Optionalverbosity: null | number
Returns Promise<undefined | ClientBlockHeader>
Inherited from ClientJsonRpc.getHeaderByHash
- Defined in client/client.ts:150

getCell

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

getCellWithHeader

getCellWithHeader(
outPointLike: OutPointLike,
): Promise<undefined | { cell: Cell; header?: ClientBlockHeader }>
Parameters
- outPointLike: OutPointLike
Returns Promise<undefined | { cell: Cell; header?: ClientBlockHeader }>
Inherited from ClientJsonRpc.getCellWithHeader
- Defined in client/client.ts:205

getCellLive

getCellLive(
    outPointLike: OutPointLike,
    withData?: null | boolean,
    includeTxPool?: null | boolean,
): 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:234

findCellsPaged

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

findCellsOnChain

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

findCells

findCells(
    keyLike: ClientCollectableSearchKeyLike,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<Cell>
Find cells by search key designed for collectable cells. The result also includes cached cells, the order param only works for cells fetched from RPC.
Parameters
- keyLike: ClientCollectableSearchKeyLike
  The search key.
- Optionalorder: "asc" | "desc"
- limit: number = 10
Returns AsyncGenerator<Cell>
A async generator for yielding cells.
Inherited from ClientJsonRpc.findCells
- Defined in client/client.ts:298

findCellsByLock

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

findCellsByType

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

findSingletonCellByType

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

getCellDeps

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

findTransactions

findTransactions(
    key: Omit<ClientIndexerSearchKeyTransactionLike, "groupByTransaction"> & {
        groupByTransaction: true;
    },
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<
    {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        cells: { isInput: boolean; cellIndex: bigint }[];
    },
>
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 }[];
    },
>
Inherited from ClientJsonRpc.findTransactions
- Defined in client/client.ts:424
findTransactions(
    key: Omit<ClientIndexerSearchKeyTransactionLike, "groupByTransaction"> & {
        groupByTransaction?: null | false;
    },
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<
    {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        isInput: boolean;
        cellIndex: bigint;
    },
>
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;
    },
>
Inherited from ClientJsonRpc.findTransactions
- Defined in client/client.ts:431
findTransactions(
    key: ClientIndexerSearchKeyTransactionLike,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<
    | {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        isInput: boolean;
        cellIndex: bigint;
    }
    | {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        cells: { isInput: boolean; cellIndex: bigint }[];
    },
>
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 }[];
    },
>
Inherited from ClientJsonRpc.findTransactions
- Defined in client/client.ts:438

findTransactionsByLock

findTransactionsByLock(
    lock: ScriptLike,
    type: undefined | null | ScriptLike,
    groupByTransaction: true,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<
    {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        cells: { isInput: boolean; cellIndex: bigint }[];
    },
>
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 }[];
    },
>
Inherited from ClientJsonRpc.findTransactionsByLock
- Defined in client/client.ts:474
findTransactionsByLock(
    lock: ScriptLike,
    type?: null | ScriptLike,
    groupByTransaction?: null | false,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<
    {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        isInput: boolean;
        cellIndex: bigint;
    },
>
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;
    },
>
Inherited from ClientJsonRpc.findTransactionsByLock
- Defined in client/client.ts:481
findTransactionsByLock(
    lock: ScriptLike,
    type?: null | ScriptLike,
    groupByTransaction?: null | boolean,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<
    | {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        isInput: boolean;
        cellIndex: bigint;
    }
    | {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        cells: { isInput: boolean; cellIndex: bigint }[];
    },
>
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 }[];
    },
>
Inherited from ClientJsonRpc.findTransactionsByLock
- Defined in client/client.ts:488

findTransactionsByType

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

getBalanceSingle

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

getBalance

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

sendTransaction

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

getTransaction

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

getTransactionWithHeader

getTransactionWithHeader(
    txHashLike: BytesLike,
): Promise<
    | undefined
    | { transaction: ClientTransactionResponse; header?: ClientBlockHeader },
>
This method gets specified transaction with its block header (if existed). This is mainly for caching because we need the header to test if we can safely trust the cached tx status.
Parameters
- txHashLike: BytesLike
Returns Promise<
| undefined
| { transaction: ClientTransactionResponse; header?: ClientBlockHeader },
>
Inherited from ClientJsonRpc.getTransactionWithHeader
- Defined in client/client.ts:624

waitTransaction

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

getKnownScript

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

getCellLiveNoCache

getCellLiveNoCache(
    outPoint: OutPointLike,
    withData?: null | boolean,
    includeTxPool?: null | boolean,
): 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/client.ts:285

buildSender

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

Class ClientPublicMainnet

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ClientPublicMainnet

Properties

cache

Readonlyrequestor

getFeeRateStatistics

Type declaration

Parameters

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

getTip

Type declaration

Returns Promise<bigint>

getTipHeader

Type declaration

Parameters

Returns Promise<ClientBlockHeader>

getBlockByNumberNoCache

Type declaration

Parameters

Returns Promise<undefined | ClientBlock>

getBlockByHashNoCache

Type declaration

Parameters

Returns Promise<undefined | ClientBlock>

getHeaderByNumberNoCache

Type declaration

Parameters

Returns Promise<undefined | ClientBlockHeader>

getHeaderByHashNoCache

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, ScriptInfoLike | undefined>

addressPrefix

Returns string

url

Returns string

Methods

getFeeRate

`Readonly`requestor

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

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

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 }[];
},
>

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

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

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 }[];
},
>

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

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

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 }[];
},
>