Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
LilaRest authored May 16, 2024
1 parent f913ab5 commit 83a0d0e
Showing 1 changed file with 11 additions and 16 deletions.
27 changes: 11 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,20 @@
# LDY-token

The $LDY is the utility and governance token of the whole Ledgity ecosystem. This repo holds its contract source code.

This token is currently used in the following projects:

- [Ledgity.com](https://ledgity.com)
- [Ledgity DeFi](https://ledgity.finance)
- [Ledgity DAO (coming soon)](https://ledgity.org)
The $LDY is the utility and governance token of the Ledgity ecosystem. This repo holds its contract source code.

## Design

The $LDY contract inherits from:
This contract is taken from the official Chainlink CCIP cross-chain token template:
https://github.com/smartcontractkit/ccip/blob/onchain-release/v1.1.0/contracts/src/v0.8/shared/token/ERC677/BurnMintERC677.sol

No changes have been made to the original contract; only the imports and folder structure have been reworked. This was done to eliminate hundreds of unused files and to import OpenZeppelin libraries directly from their NPM package.

- [OpenZepellin 'ERC20' contract](https://docs.openzeppelin.com/contracts/4.x/api/token/erc20#ERC20)
- [OpenZepellin 'ERC20Burnable' contract](https://docs.openzeppelin.com/contracts/4.x/api/token/erc20#ERC20Burnable)
$LDY token is non-upgradeable, non-pausable, and non-restrictable.

It has been designed to be as light as possible and so doesn't implement any functions and states in addition to the ones provided by the above OpenZepellin contracts.

It is non-upgradeable, non-ownable, non-pausable and non-restrictable. It is so safe to use in a DAO context.

It's supply is fixed to 75M tokens which are minted at deploy time. There is no way to mint additional tokens later.
This token is currently used in the following projects:
- [Ledgity.com](https://ledgity.com)
- [Ledgity DeFi](https://ledgity.finance)
- [Ledgity DAO (coming soon)](https://ledgity.org)

Finally, here are its specifications:

Expand All @@ -30,7 +25,7 @@ Finally, here are its specifications:

## Security

To report any security-related information that may directly or indirectly have an impact on the $LDY token, please reach us at [email protected].
To report any security-related information that may directly or indirectly impact the $LDY token, please email [email protected].

## License

Expand Down

0 comments on commit 83a0d0e

Please sign in to comment.