@squirrel-labs/peanut-sdk
v0.4.33
Published
The Peanut Protocol SDK! Check out the documentation at https://docs.peanut.to
Downloads
1,900
Maintainers
Readme
Peanut Protocol SDK
Send tokens via cryptographically secure links.
NPM package here. This package makes use of ethers v5. If you're using ethers v6 or a different web3 library, please reach out on discord.
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
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.
Development
Section for the people that develop this sdk / want to contribute.
Running devnet tests
- Install tenderly cli
- Type
tenderly login
in the terminal - Choose "Access key" option
- Enter the key. Find it in the peanut's notion in the tools section or ask @nebolax.
- Ready! Develop & run devnet tests the way you normally do it 🥜
Statement Of Procedures (SOP)
Adding a chain
EVM:
- update
src/data/contracts.json
cd src/data && python3 fillChainDetails.py
python3 fillTokenDetails.py
- Add test case
- 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
- Fill out
src/data/manualTokenDetails.json
with the token details - run
fillTokenDetails.py
- release