@otterspacexyz/contracts v0.1.0

otterspace-contracts

An EIP-4973-compliant Account-bound token to otterify Ethereum.

Project Information

This repository hosts the code for an EIP-4973 demo. We've created a front end hosted at https://badges.otterspace.xyz/ [source] that users can interact with on the Rinkeby Test Network. It allows anyone with Rinkeby Ether to mint an account-bound token to a given address with a fixed metadata.json.

Contracts

• Contract on Etherscan (Rinkeby): rinkeby.etherscan.io/address/0x9a8469255a7d41a715e539a22eb1127be0973a1e
• Metadata hosted on IPFS: QmdoUaYzKCMUmeH473amYJNyFrL1a6gtccQ5rYsqqeHBsC

Use ABIs with JavaScript

We're publishing this repository at @otterspacexyz/contracts.

npm i @otterspacexyz/contracts

With node >= 16, contract ABIs can be imported into JavaScript applications as npm dependencies as follows:

import Badges from "@otterspacexyz/contracts/out/Badges.sol/Badges.json" assert { type: "json" };

Developer setup

Foundry

• This project used git submodules
• Install Foundry

git clone git@github.com:otterspace-xyz/otterspace-contracts.git
git submodule update --init
forge install
forge build
forge test

Foundry setup for VS Code Users

Per instructions laid out at https://book.getfoundry.sh/config/vscode.html

Generate a remappings with forge remappings and create a remappings.txt under the root

Sample remappings.txt file

@openzeppelin/=lib/openzeppelin-contracts/
chain-claim/=lib/chain-claim/src/
forge-std/=lib/forge-std/src/
ds-test/=lib/forge-std/lib/ds-test/src/
ERC4973/=lib/ERC4973/src/

Add a .vscode file under the root

{
  "solidity.packageDefaultDependenciesContractsDirectory": "src",
  "solidity.packageDefaultDependenciesDirectory": "lib",
  "solidity.compileUsingRemoteVersion": "v0.8.10"
}

Hardhat

Alternatively, this repository is available for importing with npm/hardhat:

npm i @otterspacexyz/contracts

We're exporting specific .sol files using the "files" property in package.json. Please familiarize yourself with the .sol files we're exporting by looking into package.json.

Changelog

See changelog.md file.

License

See LICENSE file.