Options
All
  • Public
  • Public/Protected
  • All
Menu

Package rpc

Index

References

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

References

BigintOrHexStringTypeException

Re-exports BigintOrHexStringTypeException

BigintOrHexStringTypeException

Re-exports BigintOrHexStringTypeException

HexStringWithout0xException

Re-exports HexStringWithout0xException

HexStringWithout0xException

Re-exports HexStringWithout0xException

IdNotMatchException

Re-exports IdNotMatchException

IdNotMatchException

Re-exports IdNotMatchException

IdNotMatchedInBatchException

Re-exports IdNotMatchedInBatchException

IdNotMatchedInBatchException

Re-exports IdNotMatchedInBatchException

MethodInBatchNotFoundException

Re-exports MethodInBatchNotFoundException

MethodInBatchNotFoundException

Re-exports MethodInBatchNotFoundException

OutputsValidatorTypeException

Re-exports OutputsValidatorTypeException

OutputsValidatorTypeException

Re-exports OutputsValidatorTypeException

PageSizeTooLargeException

Re-exports PageSizeTooLargeException

PageSizeTooLargeException

Re-exports PageSizeTooLargeException

PageSizeTooSmallException

Re-exports PageSizeTooSmallException

PageSizeTooSmallException

Re-exports PageSizeTooSmallException

PayloadInBatchException

Re-exports PayloadInBatchException

PayloadInBatchException

Re-exports PayloadInBatchException

RPC

Renames and re-exports CKBRPC

RPC

Renames and re-exports CKBRPC

ResponseException

Re-exports ResponseException

ResponseException

Re-exports ResponseException

StringHashTypeException

Re-exports StringHashTypeException

StringHashTypeException

Re-exports StringHashTypeException

Type aliases

MethodSchema

MethodSchema: { method: string; paramsFormatters: ((arg: any) => any)[]; resultFormatters: (arg: any) => any }

Type declaration

  • method: string
  • paramsFormatters: ((arg: any) => any)[]
  • resultFormatters: (arg: any) => any
      • (arg: any): any

      • Parameters

        • arg: any

        Returns any

MethodSchema

MethodSchema: { method: string; paramsFormatters: ((arg: any) => any)[]; resultFormatters: (arg: any) => any }

Type declaration

  • method: string
  • paramsFormatters: ((arg: any) => any)[]
  • resultFormatters: (arg: any) => any
      • (arg: any): any

      • Parameters

        • arg: any

        Returns any

RPCConfig

RPCConfig: { timeout: number }

Type declaration

  • timeout: number

RPCConfig

RPCConfig: { timeout: number }

Type declaration

  • timeout: number

Variables

Const ERROR_LABEL

ERROR_LABEL: "Batch Request" = "Batch Request"

Const ParamsFormatter

ParamsFormatter: { toArray: (format?: ((args: any) => any) | undefined) => (arg: any) => any; toBoolean: (value: boolean) => boolean; toCellDep: (cellDep: CellDep) => CellDep; toDepType: (type: "depGroup" | "code") => "code" | "dep_group"; toGetCellsSearchKey: (data: GetCellsSearchKey<boolean>) => GetCellsSearchKey; toGetTransactionsSearchKey: (data: GetTransactionsSearchKey<boolean>) => GetTransactionsSearchKey; toHash: (hash: string) => string; toInput: (input: Input) => CellInput; toNumber: (number: string | bigint) => string; toOptional: (format?: ((args: any) => any) | undefined) => (arg: any) => any; toOrder: (order: "asc" | "desc") => "asc" | "desc"; toOutPoint: (outPoint: OutPoint) => OutPoint; toOutput: (output: Output) => CellOutput; toOutputsValidator: (outputsValidator: OutputsValidator) => OutputsValidator; toPageNumber: (pageNo?: string | bigint) => string; toPageSize: (pageSize?: string | bigint) => string; toRawTransaction: (transaction: RawTransaction) => RawTransaction; toReverseOrder: (reverse?: undefined | false | true) => boolean; toScript: (script: Script) => Script; toSearchFilter: (data: SearchFilter) => SearchFilter; toSearchKey: (data: SearchKey) => SearchKey; toTransactionAndWitnessProof: (proof: TransactionAndWitnessProof) => TransactionAndWitnessProof; toTransactionProof: (proof: TransactionProof) => TransactionProof }

Type declaration

Const ParamsFormatter

ParamsFormatter: { toArray: any; toBoolean: any; toCellDep: any; toDepType: any; toGetCellsSearchKey: any; toGetTransactionsSearchKey: any; toHash: any; toInput: any; toNumber: any; toOptional: any; toOrder: any; toOutPoint: any; toOutput: any; toOutputsValidator: any; toPageNumber: any; toPageSize: any; toRawTransaction: any; toReverseOrder: any; toScript: any; toSearchFilter: any; toSearchKey: any; toTransactionAndWitnessProof: any; toTransactionProof: any } = paramsFormatter

Type declaration

  • toArray: function
    • toArray(format?: undefined | ((args: any) => any)): (Anonymous function)

    • Parameters

      • Optional format: undefined | ((args: any) => any)

      Returns (Anonymous function)

  • toBoolean: function
    • toBoolean(value: boolean): boolean

    • Parameters

      • value: boolean

      Returns boolean

  • toCellDep: function

    • Parameters

      Returns CellDep

  • toDepType: function
    • toDepType(type: DepType): "code" | "dep_group"

    • Parameters

      Returns "code" | "dep_group"

  • toGetCellsSearchKey: function
  • toGetTransactionsSearchKey: function
  • toHash: function

    • Parameters

      • hash: string

      Returns Hash256

  • toInput: function

    • Parameters

      Returns CellInput

  • toNumber: function

    • Parameters

      Returns Number

  • toOptional: function
    • toOptional(format?: undefined | ((args: any) => any)): (Anonymous function)

    • Parameters

      • Optional format: undefined | ((args: any) => any)

      Returns (Anonymous function)

  • toOrder: function
    • toOrder(order: Order): "asc" | "desc"

    • Parameters

      Returns "asc" | "desc"

  • toOutPoint: function

    • Parameters

      Returns OutPoint

  • toOutput: function

    • Parameters

      Returns CellOutput

  • toOutputsValidator: function
    • toOutputsValidator(outputsValidator: OutputsValidator): undefined | "default" | "passthrough"

    • Parameters

      Returns undefined | "default" | "passthrough"

  • toPageNumber: function
    • toPageNumber(pageNo?: string | bigint): string

    • Parameters

      • Default value pageNo: string | bigint = "0x1"

      Returns string

  • toPageSize: function
    • toPageSize(pageSize?: string | bigint): string

    • Parameters

      • Default value pageSize: string | bigint = "0x32"

      Returns string

  • toRawTransaction: function
  • toReverseOrder: function
    • toReverseOrder(reverse?: boolean): boolean

    • Parameters

      • Default value reverse: boolean = false

      Returns boolean

  • toScript: function

    • Parameters

      Returns Script

  • toSearchFilter: function
  • toSearchKey: function

    • Parameters

      Returns SearchKey

  • toTransactionAndWitnessProof: function
  • toTransactionProof: function

Const ResultFormatter

ResultFormatter: typeof resultFormatter

Const ResultFormatter

ResultFormatter: "/vercel/path0/packages/rpc/src/resultFormatter" = resultFormatter

Const _default

_default: { getBlock: { method: string; paramsFormatters: ((hash: string) => string)[]; resultFormatters: (block: Block) => Block }; getBlockByNumber: { method: string; paramsFormatters: ((number: string | bigint) => string)[]; resultFormatters: (block: Block) => Block }; getBlockEconomicState: { method: string; paramsFormatters: ((hash: string) => string)[]; resultFormatters: (blockEconomicState: BlockEconomicState) => BlockEconomicState }; getBlockHash: { method: string; paramsFormatters: ((number: string | bigint) => string)[] }; getCellbaseOutputCapacityDetails: { method: string; paramsFormatters: ((hash: string) => string)[]; resultFormatters: (details: CellbaseOutputCapacityDetails) => CellbaseOutputCapacityDetails }; getConsensus: { method: string; paramsFormatters: never[]; resultFormatters: (consensus: Consensus) => Consensus }; getCurrentEpoch: { method: string; paramsFormatters: never[]; resultFormatters: (epoch: Epoch) => Epoch }; getEpochByNumber: { method: string; paramsFormatters: ((number: string | bigint) => string)[]; resultFormatters: (epoch: Epoch) => Epoch }; getHeader: { method: string; paramsFormatters: ((hash: string) => string)[]; resultFormatters: (header: Header) => Header }; getHeaderByNumber: { method: string; paramsFormatters: ((number: string | bigint) => string)[]; resultFormatters: (header: Header) => Header }; getLiveCell: { method: string; paramsFormatters: ((outPoint: OutPoint) => OutPoint)[]; resultFormatters: (cellWithStatus: { cell: LiveCell; status: string }) => { cell: LiveCell; status: string } }; getTipBlockNumber: { method: string; paramsFormatters: never[]; resultFormatters: (number: string) => string }; getTipHeader: { method: string; paramsFormatters: never[]; resultFormatters: (header: Header) => Header }; getTransaction: { method: string; paramsFormatters: ((hash: string) => string)[]; resultFormatters: (txWithStatus: TransactionWithStatus) => { transaction: RawTransaction & { witnesses: Witness[] }; txStatus: { blockHash: string | undefined; status: TransactionStatus } } }; getTransactionProof: { method: string; paramsFormatters: ((arg: any) => any)[]; resultFormatters: (proof: TransactionProof) => TransactionProof }; verifyTransactionProof: { method: string; paramsFormatters: ((proof: TransactionProof) => TransactionProof)[] } }

Type declaration

Const _default

_default: { calculateDaoMaximumWithdraw: { method: string; paramsFormatters: (((hash: string) => string) | ((outPoint: OutPoint) => OutPoint))[] }; dryRunTransaction: { method: string; paramsFormatters: ((transaction: RawTransaction & { witnesses: Witness[] }) => RawTransaction)[] } }

Type declaration

Const _default

_default: { addNode: { method: string; paramsFormatters: never[] }; clearBannedAddresses: { method: string; paramsFormatters: never[] }; getBannedAddresses: { method: string; paramsFormatters: never[]; resultFormatters: (bannedAddresses: Array) => Array }; getPeers: { method: string; paramsFormatters: never[]; resultFormatters: (nodes: RemoteNodeInfo[]) => RemoteNode[] }; localNodeInfo: { method: string; paramsFormatters: never[]; resultFormatters: (info: LocalNodeInfo) => LocalNode }; pingPeers: { method: string; paramsFormatters: never[] }; removeNode: { method: string; paramsFormatters: never[] }; setBan: { method: string; paramsFormatters: never[] }; setNetworkActive: { method: string; paramsFormatters: ((value: boolean) => boolean)[] }; syncState: { method: string; paramsFormatters: never[]; resultFormatters: (state: SyncState) => SyncState } }

Type declaration

  • addNode: { method: string; paramsFormatters: never[] }
    • method: string
    • paramsFormatters: never[]
  • clearBannedAddresses: { method: string; paramsFormatters: never[] }
    • method: string
    • paramsFormatters: never[]
  • getBannedAddresses: { method: string; paramsFormatters: never[]; resultFormatters: (bannedAddresses: Array) => Array }
    • method: string
    • paramsFormatters: never[]
    • resultFormatters: (bannedAddresses: Array) => Array
        • (bannedAddresses: Array): Array

        • Parameters

          • bannedAddresses: Array

          Returns Array

  • getPeers: { method: string; paramsFormatters: never[]; resultFormatters: (nodes: RemoteNodeInfo[]) => RemoteNode[] }
  • localNodeInfo: { method: string; paramsFormatters: never[]; resultFormatters: (info: LocalNodeInfo) => LocalNode }
  • pingPeers: { method: string; paramsFormatters: never[] }
    • method: string
    • paramsFormatters: never[]
  • removeNode: { method: string; paramsFormatters: never[] }
    • method: string
    • paramsFormatters: never[]
  • setBan: { method: string; paramsFormatters: never[] }
    • method: string
    • paramsFormatters: never[]
  • setNetworkActive: { method: string; paramsFormatters: ((value: boolean) => boolean)[] }
    • method: string
    • paramsFormatters: ((value: boolean) => boolean)[]
  • syncState: { method: string; paramsFormatters: never[]; resultFormatters: (state: SyncState) => SyncState }

Const _default

_default: { clearTxPool: { method: string; paramsFormatters: never[] }; getRawTxPool: { method: string; paramsFormatters: never[]; resultFormatters: (rawTxPool: {} | {}) => TxPoolIds | TxPoolVerbosity }; sendTransaction: { method: string; paramsFormatters: (((transaction: RawTransaction & { witnesses: Witness[] }) => RawTransaction) | ((outputsValidator: undefined | "default" | "passthrough") => undefined | "default" | "passthrough"))[]; resultFormatters: (hash: string) => string }; txPoolInfo: { method: string; paramsFormatters: never[]; resultFormatters: (info: TxPoolInfo) => TxPoolInfo } }

Type declaration

  • clearTxPool: { method: string; paramsFormatters: never[] }
    • method: string
    • paramsFormatters: never[]
  • getRawTxPool: { method: string; paramsFormatters: never[]; resultFormatters: (rawTxPool: {} | {}) => TxPoolIds | TxPoolVerbosity }
  • sendTransaction: { method: string; paramsFormatters: (((transaction: RawTransaction & { witnesses: Witness[] }) => RawTransaction) | ((outputsValidator: undefined | "default" | "passthrough") => undefined | "default" | "passthrough"))[]; resultFormatters: (hash: string) => string }
    • method: string
    • paramsFormatters: (((transaction: RawTransaction & { witnesses: Witness[] }) => RawTransaction) | ((outputsValidator: undefined | "default" | "passthrough") => undefined | "default" | "passthrough"))[]
    • resultFormatters: (hash: string) => string
        • (hash: string): string

        • Parameters

          • hash: string

          Returns string

  • txPoolInfo: { method: string; paramsFormatters: never[]; resultFormatters: (info: TxPoolInfo) => TxPoolInfo }

Const _default

_default: { getBlockchainInfo: { method: string; paramsFormatters: never[]; resultFormatters: (info: BlockchainInfo) => ChainInfo } }

Type declaration

Const _default

_default: { IdNotMatchException: typeof IdNotMatchException; ResponseException: typeof ResponseException }

Type declaration

Const _default

_default: { IdNotMatchedInBatchException: typeof IdNotMatchedInBatchException; MethodInBatchNotFoundException: typeof MethodInBatchNotFoundException; PayloadInBatchException: typeof PayloadInBatchException }

Type declaration

Const _default

_default: { BigintOrHexStringTypeException: typeof BigintOrHexStringTypeException; HexStringWithout0xException: typeof HexStringWithout0xException; OutputsValidatorTypeException: typeof OutputsValidatorTypeException; PageSizeTooLargeException: typeof PageSizeTooLargeException; PageSizeTooSmallException: typeof PageSizeTooSmallException; StringHashTypeException: typeof StringHashTypeException }

Type declaration

Const app

app: Express = express()

Const formatter

formatter: { toArray: (format?: ((args: any) => any) | undefined) => (arg: any) => any; toBoolean: (value: boolean) => boolean; toCellDep: (cellDep: CellDep) => CellDep; toDepType: (type: DepType) => "code" | "dep_group"; toGetCellsSearchKey: (data: GetCellsSearchKey) => GetCellsSearchKey; toGetTransactionsSearchKey: (data: GetTransactionsSearchKey) => GetTransactionsSearchKey; toHash: (hash: string) => Hash256; toInput: (input: CellInput) => CellInput; toNumber: (number: Number | bigint) => Number; toOptional: (format?: ((args: any) => any) | undefined) => (arg: any) => any; toOrder: (order: Order) => "asc" | "desc"; toOutPoint: (outPoint: OutPoint) => OutPoint; toOutput: (output: CellOutput) => CellOutput; toOutputsValidator: (outputsValidator: OutputsValidator) => OutputsValidator; toPageNumber: (pageNo?: string | bigint) => string; toPageSize: (pageSize?: string | bigint) => string; toRawTransaction: (transaction: RawTransaction) => RawTransaction; toReverseOrder: (reverse?: undefined | false | true) => boolean; toScript: (script: Script) => Script; toSearchFilter: (data: SearchFilter) => SearchFilter; toSearchKey: (data: SearchKey) => SearchKey; toTransactionAndWitnessProof: (proof: TransactionAndWitnessProof) => TransactionAndWitnessProof; toTransactionProof: (proof: TransactionProof) => TransactionProof }

Type declaration

Const rpcProperties

rpcProperties: RpcPropertes

Const schemas

schemas: Record<string, MethodSchema>

Const toAlertMessage

toAlertMessage: (alertMessage: AlertMessage) => AlertMessage

Type declaration

Const toArray

toArray: <I, O>(format?: ((args: I) => O) | undefined) => (arg: I[]) => I[] | O[]

Type declaration

    • <I, O>(format?: ((args: I) => O) | undefined): (arg: I[]) => I[] | O[]

    • Type parameters

      • I

      • O

      Parameters

      • Optional format: ((args: I) => O) | undefined

      Returns (arg: I[]) => I[] | O[]

        • (arg: I[]): I[] | O[]

        • Parameters

          • arg: I[]

          Returns I[] | O[]

Const toBannedAddress

toBannedAddress: (bannedAddress: BannedAddress) => BannedAddress

Type declaration

Const toBannedAddresses

toBannedAddresses: (bannedAddresses: BannedAddresses) => BannedAddresses

Type declaration

Const toBlock

toBlock: (block: Block) => Block

Type declaration

Const toBlockEconomicState

toBlockEconomicState: (blockEconomicState: BlockEconomicState) => BlockEconomicState

Type declaration

Const toBlockFilter

toBlockFilter: (blockFilter: BlockFilter) => BlockFilter

Type declaration

Const toBlockchainInfo

toBlockchainInfo: (info: BlockchainInfo) => BlockchainInfo

Type declaration

Const toCapacityByLockHash

toCapacityByLockHash: (capacityByLockHash: CapacityByLockHash) => CapacityByLockHash

Type declaration

Const toCell

toCell: (cell: Cell) => Cell

Type declaration

Const toCellDep

toCellDep: (cellDep: CellDep) => CellDep

Type declaration

Const toCellIncludingOutPoint

toCellIncludingOutPoint: (cell: CellIncludingOutPoint) => { blockHash: string; capacity: string; cellbase: boolean; lock: Script; outPoint: OutPoint; outputDataLen: string }

Type declaration

Const toCellbaseOutputCapacityDetails

toCellbaseOutputCapacityDetails: (details: CellbaseOutputCapacityDetails) => CellbaseOutputCapacityDetails

Type declaration

Const toCells

toCells: (cells: Cell[]) => Cell[]

Type declaration

Const toCellsCapacity

toCellsCapacity: (cellsCapacity: CellsCapacity) => CellsCapacity

Type declaration

Const toCellsIncludingOutPoint

toCellsIncludingOutPoint: (cells: CellIncludingOutPoint[]) => CellIncludingOutPoint[]

Type declaration

Const toConsensus

toConsensus: (consensus: Consensus) => Consensus

Type declaration

Const toDepType

toDepType: (type: DepType) => DepType

Type declaration

Const toEpoch

toEpoch: (epoch: Epoch) => Epoch

Type declaration

Const toEstimateCycles

toEstimateCycles: (cycle: EstimateCycles) => EstimateCycles

Type declaration

Const toFeeRate

toFeeRate: (feeRateObj: FeeRate) => FeeRate

Type declaration

Const toFeeRateStatistics

toFeeRateStatistics: (statistics: FeeRateStatistics) => FeeRateStatistics

Type declaration

Const toForkBlockResult

toForkBlockResult: (result: BlockView | SerializedBlock) => BlockView | SerializedBlock

Type declaration

Const toGetCellsResult

toGetCellsResult: (getCellsResult: GetLiveCellsResult) => GetLiveCellsResult

Type declaration

Const toGetTransactionsResult

toGetTransactionsResult: <Goruped>(getTransactionsResult: GetTransactionsResult<Goruped>) => GetTransactionsResult<Goruped>

Type declaration

Const toHash

toHash: (hash: Hash256) => Hash256

Type declaration

Const toHeader

toHeader: (header: Header) => BlockHeader

Type declaration

Const toInput

toInput: (input: CellInput) => CellInput

Type declaration

Const toLiveCell

toLiveCell: (liveCell: LiveCell) => LiveCell

Type declaration

Const toLiveCellWithStatus

toLiveCellWithStatus: (cellWithStatus: { cell: LiveCell; status: string }) => { cell: LiveCell; status: string }

Type declaration

    • (cellWithStatus: { cell: LiveCell; status: string }): { cell: LiveCell; status: string }

    • Parameters

      • cellWithStatus: { cell: LiveCell; status: string }

      Returns { cell: LiveCell; status: string }

Const toLiveCellsByLockHash

toLiveCellsByLockHash: (cells: LiveCellsByLockHash) => LiveCellsByLockHash

Type declaration

Const toLocalNodeInfo

toLocalNodeInfo: (info: LocalNodeInfo) => LocalNodeInfo

Type declaration

Const toLockHashIndexState

toLockHashIndexState: (index: LockHashIndexState) => LockHashIndexState

Type declaration

Const toLockHashIndexStates

toLockHashIndexStates: (states: LockHashIndexStates) => LockHashIndexStates

Type declaration

Const toNullable

toNullable: <I, O>(format?: ((args: I) => O) | undefined) => (origin: I | null) => I | O | null

Type declaration

    • <I, O>(format?: ((args: I) => O) | undefined): (origin: I | null) => I | O | null

    • Type parameters

      • I

      • O

      Parameters

      • Optional format: ((args: I) => O) | undefined

      Returns (origin: I | null) => I | O | null

        • (origin: I | null): I | O | null

        • Parameters

          • origin: I | null

          Returns I | O | null

Const toNumber

toNumber: (number: BlockNumber) => BlockNumber

Type declaration

Const toOutPoint

toOutPoint: (outPoint: OutPoint) => OutPoint

Type declaration

Const toOutput

toOutput: (output: CellOutput) => CellOutput

Type declaration

Const toPeers

toPeers: (nodes: RemoteNodeInfo[]) => RemoteNodeInfo[]

Type declaration

Const toRawTxPool

toRawTxPool: (rawTxPool: RawTxPool) => RawTxPool

Type declaration

Const toRemoteNodeInfo

toRemoteNodeInfo: (info: RemoteNodeInfo) => RemoteNodeInfo

Type declaration

Const toScript

toScript: (script: Script) => Script

Type declaration

Const toSyncState

toSyncState: (state: SyncState) => SyncState

Type declaration

Const toTip

toTip: (tip: Tip) => Tip

Type declaration

Const toTransactionAndWitnessProof

toTransactionAndWitnessProof: (proof: TransactionAndWitnessProof) => TransactionAndWitnessProof

Type declaration

Const toTransactionPoint

toTransactionPoint: (transactionPoint: TransactionPoint) => TransactionPoint

Type declaration

Const toTransactionProof

toTransactionProof: (proof: TransactionProof) => TransactionProof

Type declaration

Const toTransactionWithStatus

toTransactionWithStatus: (txWithStatus: TransactionWithStatus) => { transaction: RawTransaction; txStatus: { blockHash: string | undefined; status: TransactionStatus } }

Type declaration

Const toTransactionsByLockHash

toTransactionsByLockHash: (transactions: TransactionsByLockHash) => TransactionsByLockHash

Type declaration

Const toTxPoolInfo

toTxPoolInfo: (info: TxPoolInfo) => TxPoolInfo

Type declaration

Const toUncleBlock

toUncleBlock: (uncleBlock: UncleBlock) => UncleBlock

Type declaration

Functions

Const isTxPoolIds

  • isTxPoolIds(rawTxPool: RawTxPool): rawTxPool is RPC.TxPoolIds

  • Parameters

    Returns rawTxPool is RPC.TxPoolIds

Const isUngroupedIndexerTransaction

Const main

  • main(): Promise<void>

  • Returns Promise<void>

Const toAlertMessage

Const toArray

  • toArray<I, O>(format?: undefined | ((args: I) => O)): (Anonymous function)

  • Type parameters

    • I

    • O

    Parameters

    • Optional format: undefined | ((args: I) => O)

    Returns (Anonymous function)

Const toBannedAddress

Const toBannedAddresses

Const toBlock

  • Parameters

    Returns Block

Const toBlockEconomicState

Const toBlockFilter

Const toBlockchainInfo

Const toCapacityByLockHash

Const toCell

  • Parameters

    Returns Cell

Const toCellDep

  • Parameters

    Returns CellDep

Const toCellIncludingOutPoint

  • Parameters

    Returns { blockHash: string; lock: Script; outPoint: OutPoint; outputDataLen: string }

    • blockHash: string
    • lock: Script
    • outPoint: OutPoint
    • outputDataLen: string

Const toCellbaseOutputCapacityDetails

Const toCells

  • Parameters

    Returns Cell[]

Const toCellsCapacity

Const toCellsIncludingOutPoint

Const toConsensus

  • Parameters

    Returns Consensus

Const toDepType

  • Parameters

    Returns DepType

Const toEpoch

  • Parameters

    Returns Epoch

Const toEstimateCycles

Const toFeeRate

  • Parameters

    Returns FeeRate

Const toFeeRateStatistics

Const toForkBlockResult

Const toGetCellsResult

Const toGetTransactionsResult

Const toHash

  • Parameters

    Returns Hash256

Const toHeader

  • Parameters

    Returns BlockHeader

Const toIndexerCell

Const toIndexerTransaction

Const toInput

  • Parameters

    Returns CellInput

Const toLiveCell

  • Parameters

    Returns LiveCell

Const toLiveCellWithStatus

  • toLiveCellWithStatus(cellWithStatus: { cell: LiveCell; status: string }): { cell: LiveCell; status: string }

  • Parameters

    • cellWithStatus: { cell: LiveCell; status: string }

    Returns { cell: LiveCell; status: string }

Const toLiveCellsByLockHash

Const toLocalNodeInfo

Const toLockHashIndexState

Const toLockHashIndexStates

Const toNullable

  • toNullable<I, O>(format?: undefined | ((args: I) => O)): (Anonymous function)

  • Type parameters

    • I

    • O

    Parameters

    • Optional format: undefined | ((args: I) => O)

    Returns (Anonymous function)

Const toNumber

Const toOutPoint

  • Parameters

    Returns OutPoint

Const toOutput

  • Parameters

    Returns CellOutput

Const toPeers

Const toRawTxPool

  • Parameters

    Returns RawTxPool

Const toRemoteNodeInfo

Const toScript

  • Parameters

    Returns Script

Const toSyncState

  • Parameters

    Returns SyncState

Const toTip

  • Parameters

    Returns Tip

toTransaction

toTransaction

Const toTransactionAndWitnessProof

Const toTransactionPoint

Const toTransactionProof

Const toTransactionWithStatus

Const toTransactionsByLockHash

Const toTxPoolInfo

Const toUncleBlock

  • Parameters

    Returns UncleBlock

Object literals

Const formatter

formatter: object

toArray

  • toArray(format?: undefined | ((args: any) => any)): (Anonymous function)

  • Parameters

    • Optional format: undefined | ((args: any) => any)

    Returns (Anonymous function)

toBoolean

  • toBoolean(value: boolean): boolean

  • Parameters

    • value: boolean

    Returns boolean

toCellDep

  • Parameters

    Returns CellDep

toDepType

  • toDepType(type: DepType): "code" | "dep_group"

  • Parameters

    Returns "code" | "dep_group"

toGetCellsSearchKey

toGetTransactionsSearchKey

toHash

  • Parameters

    • hash: string

    Returns Hash256

toInput

  • Parameters

    Returns CellInput

toNumber

  • Parameters

    Returns Number

toOptional

  • toOptional(format?: undefined | ((args: any) => any)): (Anonymous function)

  • Parameters

    • Optional format: undefined | ((args: any) => any)

    Returns (Anonymous function)

toOrder

  • toOrder(order: Order): "asc" | "desc"

  • Parameters

    Returns "asc" | "desc"

toOutPoint

  • Parameters

    Returns OutPoint

toOutput

  • Parameters

    Returns CellOutput

toOutputsValidator

  • toOutputsValidator(outputsValidator: OutputsValidator): undefined | "default" | "passthrough"

  • Parameters

    Returns undefined | "default" | "passthrough"

toPageNumber

  • toPageNumber(pageNo?: string | bigint): string

  • Parameters

    • Default value pageNo: string | bigint = "0x1"

    Returns string

toPageSize

  • toPageSize(pageSize?: string | bigint): string

  • Parameters

    • Default value pageSize: string | bigint = "0x32"

    Returns string

toRawTransaction

toReverseOrder

  • toReverseOrder(reverse?: boolean): boolean

  • Parameters

    • Default value reverse: boolean = false

    Returns boolean

toScript

  • Parameters

    Returns Script

toSearchFilter

toSearchKey

  • Parameters

    Returns SearchKey

toTransactionAndWitnessProof

toTransactionProof

Const rpcProperties

rpcProperties: object

Const schemas

schemas: object

estimateCycles

estimateCycles: object

method

method: string = "estimate_cycles"

paramsFormatters

paramsFormatters: (Anonymous function)[] = [paramsFmts.toRawTransaction]

resultFormatters

resultFormatters: toEstimateCycles = resultFmts.toEstimateCycles

getBlockFilter

getBlockFilter: object

method

method: string = "get_block_filter"

paramsFormatters

paramsFormatters: (Anonymous function)[] = [paramsFmts.toHash]

resultFormatters

resultFormatters: (Anonymous function) = resultFmts.toNullable(resultFmts.toBlockFilter)

getBlockMedianTime

getBlockMedianTime: object

method

method: string = "get_block_median_time"

paramsFormatters

paramsFormatters: (Anonymous function)[] = [paramsFmts.toHash]

resultFormatters

resultFormatters: (Anonymous function) = resultFmts.toNullable(resultFmts.toNumber)

getCells

getCells: object

method

method: string = "get_cells"

paramsFormatters

paramsFormatters: ((Anonymous function) | (Anonymous function) | (Anonymous function) | (Anonymous function))[] = [paramsFmts.toGetCellsSearchKey,paramsFmts.toOrder,paramsFmts.toNumber,paramsFmts.toOptional(paramsFmts.toHash),]

resultFormatters

resultFormatters: toGetCellsResult = resultFmts.toGetCellsResult

getCellsCapacity

getCellsCapacity: object

method

method: string = "get_cells_capacity"

paramsFormatters

paramsFormatters: (Anonymous function)[] = [paramsFmts.toSearchKey]

resultFormatters

resultFormatters: toCellsCapacity = resultFmts.toCellsCapacity

getFeeRateStatics

getFeeRateStatics: object

method

method: string = "get_fee_rate_statics"

paramsFormatters

paramsFormatters: (Anonymous function)[] = [paramsFmts.toOptional(paramsFmts.toNumber)]

resultFormatters

resultFormatters: (Anonymous function) = resultFmts.toNullable(resultFmts.toFeeRateStatistics)

getFeeRateStatistics

getFeeRateStatistics: object

method

method: string = "get_fee_rate_statistics"

paramsFormatters

paramsFormatters: (Anonymous function)[] = [paramsFmts.toOptional(paramsFmts.toNumber)]

resultFormatters

resultFormatters: (Anonymous function) = resultFmts.toNullable(resultFmts.toFeeRateStatistics)

getForkBlock

getForkBlock: object

method

method: string = "get_fork_block"

paramsFormatters

paramsFormatters: ((Anonymous function) | (Anonymous function))[] = [paramsFmts.toHash,paramsFmts.toOptional(paramsFmts.toNumber),]

resultFormatters

resultFormatters: (Anonymous function) = resultFmts.toNullable(resultFmts.toForkBlockResult)

getIndexerTip

getIndexerTip: object

method

method: string = "get_indexer_tip"

paramsFormatters

paramsFormatters: never[] = []

resultFormatters

resultFormatters: toTip = resultFmts.toTip

getTransactionAndWitnessProof

getTransactionAndWitnessProof: object

method

method: string = "get_transaction_and_witness_proof"

paramsFormatters

paramsFormatters: (Anonymous function)[] = [paramsFmts.toArray(paramsFmts.toHash),paramsFmts.toOptional(paramsFmts.toHash),]

resultFormatters

resultFormatters: toTransactionAndWitnessProof = resultFmts.toTransactionAndWitnessProof

getTransactions

getTransactions: object

method

method: string = "get_transactions"

paramsFormatters

paramsFormatters: ((Anonymous function) | (Anonymous function) | (Anonymous function) | (Anonymous function))[] = [paramsFmts.toGetTransactionsSearchKey,paramsFmts.toOrder,paramsFmts.toNumber,paramsFmts.toOptional(paramsFmts.toHash),]

resultFormatters

resultFormatters: toGetTransactionsResult = resultFmts.toGetTransactionsResult

verifyTransactionAndWitnessProof

verifyTransactionAndWitnessProof: object

method

method: string = "verify_transaction_and_witness_proof"

paramsFormatters

paramsFormatters: (Anonymous function)[] = [paramsFmts.toTransactionAndWitnessProof]

resultFormatters

resultFormatters: (Anonymous function) = resultFmts.toArray(resultFmts.toHash)

Generated using TypeDoc