@burnt-labs/xion-types 0.0.1-test.1762962136

package/types/ibc/core/commitment/v1/commitment.ts

@@ -0,0 +1,321 @@
+//@ts-nocheck
+import { CommitmentProof, CommitmentProofAmino, CommitmentProofSDKType } from "../../../../cosmos/ics23/v1/proofs";
+import { BinaryReader, BinaryWriter } from "../../../../binary";
+import { bytesFromBase64, base64FromBytes } from "../../../../helpers";
+/**
+ * MerkleRoot defines a merkle root hash.
+ * In the Cosmos SDK, the AppHash of a block header becomes the root.
+ */
+export interface MerkleRoot {
+  hash: Uint8Array;
+}
+export interface MerkleRootProtoMsg {
+  typeUrl: "/ibc.core.commitment.v1.MerkleRoot";
+  value: Uint8Array;
+}
+/**
+ * MerkleRoot defines a merkle root hash.
+ * In the Cosmos SDK, the AppHash of a block header becomes the root.
+ * @name MerkleRootAmino
+ * @package ibc.core.commitment.v1
+ * @see proto type: ibc.core.commitment.v1.MerkleRoot
+ */
+export interface MerkleRootAmino {
+  hash?: string;
+}
+export interface MerkleRootAminoMsg {
+  type: "cosmos-sdk/MerkleRoot";
+  value: MerkleRootAmino;
+}
+/**
+ * MerkleRoot defines a merkle root hash.
+ * In the Cosmos SDK, the AppHash of a block header becomes the root.
+ */
+export interface MerkleRootSDKType {
+  hash: Uint8Array;
+}
+/**
+ * MerklePrefix is merkle path prefixed to the key.
+ * The constructed key from the Path and the key will be append(Path.KeyPath,
+ * append(Path.KeyPrefix, key...))
+ */
+export interface MerklePrefix {
+  keyPrefix: Uint8Array;
+}
+export interface MerklePrefixProtoMsg {
+  typeUrl: "/ibc.core.commitment.v1.MerklePrefix";
+  value: Uint8Array;
+}
+/**
+ * MerklePrefix is merkle path prefixed to the key.
+ * The constructed key from the Path and the key will be append(Path.KeyPath,
+ * append(Path.KeyPrefix, key...))
+ * @name MerklePrefixAmino
+ * @package ibc.core.commitment.v1
+ * @see proto type: ibc.core.commitment.v1.MerklePrefix
+ */
+export interface MerklePrefixAmino {
+  key_prefix?: string;
+}
+export interface MerklePrefixAminoMsg {
+  type: "cosmos-sdk/MerklePrefix";
+  value: MerklePrefixAmino;
+}
+/**
+ * MerklePrefix is merkle path prefixed to the key.
+ * The constructed key from the Path and the key will be append(Path.KeyPath,
+ * append(Path.KeyPrefix, key...))
+ */
+export interface MerklePrefixSDKType {
+  key_prefix: Uint8Array;
+}
+/**
+ * MerkleProof is a wrapper type over a chain of CommitmentProofs.
+ * It demonstrates membership or non-membership for an element or set of
+ * elements, verifiable in conjunction with a known commitment root. Proofs
+ * should be succinct.
+ * MerkleProofs are ordered from leaf-to-root
+ */
+export interface MerkleProof {
+  proofs: CommitmentProof[];
+}
+export interface MerkleProofProtoMsg {
+  typeUrl: "/ibc.core.commitment.v1.MerkleProof";
+  value: Uint8Array;
+}
+/**
+ * MerkleProof is a wrapper type over a chain of CommitmentProofs.
+ * It demonstrates membership or non-membership for an element or set of
+ * elements, verifiable in conjunction with a known commitment root. Proofs
+ * should be succinct.
+ * MerkleProofs are ordered from leaf-to-root
+ * @name MerkleProofAmino
+ * @package ibc.core.commitment.v1
+ * @see proto type: ibc.core.commitment.v1.MerkleProof
+ */
+export interface MerkleProofAmino {
+  proofs?: CommitmentProofAmino[];
+}
+export interface MerkleProofAminoMsg {
+  type: "cosmos-sdk/MerkleProof";
+  value: MerkleProofAmino;
+}
+/**
+ * MerkleProof is a wrapper type over a chain of CommitmentProofs.
+ * It demonstrates membership or non-membership for an element or set of
+ * elements, verifiable in conjunction with a known commitment root. Proofs
+ * should be succinct.
+ * MerkleProofs are ordered from leaf-to-root
+ */
+export interface MerkleProofSDKType {
+  proofs: CommitmentProofSDKType[];
+}
+function createBaseMerkleRoot(): MerkleRoot {
+  return {
+    hash: new Uint8Array()
+  };
+}
+export const MerkleRoot = {
+  typeUrl: "/ibc.core.commitment.v1.MerkleRoot",
+  encode(message: MerkleRoot, writer: BinaryWriter = BinaryWriter.create()): BinaryWriter {
+    if (message.hash.length !== 0) {
+      writer.uint32(10).bytes(message.hash);
+    }
+    return writer;
+  },
+  decode(input: BinaryReader | Uint8Array, length?: number): MerkleRoot {
+    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseMerkleRoot();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          message.hash = reader.bytes();
+          break;
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+    return message;
+  },
+  fromPartial(object: Partial<MerkleRoot>): MerkleRoot {
+    const message = createBaseMerkleRoot();
+    message.hash = object.hash ?? new Uint8Array();
+    return message;
+  },
+  fromAmino(object: MerkleRootAmino): MerkleRoot {
+    const message = createBaseMerkleRoot();
+    if (object.hash !== undefined && object.hash !== null) {
+      message.hash = bytesFromBase64(object.hash);
+    }
+    return message;
+  },
+  toAmino(message: MerkleRoot): MerkleRootAmino {
+    const obj: any = {};
+    obj.hash = message.hash ? base64FromBytes(message.hash) : undefined;
+    return obj;
+  },
+  fromAminoMsg(object: MerkleRootAminoMsg): MerkleRoot {
+    return MerkleRoot.fromAmino(object.value);
+  },
+  toAminoMsg(message: MerkleRoot): MerkleRootAminoMsg {
+    return {
+      type: "cosmos-sdk/MerkleRoot",
+      value: MerkleRoot.toAmino(message)
+    };
+  },
+  fromProtoMsg(message: MerkleRootProtoMsg): MerkleRoot {
+    return MerkleRoot.decode(message.value);
+  },
+  toProto(message: MerkleRoot): Uint8Array {
+    return MerkleRoot.encode(message).finish();
+  },
+  toProtoMsg(message: MerkleRoot): MerkleRootProtoMsg {
+    return {
+      typeUrl: "/ibc.core.commitment.v1.MerkleRoot",
+      value: MerkleRoot.encode(message).finish()
+    };
+  }
+};
+function createBaseMerklePrefix(): MerklePrefix {
+  return {
+    keyPrefix: new Uint8Array()
+  };
+}
+export const MerklePrefix = {
+  typeUrl: "/ibc.core.commitment.v1.MerklePrefix",
+  encode(message: MerklePrefix, writer: BinaryWriter = BinaryWriter.create()): BinaryWriter {
+    if (message.keyPrefix.length !== 0) {
+      writer.uint32(10).bytes(message.keyPrefix);
+    }
+    return writer;
+  },
+  decode(input: BinaryReader | Uint8Array, length?: number): MerklePrefix {
+    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseMerklePrefix();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          message.keyPrefix = reader.bytes();
+          break;
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+    return message;
+  },
+  fromPartial(object: Partial<MerklePrefix>): MerklePrefix {
+    const message = createBaseMerklePrefix();
+    message.keyPrefix = object.keyPrefix ?? new Uint8Array();
+    return message;
+  },
+  fromAmino(object: MerklePrefixAmino): MerklePrefix {
+    const message = createBaseMerklePrefix();
+    if (object.key_prefix !== undefined && object.key_prefix !== null) {
+      message.keyPrefix = bytesFromBase64(object.key_prefix);
+    }
+    return message;
+  },
+  toAmino(message: MerklePrefix): MerklePrefixAmino {
+    const obj: any = {};
+    obj.key_prefix = message.keyPrefix ? base64FromBytes(message.keyPrefix) : undefined;
+    return obj;
+  },
+  fromAminoMsg(object: MerklePrefixAminoMsg): MerklePrefix {
+    return MerklePrefix.fromAmino(object.value);
+  },
+  toAminoMsg(message: MerklePrefix): MerklePrefixAminoMsg {
+    return {
+      type: "cosmos-sdk/MerklePrefix",
+      value: MerklePrefix.toAmino(message)
+    };
+  },
+  fromProtoMsg(message: MerklePrefixProtoMsg): MerklePrefix {
+    return MerklePrefix.decode(message.value);
+  },
+  toProto(message: MerklePrefix): Uint8Array {
+    return MerklePrefix.encode(message).finish();
+  },
+  toProtoMsg(message: MerklePrefix): MerklePrefixProtoMsg {
+    return {
+      typeUrl: "/ibc.core.commitment.v1.MerklePrefix",
+      value: MerklePrefix.encode(message).finish()
+    };
+  }
+};
+function createBaseMerkleProof(): MerkleProof {
+  return {
+    proofs: []
+  };
+}
+export const MerkleProof = {
+  typeUrl: "/ibc.core.commitment.v1.MerkleProof",
+  encode(message: MerkleProof, writer: BinaryWriter = BinaryWriter.create()): BinaryWriter {
+    for (const v of message.proofs) {
+      CommitmentProof.encode(v!, writer.uint32(10).fork()).ldelim();
+    }
+    return writer;
+  },
+  decode(input: BinaryReader | Uint8Array, length?: number): MerkleProof {
+    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseMerkleProof();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          message.proofs.push(CommitmentProof.decode(reader, reader.uint32()));
+          break;
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+    return message;
+  },
+  fromPartial(object: Partial<MerkleProof>): MerkleProof {
+    const message = createBaseMerkleProof();
+    message.proofs = object.proofs?.map(e => CommitmentProof.fromPartial(e)) || [];
+    return message;
+  },
+  fromAmino(object: MerkleProofAmino): MerkleProof {
+    const message = createBaseMerkleProof();
+    message.proofs = object.proofs?.map(e => CommitmentProof.fromAmino(e)) || [];
+    return message;
+  },
+  toAmino(message: MerkleProof): MerkleProofAmino {
+    const obj: any = {};
+    if (message.proofs) {
+      obj.proofs = message.proofs.map(e => e ? CommitmentProof.toAmino(e) : undefined);
+    } else {
+      obj.proofs = message.proofs;
+    }
+    return obj;
+  },
+  fromAminoMsg(object: MerkleProofAminoMsg): MerkleProof {
+    return MerkleProof.fromAmino(object.value);
+  },
+  toAminoMsg(message: MerkleProof): MerkleProofAminoMsg {
+    return {
+      type: "cosmos-sdk/MerkleProof",
+      value: MerkleProof.toAmino(message)
+    };
+  },
+  fromProtoMsg(message: MerkleProofProtoMsg): MerkleProof {
+    return MerkleProof.decode(message.value);
+  },
+  toProto(message: MerkleProof): Uint8Array {
+    return MerkleProof.encode(message).finish();
+  },
+  toProtoMsg(message: MerkleProof): MerkleProofProtoMsg {
+    return {
+      typeUrl: "/ibc.core.commitment.v1.MerkleProof",
+      value: MerkleProof.encode(message).finish()
+    };
+  }
+};

package/types/ibc/core/commitment/v2/commitment.ts

@@ -0,0 +1,193 @@
+//@ts-nocheck
+import { BinaryReader, BinaryWriter } from "../../../../binary";
+import { bytesFromBase64, base64FromBytes } from "../../../../helpers";
+/**
+ * MerklePath is the path used to verify commitment proofs, which can be an
+ * arbitrary structured object (defined by a commitment type).
+ * ICS-23 verification supports membership proofs for nested merkle trees.
+ * The ICS-24 standard provable keys MUST be stored in the lowest level tree with an optional prefix.
+ * The IC24 provable tree may then be stored in a higher level tree(s) that hash up to the root hash
+ * stored in the consensus state of the client.
+ * Each element of the path represents the key of a merkle tree from the root to the leaf.
+ * The elements of the path before the final element must be the path to the tree that contains
+ * the ICS24 provable store. Thus, it should remain constant for all ICS24 proofs.
+ * The final element of the path is the key of the leaf in the ICS24 provable store,
+ * Thus IBC core will append the ICS24 path to the final element of the MerklePath
+ * stored in the counterparty to create the full path to the leaf for proof verification.
+ * Examples:
+ * Cosmos SDK:
+ * The Cosmos SDK commits to a multi-tree where each store is an IAVL tree and all store hashes
+ * are hashed in a simple merkle tree to get the final root hash. Thus, the MerklePath in the counterparty
+ * MerklePrefix has the following structure: ["ibc", ""]
+ * The core IBC handler will append the ICS24 path to the final element of the MerklePath
+ * like so: ["ibc", "{packetCommitmentPath}"] which will then be used for final verification.
+ * Ethereum:
+ * The Ethereum client commits to a single Patricia merkle trie. The ICS24 provable store is managed
+ * by the smart contract state. Each smart contract has a specific prefix reserved within the global trie.
+ * Thus the MerklePath in the counterparty is the prefix to the smart contract state in the global trie.
+ * Since there is only one tree in the commitment structure of ethereum the MerklePath in the counterparty
+ * MerklePrefix has the following structure: ["IBCCoreContractAddressStoragePrefix"]
+ * The core IBC handler will append the ICS24 path to the final element of the MerklePath
+ * like so: ["IBCCoreContractAddressStoragePrefix{packetCommitmentPath}"] which will then be used for final
+ * verification. Thus the MerklePath in the counterparty MerklePrefix is the nested key path from the root hash of the
+ * consensus state down to the ICS24 provable store. The IBC handler retrieves the counterparty key path to the ICS24
+ * provable store from the MerklePath and appends the ICS24 path to get the final key path to the value being verified
+ * by the client against the root hash in the client's consensus state.
+ */
+export interface MerklePath {
+  keyPath: Uint8Array[];
+}
+export interface MerklePathProtoMsg {
+  typeUrl: "/ibc.core.commitment.v2.MerklePath";
+  value: Uint8Array;
+}
+/**
+ * MerklePath is the path used to verify commitment proofs, which can be an
+ * arbitrary structured object (defined by a commitment type).
+ * ICS-23 verification supports membership proofs for nested merkle trees.
+ * The ICS-24 standard provable keys MUST be stored in the lowest level tree with an optional prefix.
+ * The IC24 provable tree may then be stored in a higher level tree(s) that hash up to the root hash
+ * stored in the consensus state of the client.
+ * Each element of the path represents the key of a merkle tree from the root to the leaf.
+ * The elements of the path before the final element must be the path to the tree that contains
+ * the ICS24 provable store. Thus, it should remain constant for all ICS24 proofs.
+ * The final element of the path is the key of the leaf in the ICS24 provable store,
+ * Thus IBC core will append the ICS24 path to the final element of the MerklePath
+ * stored in the counterparty to create the full path to the leaf for proof verification.
+ * Examples:
+ * Cosmos SDK:
+ * The Cosmos SDK commits to a multi-tree where each store is an IAVL tree and all store hashes
+ * are hashed in a simple merkle tree to get the final root hash. Thus, the MerklePath in the counterparty
+ * MerklePrefix has the following structure: ["ibc", ""]
+ * The core IBC handler will append the ICS24 path to the final element of the MerklePath
+ * like so: ["ibc", "{packetCommitmentPath}"] which will then be used for final verification.
+ * Ethereum:
+ * The Ethereum client commits to a single Patricia merkle trie. The ICS24 provable store is managed
+ * by the smart contract state. Each smart contract has a specific prefix reserved within the global trie.
+ * Thus the MerklePath in the counterparty is the prefix to the smart contract state in the global trie.
+ * Since there is only one tree in the commitment structure of ethereum the MerklePath in the counterparty
+ * MerklePrefix has the following structure: ["IBCCoreContractAddressStoragePrefix"]
+ * The core IBC handler will append the ICS24 path to the final element of the MerklePath
+ * like so: ["IBCCoreContractAddressStoragePrefix{packetCommitmentPath}"] which will then be used for final
+ * verification. Thus the MerklePath in the counterparty MerklePrefix is the nested key path from the root hash of the
+ * consensus state down to the ICS24 provable store. The IBC handler retrieves the counterparty key path to the ICS24
+ * provable store from the MerklePath and appends the ICS24 path to get the final key path to the value being verified
+ * by the client against the root hash in the client's consensus state.
+ * @name MerklePathAmino
+ * @package ibc.core.commitment.v2
+ * @see proto type: ibc.core.commitment.v2.MerklePath
+ */
+export interface MerklePathAmino {
+  key_path?: string[];
+}
+export interface MerklePathAminoMsg {
+  type: "cosmos-sdk/MerklePath";
+  value: MerklePathAmino;
+}
+/**
+ * MerklePath is the path used to verify commitment proofs, which can be an
+ * arbitrary structured object (defined by a commitment type).
+ * ICS-23 verification supports membership proofs for nested merkle trees.
+ * The ICS-24 standard provable keys MUST be stored in the lowest level tree with an optional prefix.
+ * The IC24 provable tree may then be stored in a higher level tree(s) that hash up to the root hash
+ * stored in the consensus state of the client.
+ * Each element of the path represents the key of a merkle tree from the root to the leaf.
+ * The elements of the path before the final element must be the path to the tree that contains
+ * the ICS24 provable store. Thus, it should remain constant for all ICS24 proofs.
+ * The final element of the path is the key of the leaf in the ICS24 provable store,
+ * Thus IBC core will append the ICS24 path to the final element of the MerklePath
+ * stored in the counterparty to create the full path to the leaf for proof verification.
+ * Examples:
+ * Cosmos SDK:
+ * The Cosmos SDK commits to a multi-tree where each store is an IAVL tree and all store hashes
+ * are hashed in a simple merkle tree to get the final root hash. Thus, the MerklePath in the counterparty
+ * MerklePrefix has the following structure: ["ibc", ""]
+ * The core IBC handler will append the ICS24 path to the final element of the MerklePath
+ * like so: ["ibc", "{packetCommitmentPath}"] which will then be used for final verification.
+ * Ethereum:
+ * The Ethereum client commits to a single Patricia merkle trie. The ICS24 provable store is managed
+ * by the smart contract state. Each smart contract has a specific prefix reserved within the global trie.
+ * Thus the MerklePath in the counterparty is the prefix to the smart contract state in the global trie.
+ * Since there is only one tree in the commitment structure of ethereum the MerklePath in the counterparty
+ * MerklePrefix has the following structure: ["IBCCoreContractAddressStoragePrefix"]
+ * The core IBC handler will append the ICS24 path to the final element of the MerklePath
+ * like so: ["IBCCoreContractAddressStoragePrefix{packetCommitmentPath}"] which will then be used for final
+ * verification. Thus the MerklePath in the counterparty MerklePrefix is the nested key path from the root hash of the
+ * consensus state down to the ICS24 provable store. The IBC handler retrieves the counterparty key path to the ICS24
+ * provable store from the MerklePath and appends the ICS24 path to get the final key path to the value being verified
+ * by the client against the root hash in the client's consensus state.
+ */
+export interface MerklePathSDKType {
+  key_path: Uint8Array[];
+}
+function createBaseMerklePath(): MerklePath {
+  return {
+    keyPath: []
+  };
+}
+export const MerklePath = {
+  typeUrl: "/ibc.core.commitment.v2.MerklePath",
+  encode(message: MerklePath, writer: BinaryWriter = BinaryWriter.create()): BinaryWriter {
+    for (const v of message.keyPath) {
+      writer.uint32(10).bytes(v!);
+    }
+    return writer;
+  },
+  decode(input: BinaryReader | Uint8Array, length?: number): MerklePath {
+    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseMerklePath();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          message.keyPath.push(reader.bytes());
+          break;
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+    return message;
+  },
+  fromPartial(object: Partial<MerklePath>): MerklePath {
+    const message = createBaseMerklePath();
+    message.keyPath = object.keyPath?.map(e => e) || [];
+    return message;
+  },
+  fromAmino(object: MerklePathAmino): MerklePath {
+    const message = createBaseMerklePath();
+    message.keyPath = object.key_path?.map(e => bytesFromBase64(e)) || [];
+    return message;
+  },
+  toAmino(message: MerklePath): MerklePathAmino {
+    const obj: any = {};
+    if (message.keyPath) {
+      obj.key_path = message.keyPath.map(e => base64FromBytes(e));
+    } else {
+      obj.key_path = message.keyPath;
+    }
+    return obj;
+  },
+  fromAminoMsg(object: MerklePathAminoMsg): MerklePath {
+    return MerklePath.fromAmino(object.value);
+  },
+  toAminoMsg(message: MerklePath): MerklePathAminoMsg {
+    return {
+      type: "cosmos-sdk/MerklePath",
+      value: MerklePath.toAmino(message)
+    };
+  },
+  fromProtoMsg(message: MerklePathProtoMsg): MerklePath {
+    return MerklePath.decode(message.value);
+  },
+  toProto(message: MerklePath): Uint8Array {
+    return MerklePath.encode(message).finish();
+  },
+  toProtoMsg(message: MerklePath): MerklePathProtoMsg {
+    return {
+      typeUrl: "/ibc.core.commitment.v2.MerklePath",
+      value: MerklePath.encode(message).finish()
+    };
+  }
+};