Modules

Class JsonRpcProvider

Client class to interact with the Minter RPC API.

see

example

import * as minterSdk from 'minter-sdk-js';

const chain = new minterSdk.Chain(minterSdk.ChainId.TESTNET);
const provider = new minterSdk.JsonRpcProvider(chain.urls?.api?.node?.http[0]);

Hierarchy

Provider
- JsonRpcProvider

Constructors

constructor

Properties

transport

Constructors

constructor

new JsonRpcProvider(config: string | HttpTransportConfig): JsonRpcProvider

Overrides Provider.constructor
- Defined in src/providers/json-rpc-provider.ts:47
Parameters
- config: string | HttpTransportConfig
Returns JsonRpcProvider

Properties

Protected Readonly transport

transport: default

Methods

address

address(params: AddressStateRequest): Promise<AddressStateResponse>

Overrides Provider.address
- Defined in src/providers/json-rpc-provider.ts:155
Parameters
- params: AddressStateRequest
Returns Promise<AddressStateResponse>

addresses

addresses(params: AddressesRequest): Promise<AddressesResponse>

Overrides Provider.addresses
- Defined in src/providers/json-rpc-provider.ts:168
Parameters
- params: AddressesRequest
Returns Promise<AddressesResponse>

block

block(params: BlockRequest): Promise<BlockResponse>

Overrides Provider.block
- Defined in src/providers/json-rpc-provider.ts:67
Parameters
- params: BlockRequest
Returns Promise<BlockResponse>

blocks

blocks(params: BlocksRequest): Promise<BlocksResponse>

Overrides Provider.blocks
- Defined in src/providers/json-rpc-provider.ts:80
Parameters
- params: BlocksRequest
Returns Promise<BlocksResponse>

candidate

candidate(params: CandidateRequest): Promise<CandidateResponse>

Overrides Provider.candidate
- Defined in src/providers/json-rpc-provider.ts:209
Parameters
- params: CandidateRequest
Returns Promise<CandidateResponse>

candidates

candidates(params?: CandidatesRequest): Promise<CandidatesResponse>

Overrides Provider.candidates
- Defined in src/providers/json-rpc-provider.ts:222
Parameters
- Optional params: CandidatesRequest
Returns Promise<CandidatesResponse>

coinInfo

coinInfo(params: CoinInfoRequest): Promise<CoinInfoResponse>

Overrides Provider.coinInfo
- Defined in src/providers/json-rpc-provider.ts:254
Parameters
- params: CoinInfoRequest
Returns Promise<CoinInfoResponse>

coinInfoById

coinInfoById(params: CoinInfoByIdRequest): Promise<CoinInfoByIdResponse>

Overrides Provider.coinInfoById
- Defined in src/providers/json-rpc-provider.ts:263
Parameters
- params: CoinInfoByIdRequest
Returns Promise<CoinInfoByIdResponse>

commissionVotes

commissionVotes(params: CommissionVotesRequest): Promise<CommissionVotesResponse>

Overrides Provider.commissionVotes
- Defined in src/providers/json-rpc-provider.ts:523
Parameters
- params: CommissionVotesRequest
Returns Promise<CommissionVotesResponse>

estimateCoinBuy

estimateCoinBuy(params: EstimateCoinBuyRequest): Promise<EstimateCoinBuyResponse>

Overrides Provider.estimateCoinBuy
- Defined in src/providers/json-rpc-provider.ts:276
Parameters
- params: EstimateCoinBuyRequest
Returns Promise<EstimateCoinBuyResponse>

estimateCoinSell

estimateCoinSell(params: EstimateCoinSellRequest): Promise<EstimateCoinSellResponse>

Overrides Provider.estimateCoinSell
- Defined in src/providers/json-rpc-provider.ts:327
Parameters
- params: EstimateCoinSellRequest
Returns Promise<EstimateCoinSellResponse>

estimateCoinSellAll

estimateCoinSellAll(params: EstimateCoinSellAllRequest): Promise<EstimateCoinSellAllResponse>

Overrides Provider.estimateCoinSellAll
- Defined in src/providers/json-rpc-provider.ts:380
Parameters
- params: EstimateCoinSellAllRequest
Returns Promise<EstimateCoinSellAllResponse>

estimateTxCommission

estimateTxCommission(params: EstimateTxCommissionRequest): Promise<EstimateTxCommissionResponse>

Overrides Provider.estimateTxCommission
- Defined in src/providers/json-rpc-provider.ts:485
Parameters
- params: EstimateTxCommissionRequest
Returns Promise<EstimateTxCommissionResponse>

events

events(params: EventsRequest): Promise<EventsResponse>

Overrides Provider.events
- Defined in src/providers/json-rpc-provider.ts:558
Parameters
- params: EventsRequest
Returns Promise<EventsResponse>

frozen

frozen(params: AddressFrozenRequest): Promise<AddressFrozenResponse>

Overrides Provider.frozen
- Defined in src/providers/json-rpc-provider.ts:183
Parameters
- params: AddressFrozenRequest
Returns Promise<AddressFrozenResponse>

genesis

genesis(): Promise<GenesisResponse>

Overrides Provider.genesis
- Defined in src/providers/json-rpc-provider.ts:96
Returns Promise<GenesisResponse>

haltVotes

haltVotes(params: HaltVotesRequest): Promise<HaltVotesResponse>

Overrides Provider.haltVotes
- Defined in src/providers/json-rpc-provider.ts:535
Parameters
- params: HaltVotesRequest
Returns Promise<HaltVotesResponse>

limitOrder

limitOrder(params: LimitOrderRequest): Promise<LimitOrderResponse>

Overrides Provider.limitOrder
- Defined in src/providers/json-rpc-provider.ts:428
Parameters
- params: LimitOrderRequest
Returns Promise<LimitOrderResponse>

limitOrders

limitOrders(params: LimitOrdersRequest): Promise<LimitOrdersResponse>

Overrides Provider.limitOrders
- Defined in src/providers/json-rpc-provider.ts:441
Parameters
- params: LimitOrdersRequest
Returns Promise<LimitOrdersResponse>

maxGasPrice

maxGasPrice(params?: MaxGasPriceRequest): Promise<MaxGasPriceResponse>

Overrides Provider.maxGasPrice
- Defined in src/providers/json-rpc-provider.ts:502
Parameters
- Optional params: MaxGasPriceRequest
Returns Promise<MaxGasPriceResponse>

minGasPrice

minGasPrice(params?: MinGasPriceRequest): Promise<MinGasPriceResponse>

Overrides Provider.minGasPrice
- Defined in src/providers/json-rpc-provider.ts:494
Parameters
- Optional params: MinGasPriceRequest
Returns Promise<MinGasPriceResponse>

missedBlocks

missedBlocks(params: MissedBlocksRequest): Promise<MissedBlocksResponse>

Overrides Provider.missedBlocks
- Defined in src/providers/json-rpc-provider.ts:234
Parameters
- params: MissedBlocksRequest
Returns Promise<MissedBlocksResponse>

netInfo

netInfo(): Promise<NetInfoResponse>

Overrides Provider.netInfo
- Defined in src/providers/json-rpc-provider.ts:100
Returns Promise<NetInfoResponse>

netUpdateVotes

netUpdateVotes(params: NetUpdateVotesRequest): Promise<NetUpdateVotesResponse>

Overrides Provider.netUpdateVotes
- Defined in src/providers/json-rpc-provider.ts:545
Parameters
- params: NetUpdateVotesRequest
Returns Promise<NetUpdateVotesResponse>

networkVersion

networkVersion(): Promise<NetworkVersionResponse>

Overrides Provider.networkVersion
- Defined in src/providers/json-rpc-provider.ts:148
Returns Promise<NetworkVersionResponse>

priceCommissions

priceCommissions(params: PriceCommissionsRequest): Promise<PriceCommissionsResponse>

Overrides Provider.priceCommissions
- Defined in src/providers/json-rpc-provider.ts:512
Parameters
- params: PriceCommissionsRequest
Returns Promise<PriceCommissionsResponse>

sendTransaction

sendTransaction(params: SendTransactionRequest): Promise<SendTransactionResponse>

Overrides Provider.sendTransaction
- Defined in src/providers/json-rpc-provider.ts:104
Parameters
- params: SendTransactionRequest
Returns Promise<SendTransactionResponse>

status

status(): Promise<NodeStatusResponse>

Overrides Provider.status
- Defined in src/providers/json-rpc-provider.ts:112
Returns Promise<NodeStatusResponse>

swapPool

swapPool(params: SwapPoolRequest): Promise<SwapPoolResponse>

Overrides Provider.swapPool
- Defined in src/providers/json-rpc-provider.ts:458
Parameters
- params: SwapPoolRequest
Returns Promise<SwapPoolResponse>

transaction

transaction(params: TransactionRequest): Promise<TransactionResponse>

Overrides Provider.transaction
- Defined in src/providers/json-rpc-provider.ts:116
Parameters
- params: TransactionRequest
Returns Promise<TransactionResponse>

transactions

transactions(params: TransactionsRequest): Promise<TransactionsResponse>

Overrides Provider.transactions
- Defined in src/providers/json-rpc-provider.ts:125
Parameters
- params: TransactionsRequest
Returns Promise<TransactionsResponse>

unconfirmedTransactions

unconfirmedTransactions(params: UnconfirmedTxsRequest): Promise<UnconfirmedTxsResponse>

Overrides Provider.unconfirmedTransactions
- Defined in src/providers/json-rpc-provider.ts:140
Parameters
- params: UnconfirmedTxsRequest
Returns Promise<UnconfirmedTxsResponse>

validators

validators(params?: ValidatorsRequest): Promise<ValidatorsResponse>

Overrides Provider.validators
- Defined in src/providers/json-rpc-provider.ts:245
Parameters
- Optional params: ValidatorsRequest
Returns Promise<ValidatorsResponse>

waitlist

waitlist(params: AddressWaitListRequest): Promise<AddressWaitListResponse>

Overrides Provider.waitlist
- Defined in src/providers/json-rpc-provider.ts:196
Parameters
- params: AddressWaitListRequest
Returns Promise<AddressWaitListResponse>

Class JsonRpcProvider

Hierarchy

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: string | HttpTransportConfig

Returns JsonRpcProvider

Properties

Protected Readonly transport

Methods

address

Parameters

params: AddressStateRequest

Returns Promise<AddressStateResponse>

addresses

Parameters

params: AddressesRequest

Returns Promise<AddressesResponse>

block

Parameters

params: BlockRequest

Returns Promise<BlockResponse>

blocks

Parameters

params: BlocksRequest

Returns Promise<BlocksResponse>

candidate

Parameters

params: CandidateRequest

Returns Promise<CandidateResponse>

candidates

Parameters

Optional params: CandidatesRequest

Returns Promise<CandidatesResponse>

coinInfo

Parameters

params: CoinInfoRequest

Returns Promise<CoinInfoResponse>

coinInfoById

Parameters

params: CoinInfoByIdRequest

Returns Promise<CoinInfoByIdResponse>

commissionVotes

Parameters

params: CommissionVotesRequest

Returns Promise<CommissionVotesResponse>

estimateCoinBuy

Parameters

params: EstimateCoinBuyRequest

Returns Promise<EstimateCoinBuyResponse>

estimateCoinSell

Parameters

params: EstimateCoinSellRequest

Returns Promise<EstimateCoinSellResponse>

estimateCoinSellAll

Parameters

params: EstimateCoinSellAllRequest

Returns Promise<EstimateCoinSellAllResponse>

estimateTxCommission

Parameters

params: EstimateTxCommissionRequest

Returns Promise<EstimateTxCommissionResponse>

events

Parameters

params: EventsRequest

Returns Promise<EventsResponse>

frozen

Parameters

params: AddressFrozenRequest

Returns Promise<AddressFrozenResponse>

genesis

Returns Promise<GenesisResponse>

haltVotes

Parameters

params: HaltVotesRequest

Returns Promise<HaltVotesResponse>

limitOrder