@bananapus/project-handles v0.0.4

Bananapus Project Handles

Juicebox projects can use an ENS address as their project's "handle" in frontend clients like juicebox.money. To make this association, they must first set their juicebox_project ENS text record to their project's ID.

This JBProjectHandles contract manages reverse records that point from project IDs to ENS nodes. If the two records match, that ENS is considered the project's handle.

If you're having trouble understanding this contract, take a look at the core protocol contracts and the documentation first. If you have questions, reach out on Discord.

Install

How to install nana-project-handles in another project.

For projects using npm to manage dependencies (recommended):

npm install @bananapus/project-handles

For projects using forge to manage dependencies (not recommended):

forge install Bananapus/nana-project-handles

If you're using forge to manage dependencies, add @bananapus/project-handles/=lib/nana-project-handles/ to remappings.txt. You'll also need to install nana-project-handles' dependencies and add similar remappings for them.

Develop

nana-project-handles uses npm (version >=20.0.0) for package management and the Foundry development toolchain for builds, tests, and deployments. To get set up, install Node.js and install Foundry:

curl -L https://foundry.paradigm.xyz | sh

You can download and install dependencies with:

npm install && forge install

If you run into trouble with forge install, try using git submodule update --init --recursive to ensure that nested submodules have been properly initialized.

Some useful commands:

To learn more, visit the Foundry Book docs.