pradhumnapancholi/sense-v1

Smart contracts for Sense v1

Sense v1 •

The Sense Protocol is a decentralized fixed-income protocol on Ethereum, allowing users to manage risk through fixed rates and future yield trading on existing yield bearing-assets.

Extensive documentation and use cases are available within this README and in the Sense docs here.

One way to interact with Sense is through our official app

Active development occurs in this repository, which means some contracts in it might not be production-ready. Proceed with caution.

Community

Deployments

Underlying & Targets

Token	Address
WETH	0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2
USDC	0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48
wstETH	0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0
cUSDC	0x39aa39c021dfbae8fac545936693ac917d5e7563

v1.3.0

Contract	Address
Divider	0x86bA3E96Be68563E41c2f5769F1AF9fAf758e6E0
Periphery	0xFff11417a58781D3C72083CB45EF54d79Cd02437
PoolManager	0xf01eb98de53ed964ac3f786b80ed8ce33f05f417
TokenHandler	0x4933494b4070c01bfFBd3c53C1E44A3d9d95DD8e
EmergencyStop	0xdC2eDFf06AF7944F4eFd22A105ac693d848Ee52f
WstETHAdapter	0x36c744Dd2916E9E04173Bee9d93D554f955a999d
CFactory	0xeC0E2e78BbEcFA2313150Edb273a429C9D4B25Da
cUSDC-CAdapter	0xEc30fEaC79898aC5FFe055bD128BBbA9584080eC
sP-wstETH:01-05-2022:5	0x923d411E62Cd3727e0B7dec458Ba89B0191A7067
sY-wstETH:01-05-2022:5	0x3A3359af098bb20a4EB1809a298Ca7B1d5B6Be94
sP-wstETH:01-07-2022:5	0xc1Fd90b0C31CF4BF16C04Ed8c6A05105EFc7c989
sY-wstETH:01-07-2022:5	0x7ecE94fD7F997800F7bfE2D53B9D0AABcE05d10b
sP-cUSDC:01-05-2022:6	0xa93fBC8114f6AD04B59426A2aFc1dB9eDB841f7a
sY-cUSDC:01-05-2022:6	0xA5240A4a27817135E2aB30c8f1996a2d460C9Db4
sP-cUSDC:01-07-2022:6	0xb636ADB2031DCbf6e2A04498e8Af494A819d4CB9
sY-cUSDC:01-07-2022:6	0x4ACA82E5686226A679875AACde7ECdf5fC5477ec
SpaceFactory	0x5f6e8e9C888760856e22057CBc81dD9e0494aA34
Space LP Share-wstETH:01-05-2022:5 *	0xbB6C7b5E0804d07aE31A43E6E83Ea66fb128a3BB
Space LP Share-wstETH:01-07-2022:5 *	0x34d179259336812A1C7d320A0972e949dA5fa26d
Space LP Share-cUSDC:01-05-2022:6 *	0x64db005d040EE62E8fa202291C73E8a6151A0399
Space LP Share-cUSDC:01-07-2022:6 *	0x76E5F9860Bd5b8666DE322496f114B8a89183A2E

* We are aware that the Name and Symbol does not include the Space LP Share. This will be fixed in the next version of Space.

Goerli v1.2.0

Contract	Address
Divider	0x240c7D23cfFB8438ad4fdF1a4FAcF47505A4A37f
Periphery	0xeEb84e2381f262e88EDB193665C017DBd965Af78
PoolManager	0x57D69DF010C495aceb22D8433288C1C774Cbb77E
BalancerVault	0x968b38155b99B05b93c8aAF963127Fb128f812F4

Development

This repo uses Foundry: forge for development and testing and git submodules for dependency management (we previously used dapp and nix, so there are vestiges from those tools around).

To install Foundry Foundry: Forge, use the instructions in the linked repo.

In addition, this repo uses just as our command runner:

brew install just
# or
cargo install just

Test

# Get contract dependencies
git submodule update --init --recursive
yarn isntall # or npm install

# Run local tests
just turbo-test-local

# Run mainnet fork tests
just turbo-test-mainnet

Format

# Run linter
yarn lint

# Run formatter
yarn fix

Deploy

This repo uses hardhat deploy for replicable deployments. To create a new deployment:

# Navigate to the `deployments` package
cd pkg/deployments

# Deploy the protcol with mocks on a forked network
yarn deploy:hardhat-fork:sim

# Deploy the protcol with production config on a forked network
yarn deploy:hardhat-fork:sim

# Deploy the protcol with mocks on a live network
yarn hardhat deploy --network <network> --tags scenario:simulated

# Deploy the protcol with production config on a live network
yarn hardhat deploy --network <network> --tags scenario:prod

Environment

1. Create a local .env file in the root directory of this project
2. Set ALCHEMY_KEY to a valid Alchemy API key
3. Set MNEMONIC to a valid seed phrase for deployments

Security

Sense-v1 has been audited by four, independent smart contract auditors, ranked by recency:

1. 2022-02/03 Space AMM - Fixed Point Solutions (Kurt Barry)
2. 2022-03 Sense - ABDK
3. 2022-01 Sense & Space AMM - Spearbit
4. 2021-11/12 Sense - Fixed Point Solutions (Kurt Barry)
5. 2021-11 Sense - ABDK
6. 2022-11 Sense - Peckshield

Bug Bounties

Sense has an active bug bounty on ImmuneFi, with up to $50,000 for reporting a bug in deployed contracts & the Sense Portal.

Conventions

Branching

Right now, we are using dev and main branches.

• main represents the contracts live on mainnet and all testnets
• dev is for the newest version of contracts, and is reserved for deployments to goerli

When a new version of the contracts makes its way through the testnet, it eventually becomes promoted in main, with semver reflecting contract changes in the major or minor portion of the version (depending on backwards compatibility).