Skip to content

Commit

Permalink
Merge branch 'main' into docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Hugo0 authored Dec 2, 2024
2 parents b858709 + 5d62b2a commit 4430305
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 52 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ archive/
src/data/package.json
test/basic/playground.test.ts
**.env
chains.json

**/venv/

Expand Down
54 changes: 3 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,62 +1,14 @@
# 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.
Read the full docs [here](https://docs.peanut.to).

- [Documentation available here](https://docs.peanut.to/using-the-sdk)

### Install

`npm i @squirrel-labs/peanut-sdk`

or via CDN:

`<script src="https://cdn.jsdelivr.net/npm/@squirrel-labs/peanut-sdk/dist/index.js"></script> `

### Documentation

- [Usage and docs available here](https://docs.peanut.to/using-the-sdk)

### 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
`<script src="https://cdn.jsdelivr.net/npm/@squirrel-labs/peanut-sdk/dist/index.js"></script>`
40 changes: 40 additions & 0 deletions SOP.md
Original file line number Diff line number Diff line change
@@ -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
5 changes: 4 additions & 1 deletion test/deprecated/playground.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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:', {
Expand Down

0 comments on commit 4430305

Please sign in to comment.