@xpla/xpla-react 1.7.0 → 1.8.0-rc.1

package/cosmos/tx/v1beta1/tx.js

@@ -5,6 +5,7 @@ const any_1 = require("../../../google/protobuf/any");
 const multisig_1 = require("../../crypto/multisig/v1beta1/multisig");
 const coin_1 = require("../../base/v1beta1/coin");
 const binary_1 = require("../../../binary");
+const registry_1 = require("../../../registry");
 const helpers_1 = require("../../../helpers");
 function createBaseTx() {
     return {
@@ -13,6 +14,12 @@ function createBaseTx() {
         signatures: []
     };
 }
+/**
+ * Tx is the standard type used for broadcasting transactions.
+ * @name Tx
+ * @package cosmos.tx.v1beta1
+ * @see proto type: cosmos.tx.v1beta1.Tx
+ */
 exports.Tx = {
     typeUrl: "/cosmos.tx.v1beta1.Tx",
     aminoType: "cosmos-sdk/Tx",
@@ -109,6 +116,9 @@ exports.Tx = {
         };
     },
     registerTypeUrl() {
+        if (!registry_1.GlobalDecoderRegistry.registerExistingTypeUrl(exports.Tx.typeUrl)) {
+            return;
+        }
         exports.TxBody.registerTypeUrl();
         exports.AuthInfo.registerTypeUrl();
     }
@@ -120,6 +130,16 @@ function createBaseTxRaw() {
         signatures: []
     };
 }
+/**
+ * TxRaw is a variant of Tx that pins the signer's exact binary representation
+ * of body and auth_info. This is used for signing, broadcasting and
+ * verification. The binary `serialize(tx: TxRaw)` is stored in Tendermint and
+ * the hash `sha256(serialize(tx: TxRaw))` becomes the "txhash", commonly used
+ * as the transaction ID.
+ * @name TxRaw
+ * @package cosmos.tx.v1beta1
+ * @see proto type: cosmos.tx.v1beta1.TxRaw
+ */
 exports.TxRaw = {
     typeUrl: "/cosmos.tx.v1beta1.TxRaw",
     aminoType: "cosmos-sdk/TxRaw",
@@ -225,6 +245,12 @@ function createBaseSignDoc() {
         accountNumber: BigInt(0)
     };
 }
+/**
+ * SignDoc is the type used for generating sign bytes for SIGN_MODE_DIRECT.
+ * @name SignDoc
+ * @package cosmos.tx.v1beta1
+ * @see proto type: cosmos.tx.v1beta1.SignDoc
+ */
 exports.SignDoc = {
     typeUrl: "/cosmos.tx.v1beta1.SignDoc",
     aminoType: "cosmos-sdk/SignDoc",
@@ -340,6 +366,15 @@ function createBaseSignDocDirectAux() {
         tip: undefined
     };
 }
+/**
+ * SignDocDirectAux is the type used for generating sign bytes for
+ * SIGN_MODE_DIRECT_AUX.
+ *
+ * Since: cosmos-sdk 0.46
+ * @name SignDocDirectAux
+ * @package cosmos.tx.v1beta1
+ * @see proto type: cosmos.tx.v1beta1.SignDocDirectAux
+ */
 exports.SignDocDirectAux = {
     typeUrl: "/cosmos.tx.v1beta1.SignDocDirectAux",
     aminoType: "cosmos-sdk/SignDocDirectAux",
@@ -466,6 +501,9 @@ exports.SignDocDirectAux = {
         };
     },
     registerTypeUrl() {
+        if (!registry_1.GlobalDecoderRegistry.registerExistingTypeUrl(exports.SignDocDirectAux.typeUrl)) {
+            return;
+        }
         exports.Tip.registerTypeUrl();
     }
 };
@@ -478,6 +516,12 @@ function createBaseTxBody() {
         nonCriticalExtensionOptions: []
     };
 }
+/**
+ * TxBody is the body of a transaction that all signers sign over.
+ * @name TxBody
+ * @package cosmos.tx.v1beta1
+ * @see proto type: cosmos.tx.v1beta1.TxBody
+ */
 exports.TxBody = {
     typeUrl: "/cosmos.tx.v1beta1.TxBody",
     aminoType: "cosmos-sdk/TxBody",
@@ -610,6 +654,13 @@ function createBaseAuthInfo() {
         tip: undefined
     };
 }
+/**
+ * AuthInfo describes the fee and signer modes that are used to sign a
+ * transaction.
+ * @name AuthInfo
+ * @package cosmos.tx.v1beta1
+ * @see proto type: cosmos.tx.v1beta1.AuthInfo
+ */
 exports.AuthInfo = {
     typeUrl: "/cosmos.tx.v1beta1.AuthInfo",
     aminoType: "cosmos-sdk/AuthInfo",
@@ -706,6 +757,9 @@ exports.AuthInfo = {
         };
     },
     registerTypeUrl() {
+        if (!registry_1.GlobalDecoderRegistry.registerExistingTypeUrl(exports.AuthInfo.typeUrl)) {
+            return;
+        }
         exports.SignerInfo.registerTypeUrl();
         exports.Fee.registerTypeUrl();
         exports.Tip.registerTypeUrl();
@@ -718,6 +772,13 @@ function createBaseSignerInfo() {
         sequence: BigInt(0)
     };
 }
+/**
+ * SignerInfo describes the public key and signing mode of a single top-level
+ * signer.
+ * @name SignerInfo
+ * @package cosmos.tx.v1beta1
+ * @see proto type: cosmos.tx.v1beta1.SignerInfo
+ */
 exports.SignerInfo = {
     typeUrl: "/cosmos.tx.v1beta1.SignerInfo",
     aminoType: "cosmos-sdk/SignerInfo",
@@ -811,6 +872,9 @@ exports.SignerInfo = {
         };
     },
     registerTypeUrl() {
+        if (!registry_1.GlobalDecoderRegistry.registerExistingTypeUrl(exports.SignerInfo.typeUrl)) {
+            return;
+        }
         exports.ModeInfo.registerTypeUrl();
     }
 };
@@ -820,6 +884,12 @@ function createBaseModeInfo() {
         multi: undefined
     };
 }
+/**
+ * ModeInfo describes the signing mode of a single or nested multisig signer.
+ * @name ModeInfo
+ * @package cosmos.tx.v1beta1
+ * @see proto type: cosmos.tx.v1beta1.ModeInfo
+ */
 exports.ModeInfo = {
     typeUrl: "/cosmos.tx.v1beta1.ModeInfo",
     aminoType: "cosmos-sdk/ModeInfo",
@@ -902,6 +972,9 @@ exports.ModeInfo = {
         };
     },
     registerTypeUrl() {
+        if (!registry_1.GlobalDecoderRegistry.registerExistingTypeUrl(exports.ModeInfo.typeUrl)) {
+            return;
+        }
         exports.ModeInfo_Single.registerTypeUrl();
         exports.ModeInfo_Multi.registerTypeUrl();
     }
@@ -911,6 +984,14 @@ function createBaseModeInfo_Single() {
         mode: 0
     };
 }
+/**
+ * Single is the mode info for a single signer. It is structured as a message
+ * to allow for additional fields such as locale for SIGN_MODE_TEXTUAL in the
+ * future
+ * @name ModeInfo_Single
+ * @package cosmos.tx.v1beta1
+ * @see proto type: cosmos.tx.v1beta1.Single
+ */
 exports.ModeInfo_Single = {
     typeUrl: "/cosmos.tx.v1beta1.Single",
     aminoType: "cosmos-sdk/Single",
@@ -989,6 +1070,12 @@ function createBaseModeInfo_Multi() {
         modeInfos: []
     };
 }
+/**
+ * Multi is the mode info for a multisig public key
+ * @name ModeInfo_Multi
+ * @package cosmos.tx.v1beta1
+ * @see proto type: cosmos.tx.v1beta1.Multi
+ */
 exports.ModeInfo_Multi = {
     typeUrl: "/cosmos.tx.v1beta1.Multi",
     aminoType: "cosmos-sdk/Multi",
@@ -1074,6 +1161,9 @@ exports.ModeInfo_Multi = {
         };
     },
     registerTypeUrl() {
+        if (!registry_1.GlobalDecoderRegistry.registerExistingTypeUrl(exports.ModeInfo_Multi.typeUrl)) {
+            return;
+        }
         multisig_1.CompactBitArray.registerTypeUrl();
         exports.ModeInfo.registerTypeUrl();
     }
@@ -1086,6 +1176,14 @@ function createBaseFee() {
         granter: ""
     };
 }
+/**
+ * Fee includes the amount of coins paid in fees and the maximum
+ * gas to be used by the transaction. The ratio yields an effective "gasprice",
+ * which must be above some miminum to be accepted into the mempool.
+ * @name Fee
+ * @package cosmos.tx.v1beta1
+ * @see proto type: cosmos.tx.v1beta1.Fee
+ */
 exports.Fee = {
     typeUrl: "/cosmos.tx.v1beta1.Fee",
     aminoType: "cosmos-sdk/Fee",
@@ -1193,6 +1291,9 @@ exports.Fee = {
         };
     },
     registerTypeUrl() {
+        if (!registry_1.GlobalDecoderRegistry.registerExistingTypeUrl(exports.Fee.typeUrl)) {
+            return;
+        }
         coin_1.Coin.registerTypeUrl();
     }
 };
@@ -1202,6 +1303,15 @@ function createBaseTip() {
         tipper: ""
     };
 }
+/**
+ * Tip is the tip used for meta-transactions.
+ *
+ * Since: cosmos-sdk 0.46
+ * @name Tip
+ * @package cosmos.tx.v1beta1
+ * @see proto type: cosmos.tx.v1beta1.Tip
+ * @deprecated
+ */
 exports.Tip = {
     typeUrl: "/cosmos.tx.v1beta1.Tip",
     aminoType: "cosmos-sdk/Tip",
@@ -1287,6 +1397,9 @@ exports.Tip = {
         };
     },
     registerTypeUrl() {
+        if (!registry_1.GlobalDecoderRegistry.registerExistingTypeUrl(exports.Tip.typeUrl)) {
+            return;
+        }
         coin_1.Coin.registerTypeUrl();
     }
 };
@@ -1298,6 +1411,17 @@ function createBaseAuxSignerData() {
         sig: new Uint8Array()
     };
 }
+/**
+ * AuxSignerData is the intermediary format that an auxiliary signer (e.g. a
+ * tipper) builds and sends to the fee payer (who will build and broadcast the
+ * actual tx). AuxSignerData is not a valid tx in itself, and will be rejected
+ * by the node if sent directly as-is.
+ *
+ * Since: cosmos-sdk 0.46
+ * @name AuxSignerData
+ * @package cosmos.tx.v1beta1
+ * @see proto type: cosmos.tx.v1beta1.AuxSignerData
+ */
 exports.AuxSignerData = {
     typeUrl: "/cosmos.tx.v1beta1.AuxSignerData",
     aminoType: "cosmos-sdk/AuxSignerData",
@@ -1402,6 +1526,9 @@ exports.AuxSignerData = {
         };
     },
     registerTypeUrl() {
+        if (!registry_1.GlobalDecoderRegistry.registerExistingTypeUrl(exports.AuxSignerData.typeUrl)) {
+            return;
+        }
         exports.SignDocDirectAux.registerTypeUrl();
     }
 };

package/cosmos/upgrade/module/v1/module.d.ts

@@ -1,23 +1,43 @@
 import { BinaryReader, BinaryWriter } from "../../../../binary";
 import { DeepPartial } from "../../../../helpers";
-/** Module is the config object of the upgrade module. */
+/**
+ * Module is the config object of the upgrade module.
+ * @name Module
+ * @package cosmos.upgrade.module.v1
+ * @see proto type: cosmos.upgrade.module.v1.Module
+ */
 export interface Module {
-    /** authority defines the custom module authority. If not set, defaults to the governance module. */
+    /**
+     * authority defines the custom module authority. If not set, defaults to the governance module.
+     */
     authority: string;
 }
 export interface ModuleProtoMsg {
     typeUrl: "/cosmos.upgrade.module.v1.Module";
     value: Uint8Array;
 }
-/** Module is the config object of the upgrade module. */
+/**
+ * Module is the config object of the upgrade module.
+ * @name ModuleAmino
+ * @package cosmos.upgrade.module.v1
+ * @see proto type: cosmos.upgrade.module.v1.Module
+ */
 export interface ModuleAmino {
-    /** authority defines the custom module authority. If not set, defaults to the governance module. */
+    /**
+     * authority defines the custom module authority. If not set, defaults to the governance module.
+     */
     authority: string;
 }
 export interface ModuleAminoMsg {
     type: "cosmos-sdk/Module";
     value: ModuleAmino;
 }
+/**
+ * Module is the config object of the upgrade module.
+ * @name Module
+ * @package cosmos.upgrade.module.v1
+ * @see proto type: cosmos.upgrade.module.v1.Module
+ */
 export declare const Module: {
     typeUrl: string;
     aminoType: string;

package/cosmos/upgrade/module/v1/module.js

@@ -7,6 +7,12 @@ function createBaseModule() {
         authority: ""
     };
 }
+/**
+ * Module is the config object of the upgrade module.
+ * @name Module
+ * @package cosmos.upgrade.module.v1
+ * @see proto type: cosmos.upgrade.module.v1.Module
+ */
 exports.Module = {
     typeUrl: "/cosmos.upgrade.module.v1.Module",
     aminoType: "cosmos-sdk/Module",