Skip to content

Latest commit

 

History

History
288 lines (202 loc) · 13.7 KB

README.md

File metadata and controls

288 lines (202 loc) · 13.7 KB
Raw

On Chain Bonds

solidity - v0.8.25 Foundry - Latest Conventional Commits

A (kind-of) decentralized and (relatively) gas-efficient protocol for deploying and managing general purpose on-chain bonds, represented as ERC721 (NFT) tokens.

This is a sister project of vile/eth-bonds, inspired by the same issue.

AI generated image of a chain

Protocol Architecture

Simply put, the protocol is a mostly decentralized, completely un-owned, non-upgradeable beacon proxy pattern. However, individual instances of Bonds are owned, but potentially can be decentralized.

The initial protocol deployment consists are three (3) parts:

  1. BondERC20 Implementation
  2. Non-Upgradeable Beacon
  3. Beacon Proxy Factory
General Architecture Diagram

Diagram showing the general architecture of the protocol

Entities who are interested in using the protocol, can deploy a beacon proxy (using the proxy factory), which creates a new "instance" of an independently owned Bond. The initial owner is the proxy contract caller, but ownership can be transferred to, say, a multi-sig operated by a decentralized governance structure.

Bond Life Cycle

Diagram showing the life cycle of a bond NFT

Beyond this extra step and external infrastructure, the owner of the Bond instance has the final say in "accepting" or "rejecting" bonds. And, therefore, without a decentralized instance owner, all users who mint bonds must trust the owner to act in good faith. Ownership is required for each Bond instance to function; there is no other way to properly handle accepting or rejecting bonds, as each instance can have arbitrary, socialized rulesets that may/must be evaluated by human judgment.

Getting Started

Requirements

  1. Git - Install Git
    1. Check if you have Git installed with git --version
  2. Foundry - Install Foundry
    1. Check if you have Foundry installed with forge --version
  3. Soldeer - Install Soldeer
    1. Check if you have Soldeer installed with soldeer -V

Installation

git clone https://github.com/vile/on-chain-bonds.git
cd on-chain-bonds
make # clean, install deps, build

Usage

See the Static Analyzers for external tool installation.

Testing

Run all Foundry tests, slither, and aderyn:

make test-ext

Run slitherin instead of slither:

make test-ext2

Run individual tests:

forge test --mt test_testName -vvvvv

Deploying

Test Net Funding

Deployments on testnets can get a little pricey (ETH-wise), and sometimes faucets don't cut it. If that is the case, LayerZero's TestNet Bridge allows you to bridge a small amount (usually less than $2) from a handful of L2s to Ethereum L1 Sepolia. On average, bridging 0.0001 ETH from ARB or OP to ETH L1 Sepolia, gives ~3.5 sepETH. When deploying on L2 testnets, use their respective bridges, such as the Arbitrum Sepolia bridge or the Optimism Sepolia bridge via SuperBridge.

Deployer Wallet, RPCs, API Key(s)

This project uses Foundry's keystore feature to manage deployer wallet(s). As such, either import your existing deployer private key using cast wallet import. Or, generate a new keystore (and associated private key) using:

cast wallet new ~/.foundry/keystores # this is the default foundry keystore folder on linux 
# Enter secret: [your keystore password here]
cast wallet list # check your new keystore (usually will be a random alphanumeric string)
mv ~/.foundry/keystores/name-of-keystore-you-generated ~/.foundry/keystores/new_key_name # rename your local keystore file
cast wallet list # ensure it was renamed

You need to prepare your .env file before you can add your RPC and Etherscan API key. To do so, simply rename the current .env.example using mv .env.example .env. NEVER SHARE THIS FILE OR ITS CONTENTS, INCLUDING UPLOADING IT TO A GIT REPO.

An easy RPC solution is Alchemy. Either create an account with Alchemy, or sign-in using your GitHub account. Then, create a new app on the Alchemy dashboard, and copy your target deployment chain's HTTP RPC URL (for this example, Sepolia). Now, put the copied RPC URL after the = in .env under ETHEREUM_SEPOLIA_RPC_URL. Follow the same process to deploy on other networks, such as Arbitrum (e.g., under ARBITRUM_SEPOLIA_RPC_URL).

Now, to get an Etherscan API key (used to verify the contracts on the block explorer), create an Etherscan account, or if you already have one, use that. Then, create a new API key in your account settings. Copy that API key, and put it after the = in .env under ETHERSCAN_API_KEY. Etherscan API keys work across all Ethereum network explorers (Mainnet, Sepolia, Holesky, etc.). Follow the same process to verify on other deployed networks, such as Arbitrum (e.g., under ARBISCAN_API_KEY).

CREATE2 Salts

All contracts are deployed using the Keyless CREATE2 Factory. This means that unique salts were mined for this specific protocol's deployer address (0x2F51). As such, deploying from a different wallet requires different salts to be used for efficient 0-leading addresses, if desired.

Salts must be mined sequentially, as previous addresses are required for the beacon and proxy factory constructors. A helper forge script (./script/util/CodeCreationScript.s.sol), helps manage the INIT_CODE_HASH of each contract as two of them take constructor arguments.

Running Deploy Script

To run a test (anvil) deployment, use:

# start Anvil (in a separate terminal)
anvil

# run the (old, non-CREATE2) deploy script, targeting the local Anvil chain
make deploy-anvil

To run a forked test deployment (against Ethereum Sepolia), use:

make fork-create2-deploy KEYSTORE=DEPLOYER_KEYSTORE # change `DEPLOYER_KEYSTORE` to your actual keystore name

To run a live, testnet deployment, use:

Ethereum Sepolia:

make deploy-eth-sepolia-create2 KEYSTORE=DEPLOYER_KEYSTORE # change `DEPLOYER_KEYSTORE` to your actual keystore name

Arbitrum Sepolia:

make deploy-arb-sepolia-create2 KEYSTORE=DEPLOYER_KEYSTORE # change `DEPLOYER_KEYSTORE` to your actual keystore name

Optimism Sepolia:

make deploy-op-sepolia-create2 KEYSTORE=DEPLOYER_KEYSTORE # change `DEPLOYER_KEYSTORE` to your actual keystore name

Running the live deployment command will deploy all the required contracts, and verify them on their respective Etherscan block explorers.

Retrying Failed Etherscan Verifications

For some reason if verifications fail during script execution, and forge verify-contract is not working, change your network deploy target in Makefile to a fork deploy instead. This will have foundry re-try the verification (which is somehow different than verify-contract) after the script has finished, like normal.

For example, if you're attempting to re-verify OP Sepolia, your target will look like the following (notice that rpc-url is now fork-url and the removal of --broadcast):

deploy-op-sepolia-create2 :; forge script script/DeployWithCREATE2FactoryScript.s.sol:DeployWithCREATE2FactoryScript --account $(KEYSTORE) --fork-url $(OPTIMISM_SEPOLIA_RPC_URL) --verify --etherscan-api-key $(OP_ETHERSCAN_API_KEY) -vvvv

Live Deployments

All live deployment across all networks share the same address, and are deployed using the Keyless CREATE2 Factory.

Ethereum Sepolia

Contract Address
BondERC20 (Implementation) 0x0000000a9900006ee5AEe818870B573e3F00EFdE
NonUpgradeableBondERC20Beacon 0x00000000002A68e045fcF1b392cD1C53D4A400aA
BondERC20ProxyFactory 0x00000000000d2F16966bD08eb4424a60E8C9008e

Arbitrum Sepolia

Contract Address
BondERC20 (Implementation) 0x0000000a9900006ee5AEe818870B573e3F00EFdE
NonUpgradeableBondERC20Beacon 0x00000000002A68e045fcF1b392cD1C53D4A400aA
BondERC20ProxyFactory 0x00000000000d2F16966bD08eb4424a60E8C9008e

Optimism Sepolia

Contract Address
BondERC20 (Implementation) 0x0000000a9900006ee5AEe818870B573e3F00EFdE
NonUpgradeableBondERC20Beacon 0x00000000002A68e045fcF1b392cD1C53D4A400aA
BondERC20ProxyFactory 0x00000000000d2F16966bD08eb4424a60E8C9008e
Ethereum Sepolia Deprecated Non-CREATE2
Contract Address
BondERC20 (Implementation) 0x596235e3ac7fc8ec0108093722648c5ce7feca85
NonUpgradeableBondERC20Beacon 0xc6d794daa00fe35487fef38b28439dce7c431346
BondERC20ProxyFactory 0x24e580ca133cce4040f682298de13d1d7fcbddcd
Example Bond Instance (Proxy) 0x335e088f203cb1eB08c364218869F3e8172615Ea

Static Analyzers

Slither 
python3 -m pip install slither-analyzer # OR
pipx install slither-analyzer
Slitherin 
pip install slitherin
# OR
pipx install slitherin
echo -e "# Slitherin with pipx\nexport PATH=\"\$PATH:/home/$USER/.local/pipx/venvs/slitherin/bin\"\n" >> ~/.bashrc \
&& source ~/.bashrc
Aderyn 
# Install rust if not installed already
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
cargo install aderyn
4n4lyz3r

Refer to repo usage steps.

Known Issues

  1. Bond instances are to not be used with any weird ERC20s (e.g., stETH (rebasing) or PAXG (fee-on-transfer)).
  2. Ether can become locked forever in certain contracts if value is included with specific function calls.
  3. Individual Bond instances (beacon proxies) are owned, users of each bond instance need to trust the owner.
  4. NFTs are transferrable; the original bond purchaser (minter) and the recipient of an accepted bond's tokens may differ.
  5. When creating proxies, NFT metadata (name, symbol, URI) is not validated or checked that it follows any convention.