diff --git a/PROPOSALS.md b/PROPOSALS.md index 14d6725c32..ee9a4fa7b2 100644 --- a/PROPOSALS.md +++ b/PROPOSALS.md @@ -44,6 +44,9 @@ You can read more about BIPs [here](https://docs.bean.money/almanac/governance/p * [BIP-33](https://bean.money/bip-33): Beanstalk Farms H1 2023 Budget * [BIP-34](https://bean.money/bip-34): Sunrise Improvements * [BIP-35](https://bean.money/bip-35): Stalk Delegation and Process Amendments +* [BIP-36](https://bean.money/bip-36): Silo V3 +* [BIP-37](https://bean.money/bip-37): Basin Integration +* [BIP-38](https://bean.money/bip-38): Migrate urBEAN3CRV to urBEANETH ## Emergency Beanstalk Improvement Proposal (EBIP) @@ -59,6 +62,7 @@ You can read about the BCM's Emergency Response Procedures [here](https://docs.b * [EBIP-5](https://bean.money/ebip-5): Remove transferTokenFrom Function * [EBIP-6](https://bean.money/ebip-6): Resolve EBIP-4 and EBIP-5 * [EBIP-7](https://bean.money/ebip-7): Enroot BDV Update +* [EBIP-8](https://bean.money/ebip-8): Enroot BDV Rounding ## Beanstalk Operations Proposal (BOP) @@ -68,4 +72,4 @@ You can read more about BOPs [here](https://docs.bean.money/almanac/governance/p * [BOP-1](https://bean.money/bop-1): Ratify Disclosures Statement * [BOP-2](https://bean.money/bop-2): Increase and Revisit Bounty for April Governance Exploit -* [BOP-2](https://bean.money/bop-3): Form the BeaNFT DAO +* [BOP-3](https://bean.money/bop-3): Form the BeaNFT DAO diff --git a/README.md b/README.md index a8d0ea9edf..034ae4fd4e 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,25 @@ [discord-badge]: https://img.shields.io/discord/880413392916054098?label=Beanstalk [discord-url]: https://discord.gg/beanstalk + [proj-protocol]: /protocol -[proj-sdk]: /projects/sdk [proj-ui]: /projects/ui +[proj-sdk]: /projects/sdk [proj-subgraph-beanstalk]: /projects/subgraph-beanstalk [proj-subgraph-bean]: /projects/subgraph-bean [proj-cli]: /projects/cli +[proj-basin-ui]: /projects/dex-ui +[proj-basin-sdk]: /projects/sdk-wells +[proj-subgraph-basin]: /projects/subgraph-wells + +[basin-protocol]: https://github.com/BeanstalkFarms/Basin +[pipeline-protocol]: https://github.com/BeanstalkFarms/Pipeline + + [es-beanstalk]: https://etherscan.io/address/0xC1E088fC1323b20BCBee9bd1B9fC9546db5624C5 [es-bean]: https://etherscan.io/address/0xBEA0000029AD1c77D3d5D23Ba2D8893dB9d1Efab +[es-basin]: https://docs.basin.exchange/resources/contracts + +[npm-beanstalk]: https://www.npmjs.com/package/@beanstalk/sdk Beanstalk logo @@ -15,15 +27,17 @@ [![Discord][discord-badge]][discord-url] -Code Version: `2.5.0`
-Whitepaper Version: `2.5.0` +Code Version: `2.6.0`
+Whitepaper Version: `2.6.0` ## About Beanstalk is a permissionless fiat stablecoin protocol built on Ethereum. - [Repository](#repository) +- [Development](#development) - [Documentation](#documentation) +- [Governance](#governance) - [Audits](#audits) - [Bug Bounty Program](#bug-bounty-program) - [Contracts](#contracts) @@ -31,14 +45,19 @@ Beanstalk is a permissionless fiat stablecoin protocol built on Ethereum. ## Repository -| Project | Description | -| ----------------------------------------------- | ------------------------------------------------------------------------------------ | -| [`protocol`][proj-protocol] | The Beanstalk protocol, its facets and related contracts in the Beanstalk ecosystem. | -| [`subgraph-beanstalk`][proj-subgraph-beanstalk] | A subgraph indexing Beanstalk ([0xC1E088][es-beanstalk]). | -| [`subgraph-bean`][proj-subgraph-bean] | A subgraph indexing the Bean ERC-20 token ([0xBEA000][es-bean]). | -| [`sdk`][proj-sdk] | A Typescript SDK for interacting with Beanstalk and ecosystem contracts. | -| [`ui`][proj-ui] | The Beanstalk UI hosted at [app.bean.money](https://app.bean.money). | -| [`cli`][proj-cli] | A tool for interacting with Beanstalk in a development environment. | +| Project | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------| +| [`protocol`][proj-protocol] | The Beanstalk protocol, its facets and related contracts in the Beanstalk ecosystem. | +| [`ui`][proj-ui] | The Beanstalk UI hosted at [app.bean.money](https://app.bean.money). | +| [`sdk`][proj-sdk] | A Typescript SDK for interacting with Beanstalk and ecosystem contracts ([npm module][npm-beanstalk]). | +| [`subgraph-beanstalk`][proj-subgraph-beanstalk] | A subgraph indexing Beanstalk ([0xC1E088][es-beanstalk]). | +| [`subgraph-bean`][proj-subgraph-bean] | A subgraph indexing the Bean ERC-20 token ([0xBEA000][es-bean]). | +| [`cli`][proj-cli] | A tool for interacting with Beanstalk in a development environment. | +| [`dex-ui`][proj-basin-ui] | The Basin UI hosted at [basin.exchange](https://basin.exchange). | +| [`sdk-wells`][proj-basin-sdk] | A Typescript SDK for interacting with Basin its components' contracts. | +| [`subgraph-wells`][proj-subgraph-basin] | A subgraph indexing Basin and its components. | + +Note that the [Basin][basin-protocol] and [Pipeline][pipeline-protocol] contracts are in separate repostitories. ## Development @@ -51,6 +70,10 @@ Technical documentation on Beanstalk can be found in the [Agronomics Handbook](h The latest version of the Beanstalk Whitepaper is available [here](https://bean.money/beanstalk.pdf) (version history can be found [here](https://github.com/BeanstalkFarms/Beanstalk-Whitepaper/tree/main/version-history)). +## Governance + +Read more about Beanstalk governance [here](https://docs.bean.money/almanac/governance/beanstalk). All past governance proposals can be found [here](https://github.com/BeanstalkFarms/Beanstalk-Governance-Proposals). + ## Audits Read more about Beanstalk audits [here](https://docs.bean.money/almanac/protocol/audits). @@ -65,16 +88,6 @@ You can find the bug bounty program and submit bug reports [here](https://immune A comprehensive list of contract addresses related to Beanstalk is available [here](https://docs.bean.money/almanac/protocol/contracts). -| Contract | Address | -| :--------------------------- | :-------------------------------------------------------------------------------------------------------------------- | -| Beanstalk | [0xC1E088fC1323b20BCBee9bd1B9fC9546db5624C5][es-beanstalk] | -| Bean | [0xBEA0000029AD1c77D3d5D23Ba2D8893dB9d1Efab][es-bean] | -| BEAN:3CRV LP token | [0xc9C32cd16Bf7eFB85Ff14e0c8603cc90F6F2eE49](https://etherscan.io/address/0xc9C32cd16Bf7eFB85Ff14e0c8603cc90F6F2eE49) | -| Unripe Bean token | [0x1BEA0050E63e05FBb5D8BA2f10cf5800B6224449](https://etherscan.io/address/0x1BEA0050E63e05FBb5D8BA2f10cf5800B6224449) | -| Unripe BEAN:3CRV LP token | [0x1BEA3CcD22F4EBd3d37d731BA31Eeca95713716D](https://etherscan.io/address/0x1BEA3CcD22F4EBd3d37d731BA31Eeca95713716D) | -| Fertilizer ERC-1155 token | [0x402c84de2ce49af88f5e2ef3710ff89bfed36cb6](https://etherscan.io/address/0x402c84de2ce49af88f5e2ef3710ff89bfed36cb6) | -| Beanstalk Community Multisig | [0xa9bA2C40b263843C04d344727b954A545c81D043](https://etherscan.io/address/0xa9bA2C40b263843C04d344727b954A545c81D043) | - ## License [MIT](https://github.com/BeanstalkFarms/Beanstalk/blob/master/LICENSE.txt) diff --git a/beanstalk.pdf b/beanstalk.pdf index f6624a906a..60ab5fea10 100644 Binary files a/beanstalk.pdf and b/beanstalk.pdf differ