WalletAccountReadOnlyTron

Defined in: wallet-tron/src/read-only-account.ts:101

A Tron address without a key: TRX and TRC-20 balances, allowances, resources, fee estimates, simulation, receipts and signature checks.

Extended by

WalletAccountTron

Implements

IWalletAccountReadOnly

Constructors

Constructor

new WalletAccountReadOnlyTron(address, config?): WalletAccountReadOnlyTron

Defined in: wallet-tron/src/read-only-account.ts:110

Parameters

address

string

config?

TronConfig = {}

Returns

WalletAccountReadOnlyTron

Properties

_client

protected readonly _client: TronFetch | undefined

Defined in: wallet-tron/src/read-only-account.ts:108

_config

protected readonly _config: TronConfig

Defined in: wallet-tron/src/read-only-account.ts:107

address

readonly address: string

Defined in: wallet-tron/src/read-only-account.ts:103

base58 T…

addressHex

readonly addressHex: string

Defined in: wallet-tron/src/read-only-account.ts:105

Hex form (41…).

chain

readonly chain: string

Defined in: wallet-tron/src/read-only-account.ts:106

CAIP-2 chain id, e.g. “eip155:1”, “solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp”, “ton:-239”, “tron:0x2b6653dc”, “bip122:000000000019d6689c085ae165831e93”.

Implementation of

IWalletAccountReadOnly.chain

Methods

accountExists()

accountExists(address): Promise<boolean>

Defined in: wallet-tron/src/read-only-account.ts:168

Does an account exist on chain (/wallet/getaccount non-empty)?

Parameters

address

string

Returns

Promise<boolean>

asTransaction()

protected asTransaction(o): TronTransaction

Defined in: wallet-tron/src/read-only-account.ts:361

Parameters

o

TronTransferOptions

Returns

TronTransaction

buildTransaction()

protected buildTransaction(tx): Promise<TronRawTransaction>

Defined in: wallet-tron/src/read-only-account.ts:214

Parameters

tx

TronTransaction

Returns

Promise<TronRawTransaction>

buildWithSimulation()

protected buildWithSimulation(tx, cap?): Promise<{ built: TronRawTransaction; sim?: TronSimulation; }>

Defined in: wallet-tron/src/read-only-account.ts:180

Ask the node for raw_data. Contract calls are simulated first so fee_limit can be derived from the energy they need (×1.2, capped at transactionMaxFee and the call’s cap) when the caller gives none; the simulation rides along so nobody pays for a second one.

Parameters

tx

TronTransaction

cap?

number | bigint

Returns

Promise<{ built: TronRawTransaction; sim?: TronSimulation; }>

constantCall()

protected constantCall(contract, functionSelector, parameters, what, extra?): Promise<ConstantCallResponse>

Defined in: wallet-tron/src/read-only-account.ts:140

Read-only contract call. Returns constant_result hex strings.

Parameters

contract

string

functionSelector

string

parameters

object[]

what

string

extra?

Record<string, unknown> = {}

Returns

Promise<ConstantCallResponse>

describeTransactionOnline()

describeTransactionOnline(tx, ctx?): Promise<TronTxDescription>

Defined in: wallet-tron/src/read-only-account.ts:377

describeTransaction plus the unactivated-recipient check against the node.

Parameters

estimateFee()

estimateFee(tx): Promise<TronFeeEstimate>

Defined in: wallet-tron/src/read-only-account.ts:339

Build (if needed) and price a transaction: bandwidth, energy and the sun the sender burns.

Parameters

tx

TronTransaction

Returns

Promise<TronFeeEstimate>

estimateRaw()

protected estimateRaw(tx, sim?): Promise<TronFeeEstimate>

Defined in: wallet-tron/src/read-only-account.ts:301

Resource-by-resource cost of a node-built transaction. energy comes from a constant call unless the caller already has one (sim).

Parameters

tx

TronRawTransaction

sim?

TronSimulation

Returns

Promise<TronFeeEstimate>

getAddress()

getAddress(): Promise<string>

Defined in: wallet-tron/src/read-only-account.ts:131

The base58 address.

Returns

Promise<string>

Implementation of

IWalletAccountReadOnly.getAddress

getAllowance()

getAllowance(token, spender): Promise<bigint>

Defined in: wallet-tron/src/read-only-account.ts:162

TRC-20 allowance(owner, spender) in base units.

Parameters

token

string

spender

string

Returns

Promise<bigint>

getBalance()

getBalance(): Promise<bigint>

Defined in: wallet-tron/src/read-only-account.ts:134

TRX balance in sun; 0 for an account that does not exist yet.

Returns

Promise<bigint>

Implementation of

IWalletAccountReadOnly.getBalance

getChainParameter()

protected getChainParameter(key): Promise<bigint>

Defined in: wallet-tron/src/read-only-account.ts:291

Parameters

key

string

Returns

Promise<bigint>

getChainParameters()

protected getChainParameters(): Promise<Record<string, bigint>>

Defined in: wallet-tron/src/read-only-account.ts:284

Returns

Promise<Record<string, bigint>>

getResources()

protected getResources(): Promise<Resources>

Defined in: wallet-tron/src/read-only-account.ts:280

Returns

Promise<Resources>

getTokenBalance()

getTokenBalance(token): Promise<bigint>

Defined in: wallet-tron/src/read-only-account.ts:149

TRC-20 balanceOf in the token’s base units.

Parameters

token

string

Returns

Promise<bigint>

Implementation of

IWalletAccountReadOnly.getTokenBalance

getTokenBalances()

getTokenBalances(tokens): Promise<Record<string, bigint>>

Defined in: wallet-tron/src/read-only-account.ts:155

Several TRC-20 balances in parallel, keyed by the tokens as given.

Parameters

tokens

string[]

Returns

Promise<Record<string, bigint>>

getTransactionReceipt()

getTransactionReceipt(hash): Promise<TronReceipt | undefined>

Defined in: wallet-tron/src/read-only-account.ts:384

The receipt, or undefined while the transaction is unconfirmed.

Parameters

hash

string

Returns

Promise<TronReceipt | undefined>

Implementation of

IWalletAccountReadOnly.getTransactionReceipt

post()

protected post<T>(path, body, what): Promise<T>

Defined in: wallet-tron/src/read-only-account.ts:124

Type Parameters

T

T

Parameters

path

string

body

unknown

what

string

Returns

Promise<T>

quoteSendTransaction()

quoteSendTransaction(tx): Promise<TronQuote>

Defined in: wallet-tron/src/read-only-account.ts:351

fee = the sun the sender burns, after staked / free resources.

Parameters

tx

TronTransaction

Returns

Promise<TronQuote>

Implementation of

IWalletAccountReadOnly.quoteSendTransaction

quoteTransaction()

protected quoteTransaction(tx, sim?): Promise<TronQuote>

Defined in: wallet-tron/src/read-only-account.ts:345

Parameters

tx

TronRawTransaction

sim?

TronSimulation

Returns

Promise<TronQuote>

quoteTransfer()

quoteTransfer(o): Promise<TronQuote>

Defined in: wallet-tron/src/read-only-account.ts:369

Fee of a transfer in sun, including account activation when the recipient is new.

Parameters

o

TronTransferOptions

Returns

Promise<TronQuote>

Implementation of

IWalletAccountReadOnly.quoteTransfer

requireClient()

protected requireClient(what): TronFetch

Defined in: wallet-tron/src/read-only-account.ts:119

Parameters

what

string

Returns

TronFetch

simulateCall()

protected simulateCall(tx): Promise<TronSimulation>

Defined in: wallet-tron/src/read-only-account.ts:221

Constant call by selector + params (unbuilt contract call). Never throws on a revert.

Parameters

tx

TronContractCall

Returns

Promise<TronSimulation>

simulateRaw()

protected simulateRaw(tx): Promise<TronSimulation>

Defined in: wallet-tron/src/read-only-account.ts:260

Parameters

tx

TronRawTransaction

Returns

Promise<TronSimulation>

simulateTransaction()

simulateTransaction(tx): Promise<TronSimulation>

Defined in: wallet-tron/src/read-only-account.ts:250

Predict the outcome without signing: contract calls run through /wallet/triggerconstantcontract (revert reason ABI-decoded); TRX transfers check that the balance covers amount + fees. Transport failures throw, predicted failures don’t.

Parameters

tx

TronTransaction

Returns

Promise<TronSimulation>

trc20TransferParams()

protected trc20TransferParams(recipient, amount): ({ type: string; value: string; } | { type: string; value: bigint; })[]

Defined in: wallet-tron/src/read-only-account.ts:357

Parameters

recipient

string

amount

string | number | bigint

Returns

({ type: string; value: string; } | { type: string; value: bigint; })[]

verify()

verify(message, signature): Promise<boolean>

Defined in: wallet-tron/src/read-only-account.ts:393

Verify a TIP-191 signature produced by sign (0x + r||s||v, v = 27|28 or 0|1).

Parameters

message

string | Uint8Array<ArrayBufferLike>

signature

string

Returns

Promise<boolean>

Implementation of

IWalletAccountReadOnly.verify