mirror of
https://github.com/Instadapp/dsa-connectors-old.git
synced 2024-07-29 22:47:46 +00:00
30 lines
1.5 KiB
Markdown
30 lines
1.5 KiB
Markdown
# DSA Connectors
|
|
|
|
Connectors are standardized modules that let Smart Account interact with various smart contracts, and make the important actions accessible to smart accounts.
|
|
|
|
## Add Custom Connectors
|
|
|
|
1. Fork and clone it
|
|
2. Create a feature branch: `git checkout -b new-connector`
|
|
3. Add the connector solidity file to `contracts/connectors`
|
|
4. Commit changes: `git commit -am 'Added a connector'`
|
|
5. Push to the remote branch: `git push origin new-connector`
|
|
6. Create a new Pull Request.
|
|
|
|
## Requirements
|
|
|
|
- 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 `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.
|
|
- 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.
|
|
|
|
Check out [mock.sol](https://github.com/InstaDApp/dsa-connectors/blob/master/contracts/connectors/mock.sol) for reference.
|
|
|
|
## Support
|
|
|
|
If you can't find something you're looking for or have any questions, ask them at our developers community on [Telegram](https://t.me/instadevelopers), [Discord](https://discord.gg/83vvrnY) or simply send an [Email](mailto:info@instadapp.io). |