Quick Start

Overview

Get started with the RVNWL open protocols in minutes:

• Set up your local environment

• Clone and deploy your first protocol

• Start interacting with decentralized smart contracts

• Fork and adapt protocols to fit your own use case

No prior permission or special access required.

---

Install Dependencies

Before you begin, make sure you have the following installed:

• Node.js (v18+ recommended)

• npm (v8+)

• Git

• (Optional) Solidity toolchain: Foundry or Hardhat

To install Node.js and npm:

shCopyEditcurl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
sudo apt-get install -y nodejs

Clone the main protocol repository:

shCopyEditgit clone https://github.com/MKLabs72/revamp.git
cd revamp
npm install

---

Deploy Your First Protocol

1. Select a Protocol: (e.g., Revamp Protocol, Shareholding Pool)

2. Configure Network: Edit .env or config files to set your RPC endpoint and wallet.

3. Deploy Contract: For example, using Hardhat:

   shCopyEditnpx hardhat run scripts/deploy.js --network <network>

   (Check each protocol’s README for detailed instructions.)

4. Verify Deployment: Use Etherscan or your blockchain explorer to confirm contract address and source code.

---

Try Your First Transaction

• Use the included CLI scripts or a dApp frontend.

• Example (with ethers.js):

  jsCopyEditconst contract = new ethers.Contract(ADDRESS, ABI, signer);
  await contract.revamp(TOKEN_ADDRESS, AMOUNT);

• Check your transaction hash in your block explorer.

---

Troubleshooting

• Installation errors? Make sure you’re running compatible Node/npm versions.

• RPC/network errors? Check your .env config and wallet provider.

• Smart contract issues? Join our Discord or submit an issue on GitHub.

For detailed protocol-specific troubleshooting, see each protocol’s FAQ section.