From 6464676a93dfb8f98d1616109882b1fb9030f4e5 Mon Sep 17 00:00:00 2001 From: Sowmay Jain Date: Sun, 3 May 2020 17:06:28 +1000 Subject: [PATCH] minor edits --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 63eea2d..93d1148 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # DSA Connectors -Connectors are standardized modules that let Smart Account interact with various smart contracts, and make the important actions accessible to smart accounts. +Connectors are standard modules that let DeFi Smart Account interact with various smart contracts, and make the important actions accessible. ## Add Custom Connectors @@ -13,17 +13,17 @@ Connectors are standardized modules that let Smart Account interact with various ## Requirements +- Import common files from `contracts/common` directory. - The contracts should not have `selfdestruct()`. - The contracts should not have `delegatecall()`. - Use `uint(-1)` for maximum amount everywhere. -- Import files from common directory. -- Use `getEthAddr()` to get an address to denote Ethereum (non-ERC20) related operations. +- Use `getEthAddr()` to denote Ethereum (non-ERC20). - Use `address(this)` instead of `msg.sender` for fetching balance on-chain, etc. -- If needed, add `getId` & `setId`, two additional parameter for external public facing functions to fetch or store values. +- If required, Add two additional parameter, `getId` & `setId` in external public functions. - Use `getUint()` or `setUint()` functions to fetch or store values. -- Call `emitEvent()` after every external public facing functions to follow a common event standard for better analytics. +- Call `emitEvent()` after every external public functions. -Check out [mock.sol](https://github.com/InstaDApp/dsa-connectors/blob/master/contracts/connectors/mock.sol) for reference. +Be sure to check [this mock file](https://github.com/InstaDApp/dsa-connectors/blob/master/contracts/connectors/mock.sol) for reference. ## Support