From 70643549f0ca835537c8c6e44162a9fb6f9eaf79 Mon Sep 17 00:00:00 2001
From: Edwin Liava'a <etuini.liavaa@gmail.com>
Date: Fri, 6 Dec 2024 07:23:51 +1300
Subject: [PATCH] hacktivator-program

---
 docs/04-resources/04-tutorials/index.md       |  26 +-
 .../04-tutorials/rootstock-vyper.md           | 222 ++++++++++++++++++
 yarn.lock                                     |   6 +-
 3 files changed, 242 insertions(+), 12 deletions(-)
 create mode 100644 docs/04-resources/04-tutorials/rootstock-vyper.md

diff --git a/docs/04-resources/04-tutorials/index.md b/docs/04-resources/04-tutorials/index.md
index b203f128..4645edda 100644
--- a/docs/04-resources/04-tutorials/index.md
+++ b/docs/04-resources/04-tutorials/index.md
@@ -13,11 +13,19 @@ values={[
 {label: 'Port to Rootstock', value: 'port-dapps'}
 ]}>
 <FilterItem
+value="beginner, advanced"
+title="Deploy a Vyper Smart Contract on RootStock"
+subtitle="Vyper"
+color="orange"
+linkHref="/resources/tutorials/rootstock-vyper/"
+description="This guide walks through the process of deploying a smart contract to the RootStock (RSK) testnet using Python and Web3.py. We'll be deploying a simple Vyper contract that demonstrates how to interact with the RSK network."
+/>
+<FilterItem
 value="beginner, port-dapps"
 title="Interact with Rootstock using Rust"
 subtitle="rust"
 color="orange"
-linkHref="/resources/tutorials/rootstock-rust/" 
+linkHref="/resources/tutorials/rootstock-rust/"
 description="Rust is extensively getting used on backend side of many defi applications, dApps, developer tools, indexers and bridges. This guide will help developers to start using Rust on Rootstock blockchain."
 />
 <FilterItem
@@ -25,7 +33,7 @@ value="beginner"
 title="Deploy, Interact and Verify Smart Contracts using Remix and Rootstock Explorer"
 subtitle="Remix"
 color="orange"
-linkHref="/developers/quickstart/remix/" 
+linkHref="/developers/quickstart/remix/"
 description="In this guide, we will use the Remix IDE to write, compile, deploy, interact and verify a smart contract on the Rootstock Explorer."
 />
 <FilterItem
@@ -33,7 +41,7 @@ value="beginner, advanced"
 title="Add Rootstock to Metamask Programmatically"
 subtitle="metamask"
 color="orange"
-linkHref="/resources/tutorials/rootstock-metamask/" 
+linkHref="/resources/tutorials/rootstock-metamask/"
 description="Learn how to add and initiate a network switch on Metamask from a website."
 />
 <FilterItem
@@ -41,7 +49,7 @@ value="beginner, advanced"
 title="dApp Automation with Cucumber and Playwright"
 subtitle="dapp-automation"
 color="orange"
-linkHref="/resources/tutorials/dapp-automation-cucumber/" 
+linkHref="/resources/tutorials/dapp-automation-cucumber/"
 description="Testing decentralized applications (dApps) is crucial for delivering a smooth user experience and ensuring the reliability of decentralized systems. Cucumber and Playwright form a dynamic duo in automated testing, blending behavior-driven development (BDD) and powerful browser automation capabilities."
 />
 <FilterItem
@@ -49,7 +57,7 @@ value="advanced, port-dapps"
 title="Port an Ethereum dApp to Rootstock"
 subtitle="Ethereum"
 color="orange"
-linkHref="/resources/port-to-rootstock/ethereum-dapp/" 
+linkHref="/resources/port-to-rootstock/ethereum-dapp/"
 description="Porting an Ethereum decentralized application (dApp) to Rootstock presents an exciting opportunity to leverage the benefits of the Rootstock network, which is a smart contract platform secured by the Bitcoin network."
 />
 <FilterItem
@@ -57,7 +65,7 @@ value="advanced"
 title="Virtual Testnets on Rootstock using Tenderly"
 subtitle="Tenderly"
 color="orange"
-linkHref="/resources/tutorials/rootstock-tenderly/" 
+linkHref="/resources/tutorials/rootstock-tenderly/"
 description="Tenderly's virtual testing environment allows the creation of simulated networks, managing account balances, and manipulating contract storage – all without needing to interact with the Rootstock mainnet or testnet."
 />
 <FilterItem
@@ -65,7 +73,7 @@ value="advanced"
 title="Add a Protocol To DefiLlama"
 subtitle="defillama"
 color="orange"
-linkHref="/resources/tutorials/defillama/" 
+linkHref="/resources/tutorials/defillama/"
 description="DefiLlama is the largest TVL aggregator for DeFi. Learn how to list a DeFi project and write an SDK adapter to add a Protocol to DefiLlama."
 />
 <FilterItem
@@ -73,7 +81,7 @@ value="advanced"
 title="Run Hyperlane Bridge on Rootstock"
 subtitle="hyperlane"
 color="orange"
-linkHref="/resources/tutorials/hyperlane-bridge/" 
+linkHref="/resources/tutorials/hyperlane-bridge/"
 description="Hyperlane is the first universal and permissionless interoperability layer built for the modular blockchain stack. Learn how to run Hyperlane on Rootstock blockchain."
 />
-</Filter>
\ No newline at end of file
+</Filter>
diff --git a/docs/04-resources/04-tutorials/rootstock-vyper.md b/docs/04-resources/04-tutorials/rootstock-vyper.md
new file mode 100644
index 00000000..a1d38c10
--- /dev/null
+++ b/docs/04-resources/04-tutorials/rootstock-vyper.md
@@ -0,0 +1,222 @@
+---
+sidebar_label: Vyper Smart Contract on RootStock
+sidebar_position: 7
+title: Deploying a Vyper Smart Contract to RootStock (RSK) Testnet using Python
+description: "This guide walks through the process of deploying a smart contract to the RootStock (RSK) testnet using Python and Web3.py. We'll be deploying a simple Vyper contract that demonstrates how to interact with the RSK network."
+tags: 
+  - rsk
+  - rootstock
+  - tutorials
+  - resources
+  - tests
+  - web3py
+  - vyper
+  - smart contracts
+  - python
+  - developers
+---
+
+This guide demonstrates how to deploy smart contracts written in Vyper to the RootStock (RSK) testnet using Python and Web3.py. RSK is a groundbreaking smart contract platform that's merge-mined with Bitcoin, offering unique advantages for developers:
+
+- **Bitcoin Compatibility**: Deploy smart contracts while leveraging Bitcoin's security and network effects
+- **EVM Compatibility**: Use familiar Ethereum tools and practices while building on Bitcoin
+- **Lower Fees**: Benefit from RSK's cost-effective transaction fees
+- **Scalability**: Enjoy higher transaction throughput compared to the Bitcoin mainnet
+
+We'll walk through creating a simple Vyper contract and deploying it to RSK's testnet, covering everything from environment setup to handling RSK-specific configurations. Whether you're an experienced Ethereum developer looking to expand to Bitcoin-based smart contracts, or just starting your blockchain journey, this guide will help you get up and running with RSK.
+
+## Prerequisites
+
+- [uv](https://docs.astral.sh/uv/)
+  - You'll know you've done it right if you can run `uv --version` and see a version number.
+- [git](https://git-scm.com/)
+  - You'll know you've done it right if you can run `git --version` and see a version number.
+  - Helpful shortcut:
+
+```bash
+# For bash
+echo "source $HOME/.bashrc >> $HOME/.bash_profile"
+
+# For zsh
+echo "source $HOME/.zshenv >> $HOME/.zprofile"
+```
+
+- Python 3.x
+- A text editor
+- Basic understanding of smart contracts and Python
+- RSK testnet RBTC (will show you how to get this)
+
+## Installation
+
+```bash
+git clone https://github.com/EdwinLiavaa/Web3py-Vyper-RootStock.git
+cd Web3py-Vyper-RootStock
+```
+
+### uv
+
+```bash
+uv sync
+```
+
+### pip/python
+
+```bash
+python -m venv ./venv
+source ./venv/bin/activate
+pip install -r requirements.txt
+```
+
+## Quickstart
+
+```bash
+uv run hello.py # for UV
+# or
+python hello.py # for pip/python
+```
+
+## Setup Environment
+
+First, let's set up our Python environment and install the necessary packages:
+
+```bash
+# Create and activate virtual environment
+python3 -m venv .venv
+source .venv/bin/activate
+
+# Install required packages
+pip install python-dotenv web3 vyper
+```
+
+## Configuration
+
+Create a `.env` file in your project root with your configuration:
+
+```env
+RPC_URL="https://rpc.testnet.rootstock.io/[YOUR-API-KEY]"
+PRIVATE_KEY="your-private-key"  # Never commit your real private key!
+MY_ADDRESS="your-wallet-address"
+```
+THIS IS ONLY FOR TESTING - TYPICALLY YOU SHOULD NEVER SHARE YOUR PRIVATE KEY.
+
+## Get Testnet RBTC
+
+Before deploying, you'll need some testnet RBTC:
+
+1. Go to the RSK faucet: https://faucet.rsk.co/
+2. Enter your wallet address
+3. Complete the captcha and request funds
+4. Wait a few minutes for the transaction to be confirmed
+
+## The Smart Contract
+
+Here's our simple Vyper contract (`favorites.vy`):
+
+```python
+# @version ^0.3.7
+
+favorite_number: public(uint256)
+owner: public(address)
+
+@external
+def __init__():
+    self.owner = msg.sender
+    self.favorite_number = 0
+
+@external
+def store(new_number: uint256):
+    self.favorite_number = new_number
+```
+
+## Deployment Script
+
+Here's our Python script to deploy the contract (`deploy_favorites_unsafe.py`):
+
+```python
+from web3 import Web3
+from dotenv import load_dotenv
+from vyper import compile_code
+import os
+
+load_dotenv()
+
+RPC_URL = os.getenv("RPC_URL")
+
+def main():
+    print("Let's read in the Vyper code and deploy it to the blockchain!")
+    w3 = Web3(Web3.HTTPProvider(RPC_URL))
+    with open("favorites.vy", "r") as favorites_file:
+        favorites_code = favorites_file.read()
+        compliation_details = compile_code(
+            favorites_code, output_formats=["bytecode", "abi"]
+        )
+
+    chain_id = 31  # RSK testnet chain ID
+
+    print("Getting environment variables...")
+    my_address = os.getenv("MY_ADDRESS")
+    private_key = os.getenv("PRIVATE_KEY")
+
+    # Check balance before deployment
+    balance = w3.eth.get_balance(my_address)
+    balance_in_rbtc = w3.from_wei(balance, "ether")
+    print(f"Account balance: {balance_in_rbtc} RBTC")
+
+    if balance == 0:
+        print("Your account has no RBTC! Please get some testnet RBTC from the faucet:")
+        print("1. Go to https://faucet.rsk.co/")
+        print("2. Enter your address:", my_address)
+        print("3. Complete the captcha and request funds")
+        print("4. Wait a few minutes for the transaction to be confirmed")
+        return
+
+    # Create the contract in Python
+    favorites_contract = w3.eth.contract(
+        abi=compliation_details["abi"], bytecode=compliation_details["bytecode"]
+    )
+
+    # Submit the transaction that deploys the contract
+    nonce = w3.eth.get_transaction_count(my_address)
+
+    print("Building the transaction...")
+    transaction = favorites_contract.constructor().build_transaction(
+        {
+            "chainId": chain_id,
+            "from": my_address,
+            "nonce": nonce,
+            "gas": 3000000,  # Higher gas limit for RSK
+            "gasPrice": w3.eth.gas_price * 2,  # Double the gas price to ensure transaction goes through
+        }
+    )
+
+    print("Signing transaction...")
+    signed_txn = w3.eth.account.sign_transaction(transaction, private_key=private_key)
+    print("Deploying contract...")
+    tx_hash = w3.eth.send_raw_transaction(signed_txn.rawTransaction)
+    tx_receipt = w3.eth.wait_for_transaction_receipt(tx_hash)
+    print(f"Contract deployed! Address: {tx_receipt.contractAddress}")
+
+if __name__ == "__main__":
+    main()
+```
+
+## Key Points About RSK Deployment
+
+1. **Chain ID**: RSK testnet uses chain ID 31
+2. **Gas Settings**:
+   - We use a higher gas limit (3,000,000) for RSK
+   - We double the gas price to ensure the transaction goes through
+3. **Transaction Type**:
+   - RSK works best with legacy transactions (using `gasPrice` instead of EIP-1559 parameters)
+
+## Running the Deployment
+
+Execute the deployment script:
+
+```bash
+python deploy_favorites_unsafe.py
+```
+## Useful Links
+
+The boilerplate used in this project was adopted from the Cyfrin Updraft Python and Viper Starter Kit:
+- [Cyfrin Updraft @cyfrinupdraft](https://updraft.cyfrin.io/courses/intermediate-python-vyper-smart-contract-development)
diff --git a/yarn.lock b/yarn.lock
index 24289ee3..695d316e 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -2964,9 +2964,9 @@ caniuse-api@^3.0.0:
     lodash.uniq "^4.5.0"
 
 caniuse-lite@^1.0.0, caniuse-lite@^1.0.30001587, caniuse-lite@^1.0.30001599:
-  version "1.0.30001617"
-  resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001617.tgz#809bc25f3f5027ceb33142a7d6c40759d7a901eb"
-  integrity sha512-mLyjzNI9I+Pix8zwcrpxEbGlfqOkF9kM3ptzmKNw5tizSyYwMe+nGLTqMK9cO+0E+Bh6TsBxNAaHWEM8xwSsmA==
+  version "1.0.30001686"
+  resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001686.tgz"
+  integrity sha512-Y7deg0Aergpa24M3qLC5xjNklnKnhsmSyR/V89dLZ1n0ucJIFNs7PgR2Yfa/Zf6W79SbBicgtGxZr2juHkEUIA==
 
 ccount@^2.0.0:
   version "2.0.1"