Sats Connect - Wallet API for Bitcoin & Stacks
  • Introduction
  • Wallet Providers
    • getInfo
    • getProviders & getProviderById
  • Connecting to the wallet
    • Connect to Xverse Wallet
    • Disconnect from Xverse Wallet
    • Connect to other wallets
      • Manage a user's default wallet
    • [Legacy ⚠️] getAccounts
  • Wallet Methods
    • request methods
    • wallet_getAccount
    • wallet_getNetwork
    • wallet_changeNetwork
    • Xverse Custom Methods
  • Xverse Wallet Permissions
  • Xverse Wallet events
  • BITCOIN METHODS
    • 🟠getAddresses
    • 🟠signMessage
    • 🟠signPsbt
    • 🟠sendTransfer
    • 🟠signMultipleTransactions
    • 🟠getBalance
    • 🎨createInscription
    • 🎨createRepeatInscriptions
    • 🎨ord_getInscriptions
    • 🎨ord_sendInscriptions
    • 🔲runes_getBalance
    • 🔲runes_transfer
    • 🔲Mint Runes
      • runes_estimateMint
      • runes_mint
    • 🔲Etch Runes
      • runes_estimateEtch
      • runes_etch
    • 🔲runes_getOrder
    • 🔲Speed up a Rune Mint or Etch order
      • 🔲runes_estimateRbfOrder
      • 🔲runes_rbfOrder
  • STACKS METHODS
    • 🔴stx_getAccounts
    • 🔴stx_signMessage
    • 🔴stx_signStructuredMessage
    • 🔴stx_transferStx
    • 🔴stx_signTransaction
    • 🔴stx_callContract
    • 🔴stx_deployContract
  • GUIDES
    • Verify Bitcoin message signatures
    • Creating Bitcoin PSBTs
    • 📱Mobile Integration
    • Next.js support
  • RESOURCES
    • App Template
    • Demo App
    • Changelog
    • Github Issues
    • Developer forum
    • BIP322
Powered by GitBook
On this page
  • Available methods
  • Request parameters
  • Response format & error handling
  1. Wallet Methods

request methods

PreviousWallet MethodsNextwallet_getAccount

Last updated 2 months ago

You can use request to connect to users' wallets, prompt users to share their Bitcoin & Stacks wallet addresses, and sign messages and transactions with their Bitcoin & Stacks addresses.

The request method is available as Wallet.request from sats-connect if you'd like users to , or as a named export from @sats-connect/core if you only need Xverse Wallet support.

Available methods

request gives you access to a set of methods which follow the standard. All available Bitcoin & Stacks methods are detailed in the present documentation:

Connect, fetch accounts & manage permissions

Bitcoin Methods

Stacks Methods

Request parameters

Request parameters
Description

method

a string representing the RPC method to call

params

the params required by the RPC method

providerId (optional)

wallet provider id to use for the request

Response format & error handling

Depending on the status property the response will contain either a result or error object.

Property
Description

status

success | error

result (optional)

an object containing the result of the RPC request

error (optional)

an object containing the error of the RPC request

Error handling for these methods follows the JSON-RPC 2.0 protocol format:

Property
Description

code

RpcErrorCode

message

error message

data

any

Error codes

enum RpcErrorCode {
  PARSE_ERROR = -32700, // Parse error	Invalid JSON
  INVALID_REQUEST = -32600, // The JSON sent is not a valid Request object.
  METHOD_NOT_FOUND = -32601, // The method does not exist/is not available.
  INVALID_PARAMS = -32602, // Invalid method parameter(s)
  INTERNAL_ERROR = -32603, // Internal JSON-RPC error
  USER_REJECTION = -32000, // user rejected/canceled the request
  METHOD_NOT_SUPPORTED = -32001, // method is not supported for the address provided
}

[Legacy ]

&

&

connect to any wallet
JSON RPC 2.0
WBIP001
wallet_connect
wallet_disconnect
getAccount
wallet_requestPermissions
wallet_getCurrentPermissions
wallet_renouncePermissions
wallet_getNetwork
wallet_changeNetwork
⚠️
getAccounts
getAddresses
getBalance
signMessage
signPsbt
sendTransfer
ord_getInscriptions
ord_sendInscriptions
runes_getBalance
runes_transfer
Runes Minting methods
Runes Etching methods
stx_getAccounts
stx_signMessage
stx_signStructuredMessage
stx_signMessage
stx_transferStx
stx_signTransaction
stx_callContract
stx_deployContract