Biconomy SDK

Search…

📙

Biconomy SDK

Enable meta transactions or gasless transactions in your Dapp by integrating Biconomy SDK in your DApp in a few lines of code

Introduction
Biconomy SDK, enables meta transactions or gasless transactions in your DApp (Decentralized Application) out of the box without any change in your smart contracts and just a few lines of code in your DApp to integrate Biconomy SDK,.
By using Biconomy SDK,, DApp users are able to use the DApp and send transactions free of cost while developer pays the gas fee on their behalf as a part of user acquisition cost.
Let’s Get Started
1.Go to Dashboard to register your DApp and methods on which to enable meta transactions and copy your API Key.
2.Install Biconomy SDK
1. Installing and importing SDK 
Biconomy SDK can be installed either via npm repository or using standalone javascript file using html <script/> tag
Via NPM
Standalone JS File
npm install @biconomy/mexa
// Install Biconomy
<script src="https://cdn.jsdelivr.net/npm/@biconomy/[email protected]/dist/mexa.js"></script>
​
// Import Biconomy
let Biconomy = window.Biconomy.default;
2. Initializing SDK 
You can use Biconomy SDK either with Web3.js or Ethers.js library. It works with both libraries.
web3
ethers
import {Biconomy} from "@biconomy/mexa";
const biconomy = new Biconomy(<web3 provider>,{apiKey: <API Key>, debug: true});
web3 = new Web3(biconomy);
import {Biconomy} from "@biconomy/mexa";
const biconomy = new Biconomy(<web3 provider>,{apiKey: <API Key>, debug: true});
let ethersProvider = new ethers.providers.Web3Provider(biconomy);
Note: <web3 provider> could be window.ethereum for Metamask or portis.provider for Portis and so on. It should be a provider object not RPC url.
3. Initialize your DApp after Biconomy SDK initialization
biconomy.onEvent(biconomy.READY, () => {
  // Initialize your dapp here like getting user accounts etc
}).onEvent(biconomy.ERROR, (error, message) => {
  // Handle error while initializing mexa
});
Congratulations 👏  
You have now enabled meta transactions in your DApp. Interact with web3 the way you have been doing it.
Now whenever there is a write transaction action (registered in dashboard also) initiated from the user, Biconomy SDK, will ask for user’s signature either EIP-712 format or personal signature as instructed and handle the transaction rather than sending signed transaction directly to blockchain from user’s wallet.
Checkout how you can use Biconomy SDK to do gasless transactions in different ways either by sponsoring all the gas fee for your users or let your users pay the gas fee in ERC20 tokens.​

Gas Tank Balance Data

Configuration

Last modified 2mo ago

Copy link

On this page

Introduction

Let’s Get Started

1. Installing and importing SDK

2. Initializing SDK

3. Initialize your DApp after Biconomy SDK initialization