WalletAccountSolana

Defined in: wallet-solana/src/account.ts:34

Signing Solana account. The account never touches a private key: every signature is one signer.sign(bytes, {scheme: 'ed25519', context}) call over the compiled message bytes — a LocalSigner for seed wallets, anything else (hardware, MPC, backend) through externalSigner(). No WebCrypto anywhere, so it runs unchanged in Node and Hermes.

Every broadcast goes through the same plan: hard checks (fee payer, burn address, missing co-signers) → compute budget → simulation → fee guard → sign → send. A failing step throws before the signer is asked for anything.

Extends

• WalletAccountReadOnlySolana

Implements

• IWalletAccount

Constructors

Constructor

new WalletAccountSolana(signer, publicKey, path, config?): WalletAccountSolana

Defined in: wallet-solana/src/account.ts:51

Parameters

signer

Signer

publicKey

Uint8Array

path

string

config?

SolanaConfig = {}

Returns

WalletAccountSolana

Overrides

WalletAccountReadOnlySolana.constructor

Properties

_commitment

protected readonly _commitment: Commitment

Defined in: wallet-solana/src/read-only-account.ts:146

Inherited from

WalletAccountReadOnlySolana._commitment

---

_config

protected readonly _config: SolanaConfig

Defined in: wallet-solana/src/read-only-account.ts:144

Inherited from

WalletAccountReadOnlySolana._config

---

_rpc

protected readonly _rpc: Rpc<SolanaRpcApiForTestClusters> | undefined

Defined in: wallet-solana/src/read-only-account.ts:145

Inherited from

WalletAccountReadOnlySolana._rpc

---

address

readonly address: Address

Defined in: wallet-solana/src/read-only-account.ts:141

Base58 address.

Inherited from

WalletAccountReadOnlySolana.address

---

chain

readonly chain: string

Defined in: wallet-solana/src/read-only-account.ts:143

CAIP-2 id of the cluster.

Implementation of

IWalletAccount.chain

Inherited from

WalletAccountReadOnlySolana.chain

---

needsNetwork

readonly needsNetwork: true = true

Defined in: wallet-solana/src/account.ts:36

Blockhash and fee come from the network before signing.

Implementation of

IWalletAccount.needsNetwork

---

path

readonly path: string

Defined in: wallet-solana/src/account.ts:38

Derivation path, or external for an external signer.

---

publicKey

readonly publicKey: Uint8Array

Defined in: wallet-solana/src/account.ts:40

The signer’s 32-byte ed25519 public key (needed synchronously for the address).

---

signerKind

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

Defined in: wallet-solana/src/account.ts:48

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

Accessors

index

Get Signature

get index(): number | undefined

Defined in: wallet-solana/src/account.ts:65

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

Returns

number | undefined

Methods

assertWalletRecipient()

protected assertWalletRecipient(recipient): Promise<void>

Defined in: wallet-solana/src/read-only-account.ts:337

A transfer’s recipient must be a wallet (round 3, M10). A token account or a mint as recipient gets an associated token account nobody can sign for, and SOL or tokens sent to a program are lost: an account owned by Token / Token-2022, or an executable one, is refused. An address with no account yet is an ordinary wallet.

Parameters

recipient

string

Returns

Promise<void>

Inherited from

WalletAccountReadOnlySolana.assertWalletRecipient

---

ata()

protected ata(mint, owner, tokenProgram?): Promise<Address>

Defined in: wallet-solana/src/read-only-account.ts:262

Parameters

mint

Address

owner

Address

tokenProgram?

Address = TOKEN_PROGRAM_ADDRESS

Returns

Promise<Address>

Inherited from

WalletAccountReadOnlySolana.ata

---

buildNativeTransfer()

protected buildNativeTransfer(to, value): Promise<TransactionMessage>

Defined in: wallet-solana/src/read-only-account.ts:326

Parameters

to

string

value

string | number | bigint

Returns

Promise<TransactionMessage>

Inherited from

WalletAccountReadOnlySolana.buildNativeTransfer

---

buildTokenTransfer()

protected buildTokenTransfer(token, recipient, amount): Promise<{ message: TransactionMessage; tokenFee: bigint; }>

Defined in: wallet-solana/src/read-only-account.ts:348

SPL / Token-2022 transfer via transferChecked (mint + decimals verified on chain); the recipient ATA is created when missing.

Parameters

token

string

recipient

string

amount

string | number | bigint

Returns

Promise<{ message: TransactionMessage; tokenFee: bigint; }>

Inherited from

WalletAccountReadOnlySolana.buildTokenTransfer

---

checkSerialized()

checkSerialized(base64, guard, options?): Promise<SerializedCheck>

Defined in: wallet-solana/src/read-only-account.ts:793

Prove what a provider-built transaction does before anyone signs it (see serialized.ts). Throws UnsafeTransactionError (allowlist, authority changes, balance violations), MissingSignersError or SimulationError; returns the evidence otherwise. Nothing is signed.

Parameters

base64

string

guard

SerializedTxGuard

options?

PlanOptions = {}

Returns

Promise<SerializedCheck>

Inherited from

WalletAccountReadOnlySolana.checkSerialized

---

describeTransaction()

describeTransaction(tx): TransactionDescription

Defined in: wallet-solana/src/read-only-account.ts:998

Decode without the network: what the transaction does and what to be wary of.

Parameters

tx

SolanaTransaction

Returns

TransactionDescription

Inherited from

WalletAccountReadOnlySolana.describeTransaction

---

dispose()

dispose(): void

Defined in: wallet-solana/src/account.ts:187

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

Returns

void

Implementation of

IWalletAccount.dispose

---

enforce()

protected enforce(description, options?): void

Defined in: wallet-solana/src/read-only-account.ts:530

Hard checks shared by every signing path. options carries the per-call opt-ins (SolanaWriteOptions).

Parameters

description

TransactionDescription

options?

allowDurableNonce?

boolean

Returns

void

Inherited from

WalletAccountReadOnlySolana.enforce

---

enforceAuthorities()

protected enforceAuthorities(description): void

Defined in: wallet-solana/src/read-only-account.ts:552

The drainer shapes a wallet never signs by default: this wallet’s account reassigned, allocated or created under a program; a nonce, token, metadata or group authority handed away; lamports moved out by an instruction the description does not show as a transfer (a token account closed, excess or wrapped lamports withdrawn, a nonce or seed account emptied) to anyone but this wallet; a token Batch (it can carry any of these); an undecodable System / Token instruction. Instructions whose accounts sit in unresolved lookup tables are judged by their identified name (this wallet, a signer, is always a static key). A program this wallet signs for can still do any of this by CPI; sendSerialized proves the outcome by simulation instead.

Parameters

description

TransactionDescription

Returns

void

Inherited from

WalletAccountReadOnlySolana.enforceAuthorities

---

enforceCompiledSigners()

protected enforceCompiledSigners(description, options?): void

Defined in: wallet-solana/src/read-only-account.ts:709

Signer checks shared by every compiled-transaction path: this wallet must be a required signer and nobody else may still be missing.

Parameters

description

TransactionDescription

options?

PlanOptions = {}

Returns

void

Inherited from

WalletAccountReadOnlySolana.enforceCompiledSigners

---

feeForBase64()

protected feeForBase64(messageBase64): Promise<bigint>

Defined in: wallet-solana/src/read-only-account.ts:981

Parameters

messageBase64

string

Returns

Promise<bigint>

Inherited from

WalletAccountReadOnlySolana.feeForBase64

---

feeForMessage()

protected feeForMessage(msg): Promise<bigint>

Defined in: wallet-solana/src/read-only-account.ts:976

Parameters

msg

TransactionMessage

Returns

Promise<bigint>

Inherited from

WalletAccountReadOnlySolana.feeForMessage

---

getAccountInfos()

getAccountInfos(addresses): Promise<(SolanaAccountData | null)[]>

Defined in: wallet-solana/src/read-only-account.ts:767

Raw accounts in the order asked (null where none exists), batched 100 per getMultipleAccounts: for modules that check a provider’s figures against the chain state they claim to describe.

Parameters

addresses

readonly string[]

Returns

Promise<(SolanaAccountData | null)[]>

Inherited from

WalletAccountReadOnlySolana.getAccountInfos

---

getAddress()

getAddress(): Promise<string>

Defined in: wallet-solana/src/read-only-account.ts:163

The base58 address.

Returns

Promise<string>

Implementation of

IWalletAccount.getAddress

Inherited from

WalletAccountReadOnlySolana.getAddress

---

getBalance()

getBalance(): Promise<bigint>

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

Native balance in lamports.

Returns

Promise<bigint>

Implementation of

IWalletAccount.getBalance

Inherited from

WalletAccountReadOnlySolana.getBalance

---

getMintInfo()

getMintInfo(mint): Promise<MintInfo>

Defined in: wallet-solana/src/read-only-account.ts:174

Mint owner program, decimals and (Token-2022) the transfer fee in force this epoch.

Parameters

mint

string

Returns

Promise<MintInfo>

Inherited from

WalletAccountReadOnlySolana.getMintInfo

---

getTokenAccountOwner()

getTokenAccountOwner(tokenAccount): Promise<string | undefined>

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

The owner of a Token / Token-2022 token account — whom an SPL transfer into it pays — or undefined when the address holds no initialized token account (a wallet, a mint, nothing). Network errors throw. The kit’s policies read SPL transfer recipients through it.

Parameters

tokenAccount

string

Returns

Promise<string | undefined>

Inherited from

WalletAccountReadOnlySolana.getTokenAccountOwner

---

getTokenBalance()

getTokenBalance(token): Promise<bigint>

Defined in: wallet-solana/src/read-only-account.ts:272

Balance of a mint in this wallet’s associated token account (Token or Token-2022, whichever owns the mint), in base units; 0 when that account does not exist or the address is not a mint. A network error throws: it is never read as a zero balance (round 3, L10).

Parameters

token

string

Returns

Promise<bigint>

Implementation of

IWalletAccount.getTokenBalance

Inherited from

WalletAccountReadOnlySolana.getTokenBalance

---

getTokenBalances()

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

Defined in: wallet-solana/src/read-only-account.ts:287

Batched over getMultipleAccounts (100 addresses per call). Both programs’ associated token accounts are read for every mint, so Token-2022 balances count (round 3, L10); the amount comes from the token-account layout (offset 64) of the account that holds that mint.

Parameters

tokens

string[]

Returns

Promise<Record<string, bigint>>

Inherited from

WalletAccountReadOnlySolana.getTokenBalances

---

getTokenInfo()

getTokenInfo(token): Promise<TokenInfo>

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

Decimals, symbol, name, supply and the holder-relevant flags of a mint, read from the chain: a live mint or freeze authority, and the Token-2022 extensions that let someone take, tax, hook, freeze or pause holders’ tokens. Name and symbol come from the Token-2022 metadata extension, else from the Metaplex metadata account (“” when there is neither). Throws NotATokenError when the address is not an initialized Token / Token-2022 mint.

Parameters

token

string

Returns

Promise<TokenInfo>

Implementation of

IWalletAccount.getTokenInfo

Inherited from

WalletAccountReadOnlySolana.getTokenInfo

---

getTransactionReceipt()

getTransactionReceipt(hash): Promise<SolanaReceipt | undefined>

Defined in: wallet-solana/src/read-only-account.ts:1003

The receipt, or undefined while the transaction has not landed.

Parameters

hash

string

Returns

Promise<SolanaReceipt | undefined>

Implementation of

IWalletAccount.getTransactionReceipt

Inherited from

WalletAccountReadOnlySolana.getTransactionReceipt

---

latestBlockhash()

protected latestBlockhash(): Promise<Readonly<{ }>>

Defined in: wallet-solana/src/read-only-account.ts:311

Returns

Promise<Readonly<{ }>>

Inherited from

WalletAccountReadOnlySolana.latestBlockhash

---

lookupAddresses()

protected lookupAddresses(tables): Promise<Record<string, readonly string[]> | undefined>

Defined in: wallet-solana/src/read-only-account.ts:756

Addresses of a lookup-table set, fetched once; undefined when the message uses none.

Parameters

tables

readonly string[]

Returns

Promise<Record<string, readonly string[]> | undefined>

Inherited from

WalletAccountReadOnlySolana.lookupAddresses

---

plan()

protected plan(tx, opts?): Promise<SolanaPlan>

Defined in: wallet-solana/src/read-only-account.ts:960

Plan any accepted input.

Parameters

tx

SolanaTransaction

opts?

PlanOptions = {}

Returns

Promise<SolanaPlan>

Inherited from

WalletAccountReadOnlySolana.plan

---

planCompiled()

protected planCompiled(input, opts?): Promise<SolanaPlan>

Defined in: wallet-solana/src/read-only-account.ts:717

Plan a compiled transaction (kit Transaction or base64 wire): hard checks, simulation, fee quote. The bytes are never altered.

Parameters

input

string | Readonly<{ }>

opts?

PlanOptions = {}

Returns

Promise<SolanaPlan>

Inherited from

WalletAccountReadOnlySolana.planCompiled

---

planMessage()

protected planMessage(input, opts?): Promise<SolanaPlan>

Defined in: wallet-solana/src/read-only-account.ts:664

Plan a message-based transaction: lookup tables, compute budget (priority price + unit limit), simulation and the fee quote. Shared by quote / sign / send so the network is consulted once per fact.

Parameters

input

TransactionMessage

opts?

PlanOptions & object = {}

Returns

Promise<SolanaPlan>

Inherited from

WalletAccountReadOnlySolana.planMessage

---

planTransfer()

protected planTransfer(o, opts?): Promise<SolanaPlan>

Defined in: wallet-solana/src/read-only-account.ts:965

Parameters

o

SolanaTransferOptions

opts?

PlanOptions = {}

Returns

Promise<SolanaPlan>

Inherited from

WalletAccountReadOnlySolana.planTransfer

---

prepareMessage()

protected prepareMessage(tx): Promise<TransactionMessage>

Defined in: wallet-solana/src/read-only-account.ts:372

Normalise {to, value} or a kit message into a message with lifetime + this account as fee payer.

Parameters

tx

SolanaTransaction

Returns

Promise<TransactionMessage>

Inherited from

WalletAccountReadOnlySolana.prepareMessage

---

quoteCompiled()

protected quoteCompiled(transaction, description): Promise<SolanaFeeQuote>

Defined in: wallet-solana/src/read-only-account.ts:736

Fee of a compiled transaction: signatures + the compute budget it carries, floored by the RPC’s own quote.

Parameters

transaction

Transaction

description

TransactionDescription

Returns

Promise<SolanaFeeQuote>

Inherited from

WalletAccountReadOnlySolana.quoteCompiled

---

quoteSendTransaction()

quoteSendTransaction(tx): Promise<SolanaFeeQuote>

Defined in: wallet-solana/src/read-only-account.ts:988

Full fee breakdown (base + priority, Token-2022 fee for transfers). Simulation runs too, so a reverting tx is reported here.

Parameters

tx

SolanaTransaction

Returns

Promise<SolanaFeeQuote>

Implementation of

IWalletAccount.quoteSendTransaction

Inherited from

WalletAccountReadOnlySolana.quoteSendTransaction

---

quoteTransfer()

quoteTransfer(o): Promise<SolanaFeeQuote>

Defined in: wallet-solana/src/read-only-account.ts:993

Fee breakdown of a transfer, including the compute budget and any Token-2022 transfer fee.

Parameters

o

SolanaTransferOptions

Returns

Promise<SolanaFeeQuote>

Implementation of

IWalletAccount.quoteTransfer

Inherited from

WalletAccountReadOnlySolana.quoteTransfer

---

requireRpc()

protected requireRpc(what): SolanaRpc

Defined in: wallet-solana/src/read-only-account.ts:157

Parameters

what

string

Returns

SolanaRpc

Inherited from

WalletAccountReadOnlySolana.requireRpc

---

sendSerialized()

sendSerialized(base64, guard, options?): Promise<SolanaSendResult & object>

Defined in: wallet-solana/src/account.ts:171

Sign and broadcast a provider-built transaction (base64 wire) after checkSerialized proved it only does what guard.expect allows. Signatures already present (other parties) are preserved. The checked fee is held to the tighter of transactionMaxFee and options.maxFee.

Parameters

base64

string

guard

SerializedTxGuard

options?

SolanaWriteOptions = {}

Returns

Promise<SolanaSendResult & object>

---

sendTransaction()

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

Defined in: wallet-solana/src/account.ts:148

Sign and broadcast.

Parameters

tx

SolanaTransaction

options?

SolanaWriteOptions = {}

Returns

Promise<SolanaSendResult>

Implementation of

IWalletAccount.sendTransaction

---

sign()

sign(message): Promise<string>

Defined in: wallet-solana/src/account.ts:77

Hex ed25519 signature over the raw message bytes (UTF-8 for a string; context solana-offchain). Throws MessageIsTransactionError when the bytes are a Solana transaction this account would sign for (see isSolanaTransactionPayload): that must go through signTransaction. On an external signer (path ‘external’) a 32-byte message is refused too: the same ed25519 key may also be a TON or NEAR wallet, whose transactions are signed over a 32-byte digest.

Parameters

message

string | Uint8Array<ArrayBufferLike>

Returns

Promise<string>

Implementation of

IWalletAccount.sign

---

signCompiled()

signCompiled(tx, options?): Promise<Readonly<{ }>>

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

Add this wallet’s signature to a compiled transaction (other signatures are preserved). Runs the same checks as every signing path (round 3): a drainer shape, a burn or a durable nonce is refused unless the config or options opt in. No simulation and no fee quote: it is a primitive.

Parameters

tx

Transaction

options?

SolanaWriteOptions = {}

Returns

Promise<Readonly<{ }>>

---

signTransaction()

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

Defined in: wallet-solana/src/account.ts:120

Sign without broadcasting. Returns the base64 wire transaction. Simulation still runs (a reverting tx is refused).

Parameters

tx

SolanaTransaction

options?

SolanaWriteOptions = {}

Returns

Promise<string>

Implementation of

IWalletAccount.signTransaction

---

signTransactionMessage()

signTransactionMessage(msg, options?): Promise<Readonly<{ }>>

Defined in: wallet-solana/src/account.ts:95

Compile and sign a message; returns the kit Transaction (for callers that want to inspect or co-sign). Checked like signCompiled.

Parameters

msg

TransactionMessage

options?

SolanaWriteOptions = {}

Returns

Promise<Readonly<{ }>>

---

simulateSerialized()

simulateSerialized(base64, guard): Promise<{ check: SerializedCheck; ok: true; } | { code?: string; ok: false; reason: string; }>

Defined in: wallet-solana/src/read-only-account.ts:949

checkSerialized without throwing for a refusal: the check or the reason.

Parameters

base64

string

guard

SerializedTxGuard

Returns

Promise<{ check: SerializedCheck; ok: true; } | { code?: string; ok: false; reason: string; }>

Inherited from

WalletAccountReadOnlySolana.simulateSerialized

---

simulateTransaction()

simulateTransaction(tx): Promise<SimulationResult>

Defined in: wallet-solana/src/read-only-account.ts:522

simulateTransaction for any accepted input; never throws for an on-chain failure, only for transport errors.

Parameters

tx

SolanaTransaction

Returns

Promise<SimulationResult>

Inherited from

WalletAccountReadOnlySolana.simulateTransaction

---

toReadOnlyAccount()

toReadOnlyAccount(): IWalletAccountReadOnly

Defined in: wallet-solana/src/account.ts:181

The same address as a WalletAccountReadOnlySolana.

Returns

IWalletAccountReadOnly

Implementation of

IWalletAccount.toReadOnlyAccount

---

transfer()

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

Defined in: wallet-solana/src/account.ts:157

SOL (no token), SPL or Token-2022 transfer; the recipient’s ATA is created when missing.

Parameters

o

SolanaTransferOptions

writeOptions?

WriteOptions = {}

Returns

Promise<SolanaSendResult>

Implementation of

IWalletAccount.transfer

---

verify()

verify(message, signature): Promise<boolean>

Defined in: wallet-solana/src/read-only-account.ts:1012

ed25519 over the UTF-8 message; signature hex.

Parameters

message

string | Uint8Array<ArrayBufferLike>

signature

string

Returns

Promise<boolean>

Implementation of

IWalletAccount.verify

Inherited from

WalletAccountReadOnlySolana.verify

---

withLookupTables()

protected withLookupTables(msg, tables): Promise<TransactionMessage>

Defined in: wallet-solana/src/read-only-account.ts:389

Compress a v0 message with the given address lookup tables (fetched from the RPC).

Parameters

msg

TransactionMessage

tables

string[] | undefined

Returns

Promise<TransactionMessage>

Inherited from

WalletAccountReadOnlySolana.withLookupTables

---

fromPrivateKey()

static fromPrivateKey(privateKey, publicKey, path, config?): WalletAccountSolana

Defined in: wallet-solana/src/account.ts:60

Back-compat: wrap a raw derived key in a LocalSigner (the account takes ownership; it cannot derive).

Parameters

privateKey

Uint8Array

publicKey

Uint8Array

path

string

config?

SolanaConfig = {}

Returns

WalletAccountSolana

---

transferFeeFor()

static transferFeeFor(info, amount): bigint

Defined in: wallet-solana/src/read-only-account.ts:256

Token-2022 transfer fee for amount under info (0 for plain mints).

Parameters

info

MintInfo

amount

bigint

Returns

bigint

Inherited from

WalletAccountReadOnlySolana.transferFeeFor