SafePal Docs

# Bitcoin

This feature is supported by the following versions of SafePal Wallet.

platform version description
App(iOS) >=4.5.3 Testnet, Mainnet
App(Android) >=4.5.3 Testnet, Mainnet

# Methods

# requestAccounts

safepalBRC20Provider.requestAccounts()
1

Connect the current account.

# Parameters

none

# Returns

Promise returns string[] : Address of current account.

# Example

try {
  let accounts = await window.safepalBRC20Provider.requestAccounts();
  console.log('connect success', accounts);
} catch (e) {
  console.log('connect failed');
}
> connect success ['tb1qrn7tvhdf6wnh790384ahj56u0xaa0kqgautnnz']
1
2
3
4
5
6
7

# getAccounts

safepalBRC20Provider.getAccounts()
1

Get address of current account

# Parameters

none

# Returns

  • Promise - string: address of current account

# Example

try {
  let res = await window.safepalBRC20Provider.getAccounts();
  console.log(res)
} catch (e) {
  console.log(e);
}
> ["tb1qrn7tvhdf6wnh790384ahj56u0xaa0kqgautnnz"]
1
2
3
4
5
6
7

# getNetwork

safepalBRC20Provider.getNetwork()
1

get network

# Parameters

none

# Returns

  • Promise - string: the network. livenet and testnet

# Example

try {
  let res = await window.safepalBRC20Provider.getNetwork();
  console.log(res)
} catch (e) {
  console.log(e);
}
> 0
1
2
3
4
5
6
7
8

# switchNetwork

safepalBRC20Provider.switchNetwork(network)
1

switch network

# Parameters

  • network - string: the network. livenet and testnet

# Returns

none

# Example

try {
  let res = await window.safepalBRC20Provider.switchNetwork("livenet");
  console.log(res)
} catch (e) {
  console.log(e);
}
> 0
1
2
3
4
5
6
7
8

# getPublicKey

safepalBRC20Provider.getPublicKey()
1

Get publicKey of current account.

# Parameters

none

# Returns

  • Promise - string: publicKey

# Example

try {
  let res = await window.safepalBRC20Provider.getPublicKey();
  console.log(res)
} catch (e) {
  console.log(e);
}
> 03cbaedc26f03fd3ba02fc936f338e980c9e2172c5e23128877ed46827e935296f
1
2
3
4
5
6
7

# getBalance

safepalBRC20Provider.getBalance()
1

Get BTC balance

# Parameters

none

# Returns

  • Promise - Object:
    • confirmed - number : the confirmed satoshis
    • unconfirmed - number : the unconfirmed satoshis
    • total - number : the total satoshis

# Example

try {
  let res = await window.safepalBRC20Provider.getBalance();
  console.log(res)
} catch (e) {
  console.log(e);
}
> {
    "confirmed":0,
    "unconfirmed":100000,
    "total":100000
  }
1
2
3
4
5
6
7
8
9
10
11
12

# getInscriptions

safepalBRC20Provider.getInscriptions(cursor,size)
1

List inscriptions of current account

# Parameters

none

# Returns

  • Promise - Object:
    • total - number : the total count
    • list - Object[] :
    • inscriptionId - string : the id of inscription.
    • inscriptionNumber - string : the number of inscription.
    • address - string : the address of inscription.
    • outputValue - string : the output value of inscription.
    • content - string : the content url of inscription.
    • contentLength - string : the content length of inscription.
    • contentType - number : the content type of inscription.
    • preview - number : the preview link
    • timestamp - number : the blocktime of inscription.
    • offset - number : the offset of inscription.
    • genesisTransaction - string : the txid of genesis transaction
    • location - string : the txid and vout of current location

# Example

try {
  let res = await window.safepalBRC20Provider.getInscriptions(0,10);
  console.log(res)
} catch (e) {
  console.log(e);
}
> {
  "total":10,
  "list":[
    {
      inscriptionId: '6037b17df2f48cf87f6b6e6ff89af416f6f21dd3d3bc9f1832fb1ff560037531i0',
      inscriptionNumber: 959941,
      address: 'bc1q8h8s4zd9y0lkrx334aqnj4ykqs220ss735a3gh',
      outputValue: 546,
      preview: 'https://ordinals.com/preview/6037b17df2f48cf87f6b6e6ff89af416f6f21dd3d3bc9f1832fb1ff560037531i0',
      content: 'https://ordinals.com/content/6037b17df2f48cf87f6b6e6ff89af416f6f21dd3d3bc9f1832fb1ff560037531i0',
      contentLength: 53,
      contentType: 'text/plain;charset=utf-8',
      timestamp: 1680865285,
      genesisTransaction: '6037b17df2f48cf87f6b6e6ff89af416f6f21dd3d3bc9f1832fb1ff560037531',
      location: '6037b17df2f48cf87f6b6e6ff89af416f6f21dd3d3bc9f1832fb1ff560037531:0:0',
      output: '6037b17df2f48cf87f6b6e6ff89af416f6f21dd3d3bc9f1832fb1ff560037531:0',
      offset: 0
    }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

# sendBitcoin

safepalBRC20Provider.sendBitcoin(toAddress, satoshis, options)
1

Send BTC

# Parameters

  • toAddress - string: the address to send
  • satoshis - number: the satoshis to send
  • options - object:
    • feeRate - number: the network fee rate

# Returns

  • Promise - string: txid

# Example

try {
  let txid = await window.safepalBRC20Provider.sendBitcoin("tb1qrn7tvhdf6wnh790384ahj56u0xaa0kqgautnnz",1000);
  console.log(txid)
} catch (e) {
  console.log(e);
}
1
2
3
4
5
6

# sendInscription

safepalBRC20Provider.sendInscription(address, inscriptionId, options)
1

Send Inscription

# Parameters

  • options - Object:
    • id - string: the id of Inscription.
    • address - string: the receiver address.

# Returns

  • Promise - Object:
    • txid - string : the txid

# Example

try {
  let {txid} = await window.safepalBRC20Provider.sendInscription("tb1q8h8s4zd9y0lkrx334aqnj4ykqs220ss7mjxzny","e9b86a063d78cc8a1ed17d291703bcc95bcd521e087ab0c7f1621c9c607def1ai0");
  console.log("send Inscription 204 to tb1q8h8s4zd9y0lkrx334aqnj4ykqs220ss7mjxzny",{txid})
} catch (e) {
  console.log(e);
}
1
2
3
4
5
6

# signMessage

safepalBRC20Provider.signMessage(msg[, address])
1

sign message

# Parameters

  • msg - string: a string to sign

# Returns

  • Promise - string: the signature.

# Example

try {
  let res = await window.safepalBRC20Provider.signMessage("abcdefghijk123456789");
  console.log(res)
} catch (e) {
  console.log(e);
}
> IMEo3yzgqJKlmc38IqlP3YjadVOnXmVR6fqeDhtVdiyHUbitYlO2CFUHUgGtM1/cjWsWoGVhTv6pyvj9L/kNT5A=
1
2
3
4
5
6
7
8

# signPsbt

safepalBRC20Provider.signPsbt(psbtHex)
1

Sign PSBT

This method will traverse all inputs that match the current address to sign.

# Parameters

  • psbtHex - string: the hex string of psbt to sign

# Returns

  • Promise - string: the hex string of signed psbt

# Example

try {
  let res = await window.safepalBRC20Provider.signPsbt("70736274ff01007d....");
  console.log(res)
} catch (e) {
  console.log(e);
}
1
2
3
4
5
6

# Events

# accountsChanged

safepalBRC20Provider.on('accountsChanged', handler: (accounts: Array<string>) => void);
safepalBRC20Provider.removeListener('accountsChanged', handler: (accounts: Array<string>) => void);
1
2

The accountsChanged will be emitted whenever the user's exposed account address changes.

# networkChanged

safepalBRC20Provider.on('networkChanged', handler: (network: string) => void);
safepalBRC20Provider.removeListener('networkChanged', handler: (network: string) => void);
1
2

The networkChanged will be emitted whenever the user's network changes.

← WalletConnect →