@stacks-wallet-kit/extension

A Chrome extension SDK for building Stacks blockchain applications with Google authentication and wallet management.

Purpose

This SDK enables seamless Web2 authentication for Chrome extensions and provides easy wallet backup to a safe place without requiring users to store or remember their mnemonic phrase. It simplifies blockchain operations by handling the complexity of parsing arguments and data, allowing developers to focus on building their applications rather than managing low-level blockchain interactions.

The extension SDK imports functionality from the @stacks-wallet-kit/core package, which is platform-agnostic and shared between this extension SDK and the mobile SDK, ensuring consistency across platforms.

Installation

npm install @stacks-wallet-kit/extension
# or
yarn add @stacks-wallet-kit/extension
# or
pnpm add @stacks-wallet-kit/extension

Note: This package works with npm, yarn, and pnpm. Choose the package manager that fits your project.

Quick Start

import { WebClient, NetworkType } from '@stacks-wallet-kit/extension'

const client = new WebClient(
  'your-google-client-id',
  'your-google-client-secret',
  'https://your-extension-id.chromiumapp.org/',
  NetworkType.Testnet
)

// IMPORTANT: Set encryption password FIRST before any operations
await client.setEncryptionPassword('your-encryption-password')

const wallet = await client.createWallet() // Optional passphrase

const accounts = await client.getWalletAccounts()
const account = accounts[0]

const balance = await client.getBalance(account)

⚠️ Important: Password Setup

You MUST call setEncryptionPassword() before performing any wallet operations. This is required because:

1. The StorageManager uses encryption to securely store wallet data in Chrome's storage
2. Without setting the password, the storage manager cannot encrypt or decrypt data
3. The same password you use for setEncryptionPassword() must be used when creating Google Drive backups

Password Flow

// 1. Set encryption password first (required before any operations)
await client.setEncryptionPassword('my-secure-password')

// 2. Now you can perform wallet operations
const wallet = await client.createWallet()

// 3. When backing up to Google Drive, use the SAME password
await client.backupWallet('my-secure-password') // Must match encryption password

Note: After a Chrome extension refresh, the password is not stored in memory. You must call setEncryptionPassword() again to decrypt and access stored data.

WebClient Configuration

Constructor Parameters

new WebClient(
  googleClientId: string,        // Required: Google OAuth client ID
  googleClientSecret: string,    // Required: Google OAuth client secret
  redirectUri: string,           // Required: OAuth redirect URI (e.g., 'https://your-extension-id.chromiumapp.org/')
  network: NetworkType,          // Required: Initial network (Mainnet, Testnet, or Devnet)
  configOptions?: {              // Optional: Configuration options
    scopes?: string[]            // Optional: Additional OAuth scopes
    storageManager?: IWebStorageManager  // Optional: Custom storage manager
    mainnetUrl?: string          // Optional: Custom mainnet API URL
    testnetUrl?: string          // Optional: Custom testnet API URL
    devnetUrl?: string           // Optional: Custom devnet API URL
  }
)

Default Configuration

Storage Manager:

• If not provided, WebClient automatically uses StorageManager which stores encrypted data in Chrome's chrome.storage.local API

OAuth Scopes:

• Default scope: https://www.googleapis.com/auth/drive.appdata (required for Google Drive backup)
• Additional scopes can be provided via the scopes parameter and will be merged with the default scope

Stacks API URLs:

• Mainnet: https://api.hiro.so/
• Testnet: https://api.testnet.hiro.so/
• Devnet: http://localhost:3999/

Internal Components

WebClient automatically initializes the following components:

• Authentication: AuthenticationManager with GoogleSigninClient
• Backup Manager: BackupManager with GoogleBackupClient
• Wallet Manager: WalletManager for wallet operations
• Encryption Manager: EncryptionManager for encryption/decryption
• Stacks Client: StacksClient with configured network and API URLs
• Stacking Client: StackingClient with configured network

API Reference

Password Management

setEncryptionPassword(password: string)

⚠️ REQUIRED: Set the encryption password for the storage manager. Must be called before any wallet operations.

await client.setEncryptionPassword('your-encryption-password')

Important Notes:

• This must be called before any operations that read or write to storage
• The password is used to encrypt/decrypt all stored wallet data
• After extension refresh, you must call this again to access stored data
• Use the same password when calling backupWallet()

Authentication

loginWithGoogle()

Sign in with Google and check if a wallet backup exists.

const result: { accessToken: string; hasBackup: boolean } =
  await client.loginWithGoogle()

signOut()

Sign out from Google authentication.

await client.signOut()

Wallet

createWallet(passphrase?: string)

Create a new wallet with a generated mnemonic.

const wallet: Wallet = await client.createWallet() // Optional passphrase

storeExistingWallet(mnemonic: string, passphrase?: string)

Store an existing wallet from a mnemonic phrase.

const mnemonic: string = 'abandon abandon abandon ...'
const wallet: Wallet = await client.storeExistingWallet(mnemonic) // Optional passphrase

getWalletAccounts()

Get all accounts in the wallet.

const accounts: WalletAccount[] = await client.getWalletAccounts()

createAccount()

Create a new account in the wallet.

const newAccount: WalletAccount = await client.createAccount()

Backup

backupWallet(password: string)

Backup the wallet to Google Drive. The password must match the encryption password set with setEncryptionPassword().

// First set encryption password
await client.setEncryptionPassword('my-password')

// Then backup using the SAME password
await client.backupWallet('my-password')

Throws InvalidPasswordError if the password doesn't match the encryption password.

retrieveWallet(password: string)

Retrieve a wallet from Google Drive backup.

const { wallet, mnemonic }: { wallet: Wallet; mnemonic: string } =
  await client.retrieveWallet('wallet-password')

deleteBackup(password: string)

Delete the wallet backup from Google Drive.

await client.deleteBackup('wallet-password')

deleteBackupWithoutPassword()

Delete the wallet backup without requiring a password.

await client.deleteBackupWithoutPassword()

Stacks

getBalance(account)

Get the STX balance for an account.

const accounts: WalletAccount[] = await client.getWalletAccounts()
const account: WalletAccount = accounts[0]
const balance: number = await client.getBalance(account) // Returns: number

sendStx(accountIndex, to, amount, network, memo?)

Send STX tokens to another address.

const txid: string = await client.sendStx(
  0, // account index
  'ST1AWHANXSGZ3SY8XQC2J7S18E22KJJW9B3JT2T54', // recipient
  0.002, // amount in STX
  NetworkType.Devnet, // network
  'Test memo' // optional memo
) // Returns: string

transferNFT(accountIndex, contractId, tokenId, to, network)

Transfer an NFT to another address. Designed for SIP-9 NFT trait compliant contracts.

const txid: string = await client.transferNFT(
  0, // account index
  'STJK0PY5JPPNR4PZWR7HVS7T92B1MKHQKBT5Q6MX.nft-test', // contract ID
  '2', // token ID
  'ST10WDE40SQ62CSWRE99NA0KWBZ74NNK4FNS9T19Q', // recipient
  NetworkType.Devnet // network
) // Returns: string

transferFT(accountIndex, contractId, amount, to, network)

Transfer fungible tokens to another address. Designed for SIP-10 FT trait compliant contracts.

const txid: string = await client.transferFT(
  0, // account index
  'STJK0PY5JPPNR4PZWR7HVS7T92B1MKHQKBT5Q6MX.ft-test', // contract ID
  100 * 1000000, // amount in micro-units (100 tokens with 6 decimals)
  'ST10WDE40SQ62CSWRE99NA0KWBZ74NNK4FNS9T19Q', // recipient
  NetworkType.Devnet // network
) // Returns: string

makeContractCall(contractAddress, functionName, functionArgs, postConditionMode?)

Make a contract call to any Stacks smart contract.

import {
  uintCV,
  standardPrincipalCV,
  PostConditionMode,
  ClarityValue,
} from '@stacks/transactions'

const contractAddress: string =
  'STJK0PY5JPPNR4PZWR7HVS7T92B1MKHQKBT5Q6MX.nft-test'
const functionName: string = 'transfer'
const functionArgs: ClarityValue[] = [
  uintCV('2'), // token-id
  standardPrincipalCV(senderAddress), // sender
  standardPrincipalCV(recipientAddress), // recipient
]

// With default post condition mode (PostConditionMode.Deny)
const txid: string = await client.makeContractCall(
  contractAddress,
  functionName,
  functionArgs
) // Returns: string

// With custom post condition mode
const txid2: string = await client.makeContractCall(
  contractAddress,
  functionName,
  functionArgs,
  PostConditionMode.Allow // Optional: defaults to PostConditionMode.Deny
) // Returns: string

Stacking

Solo Stacking

stackSTX(account, amount, lockPeriod, maxAmount, options?)

Stack STX to earn Bitcoin rewards.

Note: If options is not provided, the signature will be automatically generated by a backend service for mainnet and testnet networks.

const accounts: WalletAccount[] = await client.getWalletAccounts()
const account: WalletAccount = accounts[0]

// Basic usage (signature generated by backend)
const txid: string = await client.stackSTX(
  account,
  1000, // amount to stack in STX
  1, // lock period in cycles
  1000 // max amount in STX
) // Returns: string

// With custom signer options (skip backend signature generation)
const txid2: string = await client.stackSTX(account, 1000, 1, 1000, {
  signerSignature: '0x...', // Optional: custom signer signature
  signerKey: '0x...', // Optional: custom signer key
  authId: '123', // Optional: custom auth ID
}) // Returns: string

stackExtend(account, extendCount, maxAmount, options?)

Extend the stacking lock period.

Note: If options is not provided, the signature will be automatically generated by a backend service for mainnet and testnet networks.

const accounts: WalletAccount[] = await client.getWalletAccounts()
const account: WalletAccount = accounts[0]

// Basic usage (signature generated by backend)
const txid: string = await client.stackExtend(
  account,
  1, // extend by 1 cycle
  1000 // max amount in STX
) // Returns: string

// With custom signer options (skip backend signature generation)
const txid2: string = await client.stackExtend(account, 1, 1000, {
  signerSignature: '0x...', // Optional: custom signer signature
  signerKey: '0x...', // Optional: custom signer key
  authId: '123', // Optional: custom auth ID
}) // Returns: string

stackIncrease(account, increaseBy, maxAmount, currentLockPeriod, options?)

Increase the stacking amount.

Note: If options is not provided, the signature will be automatically generated by a backend service for mainnet and testnet networks.

const accounts: WalletAccount[] = await client.getWalletAccounts()
const account: WalletAccount = accounts[0]

// Basic usage (signature generated by backend)
const txid: string = await client.stackIncrease(
  account,
  500, // increase by 500 STX
  1500, // max amount in STX
  1 // current lock period
) // Returns: string

// With custom signer options (skip backend signature generation)
const txid2: string = await client.stackIncrease(account, 500, 1500, 1, {
  signerSignature: '0x...', // Optional: custom signer signature
  signerKey: '0x...', // Optional: custom signer key
  authId: '123', // Optional: custom auth ID
}) // Returns: string

Stacking with a Pool

delegateSTX(account, amount, poolAddress, untilBurnHeight)

Delegate STX to a stacking pool.

const accounts: WalletAccount[] = await client.getWalletAccounts()
const account: WalletAccount = accounts[0]

const txid: string = await client.delegateSTX(
  account,
  1000, // amount to delegate in STX
  'ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM', // pool address
  100000 // until burn height
) // Returns: string

revokeDelegation(account, poolAddress)

Revoke STX delegation from a stacking pool.

const accounts: WalletAccount[] = await client.getWalletAccounts()
const account: WalletAccount = accounts[0]

const txid: string = await client.revokeDelegation(
  account,
  'ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM' // pool address
) // Returns: string

Network

setNetwork(network: NetworkType)

Change the active network.

client.setNetwork(NetworkType.Mainnet)
client.setNetwork(NetworkType.Testnet)
client.setNetwork(NetworkType.Devnet)

Custom Storage Manager

You can provide a custom storage manager that implements IWebStorageManager from @stacks-wallet-kit/core:

import { IWebStorageManager } from '@stacks-wallet-kit/core'

class CustomStorageManager implements IWebStorageManager {
  async setPassword(password: string): Promise<void> {
    // Your implementation
  }

  async checkEncryptionPasswordMatches(password: string): Promise<boolean> {
    // Your implementation
  }

  // ... implement other IStorageManager methods
}

const customStorage = new CustomStorageManager()
const client = new WebClient(
  'client-id',
  'client-secret',
  'redirect-uri',
  NetworkType.Testnet,
  {
    storageManager: customStorage,
  }
)

Note: Your custom storage manager must implement IWebStorageManager which includes setPassword() and checkEncryptionPasswordMatches() methods for password management.

Prerequisites

• Node.js 22+
• Chrome extension development environment
• Google OAuth credentials (Client ID and Client Secret)
• Google Drive API access (for backup functionality)

Types

All types are exported from @stacks-wallet-kit/core. Common types include:

• Wallet - Wallet object containing mnemonic and accounts
• WalletAccount - Individual account in a wallet
• NetworkType - Network type enum (Mainnet, Testnet, Devnet)
• InvalidPasswordError - Error thrown when password validation fails
• PasswordNotSetError - Error thrown when password is not set

Error Handling

The SDK throws specific error types for different scenarios:

• InvalidPasswordError - Thrown when password doesn't match during backup or validation
• PasswordNotSetError - Thrown when trying to access storage without setting password first
• AuthError - Thrown during authentication failures
• WalletNotStoredError - Thrown when wallet operations are attempted without a stored wallet