npm - @keetanetwork/keetanet-client - Versions diffs - 0.10.5 → 0.12.2 - Mend

@keetanetwork/keetanet-client 0.10.5 → 0.12.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (255) hide show

package/docs/variables/KeetaNetSDK.Referenced.src_lib_utils_helper.crypto.html ADDED Viewed

@@ -0,0 +1 @@

+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>crypto | @keetanetwork/keetanet-client</title><meta name="description" content="Documentation for @keetanetwork/keetanet-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script><link rel="stylesheet" href="../assets/typedoc-github-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title"><img src="../assets/logo-keeta-light.svg" alt="Keeta Logo" class="keeta-logo-light" width="50" height="20"/><img src="../assets/logo-keeta-dark.svg" alt="Keeta Logo" class="keeta-logo-dark" width="50" height="20"/>@keetanetwork/keetanet-client</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M17.9421 17.0578L14.0304 13.1469C15.1642 11.7857 15.7295 10.0398 15.6089 8.27245C15.4882 6.50506 14.6908 4.85223 13.3825 3.65779C12.0743 2.46335 10.3559 1.81926 8.58486 1.85951C6.81382 1.89976 5.12647 2.62125 3.87383 3.87389C2.62118 5.12653 1.89969 6.81388 1.85944 8.58493C1.8192 10.356 2.46328 12.0744 3.65772 13.3826C4.85217 14.6909 6.50499 15.4883 8.27238 15.6089C10.0398 15.7296 11.7856 15.1642 13.1468 14.0305L17.0577 17.9422C17.1158 18.0003 17.1848 18.0463 17.2606 18.0777C17.3365 18.1092 17.4178 18.1253 17.4999 18.1253C17.5821 18.1253 17.6634 18.1092 17.7392 18.0777C17.8151 18.0463 17.8841 18.0003 17.9421 17.9422C18.0002 17.8841 18.0463 17.8152 18.0777 17.7393C18.1091 17.6634 18.1253 17.5821 18.1253 17.5C18.1253 17.4179 18.1091 17.3366 18.0777 17.2607C18.0463 17.1848 18.0002 17.1159 17.9421 17.0578ZM3.12493 8.75C3.12493 7.63748 3.45483 6.54994 4.07292 5.62492C4.691 4.69989 5.56951 3.97892 6.59734 3.55318C7.62517 3.12743 8.75617 3.01604 9.84732 3.23308C10.9385 3.45012 11.9407 3.98585 12.7274 4.77252C13.5141 5.55919 14.0498 6.56147 14.2669 7.65262C14.4839 8.74376 14.3725 9.87476 13.9468 10.9026C13.521 11.9304 12.8 12.8089 11.875 13.427C10.95 14.0451 9.86245 14.375 8.74993 14.375C7.2586 14.3733 5.82882 13.7802 4.77429 12.7256C3.71975 11.6711 3.12659 10.2413 3.12493 8.75Z" fill="var(--color-icon-text)"></path></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><rect x="1" y="3" width="14" height="2" fill="var(--color-icon-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-icon-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-icon-text)"></rect></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/KeetaNetSDK.html">KeetaNetSDK</a></li><li><a href="../modules/KeetaNetSDK.Referenced.html">Referenced</a></li><li><a href="../modules/KeetaNetSDK.Referenced.src_lib_utils_helper.html">src/lib/utils/helper</a></li><li><a href="" aria-current="page">crypto</a></li></ul><h1>Variable crypto<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature">crypto: { createCipheriv: { ( algorithm: CipherCCMTypes, key: CipherKey, iv: BinaryLike, options: CipherCCMOptions, ): CipherCCM; ( algorithm: CipherOCBTypes, key: CipherKey, iv: BinaryLike, options: CipherOCBOptions, ): CipherOCB; ( algorithm: CipherGCMTypes, key: CipherKey, iv: BinaryLike, options?: CipherGCMOptions, ): CipherGCM; ( algorithm: string, key: CipherKey, iv: null | BinaryLike, options?: TransformOptions, ): Cipher; }; createDecipheriv: { ( algorithm: CipherCCMTypes, key: CipherKey, iv: BinaryLike, options: CipherCCMOptions, ): DecipherCCM; ( algorithm: CipherOCBTypes, key: CipherKey, iv: BinaryLike, options: CipherOCBOptions, ): DecipherOCB; ( algorithm: CipherGCMTypes, key: CipherKey, iv: BinaryLike, options?: CipherGCMOptions, ): DecipherGCM; ( algorithm: string, key: CipherKey, iv: null | BinaryLike, options?: TransformOptions, ): Decipher; }; randomBytes: { (size: number): Buffer; (size: number, callback: (err: null | Error, buf: Buffer) => void): void; }; randomUUID: | ( ( options?: RandomUUIDOptions, ) => `${string}-${string}-${string}-${string}-${string}` ) | (() => string); } = ...</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5 id="createcipheriv">createCipheriv: { ( algorithm: CipherCCMTypes, key: CipherKey, iv: BinaryLike, options: CipherCCMOptions, ): CipherCCM; ( algorithm: CipherOCBTypes, key: CipherKey, iv: BinaryLike, options: CipherOCBOptions, ): CipherOCB; ( algorithm: CipherGCMTypes, key: CipherKey, iv: BinaryLike, options?: CipherGCMOptions, ): CipherGCM; ( algorithm: string, key: CipherKey, iv: null | BinaryLike, options?: TransformOptions, ): Cipher; }</h5></li><li class="tsd-parameter"><h5 id="createdecipheriv">createDecipheriv: { ( algorithm: CipherCCMTypes, key: CipherKey, iv: BinaryLike, options: CipherCCMOptions, ): DecipherCCM; ( algorithm: CipherOCBTypes, key: CipherKey, iv: BinaryLike, options: CipherOCBOptions, ): DecipherOCB; ( algorithm: CipherGCMTypes, key: CipherKey, iv: BinaryLike, options?: CipherGCMOptions, ): DecipherGCM; ( algorithm: string, key: CipherKey, iv: null | BinaryLike, options?: TransformOptions, ): Decipher; }</h5></li><li class="tsd-parameter"><h5 id="randombytes">randomBytes: { (size: number): Buffer; (size: number, callback: (err: null | Error, buf: Buffer) => void): void; }</h5></li><li class="tsd-parameter"><h5 id="randomuuid">randomUUID: | ( ( options?: RandomUUIDOptions, ) => `${string}-${string}-${string}-${string}-${string}` ) | (() => string)</h5></li></ul></div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-icon-text)"></path></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility">Member Visibility<ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Protected</label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Inherited</label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>External</label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@keetanetwork/keetanet-client</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer>KeetaSDK Documentation</footer><div class="overlay"></div></body></html>

package/lib/account.d.ts CHANGED Viewed

@@ -16,7 +16,8 @@ export declare enum AccountKeyAlgorithm {
     NETWORK = 2,
     TOKEN = 3,
     STORAGE = 4,
-    ECDSA_SECP256R1 = 6
+    ECDSA_SECP256R1 = 6,// NIST P-256
+    MULTISIG = 7
 }
 /**
  * Type for ASN.1 encoded public keys -- this is equivalent to {@link ValidateASN1.SchemaMap<typeof publicKeyASN1Schema>}
@@ -32,7 +33,55 @@ type publicKeyASN1 = [
         value: Buffer;
     }
 ];
-declare const identifierKeyTypes: readonly [AccountKeyAlgorithm.NETWORK, AccountKeyAlgorithm.TOKEN, AccountKeyAlgorithm.STORAGE];
+/**
+ * Key pair types which we can process
+ */
+type KeyPairTypes = ECDSAKeyPair | ECDSASECP256K1KeyPair | ECDSASECP256R1KeyPair | ED25519KeyPair | IdentifierKeyPair | ExternalKeyPair;
+/**
+ * Generic interface to an account.  An account may be backed by a private key
+ * (in which case it can sign data), a seed+index (which is used to generate
+ * a private key), or a public key (which can only verify blocks).
+ */
+type PublicKeyStringPrefixed<X extends string> = `${AccountPrefix}${X}${string}`;
+export type Secp256K1PublicKeyString = PublicKeyStringPrefixed<'aa' | 'ab' | 'ac' | 'ad'>;
+export type Secp256R1PublicKeyString = PublicKeyStringPrefixed<'ay' | 'az' | 'a2' | 'a3'>;
+export type ED25519PublicKeyString = PublicKeyStringPrefixed<'ae' | 'af' | 'ag' | 'ah'>;
+export type NetworkPublicKeyString = PublicKeyStringPrefixed<'ai' | 'aj' | 'ak' | 'al'>;
+export type TokenPublicKeyString = PublicKeyStringPrefixed<'am' | 'an' | 'ao' | 'ap'>;
+export type StoragePublicKeyString = PublicKeyStringPrefixed<'aq' | 'ar' | 'as' | 'at'>;
+export type MultisigPublicKeyString = PublicKeyStringPrefixed<'a4' | 'a5' | 'a6' | 'a7'>;
+export interface PublicKeyStringMapping {
+    [AccountKeyAlgorithm.ECDSA_SECP256K1]: Secp256K1PublicKeyString;
+    [AccountKeyAlgorithm.ECDSA_SECP256R1]: Secp256R1PublicKeyString;
+    [AccountKeyAlgorithm.ED25519]: ED25519PublicKeyString;
+    [AccountKeyAlgorithm.TOKEN]: TokenPublicKeyString;
+    [AccountKeyAlgorithm.NETWORK]: NetworkPublicKeyString;
+    [AccountKeyAlgorithm.STORAGE]: StoragePublicKeyString;
+    [AccountKeyAlgorithm.MULTISIG]: MultisigPublicKeyString;
+}
+export type IdentifierPublicKeyString = PublicKeyStringMapping[IdentifierKeyAlgorithm];
+export type AccountPublicKeyString = Secp256K1PublicKeyString | Secp256R1PublicKeyString | ED25519PublicKeyString;
+type AccountKeyAlgorithmHex = {
+    [AccountKeyAlgorithm.ECDSA_SECP256K1]: '0x00';
+    [AccountKeyAlgorithm.ED25519]: '0x01';
+    [AccountKeyAlgorithm.TOKEN]: '0x02';
+    [AccountKeyAlgorithm.NETWORK]: '0x03';
+    [AccountKeyAlgorithm.STORAGE]: '0x04';
+    [AccountKeyAlgorithm.ECDSA_SECP256R1]: '0x06';
+    [AccountKeyAlgorithm.MULTISIG]: '0x07';
+};
+/**
+ * A hex-encoded public key and type, where the type is the first byte
+ * and the public key is the rest of the string.
+ */
+export type PublicKeyAndTypeStringHex<Algo extends typeof AccountKeyAlgorithm[keyof typeof AccountKeyAlgorithm] = AccountKeyAlgorithm> = `${AccountKeyAlgorithmHex[Algo]}${string}`;
+type AccountKeyAlgorithmHexReverse = {
+    [Hex in AccountKeyAlgorithmHex[keyof AccountKeyAlgorithmHex]]: Extract<keyof AccountKeyAlgorithmHex, {
+        [K in keyof AccountKeyAlgorithmHex]: AccountKeyAlgorithmHex[K] extends Hex ? K : never;
+    }[keyof AccountKeyAlgorithmHex]>;
+};
+type AccountKeyAlgorithmHexToType<T extends PublicKeyAndTypeStringHex> = T extends `0x${infer AlgorithmHex1}${infer AlgorithmHex2}${string}` ? `0x${AlgorithmHex1}${AlgorithmHex2}` extends keyof AccountKeyAlgorithmHexReverse ? AccountKeyAlgorithmHexReverse[`0x${AlgorithmHex1}${AlgorithmHex2}`] : never : never;
+declare const identifierKeyTypes: readonly [AccountKeyAlgorithm.NETWORK, AccountKeyAlgorithm.TOKEN, AccountKeyAlgorithm.STORAGE, AccountKeyAlgorithm.MULTISIG];
 export type IdentifierKeyAlgorithm = typeof identifierKeyTypes[any];
 /**
  * Things we can use to construct a key from
@@ -324,31 +373,11 @@ declare class IdentifierKeyPair extends KeyInterface {
     decrypt(..._ignored_parameters: Parameters<decryptFunctionType>): ReturnType<decryptFunctionType>;
 }
 /**
- * Key pair types which we can process
- */
-type KeyPairTypes = ECDSAKeyPair | ECDSASECP256K1KeyPair | ECDSASECP256R1KeyPair | ED25519KeyPair | IdentifierKeyPair | ExternalKeyPair;
-/**
- * Generic interface to an account.  An account may be backed by a private key
- * (in which case it can sign data), a seed+index (which is used to generate
- * a private key), or a public key (which can only verify blocks).
+ * Account class, which is used to represent a key pair or an identifier
+ * account (which have no private key) such as tokens.
+ *
+ * @template T - The type of the key algorithm used for this account.
  */
-type PublicKeyStringPrefixed<X extends string> = `${AccountPrefix}${X}${string}`;
-export type Secp256K1PublicKeyString = PublicKeyStringPrefixed<'aa' | 'ab' | 'ac' | 'ad'>;
-export type Secp256R1PublicKeyString = PublicKeyStringPrefixed<'ay' | 'az' | 'a2' | 'a3'>;
-export type ED25519PublicKeyString = PublicKeyStringPrefixed<'ae' | 'af' | 'ag' | 'ah'>;
-export type NetworkPublicKeyString = PublicKeyStringPrefixed<'ai' | 'aj' | 'ak' | 'al'>;
-export type TokenPublicKeyString = PublicKeyStringPrefixed<'am' | 'an' | 'ao' | 'ap'>;
-export type StoragePublicKeyString = PublicKeyStringPrefixed<'aq' | 'ar' | 'as' | 'at'>;
-export interface PublicKeyStringMapping {
-    [AccountKeyAlgorithm.ECDSA_SECP256K1]: Secp256K1PublicKeyString;
-    [AccountKeyAlgorithm.ECDSA_SECP256R1]: Secp256R1PublicKeyString;
-    [AccountKeyAlgorithm.ED25519]: ED25519PublicKeyString;
-    [AccountKeyAlgorithm.TOKEN]: TokenPublicKeyString;
-    [AccountKeyAlgorithm.NETWORK]: NetworkPublicKeyString;
-    [AccountKeyAlgorithm.STORAGE]: StoragePublicKeyString;
-}
-export type IdentifierPublicKeyString = PublicKeyStringMapping[IdentifierKeyAlgorithm];
-export type AccountPublicKeyString = Secp256K1PublicKeyString | Secp256R1PublicKeyString | ED25519PublicKeyString;
 export declare class Account<T extends AccountKeyAlgorithm = Exclude<AccountKeyAlgorithm, IdentifierKeyAlgorithm>> {
     #private;
     static AccountKeyAlgorithm: typeof AccountKeyAlgorithm;
@@ -360,6 +389,7 @@ export declare class Account<T extends AccountKeyAlgorithm = Exclude<AccountKeyA
     static fromPublicKeyString(key: TokenPublicKeyString): Account<AccountKeyAlgorithm.TOKEN>;
     static fromPublicKeyString(key: NetworkPublicKeyString): Account<AccountKeyAlgorithm.NETWORK>;
     static fromPublicKeyString(key: StoragePublicKeyString): Account<AccountKeyAlgorithm.STORAGE>;
+    static fromPublicKeyString(key: MultisigPublicKeyString): Account<AccountKeyAlgorithm.MULTISIG>;
     static fromPublicKeyString(key: Secp256K1PublicKeyString): Account<AccountKeyAlgorithm.ECDSA_SECP256K1>;
     static fromPublicKeyString(key: Secp256R1PublicKeyString): Account<AccountKeyAlgorithm.ECDSA_SECP256R1>;
     static fromPublicKeyString(key: ED25519PublicKeyString): Account<AccountKeyAlgorithm.ED25519>;
@@ -402,6 +432,10 @@ export declare class Account<T extends AccountKeyAlgorithm = Exclude<AccountKeyA
      * Construct an account from a storage identifier public key
      */
     static fromStoragePublicKey(key: InputKeyTypes): Account<AccountKeyAlgorithm.STORAGE>;
+    /**
+     * Construct an account from a multisig identifier public key
+     */
+    static fromMultisigPublicKey(key: InputKeyTypes): Account<AccountKeyAlgorithm.MULTISIG>;
     /**
      * Construct an account from an ED25519 public key.
      */
@@ -410,6 +444,8 @@ export declare class Account<T extends AccountKeyAlgorithm = Exclude<AccountKeyA
      * Construct an Account from an KeyType and Public Key buffer
      */
     static fromPublicKeyAndType(keyData: Buffer): GenericAccount;
+    static fromPublicKeyAndType<T extends AccountKeyAlgorithm>(keyData: PublicKeyAndTypeStringHex<T>): Account<T>;
+    static fromPublicKeyAndType(keyData: string): GenericAccount;
     /**
      * Construct a new account from a public key encoded in DER-encoded ASN.1
      */
@@ -453,6 +489,7 @@ export declare class Account<T extends AccountKeyAlgorithm = Exclude<AccountKeyA
     static toAccount(): undefined;
     static toAccount(acct: null): null;
     static toAccount(acct: undefined): undefined;
+    static toAccount<X extends PublicKeyAndTypeStringHex>(acct: X): Account<AccountKeyAlgorithmHexToType<X>>;
     static toAccount<toAlgo extends AccountKeyAlgorithm>(acct: string | Account<toAlgo>): Account<toAlgo>;
     static toAccount<toAlgo extends AccountKeyAlgorithm>(acct: string | Account<toAlgo> | null): Account<toAlgo> | null;
     static toAccount<toAlgo extends AccountKeyAlgorithm>(acct: string | Account<toAlgo> | undefined): Account<toAlgo> | undefined;
@@ -468,7 +505,7 @@ export declare class Account<T extends AccountKeyAlgorithm = Exclude<AccountKeyA
     static toPublicKeyString(acct: string | Account<AccountKeyAlgorithm> | undefined | null): string | undefined | null;
     static comparePublicKeys(acct1: Account<AccountKeyAlgorithm> | string | undefined | null, acct2: Account<AccountKeyAlgorithm> | string | undefined | null): boolean;
     static isInstance: (obj: any, strict?: boolean) => obj is Account<AccountKeyAlgorithm>;
-    static Set: import("./utils/helper").InstanceSetConstructor<Account<AccountKeyAlgorithm>, string>;
+    static Set: import("./utils/helper").InstanceSetConstructor<Account<AccountKeyAlgorithm>, `0x00${string}` | `0x01${string}` | `0x03${string}` | `0x02${string}` | `0x04${string}` | `0x06${string}` | `0x07${string}`>;
     constructor(key: KeyPairTypes | ECDSASECP256K1PrivateKey | ECDSASECP256R1PrivateKey | ED25519PrivateKey | ECDSASECP256K1PublicKey | ECDSASECP256R1PublicKey | ED25519PublicKey | IdentifierKeyPair | IdentifierKey | PublicKeyString | Account<T>, requiredKeyType?: T);
     /**
      * Sign some data and generate a detached signature in SEC format
@@ -507,6 +544,7 @@ export declare class Account<T extends AccountKeyAlgorithm = Exclude<AccountKeyA
      */
     get publicKey(): ECDSASECP256K1PublicKey | ECDSASECP256R1PublicKey | ED25519PublicKey;
     get publicKeyAndType(): Buffer;
+    get publicKeyAndTypeString(): PublicKeyAndTypeStringHex<T>;
     /**
      * Determine if this account has a private key associated with it
      */
@@ -529,15 +567,16 @@ export declare class Account<T extends AccountKeyAlgorithm = Exclude<AccountKeyA
     isStorage(): this is Account<AccountKeyAlgorithm.STORAGE>;
     isNetwork(): this is Account<AccountKeyAlgorithm.NETWORK>;
     isToken(): this is Account<AccountKeyAlgorithm.TOKEN>;
+    isMultisig(): this is Account<AccountKeyAlgorithm.MULTISIG>;
     assertKeyType<KeyType extends AccountKeyAlgorithm>(keyType: KeyType): Account<KeyType>;
     assertAccount(): Account;
     assertIdentifier(): IdentifierAddress;
-    static toJSONSerializablePrefix: string;
-    static toJSONSerializable(value: GenericAccount): Secp256K1PublicKeyString | ED25519PublicKeyString | NetworkPublicKeyString | TokenPublicKeyString | StoragePublicKeyString | Secp256R1PublicKeyString;
+    toJSON(): PublicKeyStringMapping[T];
 }
 export type TokenAddress = Account<AccountKeyAlgorithm.TOKEN>;
 export type StorageAddress = Account<AccountKeyAlgorithm.STORAGE>;
 export type NetworkAddress = Account<AccountKeyAlgorithm.NETWORK>;
+export type MultisigAddress = Account<AccountKeyAlgorithm.MULTISIG>;
 export type IdentifierAddress = Account<IdentifierKeyAlgorithm>;
 export type NonIdentifierAccount = Account<Exclude<AccountKeyAlgorithm, IdentifierKeyAlgorithm>>;
 export type GenericAccount = Account<AccountKeyAlgorithm>;

package/lib/block/index.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@ import type { GenericAccount } from '../account';
 import Account from '../account';
 import { BufferStorage } from '../utils/buffer';
 import * as ASN1 from '../utils/asn1';
-import type { JSONSupported, ToJSONSerializableOptions } from '../utils/conversion';
+import type { ToJSONSerializable, ToJSONSerializableOptions } from '../utils/conversion';
 import * as Operations from './operations';
 export declare enum AdjustMethod {
     ADD = 0,
@@ -10,18 +10,21 @@ export declare enum AdjustMethod {
     SET = 2
 }
 export declare function assertAdjustMethod(value: any, bigintOkay?: boolean): AdjustMethod;
+type BlockHashString = string & {
+    readonly __blockhash: never;
+};
 /**
  * Block hash
  */
 export declare class BlockHash extends BufferStorage {
     static isInstance: (obj: any, strict?: boolean) => obj is BlockHash;
-    static Set: import("../utils/helper").InstanceSetConstructor<BlockHash, string>;
+    static Set: import("../utils/helper").InstanceSetConstructor<BlockHash, BlockHashString>;
     static getAccountOpeningHash(account: GenericAccount): BlockHash;
     fromData(data: Buffer): BlockHash;
     get hashFunctionName(): string;
     constructor(blockhash: ConstructorParameters<typeof BufferStorage>[0]);
-    static toJSONSerializablePrefix: string;
-    static toJSONSerializable(value: BlockHash, _ignore_opts: ToJSONSerializableOptions): string;
+    toJSON(): BlockHashString;
+    toString(): BlockHashString;
 }
 /**
  * Network ID
@@ -39,7 +42,7 @@ type BlockSignature = Buffer;
  * Representation of the block
  */
 export interface BlockJSON {
-    version: number;
+    version: 1;
     date: string | Date;
     previous: string | BlockHash;
     network: string | NetworkID;
@@ -53,17 +56,13 @@ export type BlockJSONIncomplete = Partial<BlockJSON>;
 /**
  * Output of block suitable to JSON serialization
  */
-export interface BlockJSONOutput extends JSONSupported<Omit<BlockJSON, 'operations'>> {
-    operations: JSONSupported<Operations.BlockJSONOperations>[];
-    $hash: string;
-    $opening: boolean;
-}
+export type BlockJSONOutput = ToJSONSerializable<ReturnType<Block['toJSON']>>;
 export type BlockJSONOutputIncomplete = Partial<BlockJSONOutput>;
 /**
  * Map input to our values
  */
 interface BlockUnsignedCanonical {
-    version: number;
+    version: 1;
     date: Date;
     previous: BlockHash;
     account: GenericAccount;
@@ -95,11 +94,12 @@ export declare class Block implements BlockCanonical {
         TOKEN_ADMIN_SUPPLY: typeof Operations.BlockOperationTOKEN_ADMIN_SUPPLY;
         TOKEN_ADMIN_MODIFY_BALANCE: typeof Operations.BlockOperationTOKEN_ADMIN_MODIFY_BALANCE;
         RECEIVE: typeof Operations.BlockOperationRECEIVE;
+        MANAGE_CERTIFICATE: typeof Operations.BlockOperationMANAGE_CERTIFICATE;
     };
     static NO_PREVIOUS: string;
     static AdjustMethod: typeof AdjustMethod;
     static Builder: typeof BlockBuilder;
-    readonly version: number;
+    readonly version: 1;
     readonly date: Date;
     readonly previous: BlockHash;
     readonly account: GenericAccount;
@@ -116,7 +116,20 @@ export declare class Block implements BlockCanonical {
     static getAccountOpeningHash(account: GenericAccount): BlockHash;
     toBytes(includeSignature?: boolean): ArrayBuffer;
     protected static getASN1ContainerWithoutSignature(input: BlockUnsignedCanonical | BlockCanonical): BlockASN1WithoutSignature;
-    toJSON(): BlockJSONOutput;
+    toJSON(options?: ToJSONSerializableOptions): {
+        $binary?: string;
+        version: 1;
+        date: Date;
+        previous: BlockHash;
+        account: GenericAccount;
+        signer: Account<import("../account").AccountKeyAlgorithm.ECDSA_SECP256K1 | import("../account").AccountKeyAlgorithm.ED25519 | import("../account").AccountKeyAlgorithm.ECDSA_SECP256R1>;
+        signature: string;
+        network: bigint;
+        subnet: bigint | undefined;
+        operations: Operations.ExportedJSONOperation[];
+        $hash: BlockHash;
+        $opening: boolean;
+    };
     /**
      * Hash of the block minus the signature
      *
@@ -126,13 +139,6 @@ export declare class Block implements BlockCanonical {
      *           signature (which isn't signed)
      */
     get hash(): BlockHash;
-    static toJSONSerializablePrefix: string;
-    static toJSONSerializable(value: Block, opts: ToJSONSerializableOptions): {
-        [x: string]: any;
-        operations: JSONSupported<Operations.BlockJSONOperations>[];
-        $hash: string;
-        $opening: boolean;
-    };
 }
 export declare class BlockBuilder implements BlockJSONIncomplete {
     #private;
@@ -148,13 +154,37 @@ export declare class BlockBuilder implements BlockJSONIncomplete {
         TOKEN_ADMIN_SUPPLY: typeof Operations.BlockOperationTOKEN_ADMIN_SUPPLY;
         TOKEN_ADMIN_MODIFY_BALANCE: typeof Operations.BlockOperationTOKEN_ADMIN_MODIFY_BALANCE;
         RECEIVE: typeof Operations.BlockOperationRECEIVE;
+        MANAGE_CERTIFICATE: typeof Operations.BlockOperationMANAGE_CERTIFICATE;
     };
     static NO_PREVIOUS: string;
     constructor(block?: BlockJSONIncomplete | BlockJSON | Block | ArrayBuffer | string);
     protected get currentBlock(): Block | BlockJSONIncomplete;
     protected get currentWIP(): BlockJSONIncomplete;
     protected get currentBlockSealed(): Block;
-    toJSON(): BlockJSONOutput | BlockJSONOutputIncomplete;
+    toJSON(opts?: ToJSONSerializableOptions): {
+        $binary?: string;
+        version: 1;
+        date: Date;
+        previous: BlockHash;
+        account: GenericAccount;
+        signer: Account<import("../account").AccountKeyAlgorithm.ECDSA_SECP256K1 | import("../account").AccountKeyAlgorithm.ED25519 | import("../account").AccountKeyAlgorithm.ECDSA_SECP256R1>;
+        signature: string;
+        network: bigint;
+        subnet: bigint | undefined;
+        operations: Operations.ExportedJSONOperation[];
+        $hash: BlockHash;
+        $opening: boolean;
+    } | {
+        version: 1 | undefined;
+        date: Date | undefined;
+        previous: BlockHash | undefined;
+        account: GenericAccount | undefined;
+        signer: Account<import("../account").AccountKeyAlgorithm.ECDSA_SECP256K1 | import("../account").AccountKeyAlgorithm.ED25519 | import("../account").AccountKeyAlgorithm.ECDSA_SECP256R1> | undefined;
+        network: bigint | undefined;
+        subnet: bigint | undefined;
+        operations: Operations.BlockOperations[] | undefined;
+        $opening: boolean | undefined;
+    };
     seal(): Promise<Block>;
     unseal(): BlockJSONIncomplete;
     get sealed(): boolean;
@@ -169,8 +199,8 @@ export declare class BlockBuilder implements BlockJSONIncomplete {
     get $opening(): boolean | undefined;
     set date(date: Date | string | undefined);
     get date(): Date | undefined;
-    set version(version: number | undefined);
-    get version(): number | undefined;
+    set version(version: 1 | undefined);
+    get version(): 1 | undefined;
     set network(network: NetworkID | string | undefined);
     get network(): NetworkID | undefined;
     set subnet(subnet: SubnetID | string | undefined);