API Reference

Imports

import WalletManagerSolanaGasless from '@tetherto/wdk-wallet-solana-gasless'

import {
  WalletAccountReadOnlySolanaGasless,
  WalletAccountSolanaGasless
} from '@tetherto/wdk-wallet-solana-gasless'

Exports

WalletManagerSolanaGasless

Derives and returns owned Solana gasless accounts from a BIP-39 seed phrase or seed bytes. Extends WalletManager from @tetherto/wdk-wallet.

Constructor

new WalletManagerSolanaGasless(
  seed: string | Uint8Array,
  config?: SolanaGaslessWalletConfig
)

Parameters:

• seed: BIP-39 mnemonic seed phrase or seed bytes.
• config: Solana RPC and Kora-compatible paymaster configuration.

Methods

getAccount

getAccount(index?: number): Promise<WalletAccountSolanaGasless>

Returns the account for m/44'/501'/index'/0'. If index is omitted, the module uses 0.

const wallet = new WalletManagerSolanaGasless(seedPhrase, config)
const account = await wallet.getAccount(0)

getAccountByPath

getAccountByPath(path: string): Promise<WalletAccountSolanaGasless>

Returns the account at a specific Solana SLIP-0010 derivation path.

const account = await wallet.getAccountByPath("0'/0'/1'")

WalletAccountSolanaGasless

Owned Solana gasless account. Extends WalletAccountReadOnlySolanaGasless and implements IWalletAccount from @tetherto/wdk-wallet.

Constructor

new WalletAccountSolanaGasless(
  seed: string | Uint8Array,
  path: string,
  config: SolanaGaslessWalletConfig
)

Parameters:

• seed: BIP-39 mnemonic seed phrase or seed bytes.
• path: SLIP-0010 derivation path, for example "0'/0'/0'".
• config: Solana RPC and Kora-compatible paymaster configuration.

Properties

Methods

getAddress

getAddress(): Promise<string>

Returns the account's base58-encoded Solana address.

sign

sign(message: string): Promise<string>

Signs a message and returns its signature.

signTransaction

signTransaction(
  tx: SolanaTransaction,
  config?: SolanaGaslessWalletPaymasterConfigOverrides
): Promise<FullySignedTransaction>

Signs a paymaster-funded transaction without broadcasting it. The module adds paymaster payment instructions, signs with the account owner, asks the paymaster to sign, and returns the fully signed transaction.

The method throws when the quoted paymaster fee is greater than transactionMaxFee.

sendTransaction

sendTransaction(
  tx: SolanaTransaction,
  config?: SolanaGaslessWalletPaymasterConfigOverrides
): Promise<TransactionResult>

Sends a paymaster-funded native transfer or prebuilt transaction message.

const result = await account.sendTransaction({
  to: 'Recipient1111111111111111111111111111111',
  value: 1000000n
}, {
  transactionMaxFee: 500000n
})

console.log(result.hash)
console.log(result.fee)

The method throws when the quoted paymaster fee is greater than transactionMaxFee.

transfer

transfer(
  options: TransferOptions,
  config?: SolanaGaslessWalletPaymasterConfigOverrides
): Promise<TransferResult>

Transfers SPL tokens through the paymaster. Native SOL transfers are handled by sendTransaction() instead.

const result = await account.transfer({
  token: 'TokenMint111111111111111111111111111111111',
  recipient: 'Recipient1111111111111111111111111111111',
  amount: 1000000n
}, {
  transferMaxFee: 500000n
})

The method throws when the quoted paymaster fee is greater than transferMaxFee.

quoteSendTransaction

quoteSendTransaction(
  tx: SolanaTransaction,
  config?: SolanaGaslessWalletPaymasterConfigOverrides
): Promise<Omit<TransactionResult, 'hash'>>

Quotes the paymaster fee for sendTransaction() or signTransaction() inputs. Quote methods return estimates and do not enforce transactionMaxFee.

quoteTransfer

quoteTransfer(
  options: TransferOptions,
  config?: SolanaGaslessWalletPaymasterConfigOverrides
): Promise<Omit<TransferResult, 'hash'>>

Quotes the paymaster fee for transfer() inputs. Quote methods return estimates and do not enforce transferMaxFee.

getTransactionReceipt

getTransactionReceipt(hash: string): Promise<SolanaTransactionReceipt | null>

Returns the Solana transaction receipt for a submitted signature, or null if the transaction has not been included in a block yet.

toReadOnlyAccount

toReadOnlyAccount(): Promise<WalletAccountReadOnlySolanaGasless>

Returns a read-only account for the same address.

WalletAccountReadOnlySolanaGasless

Read-only Solana gasless account for an address. Extends WalletAccountReadOnly from @tetherto/wdk-wallet.

Constructor

new WalletAccountReadOnlySolanaGasless(
  addr: string,
  config: Omit<SolanaGaslessWalletConfig, 'transferMaxFee' | 'transactionMaxFee'>
)

Parameters:

• addr: Solana account address.
• config: Solana RPC and paymaster configuration. Read-only accounts do not accept transferMaxFee or transactionMaxFee.

Methods

Configuration Types

SolanaGaslessWalletConfig

type SolanaGaslessWalletConfig =
  SolanaWalletConfig & SolanaGaslessWalletPaymasterConfig

Combines the base Solana wallet configuration with the required paymaster configuration.

SolanaGaslessWalletPaymasterConfig

type SolanaGaslessWalletPaymasterConfig = {
  paymasterUrl: string | KoraClientOptions | (string | KoraClientOptions)[]
  paymasterAddress: string
  paymasterToken: PaymasterTokenConfig
}

PaymasterTokenConfig

type PaymasterTokenConfig = {
  address: string
}

SolanaGaslessWalletPaymasterConfigOverrides

type SolanaGaslessWalletPaymasterConfigOverrides = Partial<
  Pick<SolanaGaslessWalletPaymasterConfig, 'paymasterToken'> &
  Pick<SolanaWalletConfig, 'transferMaxFee' | 'transactionMaxFee'>
>

Pass overrides as the second argument to quote, sign, send, or transfer methods.

ConfigurationError

The beta.1 TypeScript declarations include ConfigurationError, and the runtime uses that error name for missing required paymaster fields. The beta.1 JavaScript root entrypoint does not re-export the class, so JavaScript code should not import ConfigurationError from @tetherto/wdk-wallet-solana-gasless.

class ConfigurationError extends Error {
  constructor(message: string)
}

Missing paymasterUrl, paymasterAddress, or paymasterToken throws an error named ConfigurationError. An empty paymasterUrl failover list throws a plain Error.

Next Steps

Need Help?