Add some comments on timeout_timestamp format

CosmWasm · Jan 20, 2021 · a80f200 · a80f200
1 parent 31a5d0d
commit a80f200
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 9 deletions.
diff --git a/contracts/ibc-reflect/schema/packet_msg.json b/contracts/ibc-reflect/schema/packet_msg.json
@@ -231,7 +231,7 @@
                   ]
                 },
                 "timeout_timestamp": {
-                  "description": "block timestamp (in nanoseconds) after which the packet times out. at least one of timeout_height, timeout_timestamp is required",
+                  "description": "block timestamp (nanoseconds since UNIX epoch) after which the packet times out. See https://golang.org/pkg/time/#Time.UnixNano at least one of timeout_height, timeout_timestamp is required",
                   "type": [
                     "integer",
                     "null"
@@ -283,7 +283,7 @@
                   ]
                 },
                 "timeout_timestamp": {
-                  "description": "block timestamp (in nanoseconds) after which the packet times out. at least one of timeout_height, timeout_timestamp is required",
+                  "description": "block timestamp (nanoseconds since UNIX epoch) after which the packet times out. See https://golang.org/pkg/time/#Time.UnixNano at least one of timeout_height, timeout_timestamp is required",
                   "type": [
                     "integer",
                     "null"

diff --git a/contracts/reflect/schema/handle_msg.json b/contracts/reflect/schema/handle_msg.json
@@ -251,7 +251,7 @@
                   ]
                 },
                 "timeout_timestamp": {
-                  "description": "block timestamp (in nanoseconds) after which the packet times out. at least one of timeout_height, timeout_timestamp is required",
+                  "description": "block timestamp (nanoseconds since UNIX epoch) after which the packet times out. See https://golang.org/pkg/time/#Time.UnixNano at least one of timeout_height, timeout_timestamp is required",
                   "type": [
                     "integer",
                     "null"
@@ -303,7 +303,7 @@
                   ]
                 },
                 "timeout_timestamp": {
-                  "description": "block timestamp (in nanoseconds) after which the packet times out. at least one of timeout_height, timeout_timestamp is required",
+                  "description": "block timestamp (nanoseconds since UNIX epoch) after which the packet times out. See https://golang.org/pkg/time/#Time.UnixNano at least one of timeout_height, timeout_timestamp is required",
                   "type": [
                     "integer",
                     "null"

diff --git a/contracts/reflect/schema/handle_response_for__custom_msg.json b/contracts/reflect/schema/handle_response_for__custom_msg.json
@@ -254,7 +254,7 @@
                   ]
                 },
                 "timeout_timestamp": {
-                  "description": "block timestamp (in nanoseconds) after which the packet times out. at least one of timeout_height, timeout_timestamp is required",
+                  "description": "block timestamp (nanoseconds since UNIX epoch) after which the packet times out. See https://golang.org/pkg/time/#Time.UnixNano at least one of timeout_height, timeout_timestamp is required",
                   "type": [
                     "integer",
                     "null"
@@ -306,7 +306,7 @@
                   ]
                 },
                 "timeout_timestamp": {
-                  "description": "block timestamp (in nanoseconds) after which the packet times out. at least one of timeout_height, timeout_timestamp is required",
+                  "description": "block timestamp (nanoseconds since UNIX epoch) after which the packet times out. See https://golang.org/pkg/time/#Time.UnixNano at least one of timeout_height, timeout_timestamp is required",
                   "type": [
                     "integer",
                     "null"

diff --git a/packages/std/src/ibc.rs b/packages/std/src/ibc.rs
@@ -34,7 +34,8 @@ pub enum IbcMsg {
         /// block height after which the packet times out.
         /// at least one of timeout_height, timeout_timestamp is required
         timeout_height: Option<IbcTimeoutHeight>,
-        /// block timestamp (in nanoseconds) after which the packet times out.
+        /// block timestamp (nanoseconds since UNIX epoch) after which the packet times out.
+        /// See https://golang.org/pkg/time/#Time.UnixNano
         /// at least one of timeout_height, timeout_timestamp is required
         timeout_timestamp: Option<u64>,
     },
@@ -47,7 +48,8 @@ pub enum IbcMsg {
         /// block height after which the packet times out.
         /// at least one of timeout_height, timeout_timestamp is required
         timeout_height: Option<IbcTimeoutHeight>,
-        /// block timestamp (in nanoseconds) after which the packet times out.
+        /// block timestamp (nanoseconds since UNIX epoch) after which the packet times out.
+        /// See https://golang.org/pkg/time/#Time.UnixNano
         /// at least one of timeout_height, timeout_timestamp is required
         timeout_timestamp: Option<u64>,
     },
@@ -176,7 +178,8 @@ pub struct IbcPacket {
     /// block height after which the packet times out.
     /// at least one of timeout_height, timeout_timestamp is required
     pub timeout_height: Option<IbcTimeoutHeight>,
-    /// block timestamp (in nanoseconds) after which the packet times out.
+    /// block timestamp (nanoseconds since UNIX epoch) after which the packet times out.
+    /// See https://golang.org/pkg/time/#Time.UnixNano
     /// at least one of timeout_height, timeout_timestamp is required
     pub timeout_timestamp: Option<u64>,
 }