Interface RPCInterface

Implement this interface if the built-in RPC class does not fit your needs. The easiest way to do this is by just extending the built-in RPC class

interface RPCInterface {
    DECIMALS?: number;
    rpc_url: string;
    use_pending: boolean;
    call(payload): Promise<Record<string, string>>;
    get_account_info(account, include_confirmed?, representative?, weight?, pending?): Promise<AccountInfoRPC>;
    get_account_receivable(account, count?, threshold?, source?): Promise<AccountReceivableRPC | AccountReceivableThresholdRPC | AccountReceivableSourceRPC>;
    get_block_info(block_hash): Promise<BlockInfoRPC>;
}

Implemented by

RPC

Index

Properties

DECIMALS? rpc_url use_pending

Methods

call get_account_info get_account_receivable get_block_info

Properties

`Optional` DECIMALS

DECIMALS?: number

rpc_url

rpc_url: string

use_pending

use_pending: boolean

Methods

call

call(payload): Promise<Record<string, string>>
Parameters
- payload: Record<string, any>
Returns Promise<Record<string, string>>
- Defined in rpc.ts:9

get_account_info

get_account_info(account, include_confirmed?, representative?, weight?, pending?): Promise<AccountInfoRPC>
Parameters
- account: `ban_${string}` | `nano_${string}`
- Optional include_confirmed: boolean
- Optional representative: boolean
- Optional weight: boolean
- Optional pending: boolean
Returns Promise<AccountInfoRPC>
- Defined in rpc.ts:11

get_account_receivable

get_account_receivable(account, count?, threshold?, source?): Promise<AccountReceivableRPC | AccountReceivableThresholdRPC | AccountReceivableSourceRPC>
Parameters
- account: `ban_${string}` | `nano_${string}`
- Optional count: number
- Optional threshold: `${number}`
- Optional source: boolean
Returns Promise<AccountReceivableRPC | AccountReceivableThresholdRPC | AccountReceivableSourceRPC>
- Defined in rpc.ts:12

get_block_info

get_block_info(block_hash): Promise<BlockInfoRPC>
Parameters
- block_hash: string
Returns Promise<BlockInfoRPC>
- Defined in rpc.ts:10