@metamask/bitcoin-wallet-snap

Bitcoin Wallet Snap

Configuration

Rename .env.example to .env Configurations are setup though .env,

LOG_LEVEL=6
# Description: Environment variables for the Testnet endpoint of QuickNode
# Required: true
QUICKNODE_TESTNET_ENDPOINT=
# Description: Environment variables for the Mainnet endpoint of QuickNode
# Required: true
QUICKNODE_MAINNET_ENDPOINT=
# Description: Environment variables for the SimpleHash API key
# Required: true
SIMPLEHASH_API_KEY=

Rpcs:

API keyring_createAccount

example:

provider.request({
  method: 'wallet_invokeKeyring',
  params: {
    snapId,
    request: {
      method: 'keyring_createAccount',
      params: {
        scope: 'bip122:000000000933ea01ad0ee984209779ba', // the CAIP-2 chain ID of bitcoin
      },
    },
  },
});

API keyring_getAccountBalances

example:

provider.request({
  method: 'wallet_invokeKeyring',
  params: {
    snapId,
    request: {
      method: 'keyring_getAccountBalances',
      params: {
        account: 'dc06350a-82db-434b-b113-066135804f63', // the uuid account id of the current account
        id: 'da40b782-e054-4260-9a6a-c8717a022f92', // an random uuid for this request
        assets: ['bip122:000000000019d6689c085ae165831e93/slip44:0'], // Caip-2 BTC Asset
      },
    },
  },
});

API chain_getTransactionStatus

example:

provider.request({
  method: 'wallet_invokeSnap',
  params: {
    snapId,
    request: {
      method: 'chain_getTransactionStatus',
      params: {
        scope: 'bip122:000000000933ea01ad0ee984209779ba', // the CAIP-2 chain ID of bitcoin
        transactionId: '5639078d-742e-4901-8993-bc25a5ef6161', // the txn id of an bitcoin transaction
      },
    },
  },
});

API sendBitcoin

example:

provider.request({
  method: 'wallet_invokeKeyring',
  params: {
    snapId,
    request: {
      method: 'keyring_submitRequest',
      params: {
        account: 'dc06350a-82db-434b-b113-066135804f63', // the uuid account id of the current account
        id: 'da40b782-e054-4260-9a6a-c8717a022f92', // an random uuid for this request
        scope: 'bip122:000000000933ea01ad0ee984209779ba', // the CAIP-2 chain ID of bitcoin
        request: {
          method: 'sendBitcoin',
          params: {
            recipients: {
              ['tb1qlhkuysju47s642834n7f3tyk67mvnt2cfd9r7y']: '0.00000500',
            }, // the recipient struct to indicate how many BTC to be received for each recipient
            replaceable: true, // an flag to opt-in RBF
            dryrun: true, // an flag to enable similation of the transaction, without broadcast to network
          },
        },
      },
    },
  },
});

API estimateFee

example:

provider.request({
  method: 'wallet_invokeSnap',
  params: {
    snapId,
    request: {
      method: 'estimateFee',
      params: {
        account: '9506e13e-d343-406f-8408-fad033ab7c0d', // the uuid account id of the current account
        amount: '0.00001', // transaction amount in BTC
      },
    },
  },
});

API getMaxSpendableBalance

example:

provider.request({
  method: 'wallet_invokeSnap',
  params: {
    snapId,
    request: {
      method: 'getMaxSpendableBalance',
       params: {
          account: "9506e13e-d343-406f-8408-fad033ab7c0d", // the uuid account id of the current account
    },
  },
});