Package Exports
- vice-aa
- vice-aa/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vice-aa) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Installation
npm install vice-aaSupported Networks
- MUMBAI NETWORK
- POLYGON NETWORK (Comming Soon...)
Paymaster URL's
Simple Paymaster -> https://vice-aa-api.vercel.app/paymaster
ERC20 Token Paymaster -> https://vice-aa-api.vercel.app/tokenpaymaster
ERC20 Token For TokenPaymaster
- Token Name: CORE TOKEN
- Token Address: 0x4613246FF4F29FaE8a6a70aceaF11670259F9A41
You can get this token from Uniswap
⚠️ WARNING: MAKE SURE TO APPROVE THE ERC20PAYMASTER CONTRACT FOR CORE TOKEN TO USE ERC20PAYMASTER URL.
Usage
This package provides four main functions:
getUserOperationgetSignedUserOpCustomJsonRpcProviderwaitForReceipt
Follow the steps below to use these functions in your project.
Step 1: Create a Provider and Contract Instance
First, set up your provider and create an instance of the contract with which you wish to interact.
import { ethers } from "ethers";
import { YourContractAddress, YourContractABI } from "<your-contract-data-location>";
const provider = new ethers.providers.Web3Provider(window.ethereum);
const contract = new ethers.Contract(YourContractAddress, YourContractABI, provider);Step 2: Populate Your Transaction
Next, populate the transaction you intend to execute.
const populatedTx = await contract.populateTransaction.<YourContractMethod>(
// Method parameters go here
);Step 3: Get User Operation
Use getUserOperation with your contract wallet address, contract address, populated transaction, paymaster URL, and your chosen RPC URL.
import { getUserOperation } from "vice-aa";
const userOperation = await getUserOperation(
yourContractWalletAddress,
YourContractAddress,
populatedTx,
"https://<your-paymaster-url>",
"<your-rpc-url>"
);Step 4: Get Signed User Operation
Then, call getSignedUserOp with the userOperation , paymaster URL, and a boolean to indicate the type of paymaster.
import { getSignedUserOp } from "vice-aa";
const signedUserOp = await getSignedUserOp(
userOperation,
"https://<your-paymaster-url>",
true // Set to false for ERC20 paymaster
);Step 5: Send User Operation
Create a custom provider and send the user operation.
import { CustomJsonRpcProvider } from "vice-aa";
const customProvider = new CustomJsonRpcProvider("<your-rpc-url>");
const userOpHash = await customProvider.sendUserOperation(signedUserOp);Step 6: Wait for Transaction Receipt
Finally, wait for the transaction hash using waitForReceipt.
import { waitForReceipt } from "vice-aa";
const txHash = await waitForReceipt(customProvider, userOpHash);Example
Support
For additional support or queries, feel free to reach out or open an issue on the vice-aa repository.