Merge pull request #44 from multiversx/on-chain-claim

On chain claim

Cargo.toml

@@ -53,6 +53,8 @@ members = [
   "contracts/nft-minter/meta",
   "contracts/nft-storage-prepay",
   "contracts/nft-storage-prepay/meta",
+  "contracts/on-chain-claim",
+  "contracts/on-chain-claim/meta",
   "contracts/order-book/factory",
   "contracts/order-book/factory/meta",
   "contracts/order-book/pair",

contracts/check-pause/wasm/src/lib.rs

@@ -10,7 +10,9 @@
 // Total number of exported functions:   6
 
 #![no_std]
-#![allow(internal_features)]
+
+// Configuration that works with rustc < 1.73.0.
+// TODO: Recommended rustc version: 1.73.0 or newer.
 #![feature(lang_items)]
 
 multiversx_sc_wasm_adapter::allocator!();

contracts/on-chain-claim/.gitignore

@@ -0,0 +1,10 @@
+# Generated by Cargo
+# will have compiled files and executables
+/target/
+*/target/
+
+# The mxpy output
+/output*/
+
+# Mandos test trace
+trace*.scen.json

contracts/on-chain-claim/Cargo.toml

@@ -0,0 +1,18 @@
+[package]
+name = "on-chain-claim"
+version = "0.0.0"
+authors = [ "Vlad Bucur <[email protected]>"]
+edition = "2021"
+publish = false
+
+[lib]
+path = "src/contract.rs"
+
+[dependencies.multiversx-sc]
+version = "0.46.0"
+
+[dependencies.multiversx-sc-modules]
+version = "0.46.0"
+
+[dev-dependencies.multiversx-sc-scenario]
+version = "0.46.0"

contracts/on-chain-claim/README.md

@@ -0,0 +1,3 @@
+# On Chain Claim
+
+`On Chain Claim` is a simple Smart Contract.

contracts/on-chain-claim/interaction/devnet.snippets.sh

@@ -0,0 +1,52 @@
+WALLET="${PWD}/wallet.pem"
+PROJECT="${PWD}"
+PROXY=https://devnet-gateway.multiversx.com
+CHAINID=D
+
+DEPLOY_GAS="25000000"
+SFT_IDENTIFIER=0x585354525245504149522d653162363733 #XSTRREPAIR-e1b673
+
+CONTRACT_ADDRESS="erd1qqqqqqqqqqqqqpgqkm3wla3wk0yqk7lk725wee8yh0e2zeru76ls3gr0nj"
+
+deploy() {
+    mxpy --verbose contract deploy \
+          --bytecode="output/on-chain-claim.wasm" \
+          --arguments ${SFT_IDENTIFIER} \
+          --pem=${WALLET} \
+          --gas-limit=${DEPLOY_GAS} \
+          --proxy=${PROXY} \
+          --chain=${CHAINID} \
+          --recall-nonce \
+          --send \
+          --outfile="deploy-devnet.interaction.json" || return
+
+    TRANSACTION=$(mxpy data parse --file="deploy-devnet.interaction.json" --expression="data['emittedTransactionHash']")
+    ADDRESS=$(mxpy data parse --file="deploy-devnet.interaction.json" --expression="data['contractAddress']")
+
+    mxpy data store --key=address-devnet --value=${ADDRESS}
+    mxpy data store --key=deployTransaction-devnet --value=${TRANSACTION}
+
+    echo ""
+    echo "Smart contract address: ${ADDRESS}"
+}
+
+upgrade() {
+    mxpy --verbose contract upgrade ${CONTRACT_ADDRESS} \
+          --bytecode="output/on-chain-claim.wasm" \
+          --pem=${WALLET} \
+          --gas-limit=${DEPLOY_GAS} \
+          --proxy=${PROXY} \
+          --chain=${CHAINID} \
+          --recall-nonce \
+          --send \
+          --outfile="upgrade-devnet.interaction.json" || return
+
+    TRANSACTION=$(mxpy data parse --file="upgrade-devnet.interaction.json" --expression="data['emittedTransactionHash']")
+    ADDRESS=$(mxpy data parse --file="upgrade-devnet.interaction.json" --expression="data['contractAddress']")
+
+    mxpy data store --key=address-devnet --value=${ADDRESS}
+    mxpy data store --key=upgradeTransaction-devnet --value=${TRANSACTION}
+
+    echo ""
+    echo "Smart contract address: ${ADDRESS}"
+}

contracts/on-chain-claim/interaction/mainnet.snippets.sh

@@ -0,0 +1,52 @@
+WALLET="${PWD}/wallet.pem"
+PROJECT="${PWD}"
+PROXY=https://gateway.multiversx.com
+CHAINID=D
+
+DEPLOY_GAS="30000000"
+SFT_IDENTIFIER=0x585354525245504149522d653162363733 #XSTRREPAIR-e1b673
+
+CONTRACT_ADDRESS="erd1qqqqqqqqqqqqqpgqkm3wla3wk0yqk7lk725wee8yh0e2zeru76ls3gr0nj"
+
+deploy() {
+    mxpy --verbose contract deploy \
+          --bytecode="output/on-chain-claim.wasm" \
+          --arguments ${SFT_IDENTIFIER} \
+          --pem=${WALLET} \
+          --gas-limit=${DEPLOY_GAS} \
+          --proxy=${PROXY} \
+          --chain=${CHAINID} \
+          --recall-nonce \
+          --send \
+          --outfile="deploy-mainnet.interaction.json" || return
+
+    TRANSACTION=$(mxpy data parse --file="deploy-mainnet.interaction.json" --expression="data['emittedTransactionHash']")
+    ADDRESS=$(mxpy data parse --file="deploy-mainnet.interaction.json" --expression="data['contractAddress']")
+
+    mxpy data store --key=address-mainnet --value=${ADDRESS}
+    mxpy data store --key=deployTransaction-mainnet --value=${TRANSACTION}
+
+    echo ""
+    echo "Smart contract address: ${ADDRESS}"
+}
+
+upgrade() {
+    mxpy --verbose contract upgrade ${CONTRACT_ADDRESS} \
+          --bytecode="output/on-chain-claim.wasm" \
+          --pem=${WALLET} \
+          --gas-limit=${DEPLOY_GAS} \
+          --proxy=${PROXY} \
+          --chain=${CHAINID} \
+          --recall-nonce \
+          --send \
+          --outfile="upgrade-mainnet.interaction.json" || return
+
+    TRANSACTION=$(mxpy data parse --file="upgrade-mainnet.interaction.json" --expression="data['emittedTransactionHash']")
+    ADDRESS=$(mxpy data parse --file="upgrade-mainnet.interaction.json" --expression="data['contractAddress']")
+
+    mxpy data store --key=address-mainnet --value=${ADDRESS}
+    mxpy data store --key=upgradeTransaction-mainnet --value=${TRANSACTION}
+
+    echo ""
+    echo "Smart contract address: ${ADDRESS}"
+}

contracts/on-chain-claim/interaction/testnet.snippets.sh

@@ -0,0 +1,28 @@
+WALLET="${PWD}/wallet.pem"
+PROJECT="${PWD}"
+PROXY=https://testnet-gateway.multiversx.com
+CHAINID=D
+
+DEPLOY_GAS="30000000"
+SFT_IDENTIFIER=0x54525245504149522d626435323730 #XSTRREPAIR-e1b673
+deploy() {
+    mxpy --verbose contract deploy \
+          --bytecode="output/on-chain-claim.wasm" \
+          --arguments ${SFT_IDENTIFIER} \
+          --pem=${WALLET} \
+          --gas-limit=${DEPLOY_GAS} \
+          --proxy=${PROXY} \
+          --chain=${CHAINID} \
+          --recall-nonce \
+          --send \
+          --outfile="deploy-testnet.interaction.json" || return
+
+    TRANSACTION=$(mxpy data parse --file="deploy-testnet.interaction.json" --expression="data['emittedTransactionHash']")
+    ADDRESS=$(mxpy data parse --file="deploy-testnet.interaction.json" --expression="data['contractAddress']")
+
+    mxpy data store --key=address-testnet --value=${ADDRESS}
+    mxpy data store --key=deployTransaction-testnet --value=${TRANSACTION}
+
+    echo ""
+    echo "Smart contract address: ${ADDRESS}"
+}

contracts/on-chain-claim/meta/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "on-chain-claim-meta"
+version = "0.0.0"
+edition = "2018"
+publish = false
+authors = [ "Vlad Bucur <[email protected]>"]
+
+[dev-dependencies]
+
+[dependencies.on-chain-claim]
+path = ".."
+
+[dependencies.multiversx-sc-meta]
+version = "0.46.0"
+default-features = false

contracts/on-chain-claim/meta/src/main.rs

@@ -0,0 +1,3 @@
+fn main() {
+    multiversx_sc_meta::cli_main::<on_chain_claim::AbiProvider>();
+}

contracts/on-chain-claim/multiversx.json

@@ -0,0 +1,3 @@
+{
+    "language": "rust"
+}

contracts/on-chain-claim/mxsc-template.toml

@@ -0,0 +1,19 @@
+name = "on-chain-claim"
+contract_trait = "OnChainClaim"
+src_file = "contract.rs"
+rename_pairs = [
+    [
+        "blockchain.set_current_dir_from_workspace(\"contracts/examples/on-chain-claim\");",
+        "// blockchain.set_current_dir_from_workspace(\"relative path to your workspace, if applicable\");",
+    ],
+]
+files_include = [
+    "meta",
+    "scenarios",
+    "src",
+    "tests",
+    "wasm/Cargo.toml",
+    "Cargo.toml",
+    "README.md",
+    "multiversx.json",
+]

contracts/on-chain-claim/src/address_info.rs

@@ -0,0 +1,35 @@
+multiversx_sc::imports!();
+multiversx_sc::derive_imports!();
+
+#[derive(Default, NestedEncode, NestedDecode, TopEncode, TopDecode, TypeAbi)]
+pub struct AddressInfo {
+    pub current_streak: u64,
+    pub last_epoch_claimed: u64,
+    pub total_epochs_claimed: u64,
+    pub best_streak: u64,
+}
+
+impl AddressInfo {
+    pub fn new(
+        current_streak: u64,
+        last_epoch_claimed: u64,
+        total_epochs_claimed: u64,
+        best_streak: u64,
+    ) -> Self {
+        AddressInfo {
+            current_streak,
+            last_epoch_claimed,
+            total_epochs_claimed,
+            best_streak,
+        }
+    }
+
+    pub fn new_with_epoch(current_epoch: u64) -> Self {
+        AddressInfo {
+            current_streak: 1,
+            last_epoch_claimed: current_epoch,
+            total_epochs_claimed: 1,
+            best_streak: 1,
+        }
+    }
+}

contracts/on-chain-claim/src/config.rs

@@ -0,0 +1,58 @@
+multiversx_sc::imports!();
+multiversx_sc::derive_imports!();
+
+use crate::address_info::*;
+
+pub const SFT_AMOUNT: u64 = 1;
+pub const MAX_REPAIR_GAP: u64 = 5;
+
+#[multiversx_sc::module]
+pub trait ConfigModule {
+    fn require_same_shard(&self, address: &ManagedAddress) {
+        let address_shard = self.blockchain().get_shard_of_address(address);
+        let sc_address = self.blockchain().get_sc_address();
+        let sc_shard = self.blockchain().get_shard_of_address(&sc_address);
+
+        require!(address_shard == sc_shard, "wrong shard");
+    }
+
+    fn get_missed_epochs(&self, current_epoch: u64, last_epoch_claimed: u64) -> u64 {
+        if current_epoch <= last_epoch_claimed {
+            return 0;
+        }
+
+        current_epoch - last_epoch_claimed - 1
+    }
+
+    #[view(getAddressInfo)]
+    fn get_address_info(&self, address: &ManagedAddress) -> AddressInfo {
+        let address_info_mapper = self.address_info(address);
+
+        if address_info_mapper.is_empty() {
+            return AddressInfo::default();
+        }
+
+        address_info_mapper.get()
+    }
+
+    #[view(canBeRepaired)]
+    fn can_be_repaired(&self, address: &ManagedAddress) -> bool {
+        let address_info_mapper = self.address_info(address);
+        if address_info_mapper.is_empty() {
+            return false;
+        }
+
+        let address_info = address_info_mapper.get();
+        let current_epoch = self.blockchain().get_block_epoch();
+        let missed_epochs = self.get_missed_epochs(current_epoch, address_info.last_epoch_claimed);
+
+        missed_epochs > 0 && missed_epochs <= MAX_REPAIR_GAP
+    }
+
+    #[storage_mapper("address_info")]
+    fn address_info(&self, address: &ManagedAddress) -> SingleValueMapper<AddressInfo>;
+
+    #[view(getRepairStreakTokenIdentifier)]
+    #[storage_mapper("repair_streak_token_identifier")]
+    fn repair_streak_token_identifier(&self) -> SingleValueMapper<TokenIdentifier>;
+}