forked from ubiquity/pay.ubq.fi
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
98 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,36 +1,112 @@ | ||
| This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). | ||
| # Generate Permit | ||
|
|
||
| ## Getting Started | ||
| Tool for generating offline permits for bounty hunters to withdraw their payments. | ||
|
|
||
| First, run the development server: | ||
| ## How to setup | ||
|
|
||
| Create a `.env` file in the project root: | ||
|
|
||
| ``` | ||
| # common variables | ||
| CHAIN_ID="" # mainnet: 1, goerli: 5 | ||
| FRONTEND_URL="" | ||
| UBIQUIBOT_PRIVATE_KEY="" | ||
| RPC_PROVIDER_URL="" | ||
| PAYMENT_TOKEN_ADDRESS="" # // DAI address, mainnet: 0x6b175474e89094c44da98b954eedeac495271d0f, goerli: 0x11fE4B6AE13d2a6055C8D9cF65c55bac32B5d844 | ||
| # variables depending on spender (bounty hunter) | ||
| AMOUNT_IN_ETH="1" # amount in ether, 1 AMOUNT_IN_ETH = 1000000000000000000 WEI | ||
| BENEFICIARY_ADDRESS="" | ||
| ``` | ||
|
|
||
| ## How it works | ||
|
|
||
| 1. Admin sets `env.AMOUNT_IN_ETH` and `env.BENEFICIARY_ADDRESS` depending on a bounty hunter's reward and address | ||
| 2. Admin generates an offline permit URL via `npx tsx generate-permit2-url.ts`. Permit URL example: | ||
|
|
||
| ``` | ||
| http://localhost:8080?claim=eyJwZXJtaXQiOnsicGVybWl0dGVkIjp7InRva2VuIjoiMHgxMWZFNEI2QUUxM2QyYTYwNTVDOEQ5Y0Y2NWM1NWJhYzMyQjVkODQ0IiwiYW1vdW50IjoiMTAwMDAwMDAwMDAwMDAwMDAwMCJ9LCJub25jZSI6IjQ0NTUxMjc4NTQwNTU0MzM1MDQ2NzU2NDQ3MzM2MjI1ODg5OTE4OTY5MTczODQwNTU0Nzk2NzQ3MzQzMzAwOTg0NzU4MDIyMzY1ODczIiwiZGVhZGxpbmUiOiIxMTU3OTIwODkyMzczMTYxOTU0MjM1NzA5ODUwMDg2ODc5MDc4NTMyNjk5ODQ2NjU2NDA1NjQwMzk0NTc1ODQwMDc5MTMxMjk2Mzk5MzUifSwidHJhbnNmZXJEZXRhaWxzIjp7InRvIjoiMHhjODZhMDU5NzgwMThlMDRkNmVGMmFhNzNFNjlhNzMzQzA2ZDFmODllIiwicmVxdWVzdGVkQW1vdW50IjoiMTAwMDAwMDAwMDAwMDAwMDAwMCJ9LCJvd25lciI6IjB4NTRmNGEzNjQyMkRjOTZkMDg0OTY3NWMxZjBkZDJCOTZEMjc1NThFMiIsInNpZ25hdHVyZSI6IjB4NWI0OTE5MjhmYzI4MzBlMjZiNTViMWUxOWQ3YzVhMmVjNGE2ZmRhYWI1OGFiYjgyOWMwNmYzYzlkNGE4YTc5YjAzYmE2NjlkMDM4YjFmYzg5NjgzYzMyYjBiYTA5MzU2MDRjMGU1MDNjYWE3ZmY2ZWM2MDg2ZWZlYjY2MTY5MjQxYyJ9 | ||
| ``` | ||
|
|
||
| 3. Admin posts offline permit URL in issue comments | ||
| 4. Bounty hunter opens permit URL, connects wallet and clicks a "withdraw" button to get a payment | ||
|
|
||
| ## How to test locally | ||
|
|
||
| 1. Set `.env` variables. | ||
| 2. Run `anvil --chain-id 31337 --fork-url https://rpc.gnosis.gateway.fm` in a separate terminal. | ||
| 3. Run the Anvil commands (uses the Anvil default wallets). | ||
| 4. In the project root run `yarn start`. | ||
| 5. A permit URL for both ERC20 and ERC721 is generated in the terminal. | ||
| 6. Open the generated permit URL defaulting to the variable values in the `.env` file. | ||
| 7. Connect the bounty hunter's address. | ||
| 8. Click the "withdraw" button to get a reward. | ||
| 9. Testing the ERC721 permit is easiest deploying the `nft-rewards` contract from the [repository](https://github.com/ubiquity/nft-rewards) | ||
|
|
||
| #### Anvil commands | ||
|
|
||
| ###### Using any other `--chain-id` will hit real RPC endpoints. | ||
|
|
||
| ```shell | ||
| cast rpc anvil_impersonateAccount 0xba12222222228d8ba445958a75a0704d566bf2c8 & | ||
| cast send 0xe91D153E0b41518A2Ce8Dd3D7944Fa863463a97d --unlocked --from 0xba12222222228d8ba445958a75a0704d566bf2c8 "transfer(address,uint256)(bool)" 0x70997970C51812dc3A010C7d01b50e0d17dc79C8 337888400000000000000000 & | ||
| cast send 0xe91D153E0b41518A2Ce8Dd3D7944Fa863463a97d --unlocked --from 0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266 "approve(address,uint256)(bool)" 0x000000000022D473030F116dDEE9F6B43aC78BA3 9999999999999991111111119999999999999999 & | ||
| cast send 0xe91D153E0b41518A2Ce8Dd3D7944Fa863463a97d --unlocked --from 0x70997970C51812dc3A010C7d01b50e0d17dc79C8 "approve(address,uint256)(bool)" 0x000000000022D473030F116dDEE9F6B43aC78BA3 999999999999999111119999999999999999 | ||
|
|
||
| ```bash | ||
| npm run dev | ||
| # or | ||
| yarn dev | ||
| # or | ||
| pnpm dev | ||
| # or | ||
| bun dev | ||
| ``` | ||
|
|
||
| Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. | ||
| ## CloudFlare Setup (GitHub Secrets) | ||
|
|
||
| ##### CLOUDFLARE_ACCOUNT_ID = | ||
|
|
||
| https://dash.cloudflare.com/***/pages | ||
| https://dash.cloudflare.com/abcd1234/pages | ||
| (Here `abcd1234` is your account ID) | ||
|
|
||
| ##### CLOUDFLARE_API_TOKEN = | ||
|
|
||
| https://dash.cloudflare.com/profile/api-tokens > Create Token > API token templates > Edit Cloudflare Workers > Use Template | ||
| Account Resources = All Accounts or Target Account | ||
| Zone Resources = All Zones | ||
| (Detailed Instructions: https://developers.cloudflare.com/workers/wrangler/ci-cd/) | ||
|
|
||
| ##### CLOUDFLARE_ASSET_DIRECTORY = | ||
|
|
||
| static | ||
|
|
||
| You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. | ||
| ##### CLOUDFLARE_PROJECT_NAME = | ||
|
|
||
| This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. | ||
| npm install -g wrangler | ||
| wrangler login | ||
| wrangler pages project create | ||
|
|
||
| ## Learn More | ||
| ## How to invalidate a permit2 nonce by example | ||
|
|
||
| To learn more about Next.js, take a look at the following resources: | ||
| This section describes how to invalidate the following [permit](https://github.com/ubiquity/ubiquity-dollar/issues/643#issuecomment-1607152588) (i.e. invalidate a permit2 nonce) | ||
|
|
||
| - [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. | ||
| - [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. | ||
| 1. Setup `.env` file with the required env variables: `NONCE` (nonce number), `NONCE_SIGNER_ADDRESS` (i.e. the bot's wallet) and `RPC_PROVIDER_URL`. For this [permit URL](https://github.com/ubiquity/ubiquity-dollar/issues/643#issuecomment-1607152588) the `.env` file will look like this: | ||
|
|
||
| You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! | ||
| ``` | ||
| NONCE="9867970486646789738815952475601005014850694197864057371518032581271992954680" | ||
| NONCE_SIGNER_ADDRESS="0xf87ca4583C792212e52720d127E7E0A38B818aD1" | ||
| RPC_PROVIDER_URL="https://rpc.ankr.com/gnosis" | ||
| ``` | ||
|
|
||
| 2. Run `yarn nonce:get-invalidate-params`. You will get this output: | ||
|
|
||
| ``` | ||
| == Logs == | ||
| Is nonce used: false | ||
| -------------------- | ||
| Params for nonce invalidation via invalidateUnorderedNonces() | ||
| wordPos: 38546759713464022417249814357816425839260524210406474107492314770593722479 | ||
| mask: 72057594037927936 | ||
| ``` | ||
|
|
||
| ## Deploy on Vercel | ||
| 3. Open https://gnosisscan.io/address/0x000000000022D473030F116dDEE9F6B43aC78BA3#writeContract and connect your wallet | ||
| 4. Call `invalidateUnorderedNonces()` with the `wordPos` and `mask` params you got on step 2 | ||
|
|
||
| The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. | ||
| Notice that this examples uses gnosis chain for nonce invalidation. If you need to invalidate nonce on some other chain then: | ||
|
|
||
| Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. | ||
| 1. Set `RPC_PROVIDER_URL` on step 1 to the desired RPC chain provider | ||
| 2. On step 3 open UI for the desired chain |