StellarWallet

You are viewing docs for the previous version of the Wallets SDK. We recommend upgrading to V1. See the updated version of this page or the V1 migration guide.

Defined in: packages/wallets/src/wallets/stellar.ts:15

Extends

• Wallet<StellarChain>

Constructors

new StellarWallet()

new StellarWallet(wallet): StellarWallet

Defined in: packages/wallets/src/wallets/stellar.ts:16

Parameters

Parameter	Type
wallet	Wallet<"stellar">

Returns

StellarWallet

Overrides

Wallet.constructor

Properties

Property	Type	Inherited from	Defined in
address	string	Wallet.address	packages/wallets/src/wallets/wallet.ts:62
alias?	string	Wallet.alias	packages/wallets/src/wallets/wallet.ts:64
chain	"stellar"	Wallet.chain	packages/wallets/src/wallets/wallet.ts:61
owner?	string	Wallet.owner	packages/wallets/src/wallets/wallet.ts:63
signer	Signer	Wallet.signer	packages/wallets/src/wallets/wallet.ts:65

Methods

addDelegatedSigner()

addDelegatedSigner<T>(params): Promise<T extends PrepareOnly<true> ? object : void>

Defined in: packages/wallets/src/wallets/wallet.ts:465

Add a delegated signer to the wallet

Type Parameters

Type Parameter	Default type
T extends AddDelegatedSignerOptions | undefined	undefined

Parameters

Parameter	Type
params	{ options: T; signer: string | { id: string; name: string; publicKey: { x: string; y: string; }; type: "passkey"; }; }
params.options?	T
params.signer	string | { id: string; name: string; publicKey: { x: string; y: string; }; type: "passkey"; }

Returns

Promise<T extends PrepareOnly<true> ? object : void>

Inherited from

Wallet.addDelegatedSigner

---

approve()

approve<T>(params): Promise<ApproveResult<T>>

Defined in: packages/wallets/src/wallets/wallet.ts:423

Approve a transaction or signature

Type Parameters

Type Parameter
T extends ApproveParams

Parameters

Parameter	Type	Description
params	T	The parameters

Returns

Promise<ApproveResult<T>>

The transaction or signature

Inherited from

Wallet.approve

---

approveTransaction()

approveTransaction(params): Promise<Error>

Defined in: packages/wallets/src/wallets/wallet.ts:399

Parameters

Parameter	Type	Description
params	ApproveParams	The parameters

Returns

Promise<Error>

The transaction

Deprecated

Use approve instead. Approve a transaction

Inherited from

Wallet.approveTransaction

---

balances()

balances(tokens?): Promise<Balances<"stellar">>

Defined in: packages/wallets/src/wallets/wallet.ts:118

Get the wallet balances - always includes USDC and native token (ETH/SOL)

Parameters

Parameter	Type	Description
tokens?	string[]	Additional tokens to request (optional: native token and usdc are always included)

Returns

Promise<Balances<"stellar">>

The balances returns nativeToken, usdc, tokens

Throws

If the balances cannot be retrieved

Inherited from

Wallet.balances

---

delegatedSigners()

delegatedSigners(): Promise<DelegatedSigner[]>

Defined in: packages/wallets/src/wallets/wallet.ts:554

List the delegated signers for this wallet.

Returns

Promise<DelegatedSigner[]>

The delegated signers

Inherited from

Wallet.delegatedSigners

---

experimental_activity()

experimental_activity(): Promise<WalletsV1Alpha2ActivityResponseDto>

Defined in: packages/wallets/src/wallets/wallet.ts:312

Experimental

Get the wallet activity

Returns

Promise<WalletsV1Alpha2ActivityResponseDto>

The activity This API is experimental and may change in the future

Throws

If the activity cannot be retrieved

Inherited from

Wallet.experimental_activity

---

experimental_apiClient()

experimental_apiClient(): WalletsApiClient

Defined in: packages/wallets/src/wallets/wallet.ts:101

Experimental

Get the API client

Returns

WalletsApiClient

The API client This API is experimental and may change in the future

Inherited from

Wallet.experimental_apiClient

---

experimental_nfts()

experimental_nfts(params): Promise<WalletNftsResponseDto>

Defined in: packages/wallets/src/wallets/wallet.ts:272

Experimental

Get the wallet NFTs

Parameters

Parameter	Type	Description
params	{ page: number; perPage: number; }	The parameters
params.page	number	The page number
params.perPage	number	The number of NFTs per page

Returns

Promise<WalletNftsResponseDto>

The NFTs This API is experimental and may change in the future

Inherited from

Wallet.experimental_nfts

---

experimental_transaction()

experimental_transaction(transactionId): Promise<WalletsTransactionV2025ResponseDto>

Defined in: packages/wallets/src/wallets/wallet.ts:298

Get a transaction by id

Parameters

Parameter	Type
transactionId	string

Returns

Promise<WalletsTransactionV2025ResponseDto>

The transaction

Throws

If the transaction cannot be retrieved

Inherited from

Wallet.experimental_transaction

---

experimental_transactions()

experimental_transactions(): Promise<GetTransactionsResponse>

Defined in: packages/wallets/src/wallets/wallet.ts:285

Get the wallet transactions

Returns

Promise<GetTransactionsResponse>

The transactions

Throws

If the transactions cannot be retrieved

Inherited from

Wallet.experimental_transactions

---

send()

send<T>(to, token, amount, options?): Promise<Transaction<T extends PrepareOnly<true> ? true : false>>

Defined in: packages/wallets/src/wallets/wallet.ts:335

Send a token to a wallet or user locator

Type Parameters

Type Parameter	Default type
T extends SendTokenTransactionOptions | undefined	undefined

Parameters

Parameter	Type	Description
to	string | UserLocator	The recipient (address or user locator)
token	string	The token (address or currency symbol)
amount	string	The amount to send (decimal units)
options?	T	The options for the transaction

Returns

Promise<Transaction<T extends PrepareOnly<true> ? true : false>>

The transaction

Inherited from

Wallet.send

---

sendTransaction()

sendTransaction<T>(params): Promise<Transaction<T extends PrepareOnly<true> ? true : false>>

Defined in: packages/wallets/src/wallets/stellar.ts:50

Send a raw Stellar transaction (serialized transaction or contract call).

Type Parameters

Type Parameter	Default type
T extends TransactionInputOptions | undefined	undefined

Parameters

Parameter	Type	Description
params	StellarTransactionInput & object	The transaction parameters

Returns

Promise<Transaction<T extends PrepareOnly<true> ? true : false>>

The transaction result

---

stagingFund()

stagingFund(amount, chain?): Promise<FundWalletResponse>

Defined in: packages/wallets/src/wallets/wallet.ts:166

Funds the wallet with Crossmint’s stablecoin (USDXM).

Note: This method is only available in staging environments and exclusively supports USDXM tokens. It cannot be used in production environments.

Parameters

Parameter	Type	Description
amount	number	The amount of USDXM to fund the wallet with
chain?	Chain	Optional chain to fund on. If not provided, uses the wallet’s default chain

Returns

Promise<FundWalletResponse>

The funding response

Throws

If the funding operation fails or if called in a production environment

Inherited from

Wallet.stagingFund

---

from()

static from(wallet): StellarWallet

Defined in: packages/wallets/src/wallets/stellar.ts:30

Parameters

Parameter	Type
wallet	Wallet<Chain>

Returns

StellarWallet