Skip to main content
The StellarWallet class extends the base Wallet class with Stellar-specific functionality for sending transactions and interacting with Stellar smart contracts.

​
Creating a Stellar Wallet

​
from()

Create a StellarWallet instance from a base Wallet. 
static from(wallet: Wallet<Chain>): StellarWallet
​
wallet
Wallet<Chain>
required
A wallet instance with a Stellar address
​
stellarWallet
StellarWallet
A StellarWallet instance with Stellar-specific methods

​
Example

import { StellarWallet } from "@crossmint/wallets";

const wallet = await wallets.getOrCreateWallet({
  chain: "stellar",
  signer: {
    type: "stellar-keypair",
    secretKey: "S..."
  }
});

const stellarWallet = StellarWallet.from(wallet);

​
Transaction Methods

​
sendTransaction()

Send a raw Stellar transaction. Supports two formats: serialized transaction or contract call. 
public async sendTransaction<T extends TransactionInputOptions | undefined = undefined>(
  params: StellarTransactionInput & { options?: T }
): Promise<Transaction<T extends PrepareOnly<true> ? true : false>>
​
params
StellarTransactionInput
required
Transaction parameters (multiple formats supported)
​
transaction
Transaction
The transaction result

​
Examples

// Example 1: Call a contract method
const result = await stellarWallet.sendTransaction({
  contractId: "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABSC4",
  method: "transfer",
  args: {
    to: "GCEXAMPLE...",
    amount: 1000000 // Amount in stroops (1 XLM = 10,000,000 stroops)
  }
});

console.log("Transaction hash:", result.hash);
console.log("Explorer:", result.explorerLink);

// Example 2: Call with memo
const result2 = await stellarWallet.sendTransaction({
  contractId: "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABSC4",
  method: "mint",
  memo: "Minting NFT #123",
  args: {
    recipient: "GCEXAMPLE...",
    tokenId: 123
  }
});

// Example 3: Send pre-serialized transaction
const result3 = await stellarWallet.sendTransaction({
  transaction: "AAAAAgAAAAD...", // Base64 serialized transaction
  contractId: "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABSC4"
});

// Example 4: Prepare only (don't auto-approve)
const result4 = await stellarWallet.sendTransaction({
  contractId: "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABSC4",
  method: "transfer",
  args: {
    to: "GCEXAMPLE...",
    amount: 1000000
  },
  options: { experimental_prepareOnly: true }
});

console.log("Transaction ID:", result4.transactionId);
// Later: await stellarWallet.approve({ transactionId: result4.transactionId });

​
Working with Stellar Contracts

​
Calling Contract Methods

You can interact with Stellar smart contracts by specifying the contract ID, method name, and arguments. 
// Example: Token transfer
const tokenTransfer = await stellarWallet.sendTransaction({
  contractId: "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABSC4",
  method: "transfer",
  args: {
    from: stellarWallet.address,
    to: "GCEXAMPLE5IVGI4XQCZCMWPZ3YLO5HI7D4ZFHQB7JV4S3H7UXJFL6NQC",
    amount: 10000000 // 1 token (assuming 7 decimals)
  }
});

// Example: NFT minting
const nftMint = await stellarWallet.sendTransaction({
  contractId: "CNFT...",
  method: "mint",
  memo: "NFT Collection #1",
  args: {
    to: stellarWallet.address,
    tokenId: 1,
    metadata: {
      name: "My NFT",
      description: "A unique digital asset",
      image: "https://example.com/nft/1.png"
    }
  }
});

// Example: Query contract state (read-only)
const balance = await stellarWallet.sendTransaction({
  contractId: "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABSC4",
  method: "balance",
  args: {
    account: stellarWallet.address
  }
});

​
Contract Argument Types

When calling contract methods, arguments should match the expected types: 
// Common argument types
const exampleArgs = {
  // Addresses
  address: "GCEXAMPLE...",
  
  // Numbers (use strings for large numbers to avoid precision loss)
  amount: 1000000,
  bigAmount: "1000000000000",
  
  // Strings
  message: "Hello, Stellar!",
  
  // Booleans
  enabled: true,
  
  // Objects
  metadata: {
    key: "value",
    nested: {
      data: 123
    }
  },
  
  // Arrays
  recipients: [
    "GCEXAMPLE1...",
    "GCEXAMPLE2..."
  ]
};

await stellarWallet.sendTransaction({
  contractId: "CONTRACT_ID",
  method: "batchTransfer",
  args: exampleArgs
});

​
Inherited Methods

StellarWallet inherits all methods from the base Wallet class:
  • balances() - Get token balances (XLM, USDC, and other tokens)
  • send() - Send tokens (simplified high-level API)
  • approve() - Approve transactions
  • addDelegatedSigner() - Add delegated signers
  • delegatedSigners() - List delegated signers
  • stagingFund() - Fund wallet (staging only)
  • All experimental methods

​
Using High-Level send() Method

For simple token transfers, you can use the inherited send() method: 
// Send XLM
const tx = await stellarWallet.send(
  "GCEXAMPLE5IVGI4XQCZCMWPZ3YLO5HI7D4ZFHQB7JV4S3H7UXJFL6NQC",
  "xlm", // Token symbol
  "10.5" // Amount in XLM
);

// Send USDC
const tx2 = await stellarWallet.send(
  "GCEXAMPLE5IVGI4XQCZCMWPZ3YLO5HI7D4ZFHQB7JV4S3H7UXJFL6NQC",
  "usdc",
  "50.00" // Amount in USDC
);

// Send to email
const tx3 = await stellarWallet.send(
  { email: "[email protected]" },
  "xlm",
  "5.0"
);

​
Stellar-Specific Considerations

​
Memo Fields

Stellar supports transaction memos for attaching messages or identifiers: 
const txWithMemo = await stellarWallet.sendTransaction({
  contractId: "CONTRACT_ID",
  method: "transfer",
  memo: "Payment for invoice #12345",
  args: {
    to: "GCEXAMPLE...",
    amount: 1000000
  }
});

​
Stroops and Decimals

Stellar uses stroops as the smallest unit (1 XLM = 10,000,000 stroops). When working with raw amounts: 
const ONE_XLM = 10_000_000; // stroops

await stellarWallet.sendTransaction({
  contractId: "CONTRACT_ID",
  method: "transfer",
  args: {
    to: "GCEXAMPLE...",
    amount: 0.5 * ONE_XLM // 0.5 XLM
  }
});

Build docs developers (and LLMs) love

Get started for freeTalk to us