Paymaster

Paymaster is a system designed to allow a company or organization to cover the transaction fees, commonly known as gas fees, for a whitelisted users.

  1. User Transaction Initiation: A whitelisted user initiates a transaction on the blockchain but does not supply the gas fee.

  2. Paymaster Intervention: The Paymaster account detects this transaction. It verifies if the user is on the whitelist and the transaction is valid.

  3. Gas Fee Payment: If the conditions are met, the Paymaster uses its funds to pay the gas fee required for the transaction.

  4. Transaction Completion: The transaction is processed on the blockchain, thanks to the Paymaster covering the cost.

The main advantage of the Paymaster feature is that it removes the burden of gas fees from individual users, especially beneficial in scenarios where users might not have the means or wish to spend their own cryptocurrency on transaction fees. This system is particularly advantageous for companies looking to onboard new users who are unfamiliar with blockchain technology or for applications aiming to provide a more user-friendly experience. By covering transaction fees, companies can encourage more frequent and frictionless interactions on their platform.

MethodsDescription

To add a whitelist using the specified accountAddress and chainId.

To check a whitelist using the specified accountAddress, sponsorAddress and chainId.

To deposit using the specified amount and chainId.

To get a sponsor balance using the specified sponsorAddress and chainId.

To remove a whitelist using the specified accountAddress, sponsorAddress and chainId.

 * @param apiKey - Contact kanalabs to obtain the API key for authentication.

Last updated