Skip to content

Commit 44f7ff3

Browse files
authored
add sdk section and mention permissionless there (#14)
* add sdk section and mention permissionless there * fix comment * fix grammar * article fix
1 parent 60c3ea1 commit 44f7ff3

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ The PimlicoERC20Paymaster contract inherits from BasePaymaster.
1919
- updatePrice: Updates the token price by fetching the latest price from the Oracle.
2020
- _validatePaymasterUserOp: Validates a paymaster user operation and calculates the required token amount for the transaction.
2121
- _postOp: Performs post-operation tasks, such as updating the token price and refunding excess tokens.
22+
2223
### Events
2324
- ConfigUpdated: Emitted when the price markup and price update threshold configurations are updated.
2425

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

33+
## SDK
34+
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.
35+
36+
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.
37+
3238
## Development setup
3339

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

0 commit comments

Comments
 (0)