Developer Guides
Contributing
We welcome contributors of all skill levels! Here’s how to participate:
Fork the repository on GitHub.
Clone your fork and create a new branch:
shCopyEditgit clone https://github.com/yourname/revamp.git git checkout -b feature/your-featureMake your changes, write clear commit messages, and ensure all tests pass.
Submit a pull request with a concise summary of what you’ve improved or fixed.
Code of Conduct:
Respect others and follow best open-source practices.
Discuss larger changes via GitHub Issues before starting.
Need help? Open an issue or join our Discord!
Integrate with Frontends
RVNWL protocols are fully compatible with modern web3 frontends. Here’s a quick guide for React + ethers.js:
jsCopyEditimport { ethers } from 'ethers';
import RevampABI from './abis/RevampDeFi.json';
const provider = new ethers.BrowserProvider(window.ethereum);
const signer = await provider.getSigner();
const contract = new ethers.Contract(CONTRACT_ADDRESS, RevampABI, signer);
// Example: Burn tokens
await contract.revamp(tokenAddress, amount);
// Example: Claim native currency
await contract.claim();MetaMask Support:
Ask the user to connect wallet before interaction.
Show transaction status and errors gracefully.
API Reference
Each protocol exposes contract methods and events. Example (RevampDeFi):
revamp(address,uint256)
Deposit & burn a token
claim()
Claim accrued native currency
getPending(address)
Check claimable balance
listAsset(address)
(Admin) Add supported token
Events:
Revamped(address indexed user, address token, uint256 amount)Claimed(address indexed user, uint256 amount)
See each protocol’s ABI for full function and event list.
Security & Best Practices
Always test on testnet first! Burn events and deposits are irreversible.
Check contract source and audits.
Never share private keys. Use multisig for protocol governance and admin roles.
Upgrade responsibly: Protocols are immutable—deploy a new version rather than altering core logic.
Auditor’s Checklist:
Review all state changes and external calls.
Validate input parameters and event emission.
Use OpenZeppelin security patterns where possible.
Last updated