Merge pull request #1919 from mintlayer/orders_v1_in_wasm_bindings

Orders V1 support in wasm bindings

Author: ImplOfAnImpl

common/src/chain/config/builder.rs

@@ -49,24 +49,51 @@ use super::{
     MagicBytes,
 };
 
-// The fork at which we upgrade consensus to dis-incentivize large pools + enable tokens v1
-const TESTNET_FORK_HEIGHT_1_TOKENS_V1_AND_CONSENSUS_UPGRADE: BlockHeight = BlockHeight::new(78_440);
-// The fork at which we upgrade chainstate to distribute reward to staker proportionally to their balance
-// and change various tokens fees
-const TESTNET_FORK_HEIGHT_2_STAKER_REWARD_AND_TOKENS_FEE: BlockHeight = BlockHeight::new(138_244);
-// The fork at which txs with htlc outputs become valid, data deposit fee and size, max future block time offset changed
-const TESTNET_FORK_HEIGHT_3_HTLC_AND_DATA_DEPOSIT_FEE: BlockHeight = BlockHeight::new(297_550);
-// The fork at which order outputs become valid
+// Note: the names of the "FORK_HEIGHT" constants below only contain the short description
+// of the most prominent change that happens at that height, which serves as the "proper name"
+// for the fork.
+
+// The fork at which we:
+// * enable tokens v1;
+// * upgrade consensus to PoSConsensusVersion::V1 to dis-incentivize large pools.
+const TESTNET_FORK_HEIGHT_1_TOKENS_V1: BlockHeight = BlockHeight::new(78_440);
+
+// The fork at which we:
+// * upgrade chainstate to RewardDistributionVersion::V1 to distribute reward to the staker
+// proportionally to their balance;
+// * change various tokens fees.
+const TESTNET_FORK_HEIGHT_2_STAKER_REWARD_DISTRIBUTION: BlockHeight = BlockHeight::new(138_244);
+
+// The fork at which:
+// * txs with htlc outputs become valid;
+// * data deposit fee and size are changed;
+// * token metadata uri change is allowed;
+// * max future block time offset is changed.
+const TESTNET_FORK_HEIGHT_3_HTLC: BlockHeight = BlockHeight::new(297_550);
+
+// The fork at which:
+// * order outputs become valid;
+// * frozen token validation logic is changed to FrozenTokensValidationVersion::V1.
 const TESTNET_FORK_HEIGHT_4_ORDERS: BlockHeight = BlockHeight::new(325_180);
-// The fork at which we enable orders v1 and prohibit updating the staker destination in ProduceBlockFromStake.
-const TESTNET_FORK_HEIGHT_5_ORDERS_V1_AND_STAKER_DESTINATION_UPDATE_PROHIBITION: BlockHeight =
-    BlockHeight::new(999_999_999);
 
-// The fork at which txs with htlc and orders outputs become valid
+// The fork at which we:
+// * enable orders v1;
+// * enable token id generation v1;
+// * prohibit updating the staker destination in ProduceBlockFromStake.
+const TESTNET_FORK_HEIGHT_5_ORDERS_V1: BlockHeight = BlockHeight::new(999_999_999);
+
+// The fork at which:
+// * txs with htlc and order outputs become valid;
+// * data deposit fee and size are changed;
+// * token metadata uri change is allowed;
+// * frozen token validation logic is changed to FrozenTokensValidationVersion::V1.
 const MAINNET_FORK_HEIGHT_1_HTLC_AND_ORDERS: BlockHeight = BlockHeight::new(254_740);
-// The fork at which we enable orders v1 and prohibit updating the staker destination in ProduceBlockFromStake.
-const MAINNET_FORK_HEIGHT_2_ORDERS_V1_AND_STAKER_DESTINATION_UPDATE_PROHIBITION: BlockHeight =
-    BlockHeight::new(999_999_999);
+
+// The fork at which we:
+// * enable orders v1;
+// * enable token id generation v1;
+// * prohibit updating the staker destination in ProduceBlockFromStake.
+const MAINNET_FORK_HEIGHT_2_ORDERS_V1: BlockHeight = BlockHeight::new(999_999_999);
 
 impl ChainType {
     fn default_genesis_init(&self) -> GenesisBlockInit {
@@ -151,7 +178,7 @@ impl ChainType {
                         },
                     ),
                     (
-                        TESTNET_FORK_HEIGHT_1_TOKENS_V1_AND_CONSENSUS_UPGRADE,
+                        TESTNET_FORK_HEIGHT_1_TOKENS_V1,
                         ConsensusUpgrade::PoS {
                             initial_difficulty: None,
                             config: PoSChainConfig::new(
@@ -193,15 +220,12 @@ impl ChainType {
                     .htlc_activated(HtlcActivated::Yes)
                     .orders_activated(OrdersActivated::Yes)
             })
-            .then(
-                MAINNET_FORK_HEIGHT_2_ORDERS_V1_AND_STAKER_DESTINATION_UPDATE_PROHIBITION,
-                |builder| {
-                    builder
-                        .orders_version(OrdersVersion::V1)
-                        .staker_destination_update_forbidden(StakerDestinationUpdateForbidden::Yes)
-                        .token_id_generation_version(TokenIdGenerationVersion::V1)
-                },
-            )
+            .then(MAINNET_FORK_HEIGHT_2_ORDERS_V1, |builder| {
+                builder
+                    .orders_version(OrdersVersion::V1)
+                    .staker_destination_update_forbidden(StakerDestinationUpdateForbidden::Yes)
+                    .token_id_generation_version(TokenIdGenerationVersion::V1)
+            })
             .build(),
             ChainType::Regtest | ChainType::Signet => {
                 let upgrades = vec![(
@@ -235,19 +259,18 @@ impl ChainType {
                 StakerDestinationUpdateForbidden::No,
                 TokenIdGenerationVersion::V0,
             ))
+            .then(TESTNET_FORK_HEIGHT_1_TOKENS_V1, |builder| {
+                builder.token_issuance_version(TokenIssuanceVersion::V1)
+            })
             .then(
-                TESTNET_FORK_HEIGHT_1_TOKENS_V1_AND_CONSENSUS_UPGRADE,
-                |builder| builder.token_issuance_version(TokenIssuanceVersion::V1),
-            )
-            .then(
-                TESTNET_FORK_HEIGHT_2_STAKER_REWARD_AND_TOKENS_FEE,
+                TESTNET_FORK_HEIGHT_2_STAKER_REWARD_DISTRIBUTION,
                 |builder| {
                     builder
                         .reward_distribution_version(RewardDistributionVersion::V1)
                         .tokens_fee_version(TokensFeeVersion::V1)
                 },
             )
-            .then(TESTNET_FORK_HEIGHT_3_HTLC_AND_DATA_DEPOSIT_FEE, |builder| {
+            .then(TESTNET_FORK_HEIGHT_3_HTLC, |builder| {
                 builder
                     .data_deposit_fee_version(DataDepositFeeVersion::V1)
                     .change_token_metadata_uri_activated(ChangeTokenMetadataUriActivated::Yes)
@@ -258,15 +281,12 @@ impl ChainType {
                     .frozen_tokens_validation_version(FrozenTokensValidationVersion::V1)
                     .orders_activated(OrdersActivated::Yes)
             })
-            .then(
-                TESTNET_FORK_HEIGHT_5_ORDERS_V1_AND_STAKER_DESTINATION_UPDATE_PROHIBITION,
-                |builder| {
-                    builder
-                        .orders_version(OrdersVersion::V1)
-                        .staker_destination_update_forbidden(StakerDestinationUpdateForbidden::Yes)
-                        .token_id_generation_version(TokenIdGenerationVersion::V1)
-                },
-            )
+            .then(TESTNET_FORK_HEIGHT_5_ORDERS_V1, |builder| {
+                builder
+                    .orders_version(OrdersVersion::V1)
+                    .staker_destination_update_forbidden(StakerDestinationUpdateForbidden::Yes)
+                    .token_id_generation_version(TokenIdGenerationVersion::V1)
+            })
             .build(),
         }
     }
@@ -661,23 +681,20 @@ mod tests {
         {
             let config = Builder::new(ChainType::Testnet).build();
 
-            let before_the_fork = BlockHeight::new(
-                rng.gen_range(0..TESTNET_FORK_HEIGHT_3_HTLC_AND_DATA_DEPOSIT_FEE.into_int()),
-            );
+            let before_the_fork =
+                BlockHeight::new(rng.gen_range(0..TESTNET_FORK_HEIGHT_3_HTLC.into_int()));
             assert_eq!(
                 DEFAULT_MAX_FUTURE_BLOCK_TIME_OFFSET_V1,
                 config.max_future_block_time_offset(before_the_fork)
             );
 
             assert_eq!(
                 DEFAULT_MAX_FUTURE_BLOCK_TIME_OFFSET_V2,
-                config
-                    .max_future_block_time_offset(TESTNET_FORK_HEIGHT_3_HTLC_AND_DATA_DEPOSIT_FEE)
+                config.max_future_block_time_offset(TESTNET_FORK_HEIGHT_3_HTLC)
             );
 
-            let after_the_fork = BlockHeight::new(
-                rng.gen_range(TESTNET_FORK_HEIGHT_3_HTLC_AND_DATA_DEPOSIT_FEE.into_int()..u64::MAX),
-            );
+            let after_the_fork =
+                BlockHeight::new(rng.gen_range(TESTNET_FORK_HEIGHT_3_HTLC.into_int()..u64::MAX));
             assert_eq!(
                 DEFAULT_MAX_FUTURE_BLOCK_TIME_OFFSET_V2,
                 config.max_future_block_time_offset(after_the_fork)
@@ -749,7 +766,7 @@ mod tests {
                         ),
                     ),
                     (
-                        MAINNET_FORK_HEIGHT_2_ORDERS_V1_AND_STAKER_DESTINATION_UPDATE_PROHIBITION,
+                        MAINNET_FORK_HEIGHT_2_ORDERS_V1,
                         ChainstateUpgrade::new(
                             TokenIssuanceVersion::V1,
                             RewardDistributionVersion::V1,
@@ -793,7 +810,7 @@ mod tests {
                         ),
                     ),
                     (
-                        TESTNET_FORK_HEIGHT_1_TOKENS_V1_AND_CONSENSUS_UPGRADE,
+                        TESTNET_FORK_HEIGHT_1_TOKENS_V1,
                         ChainstateUpgrade::new(
                             TokenIssuanceVersion::V1,
                             RewardDistributionVersion::V0,
@@ -809,7 +826,7 @@ mod tests {
                         ),
                     ),
                     (
-                        TESTNET_FORK_HEIGHT_2_STAKER_REWARD_AND_TOKENS_FEE,
+                        TESTNET_FORK_HEIGHT_2_STAKER_REWARD_DISTRIBUTION,
                         ChainstateUpgrade::new(
                             TokenIssuanceVersion::V1,
                             RewardDistributionVersion::V1,
@@ -825,7 +842,7 @@ mod tests {
                         ),
                     ),
                     (
-                        TESTNET_FORK_HEIGHT_3_HTLC_AND_DATA_DEPOSIT_FEE,
+                        TESTNET_FORK_HEIGHT_3_HTLC,
                         ChainstateUpgrade::new(
                             TokenIssuanceVersion::V1,
                             RewardDistributionVersion::V1,
@@ -857,7 +874,7 @@ mod tests {
                         ),
                     ),
                     (
-                        TESTNET_FORK_HEIGHT_5_ORDERS_V1_AND_STAKER_DESTINATION_UPDATE_PROHIBITION,
+                        TESTNET_FORK_HEIGHT_5_ORDERS_V1,
                         ChainstateUpgrade::new(
                             TokenIssuanceVersion::V1,
                             RewardDistributionVersion::V1,

wasm-wrappers/WASM-API.md

@@ -366,10 +366,22 @@ Given ask and give amounts and a conclude key create output that creates an orde
 Given an amount to fill an order (which is described in terms of ask currency) and a destination
 for result outputs create an input that fills the order.
 
+Note: the nonce is only needed before the orders V1 fork activation. After the fork the nonce is
+ignored and any value can be passed for the parameter.
+
+### Function: `encode_input_for_freeze_order`
+
+Given an order id create an input that freezes the order.
+
+Note: order freezing is available only after the orders V1 fork activation.
+
 ### Function: `encode_input_for_conclude_order`
 
 Given an order id create an input that concludes the order.
 
+Note: the nonce is only needed before the orders V1 fork activation. After the fork the nonce is
+ignored and any value can be passed for the parameter.
+
 ### Enum: `Network`
 
 The network, for which an operation to be done. Mainnet, testnet, etc.

wasm-wrappers/js-bindings/wasm_test.js

@@ -38,6 +38,7 @@ import {
   extract_htlc_secret,
   encode_create_order_output,
   encode_input_for_fill_order,
+  encode_input_for_freeze_order,
   encode_input_for_conclude_order,
   SignatureHashType,
   encode_input_for_withdraw_from_delegation,
@@ -66,12 +67,14 @@ import {
   encode_input_for_change_token_metadata_uri,
 } from "../pkg/wasm_wrappers.js";
 
+// Taken from TESTNET_FORK_HEIGHT_5_ORDERS_V1 in common/src/chain/config/builder.rs.
+// This will be updated to the actual height after we choose one.
+const ORDERS_V1_TESTNET_FORK_HEIGHT = 999999999;
+
 function assert_eq_arrays(arr1, arr2) {
-  assert(arr1.length == arr2.length, "array lengths are different");
+  const equal = arr1.length == arr2.length && arr1.every((value, index) => value == arr2[index]);
 
-  arr1.forEach((elem, idx) => {
-    assert(elem == arr2[idx], `element at index ${idx} is different`);
-  });
+  assert(equal, `array1 [${arr1}] differs from array2 [${arr2}]`);
 }
 
 function assert(condition, message) {
@@ -962,14 +965,20 @@ export async function run_test() {
     console.log("create order tokens for coins encoding ok");
 
     const order_id = "tordr1xxt0avjtt4flkq0tnlyphmdm4aaj9vmkx5r2m4g863nw3lgf7nzs7mlkqc";
-    const fill_order_input = encode_input_for_fill_order(
+    // Note: the exact heights don't matter as long as they are at the "correct side" of the fork.
+    const order_v0_height = Math.floor(Math.random() * ORDERS_V1_TESTNET_FORK_HEIGHT);
+    const order_v1_height = order_v0_height + ORDERS_V1_TESTNET_FORK_HEIGHT;
+    // Note: the nonce is ignored since orders v1.
+    const order_v1_nonce = Math.floor(Math.random() * 1000000);
+    const fill_order_v0_input = encode_input_for_fill_order(
       order_id,
       Amount.from_atoms("40000"),
       address,
       BigInt(1),
+      BigInt(order_v0_height),
       Network.Testnet
     );
-    const expected_fill_order_input = [
+    const expected_fill_order_v0_input = [
       2, 4, 7, 49, 150, 254, 178, 75, 93, 83, 251,
       1, 235, 159, 200, 27, 237, 187, 175, 123, 34, 179,
       118, 53, 6, 173, 213, 7, 212, 102, 232, 253, 9,
@@ -978,24 +987,94 @@ export async function run_test() {
       103, 207, 80, 217, 178
     ];
 
-    assert_eq_arrays(fill_order_input, expected_fill_order_input);
-    console.log("fill order encoding ok");
+    assert_eq_arrays(fill_order_v0_input, expected_fill_order_v0_input);
+    console.log("fill order v0 encoding ok");
 
-    const conclude_order_input = encode_input_for_conclude_order(
+    const fill_order_v1_input = encode_input_for_fill_order(
+      order_id,
+      Amount.from_atoms("40000"),
+      address,
+      BigInt(order_v1_nonce),
+      BigInt(order_v1_height),
+      Network.Testnet
+    );
+    const expected_fill_order_v1_input = [
+      3, 0, 49, 150, 254, 178, 75, 93,
+      83, 251, 1, 235, 159, 200, 27, 237,
+      187, 175, 123, 34, 179, 118, 53, 6,
+      173, 213, 7, 212, 102, 232, 253, 9,
+      244, 197, 2, 113, 2, 0, 1, 91,
+      58, 110, 176, 100, 207, 6, 194, 41,
+      193, 30, 91, 4, 195, 202, 103, 207,
+      80, 217, 178
+    ];
+
+    assert_eq_arrays(fill_order_v1_input, expected_fill_order_v1_input);
+    console.log("fill order v1 encoding ok");
+
+    const conclude_order_v0_input = encode_input_for_conclude_order(
       order_id,
       BigInt(1),
+      BigInt(order_v0_height),
       Network.Testnet
     );
-    const expected_conclude_order_input = [
+    const expected_conclude_order_v0_input = [
       2, 4, 6, 49, 150, 254, 178, 75,
       93, 83, 251, 1, 235, 159, 200, 27,
       237, 187, 175, 123, 34, 179, 118, 53,
       6, 173, 213, 7, 212, 102, 232, 253,
       9, 244, 197
     ];
 
-    assert_eq_arrays(conclude_order_input, expected_conclude_order_input);
-    console.log("conclude order encoding ok");
+    assert_eq_arrays(conclude_order_v0_input, expected_conclude_order_v0_input);
+    console.log("conclude order v0 encoding ok");
+
+    const conclude_order_v1_input = encode_input_for_conclude_order(
+      order_id,
+      BigInt(order_v1_nonce),
+      BigInt(order_v1_height),
+      Network.Testnet
+    );
+    const expected_conclude_order_v1_input = [
+      3, 2, 49, 150, 254, 178, 75, 93,
+      83, 251, 1, 235, 159, 200, 27, 237,
+      187, 175, 123, 34, 179, 118, 53, 6,
+      173, 213, 7, 212, 102, 232, 253, 9,
+      244, 197
+    ];
+
+    assert_eq_arrays(conclude_order_v1_input, expected_conclude_order_v1_input);
+    console.log("conclude order v1 encoding ok");
+
+    const freeze_order_input = encode_input_for_freeze_order(
+      order_id,
+      BigInt(order_v1_height),
+      Network.Testnet
+    );
+    const expected_freeze_order_input = [
+      3, 1, 49, 150, 254, 178, 75, 93,
+      83, 251, 1, 235, 159, 200, 27, 237,
+      187, 175, 123, 34, 179, 118, 53, 6,
+      173, 213, 7, 212, 102, 232, 253, 9,
+      244, 197
+    ];
+
+    assert_eq_arrays(freeze_order_input, expected_freeze_order_input);
+    console.log("freeze order encoding ok");
+
+    try {
+      encode_input_for_freeze_order(
+        order_id,
+        BigInt(order_v0_height),
+        Network.Testnet
+      );
+      throw new Error("Freezing an order before v1 worked somehow!");
+    } catch (e) {
+      if (!e.includes("Orders V1 not activated")) {
+        throw e;
+      }
+      console.log("Tested order freezing before v1 successfully");
+    }
 
     try {
       const invalid_inputs = "invalid inputs";