feat: Add Tx hash to TransactionInfo and make it non exhaustive (#2480)

* feat: Add Tx checksum to TransactionInfo and make it non exhaustive

* chore: Use Binary instead of Checksum

* chore: Move impl_hidden_constructor macro to lib.rs

* chore: Update Changelog

* [autofix.ci] apply automated fixes

* chore: Move the macro to utils module

* Update CHANGELOG.md

Co-authored-by: Simon Warta <2603011+webmaster128@users.noreply.github.com>

* chore: Update after review

* [autofix.ci] apply automated fixes

* Update packages/vm/src/testing/mock.rs

Co-authored-by: Simon Warta <2603011+webmaster128@users.noreply.github.com>

* Update packages/vm/src/testing/mock.rs

Co-authored-by: Simon Warta <2603011+webmaster128@users.noreply.github.com>

* Update packages/std/src/testing/mock.rs

Co-authored-by: Simon Warta <2603011+webmaster128@users.noreply.github.com>

* Update packages/std/src/testing/mock.rs

Co-authored-by: Simon Warta <2603011+webmaster128@users.noreply.github.com>

* Update packages/std/src/types.rs

Co-authored-by: Simon Warta <2603011+webmaster128@users.noreply.github.com>

* Update packages/std/src/types.rs

Co-authored-by: Simon Warta <2603011+webmaster128@users.noreply.github.com>

* chore: Update after review

* [autofix.ci] apply automated fixes

* chore: Add test for hex encoding

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Simon Warta <2603011+webmaster128@users.noreply.github.com>

Author: 3 people

CHANGELOG.md

@@ -31,6 +31,8 @@ and this project adheres to
 - cosmwasm-std: Add support for `ibc2_packet_ack` endpoint ([#2474])
 - cosmwasm-std: Add `Ibc2PacketSendMsg` message - ([#2477])
 - cosmwasm-vm: Add `ibc2_packet_send` entrypoint ([#2477])
+- cosmwasm-std: Add Tx hash to TransactionInfo and make it non exhaustive
+  ([#2480])
 
 ## Changed
 
@@ -130,6 +132,7 @@ and this project adheres to
 [#2472]: https://github.com/CosmWasm/cosmwasm/pull/2472
 [#2473]: https://github.com/CosmWasm/cosmwasm/pull/2473
 [#2477]: https://github.com/CosmWasm/cosmwasm/pull/2477
+[#2480]: https://github.com/CosmWasm/cosmwasm/pull/2480
 
 ## [2.2.0] - 2024-12-17
 

contracts/cyberpunk/schema/cyberpunk.json

@@ -443,6 +443,10 @@
           "description": "A human readable address.\n\nIn Cosmos, this is typically bech32 encoded. But for multi-chain smart contracts no assumptions should be made other than being UTF-8 encoded and of reasonable length.\n\nThis type represents a validated address. It can be created in the following ways 1. Use `Addr::unchecked(input)` 2. Use `let checked: Addr = deps.api.addr_validate(input)?` 3. Use `let checked: Addr = deps.api.addr_humanize(canonical_addr)?` 4. Deserialize from JSON. This must only be done from JSON that was validated before such as a contract's state. `Addr` must not be used in messages sent by the user because this would result in unvalidated instances.\n\nThis type is immutable. If you really need to mutate it (Really? Are you sure?), create a mutable copy using `let mut mutable = Addr::to_string()` and operate on that `String` instance.",
           "type": "string"
         },
+        "Binary": {
+          "description": "Binary is a wrapper around Vec<u8> to add base64 de/serialization with serde. It also adds some helper methods to help encode inline.\n\nThis is only needed as serde-json-{core,wasm} has a horrible encoding for Vec<u8>. See also <https://github.com/CosmWasm/cosmwasm/blob/main/docs/MESSAGE_TYPES.md>.",
+          "type": "string"
+        },
         "BlockInfo": {
           "type": "object",
           "required": [
@@ -461,7 +465,7 @@
               "minimum": 0.0
             },
             "time": {
-              "description": "Absolute time of the block creation in seconds since the UNIX epoch (00:00:00 on 1970-01-01 UTC).\n\nThe source of this is the [BFT Time in Tendermint](https://github.com/tendermint/tendermint/blob/58dc1726/spec/consensus/bft-time.md), which has the same nanosecond precision as the `Timestamp` type.\n\n# Examples\n\nUsing chrono:\n\n``` # use cosmwasm_std::{Addr, BlockInfo, ContractInfo, Env, MessageInfo, Timestamp, TransactionInfo}; # let env = Env { #     block: BlockInfo { #         height: 12_345, #         time: Timestamp::from_nanos(1_571_797_419_879_305_533), #         chain_id: \"cosmos-testnet-14002\".to_string(), #     }, #     transaction: Some(TransactionInfo { index: 3 }), #     contract: ContractInfo { #         address: Addr::unchecked(\"contract\"), #     }, # }; # extern crate chrono; use chrono::NaiveDateTime; let seconds = env.block.time.seconds(); let nsecs = env.block.time.subsec_nanos(); let dt = NaiveDateTime::from_timestamp(seconds as i64, nsecs as u32); ```\n\nCreating a simple millisecond-precision timestamp (as used in JavaScript):\n\n``` # use cosmwasm_std::{Addr, BlockInfo, ContractInfo, Env, MessageInfo, Timestamp, TransactionInfo}; # let env = Env { #     block: BlockInfo { #         height: 12_345, #         time: Timestamp::from_nanos(1_571_797_419_879_305_533), #         chain_id: \"cosmos-testnet-14002\".to_string(), #     }, #     transaction: Some(TransactionInfo { index: 3 }), #     contract: ContractInfo { #         address: Addr::unchecked(\"contract\"), #     }, # }; let millis = env.block.time.nanos() / 1_000_000; ```",
+              "description": "Absolute time of the block creation in seconds since the UNIX epoch (00:00:00 on 1970-01-01 UTC).\n\nThe source of this is the [BFT Time in Tendermint](https://github.com/tendermint/tendermint/blob/58dc1726/spec/consensus/bft-time.md), which has the same nanosecond precision as the `Timestamp` type.\n\n# Examples\n\nUsing chrono:\n\n``` # use cosmwasm_std::{Addr, Binary, BlockInfo, ContractInfo, Env, MessageInfo, Timestamp, TransactionInfo}; # let env = Env { #     block: BlockInfo { #         height: 12_345, #         time: Timestamp::from_nanos(1_571_797_419_879_305_533), #         chain_id: \"cosmos-testnet-14002\".to_string(), #     }, #     transaction: Some(TransactionInfo::new(3, Binary::from_hex(\"E5469DACEC17CEF8A260FD37675ED87E7FB6A2B5AD95193C51308006C7E494B3\").unwrap())), #     contract: ContractInfo { #         address: Addr::unchecked(\"contract\"), #     }, # }; # extern crate chrono; use chrono::NaiveDateTime; let seconds = env.block.time.seconds(); let nsecs = env.block.time.subsec_nanos(); let dt = NaiveDateTime::from_timestamp(seconds as i64, nsecs as u32); ```\n\nCreating a simple millisecond-precision timestamp (as used in JavaScript):\n\n``` # use cosmwasm_std::{Addr, Binary, BlockInfo, ContractInfo, Env, MessageInfo, Timestamp, TransactionInfo}; # let env = Env { #     block: BlockInfo { #         height: 12_345, #         time: Timestamp::from_nanos(1_571_797_419_879_305_533), #         chain_id: \"cosmos-testnet-14002\".to_string(), #     }, #     transaction: Some(TransactionInfo::new(3, Binary::from_hex(\"E5469DACEC17CEF8A260FD37675ED87E7FB6A2B5AD95193C51308006C7E494B3\").unwrap())), #     contract: ContractInfo { #         address: Addr::unchecked(\"contract\"), #     }, # }; let millis = env.block.time.nanos() / 1_000_000; ```",
               "allOf": [
                 {
                   "$ref": "#/definitions/Timestamp"
@@ -497,6 +501,15 @@
             "index"
           ],
           "properties": {
+            "hash": {
+              "description": "Hash of the transaction.\n\nIf the blockchain's CosmWasm version is below 3.0, this field will default to being empty.",
+              "default": "",
+              "allOf": [
+                {
+                  "$ref": "#/definitions/Binary"
+                }
+              ]
+            },
             "index": {
               "description": "The position of this transaction in the block. The first transaction has index 0.\n\nThis allows you to get a unique transaction identifier in this chain using the pair (`env.block.height`, `env.transaction.index`).",
               "type": "integer",

contracts/cyberpunk/schema/raw/response_to_mirror_env.json

@@ -31,6 +31,10 @@
       "description": "A human readable address.\n\nIn Cosmos, this is typically bech32 encoded. But for multi-chain smart contracts no assumptions should be made other than being UTF-8 encoded and of reasonable length.\n\nThis type represents a validated address. It can be created in the following ways 1. Use `Addr::unchecked(input)` 2. Use `let checked: Addr = deps.api.addr_validate(input)?` 3. Use `let checked: Addr = deps.api.addr_humanize(canonical_addr)?` 4. Deserialize from JSON. This must only be done from JSON that was validated before such as a contract's state. `Addr` must not be used in messages sent by the user because this would result in unvalidated instances.\n\nThis type is immutable. If you really need to mutate it (Really? Are you sure?), create a mutable copy using `let mut mutable = Addr::to_string()` and operate on that `String` instance.",
       "type": "string"
     },
+    "Binary": {
+      "description": "Binary is a wrapper around Vec<u8> to add base64 de/serialization with serde. It also adds some helper methods to help encode inline.\n\nThis is only needed as serde-json-{core,wasm} has a horrible encoding for Vec<u8>. See also <https://github.com/CosmWasm/cosmwasm/blob/main/docs/MESSAGE_TYPES.md>.",
+      "type": "string"
+    },
     "BlockInfo": {
       "type": "object",
       "required": [
@@ -49,7 +53,7 @@
           "minimum": 0.0
         },
         "time": {
-          "description": "Absolute time of the block creation in seconds since the UNIX epoch (00:00:00 on 1970-01-01 UTC).\n\nThe source of this is the [BFT Time in Tendermint](https://github.com/tendermint/tendermint/blob/58dc1726/spec/consensus/bft-time.md), which has the same nanosecond precision as the `Timestamp` type.\n\n# Examples\n\nUsing chrono:\n\n``` # use cosmwasm_std::{Addr, BlockInfo, ContractInfo, Env, MessageInfo, Timestamp, TransactionInfo}; # let env = Env { #     block: BlockInfo { #         height: 12_345, #         time: Timestamp::from_nanos(1_571_797_419_879_305_533), #         chain_id: \"cosmos-testnet-14002\".to_string(), #     }, #     transaction: Some(TransactionInfo { index: 3 }), #     contract: ContractInfo { #         address: Addr::unchecked(\"contract\"), #     }, # }; # extern crate chrono; use chrono::NaiveDateTime; let seconds = env.block.time.seconds(); let nsecs = env.block.time.subsec_nanos(); let dt = NaiveDateTime::from_timestamp(seconds as i64, nsecs as u32); ```\n\nCreating a simple millisecond-precision timestamp (as used in JavaScript):\n\n``` # use cosmwasm_std::{Addr, BlockInfo, ContractInfo, Env, MessageInfo, Timestamp, TransactionInfo}; # let env = Env { #     block: BlockInfo { #         height: 12_345, #         time: Timestamp::from_nanos(1_571_797_419_879_305_533), #         chain_id: \"cosmos-testnet-14002\".to_string(), #     }, #     transaction: Some(TransactionInfo { index: 3 }), #     contract: ContractInfo { #         address: Addr::unchecked(\"contract\"), #     }, # }; let millis = env.block.time.nanos() / 1_000_000; ```",
+          "description": "Absolute time of the block creation in seconds since the UNIX epoch (00:00:00 on 1970-01-01 UTC).\n\nThe source of this is the [BFT Time in Tendermint](https://github.com/tendermint/tendermint/blob/58dc1726/spec/consensus/bft-time.md), which has the same nanosecond precision as the `Timestamp` type.\n\n# Examples\n\nUsing chrono:\n\n``` # use cosmwasm_std::{Addr, Binary, BlockInfo, ContractInfo, Env, MessageInfo, Timestamp, TransactionInfo}; # let env = Env { #     block: BlockInfo { #         height: 12_345, #         time: Timestamp::from_nanos(1_571_797_419_879_305_533), #         chain_id: \"cosmos-testnet-14002\".to_string(), #     }, #     transaction: Some(TransactionInfo::new(3, Binary::from_hex(\"E5469DACEC17CEF8A260FD37675ED87E7FB6A2B5AD95193C51308006C7E494B3\").unwrap())), #     contract: ContractInfo { #         address: Addr::unchecked(\"contract\"), #     }, # }; # extern crate chrono; use chrono::NaiveDateTime; let seconds = env.block.time.seconds(); let nsecs = env.block.time.subsec_nanos(); let dt = NaiveDateTime::from_timestamp(seconds as i64, nsecs as u32); ```\n\nCreating a simple millisecond-precision timestamp (as used in JavaScript):\n\n``` # use cosmwasm_std::{Addr, Binary, BlockInfo, ContractInfo, Env, MessageInfo, Timestamp, TransactionInfo}; # let env = Env { #     block: BlockInfo { #         height: 12_345, #         time: Timestamp::from_nanos(1_571_797_419_879_305_533), #         chain_id: \"cosmos-testnet-14002\".to_string(), #     }, #     transaction: Some(TransactionInfo::new(3, Binary::from_hex(\"E5469DACEC17CEF8A260FD37675ED87E7FB6A2B5AD95193C51308006C7E494B3\").unwrap())), #     contract: ContractInfo { #         address: Addr::unchecked(\"contract\"), #     }, # }; let millis = env.block.time.nanos() / 1_000_000; ```",
           "allOf": [
             {
               "$ref": "#/definitions/Timestamp"
@@ -85,6 +89,15 @@
         "index"
       ],
       "properties": {
+        "hash": {
+          "description": "Hash of the transaction.\n\nIf the blockchain's CosmWasm version is below 3.0, this field will default to being empty.",
+          "default": "",
+          "allOf": [
+            {
+              "$ref": "#/definitions/Binary"
+            }
+          ]
+        },
         "index": {
           "description": "The position of this transaction in the block. The first transaction has index 0.\n\nThis allows you to get a unique transaction identifier in this chain using the pair (`env.block.height`, `env.transaction.index`).",
           "type": "integer",

packages/std/src/binary.rs

@@ -69,6 +69,15 @@ impl Binary {
         out.copy_from_slice(&self.0);
         Ok(out)
     }
+
+    pub fn from_hex(input: &str) -> StdResult<Self> {
+        let binary = hex::decode(input).map_err(StdError::invalid_hex)?;
+        Ok(Self(binary))
+    }
+
+    pub fn to_hex(&self) -> String {
+        hex::encode(&self.0)
+    }
 }
 
 impl fmt::Display for Binary {
@@ -593,4 +602,20 @@ mod tests {
         assert_ne!(a, [0x11, 0x22]);
         assert_ne!([0x11, 0x22], a);
     }
+
+    #[test]
+    fn hex_encoding_works() {
+        let hash = "722c8c993fd75a7627d69ed941344fe2a1423a3e75efd3e6778a142884227104";
+        let parsed = Binary::from_hex(hash).unwrap();
+        assert_eq!(parsed.to_hex(), hash);
+
+        // invalid hex
+        let odd_num_of_digits = "722c8c993fd75a7627d69ed941344fe2a1423a3e75efd3e6778a142884227";
+        assert!(Binary::from_hex(odd_num_of_digits).is_err());
+        let invalid_char = "722c8c993fd75a7627d69ed941344fe2a1423a3e75efd3e6778a1428842271g4";
+        assert!(Binary::from_hex(invalid_char).is_err());
+        let hex_prefix_unexpected =
+            "0x722c8c993fd75a7627d69ed941344fe2a1423a3e75efd3e6778a142884227104";
+        assert!(Binary::from_hex(hex_prefix_unexpected).is_err());
+    }
 }

packages/std/src/lib.rs

@@ -41,6 +41,7 @@ mod stdack;
 mod timestamp;
 mod traits;
 mod types;
+mod utils;
 
 /// This module is to simplify no_std imports
 pub(crate) mod prelude;

packages/std/src/query/bank.rs

@@ -9,6 +9,7 @@ use crate::PageRequest;
 use crate::{Binary, DenomMetadata};
 
 use super::query_response::QueryResponseType;
+use crate::utils::impl_hidden_constructor;
 
 #[non_exhaustive]
 #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
@@ -41,7 +42,7 @@ pub struct SupplyResponse {
     pub amount: Coin,
 }
 
-impl_response_constructor!(SupplyResponse, amount: Coin);
+impl_hidden_constructor!(SupplyResponse, amount: Coin);
 
 impl QueryResponseType for SupplyResponse {}
 
@@ -54,7 +55,7 @@ pub struct BalanceResponse {
     pub amount: Coin,
 }
 
-impl_response_constructor!(BalanceResponse, amount: Coin);
+impl_hidden_constructor!(BalanceResponse, amount: Coin);
 
 impl QueryResponseType for BalanceResponse {}
 
@@ -66,7 +67,7 @@ pub struct DenomMetadataResponse {
     pub metadata: DenomMetadata,
 }
 
-impl_response_constructor!(DenomMetadataResponse, metadata: DenomMetadata);
+impl_hidden_constructor!(DenomMetadataResponse, metadata: DenomMetadata);
 
 impl QueryResponseType for DenomMetadataResponse {}
 
@@ -79,7 +80,7 @@ pub struct AllDenomMetadataResponse {
     pub next_key: Option<Binary>,
 }
 
-impl_response_constructor!(
+impl_hidden_constructor!(
     AllDenomMetadataResponse,
     metadata: Vec<DenomMetadata>,
     next_key: Option<Binary>

packages/std/src/query/distribution.rs

@@ -5,6 +5,7 @@ use crate::prelude::*;
 use crate::{Addr, Decimal256};
 
 use super::query_response::QueryResponseType;
+use crate::utils::impl_hidden_constructor;
 
 #[non_exhaustive]
 #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
@@ -34,7 +35,7 @@ pub struct DelegatorWithdrawAddressResponse {
     pub withdraw_address: Addr,
 }
 
-impl_response_constructor!(DelegatorWithdrawAddressResponse, withdraw_address: Addr);
+impl_hidden_constructor!(DelegatorWithdrawAddressResponse, withdraw_address: Addr);
 impl QueryResponseType for DelegatorWithdrawAddressResponse {}
 
 /// See <https://github.com/cosmos/cosmos-sdk/blob/c74e2887b0b73e81d48c2f33e6b1020090089ee0/proto/cosmos/distribution/v1beta1/query.proto#L169-L178>
@@ -45,7 +46,7 @@ pub struct DelegationRewardsResponse {
     pub rewards: Vec<DecCoin>,
 }
 
-impl_response_constructor!(DelegationRewardsResponse, rewards: Vec<DecCoin>);
+impl_hidden_constructor!(DelegationRewardsResponse, rewards: Vec<DecCoin>);
 impl QueryResponseType for DelegationRewardsResponse {}
 
 /// A coin type with decimal amount.
@@ -85,7 +86,7 @@ pub struct DelegationTotalRewardsResponse {
     pub total: Vec<DecCoin>,
 }
 
-impl_response_constructor!(
+impl_hidden_constructor!(
     DelegationTotalRewardsResponse,
     rewards: Vec<DelegatorReward>,
     total: Vec<DecCoin>
@@ -98,7 +99,7 @@ pub struct DelegatorReward {
     pub validator_address: String,
     pub reward: Vec<DecCoin>,
 }
-impl_response_constructor!(
+impl_hidden_constructor!(
     DelegatorReward,
     validator_address: String,
     reward: Vec<DecCoin>
@@ -111,5 +112,5 @@ pub struct DelegatorValidatorsResponse {
     pub validators: Vec<String>,
 }
 
-impl_response_constructor!(DelegatorValidatorsResponse, validators: Vec<String>);
+impl_hidden_constructor!(DelegatorValidatorsResponse, validators: Vec<String>);
 impl QueryResponseType for DelegatorValidatorsResponse {}

packages/std/src/query/ibc.rs

@@ -4,6 +4,8 @@ use serde::{Deserialize, Serialize};
 use crate::ibc::IbcChannel;
 use crate::prelude::*;
 
+use crate::utils::impl_hidden_constructor;
+
 /// These are queries to the various IBC modules to see the state of the contract's
 /// IBC connection.
 /// Most of these will return errors if the contract is not "ibc enabled".
@@ -46,20 +48,20 @@ pub struct PortIdResponse {
     pub port_id: String,
 }
 
-impl_response_constructor!(PortIdResponse, port_id: String);
+impl_hidden_constructor!(PortIdResponse, port_id: String);
 
 #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
 #[non_exhaustive]
 pub struct ChannelResponse {
     pub channel: Option<IbcChannel>,
 }
 
-impl_response_constructor!(ChannelResponse, channel: Option<IbcChannel>);
+impl_hidden_constructor!(ChannelResponse, channel: Option<IbcChannel>);
 
 #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
 #[non_exhaustive]
 pub struct FeeEnabledChannelResponse {
     pub fee_enabled: bool,
 }
 
-impl_response_constructor!(FeeEnabledChannelResponse, fee_enabled: bool);
+impl_hidden_constructor!(FeeEnabledChannelResponse, fee_enabled: bool);

packages/std/src/query/mod.rs

@@ -8,25 +8,6 @@ use crate::prelude::*;
 use crate::Binary;
 use crate::Empty;
 
-/// Implements a hidden constructor for query responses.
-macro_rules! impl_response_constructor {
-    ( $response:ty, $( $field: ident : $t: ty),* ) => {
-        impl $response {
-            /// Constructor for testing frameworks such as cw-multi-test.
-            /// This is required because query response types should be #[non_exhaustive].
-            /// As a contract developer you should not need this constructor since
-            /// query responses are constructed for you via deserialization.
-            ///
-            /// Warning: This can change in breaking ways in minor versions.
-            #[doc(hidden)]
-            #[allow(dead_code)]
-            pub fn new($( $field: $t),*) -> Self {
-                Self { $( $field ),* }
-            }
-        }
-    };
-}
-
 mod bank;
 mod distribution;
 mod ibc;