injectivejs 1.11.13 → 1.11.15

package/cosmos/crypto/ed25519/keys.js

@@ -8,6 +8,16 @@ function createBasePubKey() {
         key: new Uint8Array()
     };
 }
+/**
+ * PubKey is an ed25519 public key for handling Tendermint keys in SDK.
+ * It's needed for Any serialization and SDK compatibility.
+ * It must not be used in a non Tendermint key context because it doesn't implement
+ * ADR-28. Nevertheless, you will like to use ed25519 in app user level
+ * then you must create a new proto message and follow ADR-28 for Address construction.
+ * @name PubKey
+ * @package cosmos.crypto.ed25519
+ * @see proto type: cosmos.crypto.ed25519.PubKey
+ */
 exports.PubKey = {
     typeUrl: "/cosmos.crypto.ed25519.PubKey",
     aminoType: "tendermint/PubKeyEd25519",
@@ -85,6 +95,13 @@ function createBasePrivKey() {
         key: new Uint8Array()
     };
 }
+/**
+ * PrivKey defines a ed25519 private key.
+ * NOTE: ed25519 keys must not be used in SDK apps except in a tendermint validator context.
+ * @name PrivKey
+ * @package cosmos.crypto.ed25519
+ * @see proto type: cosmos.crypto.ed25519.PrivKey
+ */
 exports.PrivKey = {
     typeUrl: "/cosmos.crypto.ed25519.PrivKey",
     aminoType: "tendermint/PrivKeyEd25519",

package/cosmos/crypto/multisig/v1beta1/multisig.d.ts

@@ -4,6 +4,9 @@ import { DeepPartial } from "../../../../helpers";
  * MultiSignature wraps the signatures from a multisig.LegacyAminoPubKey.
  * See cosmos.tx.v1betata1.ModeInfo.Multi for how to specify which signers
  * signed and with which modes.
+ * @name MultiSignature
+ * @package cosmos.crypto.multisig.v1beta1
+ * @see proto type: cosmos.crypto.multisig.v1beta1.MultiSignature
  */
 export interface MultiSignature {
     signatures: Uint8Array[];
@@ -16,6 +19,9 @@ export interface MultiSignatureProtoMsg {
  * MultiSignature wraps the signatures from a multisig.LegacyAminoPubKey.
  * See cosmos.tx.v1betata1.ModeInfo.Multi for how to specify which signers
  * signed and with which modes.
+ * @name MultiSignatureAmino
+ * @package cosmos.crypto.multisig.v1beta1
+ * @see proto type: cosmos.crypto.multisig.v1beta1.MultiSignature
  */
 export interface MultiSignatureAmino {
     signatures: string[];
@@ -29,6 +35,9 @@ export interface MultiSignatureAminoMsg {
  * This is used to ensure that the encoded data takes up a minimal amount of
  * space after proto encoding.
  * This is not thread safe, and is not intended for concurrent usage.
+ * @name CompactBitArray
+ * @package cosmos.crypto.multisig.v1beta1
+ * @see proto type: cosmos.crypto.multisig.v1beta1.CompactBitArray
  */
 export interface CompactBitArray {
     extraBitsStored: number;
@@ -43,6 +52,9 @@ export interface CompactBitArrayProtoMsg {
  * This is used to ensure that the encoded data takes up a minimal amount of
  * space after proto encoding.
  * This is not thread safe, and is not intended for concurrent usage.
+ * @name CompactBitArrayAmino
+ * @package cosmos.crypto.multisig.v1beta1
+ * @see proto type: cosmos.crypto.multisig.v1beta1.CompactBitArray
  */
 export interface CompactBitArrayAmino {
     extra_bits_stored: number;
@@ -52,6 +64,14 @@ export interface CompactBitArrayAminoMsg {
     type: "cosmos-sdk/CompactBitArray";
     value: CompactBitArrayAmino;
 }
+/**
+ * MultiSignature wraps the signatures from a multisig.LegacyAminoPubKey.
+ * See cosmos.tx.v1betata1.ModeInfo.Multi for how to specify which signers
+ * signed and with which modes.
+ * @name MultiSignature
+ * @package cosmos.crypto.multisig.v1beta1
+ * @see proto type: cosmos.crypto.multisig.v1beta1.MultiSignature
+ */
 export declare const MultiSignature: {
     typeUrl: string;
     aminoType: string;
@@ -69,6 +89,15 @@ export declare const MultiSignature: {
     toProtoMsg(message: MultiSignature): MultiSignatureProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * CompactBitArray is an implementation of a space efficient bit array.
+ * This is used to ensure that the encoded data takes up a minimal amount of
+ * space after proto encoding.
+ * This is not thread safe, and is not intended for concurrent usage.
+ * @name CompactBitArray
+ * @package cosmos.crypto.multisig.v1beta1
+ * @see proto type: cosmos.crypto.multisig.v1beta1.CompactBitArray
+ */
 export declare const CompactBitArray: {
     typeUrl: string;
     aminoType: string;

package/cosmos/crypto/multisig/v1beta1/multisig.js

@@ -8,6 +8,14 @@ function createBaseMultiSignature() {
         signatures: []
     };
 }
+/**
+ * MultiSignature wraps the signatures from a multisig.LegacyAminoPubKey.
+ * See cosmos.tx.v1betata1.ModeInfo.Multi for how to specify which signers
+ * signed and with which modes.
+ * @name MultiSignature
+ * @package cosmos.crypto.multisig.v1beta1
+ * @see proto type: cosmos.crypto.multisig.v1beta1.MultiSignature
+ */
 exports.MultiSignature = {
     typeUrl: "/cosmos.crypto.multisig.v1beta1.MultiSignature",
     aminoType: "cosmos-sdk/MultiSignature",
@@ -89,6 +97,15 @@ function createBaseCompactBitArray() {
         elems: new Uint8Array()
     };
 }
+/**
+ * CompactBitArray is an implementation of a space efficient bit array.
+ * This is used to ensure that the encoded data takes up a minimal amount of
+ * space after proto encoding.
+ * This is not thread safe, and is not intended for concurrent usage.
+ * @name CompactBitArray
+ * @package cosmos.crypto.multisig.v1beta1
+ * @see proto type: cosmos.crypto.multisig.v1beta1.CompactBitArray
+ */
 exports.CompactBitArray = {
     typeUrl: "/cosmos.crypto.multisig.v1beta1.CompactBitArray",
     aminoType: "cosmos-sdk/CompactBitArray",

package/cosmos/crypto/secp256k1/keys.d.ts

@@ -6,6 +6,9 @@ import { DeepPartial } from "../../../helpers";
  * if the y-coordinate is the lexicographically largest of the two associated with
  * the x-coordinate. Otherwise the first byte is a 0x03.
  * This prefix is followed with the x-coordinate.
+ * @name PubKey
+ * @package cosmos.crypto.secp256k1
+ * @see proto type: cosmos.crypto.secp256k1.PubKey
  */
 export interface PubKey {
     key: Uint8Array;
@@ -20,6 +23,9 @@ export interface PubKeyProtoMsg {
  * if the y-coordinate is the lexicographically largest of the two associated with
  * the x-coordinate. Otherwise the first byte is a 0x03.
  * This prefix is followed with the x-coordinate.
+ * @name PubKeyAmino
+ * @package cosmos.crypto.secp256k1
+ * @see proto type: cosmos.crypto.secp256k1.PubKey
  */
 export interface PubKeyAmino {
     key: string;
@@ -28,7 +34,12 @@ export interface PubKeyAminoMsg {
     type: "tendermint/PubKeySecp256k1";
     value: PubKeyAmino;
 }
-/** PrivKey defines a secp256k1 private key. */
+/**
+ * PrivKey defines a secp256k1 private key.
+ * @name PrivKey
+ * @package cosmos.crypto.secp256k1
+ * @see proto type: cosmos.crypto.secp256k1.PrivKey
+ */
 export interface PrivKey {
     key: Uint8Array;
 }
@@ -36,7 +47,12 @@ export interface PrivKeyProtoMsg {
     typeUrl: "/cosmos.crypto.secp256k1.PrivKey";
     value: Uint8Array;
 }
-/** PrivKey defines a secp256k1 private key. */
+/**
+ * PrivKey defines a secp256k1 private key.
+ * @name PrivKeyAmino
+ * @package cosmos.crypto.secp256k1
+ * @see proto type: cosmos.crypto.secp256k1.PrivKey
+ */
 export interface PrivKeyAmino {
     key: string;
 }
@@ -44,6 +60,16 @@ export interface PrivKeyAminoMsg {
     type: "tendermint/PrivKeySecp256k1";
     value: PrivKeyAmino;
 }
+/**
+ * PubKey defines a secp256k1 public key
+ * Key is the compressed form of the pubkey. The first byte depends is a 0x02 byte
+ * if the y-coordinate is the lexicographically largest of the two associated with
+ * the x-coordinate. Otherwise the first byte is a 0x03.
+ * This prefix is followed with the x-coordinate.
+ * @name PubKey
+ * @package cosmos.crypto.secp256k1
+ * @see proto type: cosmos.crypto.secp256k1.PubKey
+ */
 export declare const PubKey: {
     typeUrl: string;
     aminoType: string;
@@ -61,6 +87,12 @@ export declare const PubKey: {
     toProtoMsg(message: PubKey): PubKeyProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * PrivKey defines a secp256k1 private key.
+ * @name PrivKey
+ * @package cosmos.crypto.secp256k1
+ * @see proto type: cosmos.crypto.secp256k1.PrivKey
+ */
 export declare const PrivKey: {
     typeUrl: string;
     aminoType: string;

package/cosmos/crypto/secp256k1/keys.js

@@ -8,6 +8,16 @@ function createBasePubKey() {
         key: new Uint8Array()
     };
 }
+/**
+ * PubKey defines a secp256k1 public key
+ * Key is the compressed form of the pubkey. The first byte depends is a 0x02 byte
+ * if the y-coordinate is the lexicographically largest of the two associated with
+ * the x-coordinate. Otherwise the first byte is a 0x03.
+ * This prefix is followed with the x-coordinate.
+ * @name PubKey
+ * @package cosmos.crypto.secp256k1
+ * @see proto type: cosmos.crypto.secp256k1.PubKey
+ */
 exports.PubKey = {
     typeUrl: "/cosmos.crypto.secp256k1.PubKey",
     aminoType: "tendermint/PubKeySecp256k1",
@@ -85,6 +95,12 @@ function createBasePrivKey() {
         key: new Uint8Array()
     };
 }
+/**
+ * PrivKey defines a secp256k1 private key.
+ * @name PrivKey
+ * @package cosmos.crypto.secp256k1
+ * @see proto type: cosmos.crypto.secp256k1.PrivKey
+ */
 exports.PrivKey = {
     typeUrl: "/cosmos.crypto.secp256k1.PrivKey",
     aminoType: "tendermint/PrivKeySecp256k1",

package/cosmos/crypto/secp256r1/keys.d.ts

@@ -1,6 +1,11 @@
 import { BinaryReader, BinaryWriter } from "../../../binary";
 import { DeepPartial } from "../../../helpers";
-/** PubKey defines a secp256r1 ECDSA public key. */
+/**
+ * PubKey defines a secp256r1 ECDSA public key.
+ * @name PubKey
+ * @package cosmos.crypto.secp256r1
+ * @see proto type: cosmos.crypto.secp256r1.PubKey
+ */
 export interface PubKey {
     /**
      * Point on secp256r1 curve in a compressed representation as specified in section
@@ -12,7 +17,12 @@ export interface PubKeyProtoMsg {
     typeUrl: "/cosmos.crypto.secp256r1.PubKey";
     value: Uint8Array;
 }
-/** PubKey defines a secp256r1 ECDSA public key. */
+/**
+ * PubKey defines a secp256r1 ECDSA public key.
+ * @name PubKeyAmino
+ * @package cosmos.crypto.secp256r1
+ * @see proto type: cosmos.crypto.secp256r1.PubKey
+ */
 export interface PubKeyAmino {
     /**
      * Point on secp256r1 curve in a compressed representation as specified in section
@@ -24,24 +34,44 @@ export interface PubKeyAminoMsg {
     type: "cosmos-sdk/PubKey";
     value: PubKeyAmino;
 }
-/** PrivKey defines a secp256r1 ECDSA private key. */
+/**
+ * PrivKey defines a secp256r1 ECDSA private key.
+ * @name PrivKey
+ * @package cosmos.crypto.secp256r1
+ * @see proto type: cosmos.crypto.secp256r1.PrivKey
+ */
 export interface PrivKey {
-    /** secret number serialized using big-endian encoding */
+    /**
+     * secret number serialized using big-endian encoding
+     */
     secret: Uint8Array;
 }
 export interface PrivKeyProtoMsg {
     typeUrl: "/cosmos.crypto.secp256r1.PrivKey";
     value: Uint8Array;
 }
-/** PrivKey defines a secp256r1 ECDSA private key. */
+/**
+ * PrivKey defines a secp256r1 ECDSA private key.
+ * @name PrivKeyAmino
+ * @package cosmos.crypto.secp256r1
+ * @see proto type: cosmos.crypto.secp256r1.PrivKey
+ */
 export interface PrivKeyAmino {
-    /** secret number serialized using big-endian encoding */
+    /**
+     * secret number serialized using big-endian encoding
+     */
     secret: string;
 }
 export interface PrivKeyAminoMsg {
     type: "cosmos-sdk/PrivKey";
     value: PrivKeyAmino;
 }
+/**
+ * PubKey defines a secp256r1 ECDSA public key.
+ * @name PubKey
+ * @package cosmos.crypto.secp256r1
+ * @see proto type: cosmos.crypto.secp256r1.PubKey
+ */
 export declare const PubKey: {
     typeUrl: string;
     aminoType: string;
@@ -59,6 +89,12 @@ export declare const PubKey: {
     toProtoMsg(message: PubKey): PubKeyProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * PrivKey defines a secp256r1 ECDSA private key.
+ * @name PrivKey
+ * @package cosmos.crypto.secp256r1
+ * @see proto type: cosmos.crypto.secp256r1.PrivKey
+ */
 export declare const PrivKey: {
     typeUrl: string;
     aminoType: string;

package/cosmos/crypto/secp256r1/keys.js

@@ -8,6 +8,12 @@ function createBasePubKey() {
         key: new Uint8Array()
     };
 }
+/**
+ * PubKey defines a secp256r1 ECDSA public key.
+ * @name PubKey
+ * @package cosmos.crypto.secp256r1
+ * @see proto type: cosmos.crypto.secp256r1.PubKey
+ */
 exports.PubKey = {
     typeUrl: "/cosmos.crypto.secp256r1.PubKey",
     aminoType: "cosmos-sdk/PubKey",
@@ -85,6 +91,12 @@ function createBasePrivKey() {
         secret: new Uint8Array()
     };
 }
+/**
+ * PrivKey defines a secp256r1 ECDSA private key.
+ * @name PrivKey
+ * @package cosmos.crypto.secp256r1
+ * @see proto type: cosmos.crypto.secp256r1.PrivKey
+ */
 exports.PrivKey = {
     typeUrl: "/cosmos.crypto.secp256r1.PrivKey",
     aminoType: "cosmos-sdk/PrivKey",