Skip to content

Commit

Permalink
add sdk section and mention permissionless there (#14)
Browse files Browse the repository at this point in the history
* add sdk section and mention permissionless there

* fix comment

* fix grammar

* article fix
  • Loading branch information
nikmel2803 authored Feb 5, 2024
1 parent 60c3ea1 commit 44f7ff3
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ The PimlicoERC20Paymaster contract inherits from BasePaymaster.
- updatePrice: Updates the token price by fetching the latest price from the Oracle.
- _validatePaymasterUserOp: Validates a paymaster user operation and calculates the required token amount for the transaction.
- _postOp: Performs post-operation tasks, such as updating the token price and refunding excess tokens.

### Events
- ConfigUpdated: Emitted when the price markup and price update threshold configurations are updated.

Expand All @@ -29,6 +30,11 @@ If necessary, the contract owner can withdraw tokens using the withdrawToken fun
To update the token price, call the updatePrice function.
For more information, please refer to the comments within the contract source code.

## SDK
You can use permissionless.js to interact with an ERC20 Paymaster. Follow [this link](https://docs.pimlico.io/permissionless/tutorial/tutorial-3) to check out tutorial on how to submit user operation using with an ERC-20 Paymaster.

Check out [these docs](https://docs.pimlico.io/permissionless/how-to/paymasters/use-custom-paymaster) if you're going to use a custom paymaster implementation.

## Development setup

This repository uses both hardhat and foundry for development, and assumes you have already installed hardhat/foundry
Expand Down

0 comments on commit 44f7ff3

Please sign in to comment.