Skip to content

Commit

Permalink
Merge pull request #5 from symbioticfi/spec_fix
Browse files Browse the repository at this point in the history
Fix description
  • Loading branch information
1kresh authored Aug 16, 2024
2 parents ae76e3e + 116f352 commit 3e670b0
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 427 deletions.
14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,19 @@
**[Symbiotic Protocol](https://symbiotic.fi) is an extremely flexible and permissionless shared security system.**

This repository contains a Symbiotic Collateral interface and its default implementation.
This repository contains a Default Symbiotic Collateral implementation.

## Collateral

**Collateral** - a concept introduced by Symbiotic that brings capital efficiency and scale by enabling assets used to secure Symbiotic networks to be held outside of the Symbiotic protocol itself - e.g. in DeFi positions on networks other than Ethereum itself.
**Collateral** - a concept introduced by Symbiotic that brings capital efficiency and scale by allowing assets used to secure Symbiotic networks to be held outside the Symbiotic protocol itself, such as in DeFi positions on networks other than Ethereum.

Symbiotic achieves this by separating the ability to slash assets from the underlying asset itself, similar to how liquid staking tokens create tokenized representations of underlying staked positions. Technically, collateral positions in Symbiotic are ERC-20 tokens with extended functionality to handle penalties.

The Collateral interface can be found [here](./src/interfaces/ICollateral.sol).
Symbiotic achieves this by separating the ability to slash assets from the underlying asset, similar to how liquid staking tokens create tokenized representations of underlying staked positions. Technically, collateral positions in Symbiotic are ERC-20 tokens with extended functionality to handle slashing incidents if applicable. In other words, if the collateral token supports slashing, it should be possible to create a `Burner` responsible for properly burning the asset.

## Default Collateral

Default Collateral is a simple version of Collateral that has an instant debt repayment, which supports only non-rebase underlying assets.
Default Collateral is a simple implementation of the collateral token. Technically, it's a wrapper over any ERC-20 token with additional slashing history functionality. This functionality is optional and not required in most cases.

The implementation can be found [here](./src/contracts/defaultCollateral).

## Technical Documentation

Technical documentation can be found [here](./specs).

## Security

Security audits can be found [here](./audits).
Expand Down
124 changes: 0 additions & 124 deletions examples/DelayedRepayCollateral.sol

This file was deleted.

114 changes: 0 additions & 114 deletions examples/InstantRepayCollateral.sol

This file was deleted.

Loading

0 comments on commit 3e670b0

Please sign in to comment.