SignerProvider

The SignerProvider is an abstraction of an Alephium account. It can be used to sign messages and transactions, as well as submit signed transactions to the Alephium blockchain.

Create SignerProvider

The SDK offers four types of signer providers, each designed for specific use cases. Below is a guide on how to create each type of SignerProvider.

PrivateKeyWallet

You need to install the @alephium/web3-wallet package first:

npm install --save @alephium/web3-wallet

You can create a SignerProvider using a private key:

import { NodeProvider } from '@alephium/web3'
import { PrivateKeyWallet } from '@alephium/web3-wallet'
import { testPrivateKey } from '@alephium/web3-test'

const nodeProvider = new NodeProvider('http://127.0.0.1:22973')
const wallet = new PrivateKeyWallet({ privateKey: testPrivateKey })

Extension Wallet

You need to install the @alephium/get-extension-wallet package first:

npm install --save @alephium/get-extension-wallet

The @alephium/get-extension-wallet package helps to detect and interact with browser extension wallet:

import { getDefaultAlephiumWallet } from '@alephium/get-extension-wallet'
const wallet = await getDefaultAlephiumWallet()
if (wallet !== undefined) {
  const account = await wallet.enable({
    networkId: 'mainnet', // the optional network id, it allows to connect to any network if it is undefined
    addressGroup: 0, // the optional address group, it allows to connect to any group if it is undefined
    onDisconnected: () => {} // the optional disconnect callback, it will be called when the wallet disconnects
  })
}

// disconnect
await wallet?.disconnect()

WalletConnect

You need to install the @alephium/walletconnect-provider package first:

npm install --save @alephium/walletconnect-provider

The @alephium/walletconnect-provider package provides a bridge to connect dApps with wallets using the WalletConnect protocol:

import QRCodeModal from '@alephium/walletconnect-qrcode-modal'
import { WalletConnectProvider } from '@alephium/walletconnect-provider'

const provider = await WalletConnectProvider.init({
  projectId: 'your-wallet-connect-project-id', // please refer to the WalletConnect documentation to create your project id
  networkId: 'mainnet', // the optional network id, it allows to connect to any network if it is undefined
  addressGroup: 0, // the optional address group, it allows to connect to any group if it is undefined
  onDisconnected: () => {} // the optional disconnect callback, it will be called when the wallet disconnects
})
provider.on('displayUri', QRCodeModal.open(uri, () => console.log('qr closed')))
await provider.connect()
const account = provider.account

// disconnect
await provider.disconnect()

For the convenience of dApp development, Typescript SDK includes a set of React components and hooks to integrate extension wallet and WalletConnect in the @alephium/web3-react package. You can refer to the documentation here for more details.

NodeWallet

You can follow this guide to create a full node wallet, and then use the full node wallet to sign and submit transactions:

import { NodeProvider } from '@alephium/web3'
import { NodeWallet } from '@alephium/web3-wallet'

const nodeProvider = new NodeProvider('http://127.0.0.1:22973')
const wallet = new NodeWallet('alephium-web3-test-only-wallet', nodeProvider)
// wallet must be unlocked before it can sign and send transactions
await wallet.unlock('alph')

note

Both PrivateKeyWallet and NodeWallet are used for contract development and deployment, please don't use them to store large amount of tokens.

Use SignerProvider

Sign and Submit Transaction

After you build the transactions, you can use the SignerProvider to sign and submit the them. Here is an example:

import { NodeProvider, TransactionBuilder } from '@alephium/web3'
import { PrivateKeyWallet } from '@alephium/web3-wallet'

const nodeProvider = new NodeProvider('http://127.0.0.1:22973')
const signer = new PrivateKeyWallet({ privateKey: testPrivateKey, nodeProvider })
const account = await signer.getSelectedAccount()
const buildTxResult = await TransactionBuilder(nodeProvider).buildTransferTx(...)
const result = await signer.signAndSubmitUnsignedTx({
  signerAddress: account.address,
  unsignedTx: buildTxResult.unsignedTx
})
const txId = result.txId

SignerProvider also provides several signAndSubmit methods that combine the building, signing and submitting of the transaction together, namely:

signAndSubmitTransferTx: build, sign, and submit transfer transactions
signAndSubmitDeployContractTx: build, sign, and submit deploy contract transactions
signAndSubmitExecuteScriptTx: build, sign, and submit execute script transactions

Sign Messages

You can also use SignerProvider to sign a message:

const signer = new PrivateKeyWallet({ privateKey: testPrivateKey })
const account = await signer.getSelectedAccount()
const result = await signer.signMessage({
  signerAddress: account.address,
  message: 'The message that need to be signed',
  messageHasher: 'alephium', // message is prefixed with 'Alephium signed message: ' before hashed with blake2b
})
const signature = result.signature

Create SignerProvider​

PrivateKeyWallet​

Extension Wallet​

WalletConnect​

NodeWallet​

Use SignerProvider​

Sign and Submit Transaction​

Sign Messages​