Sui Escrow Vault + More Unit Tests

sui/escrow_vault/Move.lock

@@ -0,0 +1,60 @@
+# @generated by Move, please check-in and do not edit manually.
+
+[move]
+version = 3
+manifest_digest = "22A69063EDA69DCB6B671D6EDC8D98E83EEF216DBCDC2A034C6AB69DEF967BB4"
+deps_digest = "397E6A9F7A624706DBDFEE056CE88391A15876868FD18A88504DA74EB458D697"
+dependencies = [
+  { id = "Bridge", name = "Bridge" },
+  { id = "MoveStdlib", name = "MoveStdlib" },
+  { id = "Sui", name = "Sui" },
+  { id = "SuiSystem", name = "SuiSystem" },
+  { id = "ibc", name = "ibc" },
+]
+
+[[move.package]]
+id = "Bridge"
+source = { git = "https://github.com/MystenLabs/sui.git", rev = "db951a5ea6b125f6253a6b7f436ddba46eb0feb3", subdir = "crates/sui-framework/packages/bridge" }
+
+dependencies = [
+  { id = "MoveStdlib", name = "MoveStdlib" },
+  { id = "Sui", name = "Sui" },
+  { id = "SuiSystem", name = "SuiSystem" },
+]
+
+[[move.package]]
+id = "MoveStdlib"
+source = { git = "https://github.com/MystenLabs/sui.git", rev = "db951a5ea6b125f6253a6b7f436ddba46eb0feb3", subdir = "crates/sui-framework/packages/move-stdlib" }
+
+[[move.package]]
+id = "Sui"
+source = { git = "https://github.com/MystenLabs/sui.git", rev = "db951a5ea6b125f6253a6b7f436ddba46eb0feb3", subdir = "crates/sui-framework/packages/sui-framework" }
+
+dependencies = [
+  { id = "MoveStdlib", name = "MoveStdlib" },
+]
+
+[[move.package]]
+id = "SuiSystem"
+source = { git = "https://github.com/MystenLabs/sui.git", rev = "db951a5ea6b125f6253a6b7f436ddba46eb0feb3", subdir = "crates/sui-framework/packages/sui-system" }
+
+dependencies = [
+  { id = "MoveStdlib", name = "MoveStdlib" },
+  { id = "Sui", name = "Sui" },
+]
+
+[[move.package]]
+id = "ibc"
+source = { local = "../ibc" }
+
+dependencies = [
+  { id = "Bridge", name = "Bridge" },
+  { id = "MoveStdlib", name = "MoveStdlib" },
+  { id = "Sui", name = "Sui" },
+  { id = "SuiSystem", name = "SuiSystem" },
+]
+
+[move.toolchain-version]
+compiler-version = "1.55.0"
+edition = "2024.beta"
+flavor = "sui"

sui/escrow_vault/Move.toml

@@ -0,0 +1,14 @@
+[package]
+edition = "2024.beta"
+name    = "escrow_vault"
+
+[dependencies]
+ibc = { local = "../ibc" }
+
+[addresses]
+escrow_vault = "0x0"
+ibc          = "0x0"
+
+[dev-addresses]
+escrow_vault = "0x2222"
+ibc          = "0x1111"

sui/escrow_vault/sources/escrow_vault.move

@@ -0,0 +1,258 @@
+// License text copyright (c) 2020 MariaDB Corporation Ab, All Rights Reserved.
+// "Business Source License" is a trademark of MariaDB Corporation Ab.
+
+// Parameters
+
+// Licensor:             Union.fi, Labs Inc.
+// Licensed Work:        All files under https://github.com/unionlabs/union's sui subdirectory                      
+//                       The Licensed Work is (c) 2024 Union.fi, Labs Inc.
+// Change Date:          Four years from the date the Licensed Work is published.
+// Change License:       Apache-2.0
+// 
+
+// For information about alternative licensing arrangements for the Licensed Work,
+// please contact [email protected].
+
+// Notice
+
+// Business Source License 1.1
+
+// Terms
+
+// The Licensor hereby grants you the right to copy, modify, create derivative
+// works, redistribute, and make non-production use of the Licensed Work. The
+// Licensor may make an Additional Use Grant, above, permitting limited production use.
+
+// Effective on the Change Date, or the fourth anniversary of the first publicly
+// available distribution of a specific version of the Licensed Work under this
+// License, whichever comes first, the Licensor hereby grants you rights under
+// the terms of the Change License, and the rights granted in the paragraph
+// above terminate.
+
+// If your use of the Licensed Work does not comply with the requirements
+// currently in effect as described in this License, you must purchase a
+// commercial license from the Licensor, its affiliated entities, or authorized
+// resellers, or you must refrain from using the Licensed Work.
+
+// All copies of the original and modified Licensed Work, and derivative works
+// of the Licensed Work, are subject to this License. This License applies
+// separately for each version of the Licensed Work and the Change Date may vary
+// for each version of the Licensed Work released by Licensor.
+
+// You must conspicuously display this License on each original or modified copy
+// of the Licensed Work. If you receive the Licensed Work in original or
+// modified form from a third party, the terms and conditions set forth in this
+// License apply to your use of that work.
+
+// Any use of the Licensed Work in violation of this License will automatically
+// terminate your rights under this License for the current and all other
+// versions of the Licensed Work.
+
+// This License does not grant you any right in any trademark or logo of
+// Licensor or its affiliates (provided that you may use a trademark or logo of
+// Licensor as expressly required by this License).
+
+// TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+// AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+// EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+// TITLE.
+
+module escrow_vault::escrow_vault {
+    use sui::bcs;
+    use sui::table::{Self, Table};
+    use sui::object_bag::{Self, ObjectBag};
+    use sui::coin::{Self, Coin};
+    use std::type_name;
+
+    const E_UNAUTHORIZED: u64 = 1;
+    const E_INVALID_PACKET_HASH: u64 = 2;
+    const E_INTENT_WHITELISTED_ONLY: u64 = 3;
+    const E_BASE_AMOUNT_MUST_COVER_QUOTE_AMOUNT: u64 = 4;
+    const E_INVALID_QUOTE_TOKEN: u64 = 6;
+    const E_ONLY_MAKER: u64 = 0xdeadc0de;
+
+    public struct EscrowVault has key {
+        id: UID,
+        admin: address,
+        coin_bag: ObjectBag,
+        intent_whitelists: Table<IntentWhitelistKey, bool>,
+        fungible_counterparties: Table<FungibleLane, FungibleCounterparty>,
+    }
+
+    public struct ZkgmCap has key, store {
+        id: UID
+    }
+
+    public struct FungibleLane has copy, drop, store {
+        token: vector<u8>,
+        path: u256,
+        channel: u32,
+        base_token: vector<u8>,
+    }
+
+    public struct FungibleCounterparty has copy, drop, store {
+        beneficiary: vector<u8>
+    }
+
+    public struct IntentWhitelistKey has copy, drop, store {
+        token: vector<u8>,
+        packet_hash: vector<u8>,
+    }
+
+    fun init(ctx: &mut TxContext) {
+        transfer::transfer(
+            ZkgmCap {
+                id: object::new(ctx)
+            },
+            ctx.sender()
+        );
+        transfer::share_object(EscrowVault {
+            id: object::new(ctx),
+            admin: ctx.sender(),
+            coin_bag: object_bag::new(ctx),
+            intent_whitelists: table::new(ctx),
+            fungible_counterparties: table::new(ctx),
+        });
+    }
+
+    public fun set_fungible_counterparty<T>(
+        vault: &mut EscrowVault,
+        path: u256,
+        channel: u32,
+        base_token: vector<u8>,
+        beneficiary: vector<u8>,
+        ctx: &mut TxContext,
+    ) {
+        assert!(vault.admin == ctx.sender(), E_UNAUTHORIZED);
+
+        vault.fungible_counterparties.add(
+            FungibleLane {
+                token: type_name::get<T>().into_string().into_bytes(),
+                path,
+                channel,
+                base_token
+            },
+            FungibleCounterparty {
+                beneficiary
+            }
+        );
+    }
+
+    public fun whitelist_intent<T>(
+        vault: &mut EscrowVault,
+        packet_hashes: vector<vector<u8>>,
+        whitelist: bool,
+        ctx: &mut TxContext,
+    ) {
+        assert!(vault.admin == ctx.sender(), E_UNAUTHORIZED);
+
+        packet_hashes.do!(|hash| {
+            assert!(hash.length() == 32, E_INVALID_PACKET_HASH);
+
+            let whitelist_key = IntentWhitelistKey {
+                token: type_name::get<T>().into_string().into_bytes(),
+                packet_hash: hash
+            };
+
+            if (vault.intent_whitelists.contains(whitelist_key)) {
+                if (!whitelist) {
+                    let _ = vault.intent_whitelists.remove(whitelist_key);
+                };
+            } else {
+                vault.intent_whitelists.add(whitelist_key, true);
+            };
+        });
+    }
+
+    public fun solve<T>(
+        vault: &mut EscrowVault,
+        _: &ZkgmCap,
+        packet: ibc::packet::Packet,
+        base_token: vector<u8>,
+        quote_token: vector<u8>,
+        base_amount: u256,
+        quote_amount: u256,
+        receiver: vector<u8>,
+        path: u256,
+        relayer: address,
+        _relayer_msg: vector<u8>,
+        intent: bool,
+        ctx: &mut TxContext,
+    ): (vector<u8>, u64) {
+        if (type_name::get<T>().into_string().into_bytes() != quote_token) {
+            return (vector::empty(), E_INVALID_QUOTE_TOKEN)
+        };
+
+        if (intent) {
+            let packet_hash = ibc::commitment::commit_packet(&packet);
+            if (!vault.intent_whitelists.contains(IntentWhitelistKey {
+                token: quote_token,
+                packet_hash
+            })) {
+                return (vector::empty(), E_INTENT_WHITELISTED_ONLY)
+            };
+        };
+
+        let fungibility = FungibleLane {
+            token: quote_token,
+            path,
+            channel: packet.destination_channel_id(),
+            base_token,
+        };
+
+        if (!vault.fungible_counterparties.contains(fungibility)) {
+            return (vector::empty(), E_ONLY_MAKER)
+        };
+
+        let counterparty_beneficiary = vault.fungible_counterparties.borrow(fungibility).beneficiary;       
+
+        if (quote_amount > base_amount) {
+            return (vector::empty(), E_BASE_AMOUNT_MUST_COVER_QUOTE_AMOUNT)
+        };
+
+        let (base_amount, quote_amount) = (base_amount, quote_amount);
+
+        let fee = base_amount - quote_amount;
+        if (fee > 0) {
+            vault.unescrow<T>(fee as u64, relayer, ctx);
+        };
+
+        if (quote_amount > 0) {
+            let receiver = bcs::new(receiver).peel_address();
+            vault.unescrow<T>(fee as u64, receiver, ctx);
+        };
+
+        (counterparty_beneficiary, 0)
+    }
+
+    fun unescrow<T>(
+        vault: &mut EscrowVault,
+        amount: u64,
+        recipient: address,
+        ctx: &mut TxContext
+    ) {        
+        let coin: &mut Coin<T> = vault.coin_bag.borrow_mut(type_name::get<T>());
+        let coin = coin.split<T>(amount, ctx);
+        transfer::public_transfer(coin, recipient);
+    }
+
+    public fun escrow<T>(
+        vault: &mut EscrowVault,
+        _: &ZkgmCap,
+        coin: Coin<T>,
+    ) {        
+        let key = type_name::get<T>();
+        if (vault.coin_bag.contains(key)) {
+            let self_coin: &mut Coin<T> = vault.coin_bag.borrow_mut(key);
+            coin::join(self_coin, coin)
+        } else{
+            vault.coin_bag.add(key, coin)
+        }
+    }
+
+    #[test_only]
+    public fun init_for_tests(ctx: &mut TxContext) {
+        init(ctx);
+    } 
+}

sui/ibc/Move.lock

@@ -2,7 +2,7 @@
 
 [move]
 version = 3
-manifest_digest = "3E8A3117790F554B149DB37E9C96C2B3D833769E367372EC672B41846C878E5D"
+manifest_digest = "E61644EDE4644CB2BBEBF2A871578979BAD6FCE235435C5807618BDB3B11F423"
 deps_digest = "F9B494B64F0615AED0E98FC12A85B85ECD2BC5185C22D30E7F67786BB52E507C"
 dependencies = [
   { id = "Bridge", name = "Bridge" },
@@ -43,7 +43,7 @@ dependencies = [
 ]
 
 [move.toolchain-version]
-compiler-version = "1.58.1"
+compiler-version = "1.55.0"
 edition = "2024.beta"
 flavor = "sui"
 

sui/ibc/Move.toml

@@ -1,41 +1,9 @@
 [package]
-edition      = "2024.beta"                                                          # edition = "legacy" to use legacy (pre-2024) Move
-name         = "ibc"
-published-at = "0xf36048b090671467af3d6a6109403d179aaa0a699307ff9df218b893b8f6bd98"
-# original = 0xf7afcb48d53dcd8f1b75bd73779a23fb80e0750e3db7a9fd7e59fe22bb7cd7d4
-# license = ""           # e.g., "MIT", "GPL", "Apache 2.0"
-# authors = ["..."]      # e.g., ["Joe Smith ([email protected])", "John Snow ([email protected])"]
-
-[dependencies]
-# Sui = { git = "https://github.com/MystenLabs/sui.git", subdir = "crates/sui-framework/packages/sui-framework", rev = "framework/testnet" }
-
-# For remote import, use the `{ git = "...", subdir = "...", rev = "..." }`.
-# Revision can be a branch, a tag, and a commit hash.
-# MyRemotePackage = { git = "https://some.remote/host.git", subdir = "remote/path", rev = "main" }
-
-# For local dependencies use `local = path`. Path is relative to the package root
-# Local = { local = "../path/to" }
-
-# To resolve a version conflict and force a specific version for dependency
-# override use `override = true`
-# Override = { local = "../conflicting/version", override = true }
+edition = "2024.beta"
+name    = "ibc"
 
 [addresses]
 ibc = "_"
 
-# ibc = "_"
-
-# Named addresses will be accessible in Move as `@name`. They're also exported:
-# for example, `std = "0x1"` is exported by the Standard Library.
-# alice = "0xA11CE"
-
-[dev-dependencies]
-# The dev-dependencies section allows overriding dependencies for `--test` and
-# `--dev` modes. You can introduce test-only dependencies here.
-# Local = { local = "../path/to/dev-build" }
-
 [dev-addresses]
-ibc = "0x22222"
-# The dev-addresses section allows overwriting named addresses for the `--test`
-# and `--dev` modes.
-# alice = "0xB0B"
+ibc = "0x1111"