On chain claim

Cargo.toml

@@ -51,6 +51,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/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,15 @@
+[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.45.1"
+
+[dev-dependencies.multiversx-sc-scenario]
+version = "0.45.1"

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,28 @@
+WALLET="${PWD}/wallet.pem"
+PROJECT="${PWD}"
+PROXY=https://devnet-gateway.multiversx.com
+CHAINID=D
+
+DEPLOY_GAS="25000000"
+SFT_IDENTIFIER=0x585354525245504149522d653162363733 #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-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}"
+}

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="25000000"
+SFT_IDENTIFIER=0x585354525245504149522d653162363733 #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 = [ "you",]
+
+[dev-dependencies]
+
+[dependencies.on-chain-claim]
+path = ".."
+
+[dependencies.multiversx-sc-meta]
+version = "0.45.1"
+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,24 @@
+multiversx_sc::imports!();
+multiversx_sc::derive_imports!();
+
+#[derive(NestedEncode, NestedDecode, TopEncode, TopDecode, TypeAbi)]
+pub struct AddressInfo {
+    pub current_streak: u64,
+    pub last_epoch_claimed: u64,
+    pub total_epochs_claimed: u64,
+}
+
+impl AddressInfo {
+    #[inline]
+    pub fn new(
+        current_streak: u64,
+        last_epoch_claimed: u64,
+        total_epochs_claimed: u64,
+    ) -> Self {
+        AddressInfo {
+            current_streak,
+            last_epoch_claimed,
+            total_epochs_claimed,
+        }
+    }
+}

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

@@ -0,0 +1,30 @@
+multiversx_sc::imports!();
+multiversx_sc::derive_imports!();
+
+use crate::address_info::*;
+
+pub const SFT_AMOUNT: u64 = 1;
+pub const MAX_REPAIR_GAP: u64 = 2;
+
+#[multiversx_sc::module]
+pub trait ConfigModule {
+    #[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();
+
+        address_info.last_epoch_claimed + 2 == self.blockchain().get_block_epoch()
+    }
+
+    #[view(getAddressInfo)]
+    #[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>;
+}

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

@@ -0,0 +1,113 @@
+#![no_std]
+#![allow(unused_attributes)]
+
+pub use address_info::AddressInfo;
+
+multiversx_sc::imports!();
+multiversx_sc::derive_imports!();
+
+pub mod address_info;
+pub mod config;
+
+use crate::config::{SFT_AMOUNT, MAX_REPAIR_GAP};
+
+/// An empty contract. To be used as a template when starting a new contract from scratch.
+#[multiversx_sc::contract]
+pub trait OnChainClaimContract:
+    config::ConfigModule {
+    #[init]
+    fn init(
+        &self, 
+        repair_streak_token_id: TokenIdentifier, 
+    ) {
+        self.repair_streak_token_identifier()
+            .set(repair_streak_token_id);
+    }
+
+    #[endpoint(claim)]
+    fn claim(&self) {
+        let caller = self.blockchain().get_caller();
+        require!(
+            !self.blockchain().is_smart_contract(&caller),
+            "Only user accounts can perform claim"
+        );
+
+        let current_epoch = self.blockchain().get_block_epoch();
+
+        let address_info_mapper = self.address_info(&caller);
+        if address_info_mapper.is_empty() {
+            let address_info = AddressInfo::new(1, current_epoch, 1);
+            self.address_info(&caller).set(address_info);
+            return;
+        }
+
+        address_info_mapper.update(|address_info| {
+            require!(
+                address_info.last_epoch_claimed < current_epoch,
+                "epoch already claimed"
+            );
+
+            if address_info.last_epoch_claimed + 1 == current_epoch {
+                address_info.current_streak += 1;
+            } else {
+                address_info.current_streak = 1;
+            }
+
+            address_info.total_epochs_claimed += 1;
+            address_info.last_epoch_claimed = current_epoch;
+        });
+    }
+
+    #[payable("*")]
+    #[endpoint(claimAndRepair)]
+    fn claim_and_repair(&self) {
+        let caller = self.blockchain().get_caller();
+        require!(
+            !self.blockchain().is_smart_contract(&caller),
+            "Only user accounts can perform claim and repair"
+        );
+        let payment = self.call_value().single_esdt();
+        let repair_streak_token_identifier = self.repair_streak_token_identifier().get();
+        require!(
+            payment.token_identifier == repair_streak_token_identifier,
+            "Bad payment token"
+        );
+        require!(payment.amount == SFT_AMOUNT, "Bad payment amount");
+
+        let current_epoch = self.blockchain().get_block_epoch();
+
+        let address_info_mapper = self.address_info(&caller);
+
+        require!(!address_info_mapper.is_empty(), "can't repair streak for address");
+
+        address_info_mapper.update(|address_info| {
+            require!(
+                address_info.last_epoch_claimed + MAX_REPAIR_GAP == current_epoch, 
+                "can't repair streak for current epoch"
+            );
+
+            address_info.current_streak += MAX_REPAIR_GAP;
+            address_info.total_epochs_claimed += MAX_REPAIR_GAP;
+            address_info.last_epoch_claimed = current_epoch;
+        });
+
+        self.send().esdt_local_burn(
+            &payment.token_identifier,
+            payment.token_nonce,
+            &payment.amount,
+        );
+    }
+
+    #[only_owner]
+    #[endpoint(updateState)]
+    fn update_state(
+        &self, 
+        address: &ManagedAddress,
+        current_streak: u64,
+        last_epoch_claimed: u64,
+        total_epochs_claimed: u64,
+    ) {
+        let address_info = AddressInfo::new(current_streak, last_epoch_claimed, total_epochs_claimed);
+        self.address_info(address).set(address_info);
+    }
+}