Skip to content

Rename TimestampNanos to Timestamp and improve IbcTimeout docs #902

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Rename TimestampNanos to Timestamp and improve IbcTimeout docs #902

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions IBC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,21 +37,26 @@ pub enum IbcMsg {
}
}

/// In IBC each package must set at least one type of timeout:
/// the timestamp or the block height. Using this rather complex enum instead of
/// two timeout fields we ensure that at least one timeout is set.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum IbcTimeout {
/// block timestamp (nanoseconds since UNIX epoch) after which the packet times out
/// (measured on the remote chain)
/// Block timestamp (nanoseconds since UNIX epoch) after which the packet times out
/// (measured on the remote chain).
///
/// See https://golang.org/pkg/time/#Time.UnixNano
TimestampNanos(u64),
Timestamp(u64),
/// block after which the packet times out (measured on remote chain)
Block(IbcTimeoutBlock),
/// Use this to set both timestamp and block timeout. The package then times out once
/// the first of both timeouts is hit.
Both {
timestamp_nanos: u64,
timestamp: u64,
block: IbcTimeoutBlock,
},
}

```

Note the `to_address` is likely not a valid `Addr`, as it uses the bech32 prefix
Expand Down
12 changes: 7 additions & 5 deletions contracts/ibc-reflect-send/schema/execute_msg.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -435,15 +435,16 @@
]
},
"IbcTimeout": {
"description": "In IBC each package must set at least one type of timeout: the timestamp or the block height. Using this rather complex enum instead of two timeout fields we ensure that at least one timeout is set.",
"anyOf": [
{
"description": "block timestamp (nanoseconds since UNIX epoch) after which the packet times out (measured on the remote chain) See https://golang.org/pkg/time/#Time.UnixNano",
"description": "Block timestamp (nanoseconds since UNIX epoch) after which the packet times out (measured on the remote chain).\n\nSee https://golang.org/pkg/time/#Time.UnixNano",
"type": "object",
"required": [
"timestamp_nanos"
"timestamp"
],
"properties": {
"timestamp_nanos": {
"timestamp": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
Expand All @@ -465,6 +466,7 @@
"additionalProperties": false
},
{
"description": "Use this to set both timestamp and block timeout. The package then times out once the first of both timeouts is hit.",
"type": "object",
"required": [
"both"
Expand All @@ -474,13 +476,13 @@
"type": "object",
"required": [
"block",
"timestamp_nanos"
"timestamp"
],
"properties": {
"block": {
"$ref": "#/definitions/IbcTimeoutBlock"
},
"timestamp_nanos": {
"timestamp": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
Expand Down
12 changes: 7 additions & 5 deletions contracts/ibc-reflect-send/schema/packet_msg.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,15 +388,16 @@
]
},
"IbcTimeout": {
"description": "In IBC each package must set at least one type of timeout: the timestamp or the block height. Using this rather complex enum instead of two timeout fields we ensure that at least one timeout is set.",
"anyOf": [
{
"description": "block timestamp (nanoseconds since UNIX epoch) after which the packet times out (measured on the remote chain) See https://golang.org/pkg/time/#Time.UnixNano",
"description": "Block timestamp (nanoseconds since UNIX epoch) after which the packet times out (measured on the remote chain).\n\nSee https://golang.org/pkg/time/#Time.UnixNano",
"type": "object",
"required": [
"timestamp_nanos"
"timestamp"
],
"properties": {
"timestamp_nanos": {
"timestamp": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
Expand All @@ -418,6 +419,7 @@
"additionalProperties": false
},
{
"description": "Use this to set both timestamp and block timeout. The package then times out once the first of both timeouts is hit.",
"type": "object",
"required": [
"both"
Expand All @@ -427,13 +429,13 @@
"type": "object",
"required": [
"block",
"timestamp_nanos"
"timestamp"
],
"properties": {
"block": {
"$ref": "#/definitions/IbcTimeoutBlock"
},
"timestamp_nanos": {
"timestamp": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
Expand Down
2 changes: 1 addition & 1 deletion contracts/ibc-reflect-send/src/ibc.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -445,7 +445,7 @@ mod tests {
assert_eq!(transfer_channel_id, channel_id.as_str());
assert_eq!(remote_addr, to_address.as_str());
assert_eq!(&coin(12344, "utrgd"), amount);
assert!(matches!(timeout, IbcTimeout::TimestampNanos { .. }));
assert!(matches!(timeout, IbcTimeout::Timestamp { .. }));
}
o => panic!("unexpected message: {:?}", o),
}
Expand Down
2 changes: 1 addition & 1 deletion contracts/ibc-reflect-send/tests/integration.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ fn send_remote_funds() {
assert_eq!(transfer_channel_id, channel_id.as_str());
assert_eq!(remote_addr, to_address.as_str());
assert_eq!(&coin(12344, "utrgd"), amount);
assert!(matches!(timeout, IbcTimeout::TimestampNanos { .. }));
assert!(matches!(timeout, IbcTimeout::Timestamp { .. }));
}
o => panic!("unexpected message: {:?}", o),
}
Expand Down
12 changes: 7 additions & 5 deletions contracts/ibc-reflect/schema/packet_msg.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,15 +387,16 @@
]
},
"IbcTimeout": {
"description": "In IBC each package must set at least one type of timeout: the timestamp or the block height. Using this rather complex enum instead of two timeout fields we ensure that at least one timeout is set.",
"anyOf": [
{
"description": "block timestamp (nanoseconds since UNIX epoch) after which the packet times out (measured on the remote chain) See https://golang.org/pkg/time/#Time.UnixNano",
"description": "Block timestamp (nanoseconds since UNIX epoch) after which the packet times out (measured on the remote chain).\n\nSee https://golang.org/pkg/time/#Time.UnixNano",
"type": "object",
"required": [
"timestamp_nanos"
"timestamp"
],
"properties": {
"timestamp_nanos": {
"timestamp": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
Expand All @@ -417,6 +418,7 @@
"additionalProperties": false
},
{
"description": "Use this to set both timestamp and block timeout. The package then times out once the first of both timeouts is hit.",
"type": "object",
"required": [
"both"
Expand All @@ -426,13 +428,13 @@
"type": "object",
"required": [
"block",
"timestamp_nanos"
"timestamp"
],
"properties": {
"block": {
"$ref": "#/definitions/IbcTimeoutBlock"
},
"timestamp_nanos": {
"timestamp": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
Expand Down
12 changes: 7 additions & 5 deletions contracts/reflect/schema/execute_msg.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,15 +431,16 @@
]
},
"IbcTimeout": {
"description": "In IBC each package must set at least one type of timeout: the timestamp or the block height. Using this rather complex enum instead of two timeout fields we ensure that at least one timeout is set.",
"anyOf": [
{
"description": "block timestamp (nanoseconds since UNIX epoch) after which the packet times out (measured on the remote chain) See https://golang.org/pkg/time/#Time.UnixNano",
"description": "Block timestamp (nanoseconds since UNIX epoch) after which the packet times out (measured on the remote chain).\n\nSee https://golang.org/pkg/time/#Time.UnixNano",
"type": "object",
"required": [
"timestamp_nanos"
"timestamp"
],
"properties": {
"timestamp_nanos": {
"timestamp": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
Expand All @@ -461,6 +462,7 @@
"additionalProperties": false
},
{
"description": "Use this to set both timestamp and block timeout. The package then times out once the first of both timeouts is hit.",
"type": "object",
"required": [
"both"
Expand All @@ -470,13 +472,13 @@
"type": "object",
"required": [
"block",
"timestamp_nanos"
"timestamp"
],
"properties": {
"block": {
"$ref": "#/definitions/IbcTimeoutBlock"
},
"timestamp_nanos": {
"timestamp": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
Expand Down
12 changes: 7 additions & 5 deletions contracts/reflect/schema/response_for__custom_msg.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,15 +419,16 @@
]
},
"IbcTimeout": {
"description": "In IBC each package must set at least one type of timeout: the timestamp or the block height. Using this rather complex enum instead of two timeout fields we ensure that at least one timeout is set.",
"anyOf": [
{
"description": "block timestamp (nanoseconds since UNIX epoch) after which the packet times out (measured on the remote chain) See https://golang.org/pkg/time/#Time.UnixNano",
"description": "Block timestamp (nanoseconds since UNIX epoch) after which the packet times out (measured on the remote chain).\n\nSee https://golang.org/pkg/time/#Time.UnixNano",
"type": "object",
"required": [
"timestamp_nanos"
"timestamp"
],
"properties": {
"timestamp_nanos": {
"timestamp": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
Expand All @@ -449,6 +450,7 @@
"additionalProperties": false
},
{
"description": "Use this to set both timestamp and block timeout. The package then times out once the first of both timeouts is hit.",
"type": "object",
"required": [
"both"
Expand All @@ -458,13 +460,13 @@
"type": "object",
"required": [
"block",
"timestamp_nanos"
"timestamp"
],
"properties": {
"block": {
"$ref": "#/definitions/IbcTimeoutBlock"
},
"timestamp_nanos": {
"timestamp": {
"type": "integer",
"format": "uint64",
"minimum": 0.0
Expand Down
21 changes: 14 additions & 7 deletions packages/std/src/ibc.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,24 +54,31 @@ pub struct IbcEndpoint {
pub channel_id: String,
}

/// In IBC each package must set at least one type of timeout:
/// the timestamp or the block height. Using this rather complex enum instead of
/// two timeout fields we ensure that at least one timeout is set.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum IbcTimeout {
/// block timestamp (nanoseconds since UNIX epoch) after which the packet times out
/// (measured on the remote chain)
/// Block timestamp (nanoseconds since UNIX epoch) after which the packet times out
/// (measured on the remote chain).
///
/// See https://golang.org/pkg/time/#Time.UnixNano
TimestampNanos(u64),
Timestamp(u64),
/// block after which the packet times out (measured on remote chain)
Block(IbcTimeoutBlock),
/// Use this to set both timestamp and block timeout. The package then times out once
/// the first of both timeouts is hit.
Both {
timestamp_nanos: u64,
timestamp: u64,
block: IbcTimeoutBlock,
},
}

impl From<Timestamp> for IbcTimeout {
fn from(time: Timestamp) -> IbcTimeout {
IbcTimeout::TimestampNanos(time.seconds * 1_000_000_000 + time.nanos)
let nanos = time.seconds * 1_000_000_000 + time.nanos;
IbcTimeout::Timestamp(nanos)
}
}

Expand Down Expand Up @@ -253,10 +260,10 @@ mod tests {
channel_id: "channel-123".to_string(),
to_address: "my-special-addr".into(),
amount: Coin::new(12345678, "uatom"),
timeout: IbcTimeout::TimestampNanos(1234567890),
timeout: IbcTimeout::Timestamp(1234567890),
};
let encoded = to_string(&msg).unwrap();
let expected = r#"{"transfer":{"channel_id":"channel-123","to_address":"my-special-addr","amount":{"denom":"uatom","amount":"12345678"},"timeout":{"timestamp_nanos":1234567890}}}"#;
let expected = r#"{"transfer":{"channel_id":"channel-123","to_address":"my-special-addr","amount":{"denom":"uatom","amount":"12345678"},"timeout":{"timestamp":1234567890}}}"#;
assert_eq!(encoded.as_str(), expected);
}

Expand Down