Constructors
constructor
- new RPC(uri: string, indexer?: Indexer, __namedParameters?: { blockDifference: number; rpcOptions: {}; waitForSyncCheckIntervalSeconds: number }): RPC
-
Parameters
-
uri: string
-
Optional indexer: Indexer
-
Default value __namedParameters: { blockDifference: number; rpcOptions: {}; waitForSyncCheckIntervalSeconds: number } = {}
-
blockDifference: number
-
rpcOptions: {}
-
waitForSyncCheckIntervalSeconds: number
Returns RPC
Methods
add_node
- add_node(peer_id: string, address: string): Promise<null>
-
Parameters
-
peer_id: string
-
address: string
Returns Promise<null>
calculate_dao_maximum_withdraw
-
Parameters
clear_banned_addresses
- clear_banned_addresses(): Promise<null>
-
Returns Promise<null>
clear_tx_pool
- clear_tx_pool(): Promise<null>
-
Returns Promise<null>
dry_run_transaction
-
Parameters
get_banned_addresses
-
get_block
- get_block(block_hash: Hash, verbosity: "0x0"): Promise<SerializedBlock | null>
- get_block(block_hash: Hash, verbosity?: undefined | "0x2"): Promise<Block | null>
-
Parameters
-
block_hash: Hash
-
verbosity: "0x0"
-
Parameters
-
block_hash: Hash
-
Optional verbosity: undefined | "0x2"
Returns Promise<Block | null>
get_block_by_number
- get_block_by_number(block_number: HexNumber, verbosity: "0x0"): Promise<SerializedBlock | null>
- get_block_by_number(block_number: HexNumber, verbosity?: undefined | "0x2"): Promise<Block | null>
-
Parameters
-
Parameters
-
-
Optional verbosity: undefined | "0x2"
Returns Promise<Block | null>
get_block_economic_state
-
Parameters
get_block_hash
-
Parameters
Returns Promise<Hash | null>
get_blockchain_info
-
get_consensus
-
get_current_epoch
- get_current_epoch(): Promise<Epoch>
-
Returns Promise<Epoch>
get_epoch_by_number
-
Parameters
Returns Promise<Epoch | null>
get_fork_block
- get_fork_block(block_hash: Hash, verbosity: "0x0"): Promise<SerializedBlock | null>
- get_fork_block(block_hash: Hash, verbosity?: undefined | "0x2"): Promise<Block | null>
-
Parameters
-
block_hash: Hash
-
verbosity: "0x0"
-
Parameters
-
block_hash: Hash
-
Optional verbosity: undefined | "0x2"
Returns Promise<Block | null>
get_header
- get_header(block_hash: Hash, verbosity: "0x0"): Promise<SerializedHeader | null>
- get_header(block_hash: Hash, verbosity?: undefined | "0x1"): Promise<Header | null>
-
Parameters
-
block_hash: Hash
-
verbosity: "0x0"
-
Parameters
-
block_hash: Hash
-
Optional verbosity: undefined | "0x1"
Returns Promise<Header | null>
get_header_by_number
-
Parameters
-
Parameters
-
-
Optional verbosity: undefined | "0x1"
Returns Promise<Header | null>
get_live_cell
-
Parameters
get_peers
-
get_raw_tx_pool
- get_raw_tx_pool(verbose?: undefined | false): Promise<TxPoolIds>
- get_raw_tx_pool(verbose: true): Promise<TxPoolVerbosity>
-
Parameters
-
Optional verbose: undefined | false
-
Parameters
get_tip_block_number
-
get_tip_header
- get_tip_header(verbosity: "0x0"): Promise<SerializedHeader>
- get_tip_header(verbosity?: undefined | "0x1"): Promise<Header>
-
Parameters
-
Parameters
-
Optional verbosity: undefined | "0x1"
Returns Promise<Header>
get_transaction
-
Parameters
get_transaction_proof
-
Parameters
-
tx_hashes: Hash[]
-
Optional block_hash: Hash
local_node_info
-
ping_peers
- ping_peers(): Promise<null>
-
Returns Promise<null>
remove_node
- remove_node(peer_id: string): Promise<null>
-
Parameters
Returns Promise<null>
resetIndexer
- resetIndexer(indexer?: Indexer): void
-
Parameters
Returns void
send_alert
- send_alert(alert: Alert): Promise<null>
-
Parameters
Returns Promise<null>
send_transaction
-
Parameters
Returns Promise<Hash>
set_ban
- set_ban(address: string, command: string, ban_time?: HexNumber, absolute?: undefined | false | true, reason?: undefined | string): Promise<null>
-
Parameters
-
address: string
-
command: string
-
Optional ban_time: HexNumber
-
Optional absolute: undefined | false | true
-
Optional reason: undefined | string
Returns Promise<null>
set_network_active
- set_network_active(state: boolean): Promise<null>
-
Parameters
Returns Promise<null>
sync_state
-
tx_pool_info
-
verify_transaction_proof
-
Parameters
Returns Promise<Hash[]>