From 5816d11106533f07f7914e7e867176404dcec9c6 Mon Sep 17 00:00:00 2001 From: Hugo Montenegro Date: Mon, 2 Dec 2024 07:51:35 +0100 Subject: [PATCH] fix: copy fix --- .gitignore | 1 + README.md | 53 ++---------------------------- SOP.md | 40 ++++++++++++++++++++++ test/deprecated/playground.test.ts | 5 ++- 4 files changed, 47 insertions(+), 52 deletions(-) create mode 100644 SOP.md diff --git a/.gitignore b/.gitignore index 13ff170..df8efee 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,7 @@ archive/ src/data/package.json test/basic/playground.test.ts **.env +chains.json **/venv/ diff --git a/README.md b/README.md index a8e31a9..01f91dc 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,8 @@ # Peanut Protocol SDK -**Send tokens via cryptographically secure links**. +`Send tokens via cryptographically secure links`. -NPM package [here](https://www.npmjs.com/package/@squirrel-labs/peanut-sdk). This package makes use of ethers v5. If you're using ethers v6 or a different web3 library, please reach out on discord. - -- [Documentation available here](https://docs.peanut.to/sdk-documentation/building-with-the-sdk/getting-started-with-the-sdk/) +Read the full docs [here](https://docs.peanut.to). ### Install @@ -13,50 +11,3 @@ NPM package [here](https://www.npmjs.com/package/@squirrel-labs/peanut-sdk). Thi or via CDN: ` ` - -### Documentation - -- [Usage and docs available here](https://docs.peanut.to/integrations/sdk-quick-start) - -### Feedback - -This is an early SDK, and we're very open to suggestions and improvements. Please feel free to ping on discord #dev channel, or open an issue (or PR) on the [Github repo](https://github.com/peanutprotocol/peanut-sdk/issues). - -# Development - -Section for the people that develop this sdk / want to contribute. - -## Running devnet tests - -1. Install tenderly cli -2. Type `tenderly login` in the terminal -3. Choose "Access key" option -4. Enter the key. Find it in the peanut's notion in the tools section or ask @nebolax. -5. Ready! Develop & run devnet tests the way you normally do it 🥜 - -# Statement Of Procedures (SOP) - -## Adding a chain - -EVM: - -1. update `src/data/contracts.json` -2. `cd src/data && python3 fillChainDetails.py` -3. `python3 fillTokenDetails.py` -4. Add test case -5. QA / run test suite - -## New Contract Version - -(this process has to be optimized, it kinda sucks) - -- update getContract switch cases -- update with new peanut ABIs (can we reuse structure and save on package size?) -- update contracts.json (copied from peanut-contracts repo) -- update data.ts consts (also arrays) - -## Adding a custom token - -1. Fill out `src/data/manualTokenDetails.json` with the token details -2. run `fillTokenDetails.py` -3. release diff --git a/SOP.md b/SOP.md new file mode 100644 index 0000000..508cb43 --- /dev/null +++ b/SOP.md @@ -0,0 +1,40 @@ +# [DEPRECATED] Statement Of Procedures (SOP) + +# Development + +Section for the people that develop this sdk / want to contribute. + +## Running devnet tests + +1. Install tenderly cli +2. Type `tenderly login` in the terminal +3. Choose "Access key" option +4. Enter the key. Find it in the peanut's notion in the tools section or ask @nebolax. +5. Ready! Develop & run devnet tests the way you normally do it 🥜 + +# Statement Of Procedures (SOP) + +## Adding a chain + +EVM: + +1. update `src/data/contracts.json` +2. `cd src/data && python3 fillChainDetails.py` +3. `python3 fillTokenDetails.py` +4. Add test case +5. QA / run test suite + +## New Contract Version + +(this process has to be optimized, it kinda sucks) + +- update getContract switch cases +- update with new peanut ABIs (can we reuse structure and save on package size?) +- update contracts.json (copied from peanut-contracts repo) +- update data.ts consts (also arrays) + +## Adding a custom token + +1. Fill out `src/data/manualTokenDetails.json` with the token details +2. run `fillTokenDetails.py` +3. release diff --git a/test/deprecated/playground.test.ts b/test/deprecated/playground.test.ts index 89d87f7..30cfaba 100644 --- a/test/deprecated/playground.test.ts +++ b/test/deprecated/playground.test.ts @@ -13,7 +13,10 @@ describe('Playground Tests', () => { const txHash = '0xf73a0ae1a5119ac211f1f0f5244d223f57d4333d0ad155569ca55147538cbc83' const chainId = '1' // Ethereum mainnet - const provider = await peanut.getDefaultProvider(chainId) + // const provider = await peanut.getDefaultProvider(chainId) + const provider = new ethers.providers.JsonRpcProvider( + `https://mainnet.infura.io/v3/${process.env.INFURA_API_KEY}` + ) const receipt = await getTxReceiptFromHash(txHash, '1', provider) console.log('Transaction Receipt:', {