https://github.com/nnnnicholas/6551piggybank
https://github.com/nnnnicholas/6551piggybank
Last synced: 17 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/nnnnicholas/6551piggybank
- Owner: nnnnicholas
- Created: 2023-06-24T22:02:05.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-10T15:29:20.000Z (almost 2 years ago)
- Last Synced: 2025-03-31T10:42:26.678Z (about 2 months ago)
- Language: Solidity
- Size: 92.8 KB
- Stars: 10
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 6551piggybank
For more info on this project visit the EthWaterloo page describing and demoing: https://ethglobal.com/showcase/piggybank-6551-nft-e2ai5
See the project on Goerli Opensea: https://testnets.opensea.io/collection/piggybanknft6551
# contract-template
Template used to code juicy solidity stuff - includes forge, libs, etc.
This template is a good starting point for building solidity extensions to the Juicebox Protocol. Forking this template may help you to avoid submodule related dependency issues down the road.
# Getting started
## Prerequisites
### Install & Update Foundry
Install Forge with `curl -L https://foundry.paradigm.xyz | bash`. If you already have Foundry installed, run `foundryup` to update to the latest version. More detailed instructions can be found in the [Foundry Book](https://book.getfoundry.sh/getting-started/installation).
### Install & Update Yarn
Follow the instructions in the [Yarn Docs](https://classic.yarnpkg.com/en/docs/install). People tend to use the latest version of Yarn 1 (not Yarn 2+).
## Install Included Dependencies
Install the included dependencies (forge tests, Juice-contracts-V3, OZ) with `forge install && yarn install`.
# Adding dependencies
## With Yarn
If the dependency you would like to install has an NPM package, use `yarn add [package]` where [package] is the package name. This will install the dependency to `node_modules`.
Tell forge to look for node libraries by adding `node_modules` to the `foundry.toml` by updating `libs` like so: `libs = ['lib', 'node_modules']`.
Add dependencies to `remappings.txt` by running `forge remappings >> remappings.txt`. For example, the NPM package `jbx-protocol` is remapped as `@jbx-protocol/=node_modules/@jbx-protocol/`.
## With Forge
If the dependency you would like to install does not have an up-to-date NPM package, use `forge install [dependency]` where [dependency] is the path to the dependency repo. This will install the dependency to `/lib`. Forge manages dependencies using git submodules.
Run `forge remappings > remappings.txt` to write the dependencies to `remappings.txt`. Note that this will overwrite that file.
If nested dependencies are not installing, try this workaround `git submodule update --init --recursive --force`. Nested dependencies are dependencies of the dependencies you have installed.
More information on remappings is available in the Forge Book.
# Updating dependencies
## With Yarn
Run `yarn upgrade [package]`.
## With Forge
Run `foundryup` to update forge.
Run `forge update` to update all dependencies, or run `forge update [dependency]` to