Beanstalk

Beanstalk is a permissionless fiat stablecoin protocol built on Ethereum.

Techincal Documentation

Technical documentation is a WIP. Current draft is available here.

Contracts

A comprehensive list of contracts related to Beanstalk is available here.

Contract	Address
Beanstalk	0xC1E088fC1323b20BCBee9bd1B9fC9546db5624C5
Bean	0xBEA0000029AD1c77D3d5D23Ba2D8893dB9d1Efab
Curve BEAN:3CRV Metapool	0xc9C32cd16Bf7eFB85Ff14e0c8603cc90F6F2eE49
Unripe Bean ERC-20 token	0x1BEA0050E63e05FBb5D8BA2f10cf5800B6224449
Unripe BEAN:3CRV LP token	0x1BEA3CcD22F4EBd3d37d731BA31Eeca95713716D
Fertilizer ERC-1155 token	0x402c84de2ce49af88f5e2ef3710ff89bfed36cb6
Fertilizer Admin	0xfECB01359263C12Aa9eD838F878A596F0064aa6e
Fertilizer Implementation	0x39cdAf9Dc6057Fd7Ae81Aaed64D7A062aAf452fD
Beanstalk Price Contract	0xA57289161FF18D67A68841922264B317170b0b81
Beanstalk Contract Owner (BCM)	0xa9bA2C40b263843C04d344727b954A545c81D043
Beanstalk Farms Multisig	0x21DE18B6A8f78eDe6D16C50A167f6B222DC08DF7
Bean Sprout Multisig	0xb7ab3f0667eFF5e2299d39C23Aa0C956e8982235
BeaNFT Genesis	0xa755A670Aaf1FeCeF2bea56115E65e03F7722A79
BeaNFT Winter	0x459895483556dad32526efa461f75e33e458d9e9

Beanstalk Contract & EIP-2535

The Beanstalk smart contract is a multi-facet proxy as it implements EIP-2535. Thus, the Beanstalk contract pulls in functions from a variety of different contracts (called facets in the EIP-2535 documentation) that are all capable of sharing the same state object.

The following are the different facets Beanstalk uses:

Facet	Address
Whitelist	0xAeA0e6e011106968ADc7943579C829E49EFddaD0
Unripe	0xaF26527eFCbF5BA7ba5de57e7048BF605011cc39
Token	0x146f86c2EF039f9176bc2434D3DA5919C19B87fC
Silo	0x5BB733654C75dCFdD68096ad1764b9Db9b33Fd35
Season	0xcee260AF23cD262a9921A16B3586948A465801da
Pause	0xeab4398f62194948cB25F45fEE4C46Fae2e91229
Marketplace	0xD870aAB97c2739b320a3eFAd370511452894F1b2
Fundraiser	0x538C76976eF45b8cA5c12662a86034434bFC7a8E
Field	0x538C76976eF45b8cA5c12662a86034434bFC7a8E
Fertilizer	0xFC7Ed192a24FaB3093c8747c3DDBe6Cacd335B6C
Farm	0x6039c602B730f44f418145454a2D954133CBD394
BDV	0xc17ED2e41242063DB6b939f5601bA01374b9D44a
Curve	0xd231498144c5b53b65b782343CDFB366472c7bf7
Convert	0xc1A92D1fA36717bfC3C795d3A335f84784DC593d

The following facets are part of the diamond functionality:

Contract	Address
DiamondCutFacet	0xDFeFF7592915bea8D040499E961E332BD453C249
DiamondLoupeFacet	0xB51D5C699B749E0382e257244610039dDB272Da0
OwnershipFacet	0x5D45283Ff53aabDb93693095039b489Af8b18Cf7

Setup

clone the repository
run cd protocol to enter the protocol repository
run npm install
run npx hardhat compile

Forking Mainnet Locally

We elect to use anvil instead of hardhat for local node forking as anvil is considerably faster than hardhat and properly caches the blockchain locally

ensure you are in the /protocol repository
Install Foundry curl -L https://foundry.paradigm.xyz | bash & reopen terminal
Run foundryup to ensure latest version
Start a locally forked node with the following command:

anvil --fork-url <FORK_RPC> --fork-block-number <BLOCK_NUMBER> --chain-id 1337

For <FORK_RPC>, use an Alchemy or Infura RPC URL. For <BLOCK_NUMBER>, we currently use 15128715, but you are welcome to use any block after Replant2

It should be very clear if the node starts up properly.

Note: anvil will cache the blockchain provided that BLOCK_NUMBER does NOT change. Given this, we recommend picking a block and sticking to it.

Replanting

ensure that you have a localhost
run npx hardhat replant --network localhost

Testing

make sure you are in the protocol repository
run npm test to run all coverage tests
run npx hardhat coverage to run all coverage tests and generate a coverage report

Developing

Overview

As Beanstalk implements EIP-2535, Beanstalk is upgraded through a diamondCut function call. There are two different ways a diamondCut can apply code to Beanstalk:

adding/replacing/removing functions
- Functions being added/replaced are implemented in smart contracts referred to as facets. Facets are no different than a normal smart contract with callable functions. In order to share a state, Facets can only define 1 internal state variable: The AppStorage struct defined in AppStorage.sol.
calling the init function of a smart contract
- This is a one time action and will be called when the diamondCut is executed. There can be 1 init call per diamondCut.

Creating a new facet

For this tutorial, we are going to create a new facet called SampleFacet. In your own implementation replace iterations of the word Sample with the name of the Facet you want to create.

make sure you are in the protocol repository
in protocol/farm/facets/, create a new folder called SampleFacet
within the SampleFacet folder create a file called SampleFacet.sol.
implement your faucet. You can use SampleFacet.sol in protocol/samples as a template for a basis faucet. Note that facets can only have AppStorage as an internal state variable or there will be issues with accessing AppStorage.
modify the deploy function in scripts/deploy to include your new facet, so that the faucet will be deployed with the Beanstalk diamond.

Mainnet Forking and Bip Upgrades

Overview

There are a couple of steps that must be done before we can fork mainnet and upgrade Bips/test Bip upgrades

include the following code in the networks section of the hardhat.config.js, where ALCHEMY_URL is your mainnet url. We recommend using Alchemy for this. The blockNumber is optional, but we recommend to be one that is close to the current block number but not too close.
```
forking: {
    url: <RPC_URL>,
    blockNumber: <BLOCK_NUMBER>
  },
```
```
localhost: {
  chainId: 1337,
  url: "http://127.0.0.1:8545",
  forking: {
    url: <RPC_URL>,
    blockNumber: <BLOCK_NUMBER>
  },
},
```

include as in imports section

const BEANSTALK = "0xC1E088fC1323b20BCBee9bd1B9fC9546db5624C5";
const ownerFacet = await ethers.getContractAt('OwnershipFacet', BEANSTALK);
const owner = await ownerFacet.owner();
const { upgradeWithNewFacets } = require('./scripts/diamond.js')

Lastly, include the tasks required for upgrading above module.exports:

task("upgrade", "Commits a bip", async() => {
    await hre.network.provider.request({
        method: "hardhat_impersonateAccount",
        params: [owner],
    });
    const account = await ethers.getSigner(owner)
    await upgradeWithNewFacets({
        diamondAddress: BEANSTALK,
        facetNames: [],
        initFacetName: 'InitEmpty',
        initArgs: [],
        bip: false,
        verbose: true,
        account: account
    });
})

(this is an example of what bip11 deployment looked like):

await upgradeWithNewFacets({
    diamondAddress: BEANSTALK,
    initFacetName: 'InitBip11',
    facetNames: ['MarketplaceFacet'],
    libraryNames: ["LibClaim"],
    facetLibraries: {
    "MarketplaceFacet": ["LibClaim"],
    },
    bip: false,
    verbose: true,
    account: account
});

Running the Upgrade Tasks

Spin up your mainnet fork node with:
```
npx hardhat node
```
In another console, execute your tasks by running
```
npx hardhat upgrade --network localhost
```
where upgrade is where you put the name of your task, in the example above it was named upgrade.
Now you can test your changes using your local blockchain node that should now have the latest version of beanstalk that you upgraded.

Versions

Code Version: 2.0.0
Whitepaper Version 2.0.0

License

MIT

Tok1t4N1k0/Beanstalk

Beanstalk

Techincal Documentation

Contracts

Beanstalk Contract & EIP-2535

Setup

Forking Mainnet Locally

Replanting

Testing

Developing

Overview

Creating a new facet

Mainnet Forking and Bip Upgrades

Overview

Running the Upgrade Tasks

Versions

License