Merge pull request #43 from multiversx/composable-sc

Create Composable SC

Cargo.toml

@@ -8,6 +8,8 @@ members = [
   "locked-token-pos-creator/meta",
   "farm-extra-rewards-wrapper",
   "farm-extra-rewards-wrapper/meta",
+  "composable-tasks",
+  "composable-tasks/meta",
   "energy-dao",
   "energy-dao/meta",
   "tests-common"

auto-farm/src/lib.rs

@@ -69,7 +69,7 @@ pub trait AutoFarm:
             .set_if_empty(fees_collector_sc_address);
     }
 
-    #[endpoint]
+    #[upgrade]
     fn upgrade(&self) {}
 
     #[only_owner]

auto-pos-creator/Cargo.toml

@@ -72,13 +72,13 @@ rev = "b202319"
 
 [dependencies.multiversx-wegld-swap-sc]
 git = "https://github.com/multiversx/mx-contracts-rs/"
-rev = "ec189d2"
+rev = "7e6df3d"
 
 [dev-dependencies]
 num-bigint = "0.4.2"
 num-traits = "0.2"
 hex = "0.4"
-hex-literal = "0.3.4"
+hex-literal = "0.4.1"
 
 [dev-dependencies.multiversx-sc-scenario]
 version = "=0.45.2"

auto-pos-creator/src/lib.rs

@@ -30,6 +30,6 @@ pub trait AutoPosCreator:
         self.router_address().set(router_address);
     }
 
-    #[endpoint]
+    #[upgrade]
     fn upgrade(&self) {}
 }

composable-tasks/.gitignore

@@ -0,0 +1,7 @@
+# Generated by Cargo
+# will have compiled files and executables
+/target/
+*/target/
+
+# The mxpy output
+/output*/

composable-tasks/Cargo.toml

@@ -0,0 +1,43 @@
+[package]
+name = "composable-tasks"
+version = "0.0.0"
+authors = ["you"]
+edition = "2018"
+publish = false
+
+[lib]
+path = "src/lib.rs"
+
+[dev-dependencies]
+num-bigint = "0.4.2"
+
+[dev-dependencies.multiversx-sc-scenario]
+version = "0.45.2"
+
+[dev-dependencies.pausable]
+git = "https://github.com/multiversx/mx-exchange-sc"
+rev = "b202319"
+
+[dependencies.multiversx-sc]
+version = "0.45.2"
+features = ["back-transfers"]
+
+[dependencies.farm]
+git = "https://github.com/multiversx/mx-exchange-sc"
+rev = "b202319"
+
+[dependencies.farm-with-locked-rewards]
+git = "https://github.com/multiversx/mx-exchange-sc"
+rev = "b202319"
+
+[dependencies.pair]
+git = "https://github.com/multiversx/mx-exchange-sc"
+rev = "b202319"
+
+[dependencies.router]
+git = "https://github.com/multiversx/mx-exchange-sc"
+rev = "b202319"
+
+[dependencies.multiversx-wegld-swap-sc]
+git = "https://github.com/multiversx/mx-contracts-rs"
+rev = "7e6df3d"

composable-tasks/README.md

@@ -0,0 +1,63 @@
+# Composable Tasks SC
+
+## Overview
+
+This smart contract enables users to compose multiple actions while interacting with various Smart Contracts from MultiversX ecosystem, including xExchange.
+It streamlines the process of interacting with WrapEGld and xExchange and provides a convenient way to perform multiple actions in a single transaction on the blockchain.
+
+Complex actions are formed of multiple tasks. The tasks are performed synchronously, one after the other.
+Example of tasks:
+- wrapEGLD
+- unwrapEGLD
+- Swap
+- Send EGLD/ESDT to third party
+
+
+Example of actions:
+- Wrap EGLD & send to third party
+- Swap ESDT to wEGLD & unwrap to EGLD
+- Wrap EGLD & swap to ESDT & send to third party
+
+> **_Note:_** If the last task is **not** `Send tokens`, the resulted payment will be returned to the caller. Otherwise, the payment goes to the destination. 
+
+## Task Structure
+
+A task receives an `EgldOrEsdtPayment` and outputs one as well.
+The resulted `EgldOrEsdtPayment` is forwarded to the next task.
+If one task fails, the whole process will fail.
+
+The `composeTasks` endpoint:
+```
+    #[payable("*")]
+    #[endpoint(composeTasks)]
+    fn compose_tasks(
+        &self,
+        opt_dest_addr: OptionalValue<ManagedAddress>,
+        tasks: MultiValueEncoded<MultiValue2<TaskType, ManagedVec<ManagedBuffer>>>,
+    )
+```
+
+where `TaskType`:
+
+```
+pub enum TaskType {
+    WrapEGLD,
+    UnwrapEGLD,
+    Swap,
+    SendEsdt,
+}
+```
+
+
+> **_WARNING:_**  If you provide a wrong destination address, the payment will be sent there.
+
+Most of the tasks don't require arguments, but some do (like `Swap`). An example of calling `Swap` task:
+
+```
+                let mut swap_args = ManagedVec::new();
+                swap_args.push(managed_buffer!(TOKEN_ID));
+                swap_args.push(managed_buffer!(b"1"));
+
+                let mut tasks = MultiValueEncoded::new();
+                tasks.push((TaskType::Swap, swap_args).into());
+```

composable-tasks/meta/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "composable-tasks-meta"
+version = "0.0.0"
+edition = "2018"
+publish = false
+authors = ["you"]
+
+[dev-dependencies]
+
+[dependencies.composable-tasks]
+path = ".."
+
+[dependencies.multiversx-sc-meta]
+version = "0.45.2"
+default-features = false

composable-tasks/meta/src/main.rs

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

composable-tasks/multiversx.json

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

composable-tasks/mxsc-template.toml

@@ -0,0 +1,18 @@
+name = "empty"
+contract_trait = "EmptyContract"
+src_file = "empty.rs"
+rename_pairs = [
+    [
+        "blockchain.set_current_dir_from_workspace(\"contracts/examples/empty\");",
+        "// blockchain.set_current_dir_from_workspace(\"relative path to your workspace, if applicable\");",
+    ],
+]
+files_include = [
+    "meta",
+    "scenarios",
+    "src",
+    "tests",
+    "wasm/Cargo.toml",
+    "Cargo.toml",
+    "multiversx.json",
+]

composable-tasks/scenarios/empty.scen.json

@@ -0,0 +1,39 @@
+{
+    "name": "composable-tasks",
+    "steps": [
+        {
+            "step": "setState",
+            "accounts": {
+                "address:owner": {
+                    "nonce": "1",
+                    "balance": "0"
+                }
+            },
+            "newAddresses": [
+                {
+                    "creatorAddress": "address:owner",
+                    "creatorNonce": "1",
+                    "newAddress": "sc:empty"
+                }
+            ]
+        },
+        {
+            "step": "scDeploy",
+            "id": "deploy",
+            "tx": {
+                "from": "address:owner",
+                "contractCode": "file:../output/composable-tasks.wasm",
+                "arguments": [],
+                "gasLimit": "5,000,000",
+                "gasPrice": "0"
+            },
+            "expect": {
+                "out": [],
+                "status": "",
+                "logs": [],
+                "gas": "*",
+                "refund": "*"
+            }
+        }
+    ]
+}