Skip to main content
Defined in: packages/wallets/src/wallets/stellar.ts:20

​
Extends

​
Constructors

​
new StellarWallet()

new StellarWallet(wallet): StellarWallet
Defined in: packages/wallets/src/wallets/stellar.ts:21

​
Parameters

​
Returns

StellarWallet

​
Overrides

Wallet.constructor

​
Properties

​
Accessors

​
apiClient

​
Get Signature

get apiClient(): WalletsApiClient
Defined in: packages/wallets/src/wallets/wallet.ts:296
Returns
WalletsApiClient

​
Inherited from

Wallet.apiClient

​
recovery

​
Get Signature

get recovery(): SignerConfigForChain<C>
Defined in: packages/wallets/src/wallets/wallet.ts:321 Experimental Get the primary recovery signer config. Use recoveryMethods for the full list on wallets created with several recovery signers.
Returns
SignerConfigForChain<C> The recovery signer config This API is experimental and may change in the future

​
Inherited from

Wallet.recovery

​
recoveryMethods

​
Get Signature

get recoveryMethods(): RecoverySignerConfigForChain<C>[]
Defined in: packages/wallets/src/wallets/wallet.ts:331 Experimental Get every recovery signer config of the wallet. Wallets on chains that support a single recovery signer always return one entry.
Returns
RecoverySignerConfigForChain<C>[] The recovery signer configs This API is experimental and may change in the future

​
Inherited from

Wallet.recoveryMethods

​
signer

​
Get Signature

get signer(): SignerAdapter<keyof SignResultMap> | undefined
Defined in: packages/wallets/src/wallets/wallet.ts:201
Returns
SignerAdapter<keyof SignResultMap> | undefined

​
Inherited from

Wallet.signer

​
Methods

​
addRecoveryMethod()

addRecoveryMethod<T>(recoveryMethod, options?): Promise<AddRecoveryMethodReturnType>
Defined in: packages/wallets/src/wallets/wallet.ts:860 Add a recovery method to the wallet. Supported on Solana and Stellar only. Always uses one of the existing recovery methods to approve the change, selected as in addSigner.

​
Type Parameters

​
Parameters

​
Returns

Promise<AddRecoveryMethodReturnType>

​
Inherited from

Wallet.addRecoveryMethod

​
addSigner()

addSigner<T>(signer, options?): Promise<T extends PrepareOnly<true> ? Signer & object : Signer>
Defined in: packages/wallets/src/wallets/wallet.ts:649 Add a signer to the wallet. Always uses a recovery method internally to approve the registration: the one selected via useRecoveryMethod, else the active signer when it is one of the recovery methods, else the wallet’s single recovery method. Wallets with several recovery methods must select one first; an operational signer cannot authorize this. If the signer being added is the current operational signer, it will be reassembled with the new locator. Otherwise, the original signer is restored after the operation.

​
Type Parameters

​
Parameters

​
Returns

Promise<T extends PrepareOnly<true> ? Signer & object : Signer>

​
Inherited from

Wallet.addSigner

​
approve()

approve<T>(params): Promise<ApproveResult<T>>
Defined in: packages/wallets/src/wallets/wallet.ts:599 Approve a transaction or signature

​
Type Parameters

​
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:575

​
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:348 Get the wallet balances - always includes USDC and native token (ETH/SOL)

​
Parameters

​
Returns

Promise<Balances<"stellar">> The balances returns nativeToken, usdc, tokens

​
Throws

If the balances cannot be retrieved

​
Inherited from

Wallet.balances

​
isSignerApproved()

isSignerApproved(signerLocator): Promise<boolean>
Defined in: packages/wallets/src/wallets/wallet.ts:1203 Check if a signer is approved and usable for the current wallet chain.

​
Parameters

​
Returns

Promise<boolean> true if the signer is approved for this chain, false if it is not approved or not registered

​
Throws

if the approval state could not be fetched

​
Inherited from

Wallet.isSignerApproved

​
migrate()

migrate<T>(options?): Promise<Transaction<T extends PrepareOnly<true> ? true : false>>
Defined in: packages/wallets/src/wallets/stellar.ts:168 Run only the migration phase of a Stellar wallet upgrade. Use this when the upgrade transaction has already confirmed on-chain (e.g. from a previous upgrade({ prepareOnly: true }) flow) and the wallet is in the locked state.

​
Type Parameters

​
Parameters

​
Returns

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

​
needsRecovery()

needsRecovery(): boolean
Defined in: packages/wallets/src/wallets/wallet.ts:1211 Whether the wallet needs recovery (signer registration) before the next transaction.

​
Returns

boolean true if recovery is needed

​
Inherited from

Wallet.needsRecovery

​
nfts()

nfts(params): Promise<unknown>
Defined in: packages/wallets/src/wallets/wallet.ts:417 Get the wallet NFTs

​
Parameters

​
Returns

Promise<unknown> The NFTs

​
Inherited from

Wallet.nfts

​
recover()

recover(): Promise<void>
Defined in: packages/wallets/src/wallets/wallet.ts:1227 Register a device signer with the wallet using the recovery signer. Generates a new device key and registers it on-chain. Returns early if the device signer’s locator is already approved on-chain.

​
Returns

Promise<void>

​
Inherited from

Wallet.recover

​
removeRecoveryMethod()

removeRecoveryMethod<T>(recoveryMethod, options?): Promise<RemoveRecoveryMethodReturnType>
Defined in: packages/wallets/src/wallets/wallet.ts:927 Remove a recovery method from the wallet. Supported on Solana and Stellar only. Always uses one of the remaining recovery methods to approve the change, selected as in addSigner.

​
Type Parameters

​
Parameters

​
Returns

Promise<RemoveRecoveryMethodReturnType>

​
Inherited from

Wallet.removeRecoveryMethod

​
removeSigner()

removeSigner<T>(signer, options?): Promise<RemoveSignerReturnType>
Defined in: packages/wallets/src/wallets/wallet.ts:810 Remove a signer from the wallet. Always uses a recovery method internally to approve the removal, selected as in addSigner.

​
Type Parameters

​
Parameters

​
Returns

Promise<RemoveSignerReturnType>

​
Inherited from

Wallet.removeSigner

​
send()

send<T>(to, token, amount, options?): Promise<Transaction<T extends PrepareOnly<true> ? true : false>>
Defined in: packages/wallets/src/wallets/wallet.ts:492 Send a token to a wallet or user locator

​
Type Parameters

​
Parameters

​
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:59 Send a raw Stellar transaction (serialized transaction or contract call).

​
Type Parameters

​
Parameters

​
Returns

Promise<Transaction<T extends PrepareOnly<true> ? true : false>> The transaction result

​
signerIsRegistered()

signerIsRegistered(signerLocator): Promise<boolean>
Defined in: packages/wallets/src/wallets/wallet.ts:1193 Check if a signer is registered in this wallet.

​
Parameters

​
Returns

Promise<boolean> true if the signer is registered

​
Inherited from

Wallet.signerIsRegistered

​
signers()

signers(): Promise<Signer[]>
Defined in: packages/wallets/src/wallets/wallet.ts:1244 List the signers for this wallet. Returns full signer objects with status. For EVM wallets, only signers with an approval (pending or completed) for the wallet’s chain are included.

​
Returns

Promise<Signer[]> The signers

​
Inherited from

Wallet.signers

​
stagingFund()

stagingFund(amount, chain?): Promise<FundWalletResponse>
Defined in: packages/wallets/src/wallets/wallet.ts:387 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

​
Returns

Promise<FundWalletResponse> The funding response

​
Throws

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

​
Inherited from

Wallet.stagingFund

​
transaction()

transaction(transactionId): Promise<WalletsTransactionV2025ResponseDtoClass>
Defined in: packages/wallets/src/wallets/wallet.ts:449 Get a transaction by id

​
Parameters

​
Returns

Promise<WalletsTransactionV2025ResponseDtoClass> The transaction

​
Throws

If the transaction cannot be retrieved

​
Inherited from

Wallet.transaction

​
transactions()

transactions(): Promise<GetTransactionsResponse>
Defined in: packages/wallets/src/wallets/wallet.ts:436 Get the wallet transactions

​
Returns

Promise<GetTransactionsResponse> The transactions

​
Throws

If the transactions cannot be retrieved

​
Inherited from

Wallet.transactions

​
transfers()

transfers(params): Promise<WalletsActivityResponseUnstableDto>
Defined in: packages/wallets/src/wallets/wallet.ts:464 Get the wallet transfers

​
Parameters

​
Returns

Promise<WalletsActivityResponseUnstableDto> The transfers

​
Throws

If the transfers cannot be retrieved

​
Inherited from

Wallet.transfers

​
upgrade()

upgrade<T>(options?): Promise<Transaction<T extends PrepareOnly<true> ? true : false>>
Defined in: packages/wallets/src/wallets/stellar.ts:116 Upgrade this Stellar smart wallet to the latest contract version. Stellar wallet upgrades are a two-phase on-chain process: first an upgrade-wallet transaction swaps the contract bytecode (leaving the wallet temporarily locked), then a migrate-wallet transaction transforms the signer storage layout and unlocks the wallet. This method orchestrates both phases. Idempotent: if the wallet is already locked from a previous upgrade attempt, the phase-1 call is skipped and only the migration is executed.

​
Type Parameters

​
Parameters

​
Returns

Promise<Transaction<T extends PrepareOnly<true> ? true : false>>
  • When prepareOnly is true and the wallet is not already locked: the prepared phase-1 upgrade-wallet transaction.
    • When prepareOnly is true and the wallet is already locked (idempotent path): the prepared phase-2 migrate-wallet transaction.
    • Otherwise: the confirmed migrate transaction result.

​
useRecoveryMethod()

useRecoveryMethod(recoveryMethod): Promise<void>
Defined in: packages/wallets/src/wallets/wallet.ts:1044 Experimental Select which of the wallet’s recovery methods authorizes admin operations (addSigner, removeSigner, addRecoveryMethod, removeRecoveryMethod). Unlike useSigner, this does not change the active signer used for transactions and signatures. The config must refer to one of recoveryMethods; pass the fuller form when the method needs it to operate (an onSign callback for external wallets, the secret for server signers).

​
Parameters

​
Returns

Promise<void>

​
Inherited from

Wallet.useRecoveryMethod

​
useSigner()

useSigner(signer): Promise<void>
Defined in: packages/wallets/src/wallets/wallet.ts:1000 Set the active signer for this wallet. Accepts a signer config object. The locator is inferred internally. Works for both registered signers and the recovery signer. For passkey signers: if no id is provided, the wallet will auto-select the passkey if exactly one passkey signer is registered. If multiple passkeys exist, an id must be specified. For device signers: if no device key is found locally, the signer will be created automatically during the next transaction (via recovery). For external-wallet signers: the config object must include an onSign callback (applies to both registered and recovery signers).

​
Parameters

​
Returns

Promise<void>

​
Inherited from

Wallet.useSigner

​
waitForInit()

waitForInit(): Promise<void>
Defined in: packages/wallets/src/wallets/wallet.ts:209 Wait for the wallet’s internal signer initialization to complete. After this resolves, needsRecovery() reflects the true state.

​
Returns

Promise<void>

​
Inherited from

Wallet.waitForInit

​
from()

static from(wallet): StellarWallet
Defined in: packages/wallets/src/wallets/stellar.ts:39

​
Parameters

​
Returns

StellarWallet