feat: bundled improvements (#45)

Author: swift1337

README.md

@@ -3,11 +3,7 @@
 Contracts of official protocol contracts deployed by the core ZetaChain team to facilitate cross-chain
 operations using TON (The Open Network) and other chains.
 
-## Supported operations
-
-- `deposit` - deposit TON to the Gateway contract
-- `deposit_and_call` - deposit TON to the Gateway contract and call a contract on the EVM side
-- `withdraw` - withdraw TON from the Gateway contract
+[Contracts Documentation](./docs/gateway.md)
 
 ## ⚠️ Important Notice
 
@@ -76,6 +72,7 @@ Currently, a dedicated authority address is used `state::authority_address`
 - `update_tss` - update TSS public key
 - `update_code` - upgrade the contract code
 - `update_authority` - update the authority TON address
+- ...
 
 ### Withdrawals
 

contracts/gateway.fc

@@ -18,21 +18,29 @@ const size::call_data::max = 2048 * 8; ;; 2 Kilobytes of call data
 const op::internal::donate = 100;
 const op::internal::deposit = 101;
 const op::internal::deposit_and_call = 102;
+const op::internal::call = 103;
 
+;; tss ops
 const op::external::withdraw = 200;
+const op::external::increase_seqno = 205;
 
+;; authority ops
 const op::authority::set_deposits_enabled = 201;
 const op::authority::update_tss = 202;
 const op::authority::update_code = 203;
 const op::authority::update_authority = 204;
+const op::authority::reset_seqno = 206;
 
 ;; GAS FEES =========================================
-;; These constants are empirically determined based on tests
-;; and slighly bumped to cover all other non-gas fees (e.g. storage, fwd_fee, etc.)
+;; IMPORTANT: These constants are empirically determined based on tests
+;; and slightly bumped to cover all other non-gas fees (e.g. storage, fwd_fee, etc.)
 const gas::deposit = 10000;
 const gas::deposit_and_call = 13000;
+const gas::call = 10000;
+
 const gas::authority = 20000;
-const gas::withdraw = 17500;
+
+const gas::external = 17500;
 
 ;; PARSING =========================================
 
@@ -146,6 +154,30 @@ const gas::withdraw = 17500;
     send_log_message(log);
 }
 
+;; handles zeta's onCall method by ensuring call_data size and gas costs are covered;
+;;
+;; NOTE that this operation DOESN'T rebate sent amount if it's bigger than tx fee!
+;; We can consider sending surplus amount back in the future improvements.
+;; For now, send amount that is equal to calculate_gas_fee(op::call)
+() handle_call(int amount, slice in_msg_body) impure inline {
+    load_state();
+    guard_deposits();
+
+    throw_if(error::invalid_evm_recipient, in_msg_body.slice_bits() < size::evm_address);
+    in_msg_body~load_uint(size::evm_address);
+
+    throw_if(error::invalid_call_data, in_msg_body.slice_refs_empty?());
+    cell call_data = in_msg_body~load_ref();
+    guard_cell_size(call_data, size::call_data::max, error::invalid_call_data);
+
+    int tx_fee = get_gas_fee_workchain(gas::call);
+    throw_if(error::insufficient_value, amount < tx_fee);
+
+    ;; state::total_locked is NOT changed.
+
+    mutate_state();
+}
+
 ;; Enables or disables deposits.
 () handle_set_deposits_enabled(slice sender, slice message) impure inline {
     load_state();
@@ -184,6 +216,20 @@ const gas::withdraw = 17500;
     mutate_state();
 }
 
+;; Resets the seqno to the specified value
+;; handles reset_seqno (uint32 new_seqno)
+() handle_reset_seqno(slice sender, slice message) impure inline {
+    load_state();
+
+    guard_authority_sender(sender);
+
+    int new_seqno = message~load_uint(size::seqno);
+
+    state::seqno = new_seqno;
+
+    mutate_state();
+}
+
 () handle_update_authority(slice sender, slice message) impure inline {
     load_state();
 
@@ -235,6 +281,10 @@ const gas::withdraw = 17500;
         return handle_deposit_and_call(msg_value, in_msg_body);
     }
 
+    if (op == op::internal::call) {
+        return handle_call(msg_value, in_msg_body);
+    }
+
     int tx_fee_authority = get_gas_fee_workchain(gas::authority);
     throw_if(error::insufficient_value, msg_value < tx_fee_authority);
 
@@ -250,6 +300,10 @@ const gas::withdraw = 17500;
         return handle_update_code(sender, in_msg_body);
     }
 
+    if (op == op::authority::reset_seqno) {
+        return handle_reset_seqno(sender, in_msg_body);
+    }
+
     if (op == op::authority::update_authority) {
         return handle_update_authority(sender, in_msg_body);
     }
@@ -285,7 +339,7 @@ cell auth::ecdsa::external(slice message, slice expected_evm_address) inline {
 
 ;; Withdraws assets to the recipient
 ;;
-;; handle_withdrawal (MsgAddr recipient, Coins amount, int seqno)
+;; handle_withdrawal (MsgAddr recipient, Coins amount, uint32 seqno)
 () handle_withdrawal(slice payload) impure inline {
     ;; load the body
     slice recipient = payload~load_msg_addr();
@@ -300,7 +354,7 @@ cell auth::ecdsa::external(slice message, slice expected_evm_address) inline {
     throw_if(error::insufficient_value, amount == 0);
     throw_if(error::invalid_seqno, seqno != state::seqno);
 
-    int tx_fee = get_gas_fee_workchain(gas::withdraw);
+    int tx_fee = get_gas_fee_workchain(gas::external);
 
     ;; edge-case: make sure gw has enough coins when having low funds
     throw_if(error::insufficient_value, state::total_locked < (amount + tx_fee));
@@ -311,14 +365,41 @@ cell auth::ecdsa::external(slice message, slice expected_evm_address) inline {
     state::total_locked -= (amount + tx_fee);
     state::seqno += 1;
 
+    ;; Sent TON and mutate the state
     mutate_state();
     commit();
 
-    ;; Sent TON and mutate the state
     int send_mode = message::flag::pay_fees_separately;
     send_simple_message_non_bounceable(recipient_addr, amount, send_mode);
 }
 
+;; Increases seqno by 1 without doing any other operations.
+;; handle_increase_seqno (uint32 failure_reason, uint32 seqno)
+() handle_increase_seqno(slice payload) impure inline {
+    ;; load the body
+    int increase_reason = payload~load_uint(size::seqno);
+
+    ;; note that increase_reason is an arbitrary number defined by the protocol
+    ;; and is used to identify the reason for the increase (via parsing input message OR debug logs)
+    ~strdump("increase_reason");
+    increase_reason~dump();
+
+    int seqno = payload~load_uint(size::seqno);
+
+    throw_if(error::invalid_seqno, seqno != state::seqno);
+
+    int tx_fee = get_gas_fee_workchain(gas::external);
+    throw_if(error::insufficient_value, state::total_locked < tx_fee);
+
+    ;; accept the message, the contract agrees to pay gas fees
+    accept_message();
+
+    state::total_locked -= tx_fee;
+    state::seqno += 1;
+
+    mutate_state();
+}
+
 ;; Entry point for all external messages
 () recv_external(slice message) impure {
     load_state();
@@ -331,6 +412,10 @@ cell auth::ecdsa::external(slice message, slice expected_evm_address) inline {
         return handle_withdrawal(payload);
     }
 
+    if (op == op::external::increase_seqno) {
+        return handle_increase_seqno(payload);
+    }
+
     throw(error::unknown_op);
 }
 
@@ -353,7 +438,7 @@ cell auth::ecdsa::external(slice message, slice expected_evm_address) inline {
     );
 }
 
-;; get nonce (int32)
+;; get seqno [nonce] (int32)
 int seqno() method_id {
     load_state();
 
@@ -370,17 +455,25 @@ int calculate_gas_fee(int op) method_id {
         return get_gas_fee_workchain(gas::deposit_and_call);
     }
 
+    if (op == op::internal::call) {
+        return get_gas_fee_workchain(gas::call);
+    }
+
     int is_authority_op = (op == op::authority::set_deposits_enabled)
     | (op == op::authority::update_tss)
     | (op == op::authority::update_code)
-    | (op == op::authority::update_authority);
+    | (op == op::authority::update_authority)
+    | (op == op::authority::reset_seqno);
 
     if (is_authority_op) {
         return get_gas_fee_workchain(gas::authority);
     }
 
-    if (op == op::external::withdraw) {
-        return get_gas_fee_workchain(gas::withdraw);
+    int is_external_op = (op == op::external::withdraw)
+    | (op == op::external::increase_seqno);
+
+    if (is_external_op) {
+        return get_gas_fee_workchain(gas::external);
     }
 
     throw(error::unknown_op);

crypto/ecdsa.ts

@@ -1,14 +1,33 @@
 import { beginCell, Cell, Slice } from '@ton/core';
 import { ethers } from 'ethers';
 
+// Arbitrary signer
+export type Signer = (hash: Buffer) => { v: number; r: string; s: string };
+
+/**
+ * Creates a signer from an ethers.js wallet
+ * @param wallet - ethers.js wallet
+ * @returns Signer
+ */
+export function signerFromEthersWallet(wallet: ethers.Wallet): Signer {
+    return (hash: Buffer) => {
+        const sig = wallet.signingKey.sign(hash);
+
+        return {
+            v: Number(sig.v),
+            r: sig.r,
+            s: sig.s,
+        };
+    };
+}
+
 /**
  * Signs a cell with secp256k1 signature into a Slice (65 bytes)
  * @param signer
  * @param cell
  */
-export function ecdsaSignCell(signer: ethers.Wallet, cell: Cell): Slice {
-    const hash = cell.hash();
-    const sig = signer.signingKey.sign(hash);
+export function ecdsaSignCell(signer: Signer, cell: Cell): Slice {
+    const sig = signer(cell.hash());
 
     // https://docs.ton.org/learn/tvm-instructions/instructions
     //

docs/gateway.md

@@ -4,14 +4,17 @@
 
 ### Constants
 
--   **op::internal::donate** = 100
--   **op::internal::deposit** = 101
--   **op::internal::deposit_and_call** = 102
--   **op::external::withdraw** = 200
--   **op::authority::set_deposits_enabled** = 201
--   **op::authority::update_tss** = 202
--   **op::authority::update_code** = 203
--   **op::authority::update_authority** = 204
+- **op::internal::donate** = 100
+- **op::internal::deposit** = 101
+- **op::internal::deposit_and_call** = 102
+- **op::internal::call** = 103
+- **op::external::withdraw** = 200
+- **op::external::increase_seqno** = 205
+- **op::authority::set_deposits_enabled** = 201
+- **op::authority::update_tss** = 202
+- **op::authority::update_code** = 203
+- **op::authority::update_authority** = 204
+- **op::authority::reset_seqno** = 206
 
 ### `handle_deposit`
 
@@ -21,6 +24,18 @@
 
 Deposit TON to the gateway and specify the EVM recipient on ZetaChain
 
+### `handle_call`
+
+```func
+() handle_call(int amount, slice in_msg_body) impure inline {
+```
+
+Handles zeta's onCall method by ensuring call_data size and gas costs are covered;
+
+NOTE that this operation DOESN'T rebate sent amount if it's bigger than tx fee!
+We can consider sending surplus amount back in the future improvements.
+For now, send amount that is equal to calculate_gas_fee(op::call)
+
 ### `handle_set_deposits_enabled`
 
 ```func
@@ -47,6 +62,15 @@ Wrong TSS address leads to loss of funds.
 Updated the code of the contract
 Handle_code_update (cell new_code)
 
+### `handle_reset_seqno`
+
+```func
+() handle_reset_seqno(slice sender, slice message) impure inline {
+```
+
+Resets the seqno to the specified value
+Handles reset_seqno (uint32 new_seqno)
+
 ### `recv_internal`
 
 ```func
@@ -63,7 +87,16 @@ Input for all internal messages
 
 Withdraws assets to the recipient
 
-Handle_withdrawal (MsgAddr recipient, Coins amount, int seqno)
+Handle_withdrawal (MsgAddr recipient, Coins amount, uint32 seqno)
+
+### `handle_increase_seqno`
+
+```func
+() handle_increase_seqno(slice payload) impure inline {
+```
+
+Increases seqno by 1 without doing any other operations.
+Handle_increase_seqno (uint32 failure_reason, uint32 seqno)
 
 ### `recv_external`
 

package.json

@@ -32,6 +32,9 @@
         "typescript": "^5.5.3"
     },
     "dependencies": {
+        "@ton/core": "~0",
+        "@ton/crypto": "^3.2.0",
+        "@ton/ton": "^15.1.0",
         "ethers": "^6.13.2"
     },
     "packageManager": "[email protected]+sha1.1959a18351b811cdeedbd484a8f86c3cc3bbaf72"