WalletAccountNear

Defined in: wallet-near/src/account.ts:33

Signing NEAR account. The key lives in an ed25519 Signer (a local key zeroized by dispose(), or an external hardware / MPC / backend signer). The account builds the transaction (nonce + block hash from the node), checks it, runs the preflight, has the signer sign sha256(borsh(tx)) (context near-tx) and broadcasts it with send_tx.

By default the account id is the implicit one (hex of the public key). Pass accountId for a named account whose full-access key this is.

Extends

WalletAccountReadOnlyNear

Implements

IWalletAccount

Constructors

Constructor

new WalletAccountNear(signer, publicKey, path, config?, accountId?): WalletAccountNear

Defined in: wallet-near/src/account.ts:49

Parameters

signer

Signer

publicKey

Uint8Array

path

string

config?

NearConfig = {}

accountId?

string

Returns

WalletAccountNear

Overrides

WalletAccountReadOnlyNear.constructor

Properties

_client

protected readonly _client: NearFetch | undefined

Defined in: wallet-near/src/read-only-account.ts:49

Inherited from

WalletAccountReadOnlyNear._client

_config

protected readonly _config: NearConfig

Defined in: wallet-near/src/read-only-account.ts:48

Inherited from

WalletAccountReadOnlyNear._config

_rpc

protected readonly _rpc: NearRpc | undefined

Defined in: wallet-near/src/read-only-account.ts:50

Inherited from

WalletAccountReadOnlyNear._rpc

address

readonly address: string

Defined in: wallet-near/src/read-only-account.ts:45

Account id: the implicit hex id of the key, or a named account bound to it.

Inherited from

WalletAccountReadOnlyNear.address

chain

readonly chain: string

Defined in: wallet-near/src/read-only-account.ts:46

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

Implementation of

IWalletAccount.chain

Inherited from

WalletAccountReadOnlyNear.chain

needsNetwork

readonly needsNetwork: true = true

Defined in: wallet-near/src/account.ts:35

nonce / block hash come from the node, so building needs the network.

Implementation of

IWalletAccount.needsNetwork

path

readonly path: string

Defined in: wallet-near/src/account.ts:37

Derivation path, or external for an external signer.

publicKey

readonly publicKey: NearPublicKey

Defined in: wallet-near/src/read-only-account.ts:47

Inherited from

WalletAccountReadOnlyNear.publicKey

signerKind

readonly signerKind: "seed" | "key" | "external"

Defined in: wallet-near/src/account.ts:45

What holds the key: seed, key (one imported key) or external.

Accessors

index

Get Signature

get index(): number | undefined

Defined in: wallet-near/src/account.ts:62

Account index for the standard m/44’/397’/i’ path.

Returns

number | undefined

publicKeyString

Get Signature

get publicKeyString(): string

Defined in: wallet-near/src/read-only-account.ts:71

“ed25519:”

Returns

string

Inherited from

WalletAccountReadOnlyNear.publicKeyString

Methods

accountExists()

accountExists(accountId): Promise<boolean>

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

True when the account exists on chain.

Parameters

accountId

string

Returns

Promise<boolean>

Inherited from

WalletAccountReadOnlyNear.accountExists

assertSafe()

assertSafe(tx, fee?): void

Defined in: wallet-near/src/read-only-account.ts:288

Refuse what cannot be right: a foreign signer or key, no actions, a dangerous action (unless allowDangerousActions), an invalid receiver, prepaid gas over 300 Tgas, a fee above transactionMaxFee.

Parameters

tx

NearBuiltTransaction

fee?

bigint

Returns

void

Inherited from

WalletAccountReadOnlyNear.assertSafe

buildTransaction()

buildTransaction(tx): Promise<NearBuiltTransaction>

Defined in: wallet-near/src/read-only-account.ts:166

Fill signerId / publicKey / nonce / blockHash (the last two from the node when missing).

Parameters

describeTransactionOnline()

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

Defined in: wallet-near/src/read-only-account.ts:310

describeTransaction plus the recipient-existence check against the node.

Parameters

tx

NearTransaction

ctx?

DescribeContext = {}

Returns

Promise<NearTxDescription>

Inherited from

WalletAccountReadOnlyNear.describeTransactionOnline

dispose()

dispose(): void

Defined in: wallet-near/src/account.ts:174

Dispose the signer (zeroizes a local key). Idempotent.

Returns

void

Implementation of

IWalletAccount.dispose

estimate()

protected estimate(tx, recipientExists?): Promise<NearFeeEstimate>

Defined in: wallet-near/src/read-only-account.ts:211

Parameters

tx

Pick<NearBuiltTransaction, "receiverId" | "actions">

recipientExists?

boolean

Returns

Promise<NearFeeEstimate>

Inherited from

WalletAccountReadOnlyNear.estimate

estimateFee()

estimateFee(tx): Promise<NearFeeEstimate>

Defined in: wallet-near/src/read-only-account.ts:222

Gas and cost of a transaction.

Parameters

tx

string | NearTransaction

Returns

Promise<NearFeeEstimate>

Inherited from

WalletAccountReadOnlyNear.estimateFee

getAccountView()

getAccountView(accountId?): Promise<NearAccountView | undefined>

Defined in: wallet-near/src/read-only-account.ts:82

The account as the node sees it; undefined when it does not exist yet.

Parameters

accountId?

string = ...

Returns

Promise<NearAccountView | undefined>

Inherited from

WalletAccountReadOnlyNear.getAccountView

getAddress()

getAddress(): Promise<string>

Defined in: wallet-near/src/read-only-account.ts:79

The account id.

Returns

Promise<string>

Implementation of

IWalletAccount.getAddress

Inherited from

WalletAccountReadOnlyNear.getAddress

getAvailableBalance()

getAvailableBalance(): Promise<bigint>

Defined in: wallet-near/src/read-only-account.ts:98

What can actually be spent: total − locked (staked) − storage reservation.

Returns

Promise<bigint>

Inherited from

WalletAccountReadOnlyNear.getAvailableBalance

getBalance()

getBalance(): Promise<bigint>

Defined in: wallet-near/src/read-only-account.ts:93

Total NEAR balance in yoctoNEAR (0 for an account that does not exist yet).

Returns

Promise<bigint>

Implementation of

IWalletAccount.getBalance

Inherited from

WalletAccountReadOnlyNear.getBalance

getStorageBalance()

getStorageBalance(token, accountId?): Promise<{ available: bigint; total: bigint; } | null>

Defined in: wallet-near/src/read-only-account.ts:121

NEP-145 storage registration of accountId on a token contract (null = not registered).

Parameters

token

string

accountId?

string = ...

Returns

Promise<{ available: bigint; total: bigint; } | null>

Inherited from

WalletAccountReadOnlyNear.getStorageBalance

getStorageDepositMin()

getStorageDepositMin(token): Promise<bigint>

Defined in: wallet-near/src/read-only-account.ts:127

Minimum deposit a token contract wants for a registration (storage_balance_bounds.min).

Parameters

token

string

Returns

Promise<bigint>

Inherited from

WalletAccountReadOnlyNear.getStorageDepositMin

getTokenBalance()

getTokenBalance(token): Promise<bigint>

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

NEP-141 ft_balance_of.

Parameters

token

string

Returns

Promise<bigint>

Implementation of

IWalletAccount.getTokenBalance

Inherited from

WalletAccountReadOnlyNear.getTokenBalance

getTokenBalances()

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

Defined in: wallet-near/src/read-only-account.ts:114

Several NEP-141 balances in parallel, keyed by the token contracts as given.

Parameters

tokens

string[]

Returns

Promise<Record<string, bigint>>

Inherited from

WalletAccountReadOnlyNear.getTokenBalances

getTransactionReceipt()

getTransactionReceipt(hash): Promise<NearReceipt | undefined>

Defined in: wallet-near/src/read-only-account.ts:317

Status of one of this account’s transactions (the tx RPC needs the sender).

Parameters

hash

string

Returns

Promise<NearReceipt | undefined>

Implementation of

IWalletAccount.getTransactionReceipt

Inherited from

WalletAccountReadOnlyNear.getTransactionReceipt

quoteSendTransaction()

quoteSendTransaction(tx): Promise<NearQuote>

Defined in: wallet-near/src/read-only-account.ts:227

Fee of a transaction in yoctoNEAR.

Parameters

tx

string | NearTransaction

Returns

Promise<NearQuote>

Implementation of

IWalletAccount.quoteSendTransaction

Inherited from

WalletAccountReadOnlyNear.quoteSendTransaction

quoteTransfer()

quoteTransfer(o): Promise<NearQuote>

Defined in: wallet-near/src/read-only-account.ts:233

Fee of a transfer in yoctoNEAR, for the same actions transfer would send.

Parameters

o

NearTransferOptions

Returns

Promise<NearQuote>

Implementation of

IWalletAccount.quoteTransfer

Inherited from

WalletAccountReadOnlyNear.quoteTransfer

requireRpc()

protected requireRpc(what): NearRpc

Defined in: wallet-near/src/read-only-account.ts:73

Parameters

what

string

Returns

NearRpc

Inherited from

WalletAccountReadOnlyNear.requireRpc

sendTransaction()

sendTransaction(tx, options?): Promise<NearTransferResult>

Defined in: wallet-near/src/account.ts:150

Sign and broadcast. Accepts a transaction, or base64 borsh of an unsigned / already-signed transaction (a signed one is checked, not re-signed).

Parameters

tx

string | NearTransaction

options?

WriteOptions = {}

Returns

Promise<NearTransferResult>

Implementation of

IWalletAccount.sendTransaction

sign()

sign(message): Promise<string>

Defined in: wallet-near/src/account.ts:89

Raw ed25519 signature over the message bytes, as NEAR tooling prints it: “ed25519:”. A 32-byte message — string or bytes — is refused with MessageIsTransactionError: a NEAR transaction is signed over its 32-byte sha256, so those bytes could be one. Bytes that carry this account’s public key are refused as well: one ed25519 key (an external signer) may also be a Solana wallet, and a Solana transaction names its signer’s key. Sites asking a wallet to sign a message use signNep413.

Parameters

message

string | Uint8Array<ArrayBufferLike>

Returns

Promise<string>

Implementation of

IWalletAccount.sign

signBuilt()

signBuilt(tx): Promise<NearSignedTransaction>

Defined in: wallet-near/src/account.ts:102

Sign a fully built transaction. No checks — see signTransaction.

Parameters

tx

NearBuiltTransaction

Returns

Promise<NearSignedTransaction>

signNep413()

signNep413(payload): Promise<Nep413Signed>

Defined in: wallet-near/src/account.ts:96

NEP-413 off-chain message (what NEAR Intents and dApps ask wallets to sign).

Parameters

payload

Nep413Payload

Returns

Promise<Nep413Signed>

signTransaction()

signTransaction(tx, options?): Promise<string>

Defined in: wallet-near/src/account.ts:123

Build, check, preflight and sign; returns the signed transaction as base64 borsh (what send_tx takes).

Parameters

tx

string | NearTransaction

options?

WriteOptions = {}

Returns

Promise<string>

Implementation of

IWalletAccount.signTransaction

simulateTransaction()

simulateTransaction(tx, estimate?): Promise<NearSimulation>

Defined in: wallet-near/src/read-only-account.ts:245

Predict failure without signing: the signer account and its access key exist, the spendable balance covers deposits + fee, a named recipient exists (an implicit one may be created, for ≥ 0.002 NEAR), the token balance covers an ft_transfer. Transport failures throw; predicted failures don’t.

Parameters

tx

NearTransaction | NearBuiltTransaction

estimate?

NearFeeEstimate

Returns

Promise<NearSimulation>

Inherited from

WalletAccountReadOnlyNear.simulateTransaction

toReadOnlyAccount()

toReadOnlyAccount(): IWalletAccountReadOnly

Defined in: wallet-near/src/account.ts:168

The same account as a WalletAccountReadOnlyNear.

Returns

IWalletAccountReadOnly

Implementation of

IWalletAccount.toReadOnlyAccount

transfer()

transfer(o, writeOptions?): Promise<NearTransferResult>

Defined in: wallet-near/src/account.ts:160

Native NEAR (no token) or NEP-141 ft_transfer (with storage_deposit when the recipient needs it).

Parameters

o

NearTransferOptions

writeOptions?

WriteOptions = {}

Returns

Promise<NearTransferResult>

Implementation of

IWalletAccount.transfer

transferActions()

transferActions(o): Promise<{ actions: NearAction[]; receiverId: string; }>

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

The actions for transfer: native → one Transfer; NEP-141 → ft_transfer (1 yocto, 30 Tgas), preceded by storage_deposit when the recipient is not registered on the token.

Parameters

o

NearTransferOptions

Returns

Promise<{ actions: NearAction[]; receiverId: string; }>

Inherited from

WalletAccountReadOnlyNear.transferActions

verify()

verify(message, signature): Promise<boolean>

Defined in: wallet-near/src/read-only-account.ts:324

Verify an ed25519:<base58> (or bare base58 / hex) signature produced by sign.

Parameters

message

string | Uint8Array<ArrayBufferLike>

signature

string

Returns

Promise<boolean>

Implementation of

IWalletAccount.verify

Inherited from

WalletAccountReadOnlyNear.verify

withAccountId()

withAccountId(accountId): WalletAccountNear

Defined in: wallet-near/src/account.ts:68

The same key bound to a named account (alice.near) that lists it as a full-access key.

Parameters

accountId

string

Returns

WalletAccountNear

depositOf()

static depositOf(actions): bigint

Defined in: wallet-near/src/read-only-account.ts:201

Parameters

actions

NearAction[]

Returns

bigint

Inherited from

WalletAccountReadOnlyNear.depositOf

fromPrivateKey()

static fromPrivateKey(privateKey, publicKey, path, config?, accountId?): WalletAccountNear

Defined in: wallet-near/src/account.ts:57

Wrap a raw derived key (takes ownership; zeroized on dispose).

Parameters

privateKey

Uint8Array

publicKey

Uint8Array

path

string

config?

NearConfig = {}

accountId?

string

Returns

WalletAccountNear

gasOf()

static gasOf(actions, createsAccount): bigint

Defined in: wallet-near/src/read-only-account.ts:188

Gas upper bound for the actions (prepaid function-call gas in full).

Parameters

actions

NearAction[]

createsAccount

boolean

Returns

bigint

Inherited from

WalletAccountReadOnlyNear.gasOf

hashOf()

static hashOf(tx): Uint8Array

Defined in: wallet-near/src/read-only-account.ts:332

sha256(borsh(tx)) — what gets signed; base58 of it is the transaction hash.

Parameters

tx

NearBuiltTransaction

Returns

Uint8Array

Inherited from

WalletAccountReadOnlyNear.hashOf

txHash()

static txHash(tx): string

Defined in: wallet-near/src/read-only-account.ts:333

Parameters

tx

NearBuiltTransaction

Returns

string

Inherited from

WalletAccountReadOnlyNear.txHash