From 83a0d0e7389079c567ed9edf9b4f314235e714e4 Mon Sep 17 00:00:00 2001 From: Lila Rest Date: Thu, 16 May 2024 15:07:04 +0200 Subject: [PATCH] Update README.md --- README.md | 27 +++++++++++---------------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 9805187..23ecc61 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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 security@ledgity.com. +To report any security-related information that may directly or indirectly impact the $LDY token, please email security@ledgity.com. ## License