Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update contracts link table #350

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
# Shade Protocol Core Contracts
| Contract | Reference | Description |
| --------------------------- | --------------------------------- | ------------------------------------- |
| [`governance`](./contracts/governance) | [doc](./contracts/governance/README.md) | Protocol's governance module |
| [`shade_staking`](./contracts/staking) | [doc](./contracts/staking/README.md) | Snip20 staker |
| [`scrt_staking`](./contracts/scrt_staking) | [doc](./contracts/scrt_staking/README.md) | SCRT staker |
| [`treasury`](./contracts/treasury) | [doc](./contracts/treasury/README.md) | Protocol's asset manager |
| [`mint`](./contracts/mint) | [doc](./contracts/mint/README.md) | Asset burner and minter |
| [`oracle`](./contracts/oracle) | [doc](./contracts/oracle/README.md) | Asset price querier |
| [`admin`](./contracts/admin) | [doc](./contracts/admin/README.md) | Contract admin manager |
| [`governance`](./contracts/governance) | N/A | Protocol's governance module |
| [`shade_staking`](./contracts/basic_staking) | [doc](./contracts/basic_staking/README.md) | Snip20 staker |
| [`query_auth`](./contracts/query_auth) | N/A | authentication manager for validation for permits and viewing keys |
| [`dao_contracts`](./contracts/dao) | [doc](./contracts/query_auth/README.md) | collection of dao contracts |
| [`bonds`](./archived-contracts/bonds) | [doc](./archived-contracts/bonds/README.md)| snip20 bonds |
| [`peg_stability`](./contracts/peg_stability) | N/A | peg stability |
| [`snip20_migration`](./contracts/snip20_migration) | N/A | migrate snip20 tokens into a newer version |
| [`sky_arbitrage`](./contracts/sky) | N/A | protocol arbitrage contract |
| [`airdrop`](./contracts/airdrop) | [doc](./contracts/airdrop/README.md) | Task based, multichain snip20 airdropper |
| [`mock_contracts`](./contracts/mock) | N/A | testing contracts that mock mainnet contracts |
| [`snip20_derivative`](./contracts/snip20_derivative) | [doc](./contracts/snip20_derivative/README.md) | snip20 staking derivative token |

## Development Environment

Expand Down