Skip to main content

MinimaRpcClient

@totemsdk/minima-rpc


@totemsdk/minima-rpc / MinimaRpcClient

Interface: MinimaRpcClient

Methods

balance()

balance(params?): Promise<Balance[]>

Parameters

params?

BalanceQuery

Returns

Promise<Balance[]>


burn()

burn(last?): Promise<BurnInfo>

Parameters

last?

number

Returns

Promise<BurnInfo>


coinCheck()

coinCheck(coinId): Promise<CoinCheckResult>

Parameters

coinId

string

Returns

Promise<CoinCheckResult>


coinExport()

coinExport(coinId): Promise<CoinExportResult>

Parameters

coinId

string

Returns

Promise<CoinExportResult>


coins()

coins(query?): Promise<Coin[]>

Parameters

query?

CoinsQuery

Returns

Promise<Coin[]>


getAddress()

getAddress(): Promise<AddressInfo>

Returns

Promise<AddressInfo>


getTip()

getTip(): Promise<ChainTip>

Returns

Promise<ChainTip>


history()

history(params?): Promise<HistoryEntry[]>

Parameters

params?

HistoryQuery

Returns

Promise<HistoryEntry[]>


megammr()

megammr(): Promise<MegaMMRInfo>

Returns

Promise<MegaMMRInfo>


mmrProof()

mmrProof(coinId): Promise<MMRProof>

Parameters

coinId

string

Returns

Promise<MMRProof>


runCommand()

runCommand(cmd, params?): Promise<unknown>

Parameters

cmd

string

params?

Record<string, unknown>

Returns

Promise<unknown>


send()

send(params): Promise<TxnPostResult>

Parameters

params

SendParams

Returns

Promise<TxnPostResult>


status()

status(): Promise<NodeStatus>

Returns

Promise<NodeStatus>


tokens()

tokens(tokenId?, action?): Promise<TokenInfo[]>

Parameters

tokenId?

string

action?

string

Returns

Promise<TokenInfo[]>


txnBasics()

txnBasics(id): Promise<void>

Parameters

id

string

Returns

Promise<void>


txnCheck()

txnCheck(id): Promise<TxnCheckResult>

Parameters

id

string

Returns

Promise<TxnCheckResult>


txnClear()

txnClear(id): Promise<void>

Parameters

id

string

Returns

Promise<void>


txnCreate()

txnCreate(id): Promise<void>

Parameters

id

string

Returns

Promise<void>


txnDelete()

txnDelete(id): Promise<void>

Parameters

id

string

Returns

Promise<void>


txnExport()

txnExport(id): Promise<string>

Parameters

id

string

Returns

Promise<string>


txnImport()

txnImport(data, id?): Promise<void>

Parameters

data

string

id?

string

Returns

Promise<void>


txnInput()

txnInput(params): Promise<void>

Parameters

params

TxnInputParams

Returns

Promise<void>


txnList()

txnList(id?, transactionOnly?): Promise<TxnListResult>

Parameters

id?

string

transactionOnly?

boolean

Returns

Promise<TxnListResult>


txnMine()

txnMine(params): Promise<void>

Parameters

params

TxnMineParams

Returns

Promise<void>


txnMinePost()

txnMinePost(data): Promise<TxnPostResult>

Parameters

data

string

Returns

Promise<TxnPostResult>


txnOutput()

txnOutput(params): Promise<void>

Parameters

params

TxnOutputParams

Returns

Promise<void>


txnPost()

txnPost(params): Promise<TxnPostResult>

Parameters

params

TxnPostParams

Returns

Promise<TxnPostResult>


txnScript()

txnScript(params): Promise<void>

Parameters

params

TxnScriptParams

Returns

Promise<void>


txnSign()

txnSign(params): Promise<void>

Parameters

params

TxnSignParams

Returns

Promise<void>


txnState()

txnState(params): Promise<void>

Parameters

params

TxnStateParams

Returns

Promise<void>


verify()

verify(publicKey, data, signature): Promise<boolean>

Parameters

publicKey

string

data

string

signature

string

Returns

Promise<boolean>


webhooks()

Call Signature

webhooks(action): Promise<WebhookEntry[]>

Parameters
action

"list"

Returns

Promise<WebhookEntry[]>

Call Signature

webhooks(action, hook, filter): Promise<void>

Parameters
action

"add"

hook

string

filter

"NEWTXPOW" | "NEWBLOCK"

Returns

Promise<void>

Call Signature

webhooks(action, hook): Promise<void>

Parameters
action

"remove"

hook

string

Returns

Promise<void>