npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@biconomy/paymaster

v3.1.4

Published

Biconomy Paymaster to interact with Paymaster Services that interacts with ( veriying and token ) paymasters

Downloads

7,221

Readme

Paymaster

ERC4337, Account abstraction, introduces the concept of Paymasters. These specialised entities play a pivotal role in revolutionising the traditional gas payment system in EVM transactions. Paymasters, acting as third-party intermediaries, possess the capability to sponsor gas fees for an account, provided specific predefined conditions are satisfied.

Installation

Using npm package manager

npm i @biconomy/paymaster

OR

Using yarn package manager

yarn add @biconomy/paymaster

Usage

// This is how you create paymaster instance in your dapp's
import { IPaymaster, BiconomyPaymaster } from "@biconomy/paymaster";

// Currently this package only exports Biconomy Paymaster which acts as a Hybrid paymaster for gas abstraction. You can sponsor user transactions but can also make users pay gas in supported ERC20 tokens.

const paymaster = new BiconomyPaymaster({
  paymasterUrl: "", // you can get this value from biconomy dashboard. https://dashboard.biconomy.io
});

paymasterUrl you can get this value from biconomy dashboard.

Following are the methods that can be called on paymaster instance

export interface IHybridPaymaster<T> extends IPaymaster {
  getPaymasterAndData(userOp: Partial<UserOperation>, paymasterServiceData?: T): Promise<PaymasterAndDataResponse>;
  buildTokenApprovalTransaction(tokenPaymasterRequest: BiconomyTokenPaymasterRequest, provider: Provider): Promise<Transaction>;
  getPaymasterFeeQuotesOrData(userOp: Partial<UserOperation>, paymasterServiceData: FeeQuotesOrDataDto): Promise<FeeQuotesOrDataResponse>;
}

One can also build their own Paymaster API class and submit a PR or just provide instance of it in the account package / use standalone to generate paymasterAndData

It should follow below Interface.

export interface IPaymaster {
  // Implementing class may add extra parameter (for example paymasterServiceData with it's own type) in below function signature
  getPaymasterAndData(userOp: Partial<UserOperation>): Promise<PaymasterAndDataResponse>;
  getDummyPaymasterAndData(userOp: Partial<UserOperation>): Promise<string>;
}

Below API methods can be used for Biconomy Hybrid paymaster

getPaymasterAndData

This function accepts a Partial<UserOperation> object that includes all properties of userOp except for the signature and paymasterAndData field. It returns paymasterAndData as part of the PaymasterAndDataResponse

buildTokenApprovalTransaction

This function is specifically used for token paymaster sponsorship. The primary purpose of this function is to create an approve transaction for paymaster that gets batched with the rest of your transactions.

Note: You don't need to call this function. It will automatically get called as part of the buildTokenPaymasterUserOp function call.

getPaymasterFeeQuotesOrData

This function is used to fetch quote information or paymaster data based on provided userOperation and paymasterServiceData. If explicit mode is not provided it tries for sponsorship first and then falls back to serving fee quotes for supported/requested token/s

Note: This function can return paymasterAndData as well in case all of the policies checks get passed.