Add support for Soroban external calls 🎉 (#1679)

This PR adds support for Soroban external calls. This is the first step
to support value transfers from inside Soroban contracts.

---------

Signed-off-by: salaheldinsoliman <salaheldin_sameh@aucegypt.edu>

Author: salaheldinsoliman

.github/workflows/test.yml

@@ -325,6 +325,8 @@ jobs:
       with:
         node-version: '16'
     - uses: dtolnay/rust-toolchain@1.81.0
+      with:
+        target: wasm32-unknown-unknown
     - uses: actions/download-artifact@v4.1.8
       with:
         name: solang-linux-x86-64
@@ -335,14 +337,17 @@ jobs:
         echo "$(pwd)/bin" >> $GITHUB_PATH
     
     - name: Install Soroban
-      run: cargo install --locked soroban-cli --version 22.0.0
+      run: cargo install --locked stellar-cli --version 22.0.0
     - name: Add cargo install location to PATH
       run: echo "$HOME/.cargo/bin" >> $GITHUB_PATH
     - run: npm install
       working-directory: ./integration/soroban
     - name: Build Solang contracts
       run: npm run build
       working-directory: ./integration/soroban
+    - name: Build rust contracts
+      run: soroban contract build --profile release-with-logs
+      working-directory: ./integration/soroban/rust/contracts
     - name: Setup Soroban enivronment
       run: npm run setup
       working-directory: ./integration/soroban

.gitignore

@@ -9,3 +9,5 @@ Cargo.lock
 
 .helix/
 .vscode/
+
+/test_snapshots

integration/soroban/.gitignore

@@ -6,4 +6,8 @@
 node_modules
 package-lock.json
 *.txt
-*.toml
+*.wasm
+*.abi
+target/
+.stellar
+

integration/soroban/callee.sol

@@ -0,0 +1,6 @@
+contract callee {
+    function add (uint64 a, uint64 b, uint64 c) public returns (uint64) {
+        print("add called in Solidity");
+        return a + b +c;
+    }
+}

integration/soroban/caller.sol

@@ -0,0 +1,8 @@
+contract caller {
+    function add (address addr, uint64 a, uint64 b, uint64 c) public returns (uint64) {
+        bytes payload = abi.encode("add", a, b, c);
+        (bool suc, bytes returndata) = addr.call(payload);
+        uint64 result = abi.decode(returndata, (uint64));
+        return result;
+    }
+}

integration/soroban/counter.spec.js

@@ -35,7 +35,8 @@ describe('Counter', () => {
   it('get correct initial counter', async () => {
     // get the count
     let count = await call_contract_function("count", server, keypair, contract);
-    expect(count.toString()).eq("10");
+    console.log(count.returnValue().value());
+    expect(count.returnValue().value().toString()).eq("10");
   });
 
   it('increment counter', async () => {
@@ -44,7 +45,7 @@ describe('Counter', () => {
 
     // get the count
     let count = await call_contract_function("count", server, keypair, contract);
-    expect(count.toString()).eq("11");
+    expect(count.returnValue().value().toString()).eq("11");
   });
 });
 

integration/soroban/cross_contract.spec.js

@@ -0,0 +1,65 @@
+import * as StellarSdk from '@stellar/stellar-sdk';
+import { readFileSync } from 'fs';
+import { expect } from 'chai';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { call_contract_function, extractLogEvent } from './test_helpers.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const dirname = path.dirname(__filename);
+const server = new StellarSdk.SorobanRpc.Server("https://soroban-testnet.stellar.org:443");
+
+function readContractAddress(filename) {
+  return readFileSync(path.join(dirname, '.soroban', 'contract-ids', filename), 'utf8').trim();
+}
+
+describe('Cross Contract Calls', () => {
+  let keypair, caller, callee, calleeRust;
+
+  before(async () => {
+    console.log('Setting up cross contract tests...');
+
+    keypair = StellarSdk.Keypair.fromSecret(readFileSync('alice.txt', 'utf8').trim());
+    caller = new StellarSdk.Contract(readContractAddress('caller.txt'));
+    callee = new StellarSdk.Contract(readContractAddress('callee.txt'));
+    calleeRust = new StellarSdk.Contract(readContractAddress('hello_world.txt'));
+  });
+
+  it('calls Rust contract', async () => {
+    let addr = calleeRust.address().toScVal();
+    let values = [
+      new StellarSdk.xdr.Uint64(BigInt(1)),
+      new StellarSdk.xdr.Uint64(BigInt(2)),
+      new StellarSdk.xdr.Uint64(BigInt(0))
+    ].map(StellarSdk.xdr.ScVal.scvU64);
+
+    let res = await call_contract_function("add", server, keypair, caller, addr, ...values);
+    let returnValue = res.returnValue().value().toString();
+
+    console.log(returnValue);
+    expect(returnValue).to.equal("3");
+
+    let logMessages = extractLogEvent(res.diagnosticEvents()).logMessages;
+    console.log(logMessages);
+    expect(logMessages[0]).to.contain('Soroban SDK add function called!');
+  });
+
+  it('calls Solidity contract', async () => {
+    let addr = callee.address().toScVal();
+    let values = [
+      new StellarSdk.xdr.Uint64(BigInt(1)),
+      new StellarSdk.xdr.Uint64(BigInt(2)),
+      new StellarSdk.xdr.Uint64(BigInt(0))
+    ].map(StellarSdk.xdr.ScVal.scvU64);
+
+    let res = await call_contract_function("add", server, keypair, caller, addr, ...values);
+    let returnValue = res.returnValue().value().toString();
+
+    console.log(returnValue);
+    expect(returnValue).to.equal("3");
+
+    let logMessages = extractLogEvent(res.diagnosticEvents()).logMessages;
+    console.log(logMessages);
+    expect(logMessages[0]).to.contain('add called in Solidity');
+  });
+});

integration/soroban/runtime_error.spec.js

@@ -35,7 +35,7 @@ describe('Runtime Error', () => {
     await call_contract_function("decrement", server, keypair, contract);
   });
 
-  it('get correct initial counter', async () => {
+  it('prints error', async () => {
 
     // decrement the counter again, resulting in a runtime error
     let res = await call_contract_function("decrement", server, keypair, contract);

integration/soroban/rust/Cargo.toml

@@ -0,0 +1,23 @@
+[workspace]
+resolver = "2"
+members = [
+  "contracts/*",
+]
+
+[workspace.dependencies]
+soroban-sdk = "22"
+
+[profile.release]
+opt-level = "z"
+overflow-checks = true
+debug = 0
+strip = "symbols"
+debug-assertions = false
+panic = "abort"
+codegen-units = 1
+lto = true
+
+# For more information about this profile see https://soroban.stellar.org/docs/basic-tutorials/logging#cargotoml-profile
+[profile.release-with-logs]
+inherits = "release"
+debug-assertions = true

integration/soroban/rust/contracts/hello-world/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "hello-world"
+version = "0.0.0"
+edition = "2021"
+publish = false
+
+[lib]
+crate-type = ["cdylib"]
+doctest = false
+
+[dependencies]
+soroban-sdk = { workspace = true }
+
+[dev-dependencies]
+soroban-sdk = { workspace = true, features = ["testutils"] }