@keetanetwork/keetanet-client 0.10.3 → 0.10.4

package/lib/error/account.d.ts

@@ -1,4 +1,4 @@
-import KeetaNetError from '.';
+import { KeetaNetError } from '.';
 declare const AccountErrorType: "ACCOUNT";
 declare const AccountErrorCodes: readonly ["INVALID_PREFIX", "INVALID_KEYTYPE", "INVALID_KEYTYPE_EXTERNAL", "PASSPHRASE_WEAK", "INVALID_CONSTRUCTION", "NO_IDENTIFIER_SIGN", "NO_IDENTIFIER_VERIFY", "INVALID_IDENTIFIER_CONSTRUCTION", "SEED_INDEX_UNDEFINED", "SEED_INDEX_NEGATIVE", "SEED_INDEX_NOT_INT", "SEED_INDEX_TOO_LARGE", "ENCRYPTION_NOT_SUPPORTED"];
 export type AccountErrorCode = `${typeof AccountErrorType}_${typeof AccountErrorCodes[number]}`;

package/lib/error/block.d.ts

@@ -1,4 +1,4 @@
-import KeetaNetError from '.';
+import { KeetaNetError } from '.';
 declare const BlockErrorType: "BLOCK";
 declare const BlockErrorCodes: readonly ["INVALID_TYPE", "NO_MULTIPLE_SET_REP", "IDENTIFIER_NEED_DEFAULT_PERMISSIONS", "CANNOT_SEND_NON_TOKEN", "TOKEN_RECEIVE_DIFFERS", "ONLY_TOKEN_OP", "ONLY_IDENTIFIER_OP", "NO_TOKEN_OP", "NO_IDENTIFIER_OP", "IDENTIFIER_INVALID", "GENERAL_FIELD_INVALID", "PERMISSIONS_INVALID_DEFAULT", "PERMISSIONS_INVALID_ENTITY", "PERMISSIONS_INVALID_PRINCIPAL", "PERMISSIONS_INVALID_TARGET", "INVALID_ACCOUNT_TYPE", "NO_ADMIN_ON_TARGET", "PREVIOUS_SELF", "NO_DELEGATE_ADMIN", "NO_MODIFY_PERMISSION_DUPE", "CANNOT_FORWARD_TO_SELF", "EXACT_TRUE_WHEN_FORWARDING", "EXTERNAL_TOO_LONG", "EXTERNAL_INVALID", "EXTERNAL_MISSING"];
 export type BlockErrorCode = `${typeof BlockErrorType}_${typeof BlockErrorCodes[number]}`;

package/lib/error/client.d.ts

@@ -1,6 +1,6 @@
-import KeetaNetError from '.';
+import { KeetaNetError } from '.';
 declare const ClientErrorType: "CLIENT";
-declare const ClientErrorCodes: readonly ["BUILDER_CANNOT_READ_BEFORE_RENDER", "BUILDER_REQUIRES_PRIVATE_KEY", "BUILDER_AMOUNT_IS_ZERO"];
+declare const ClientErrorCodes: readonly ["BUILDER_AMOUNT_IS_ZERO", "BUILDER_CANNOT_READ_BEFORE_RENDER", "BUILDER_REQUIRES_PRIVATE_KEY", "BUILDER_USER_CLIENT_REQUIRED", "PUBLISH_AID_NOT_AVAILABLE"];
 export type ClientErrorCode = `${typeof ClientErrorType}_${typeof ClientErrorCodes[number]}`;
 export default class KeetaNetClientError extends KeetaNetError {
     static isInstance: (obj: any, strict?: boolean) => obj is KeetaNetClientError;

package/lib/error/index.d.ts

@@ -11,7 +11,7 @@ interface ValidationOptions {
     type: string;
     codes: string[] | Readonly<string[]>;
 }
-export default class KeetaNetError extends Error {
+export declare class KeetaNetError extends Error {
     static isInstance: (obj: any, strict?: boolean) => obj is KeetaNetError;
     type: string;
     code: ErrorCode;

package/lib/error/kv.d.ts

@@ -1,4 +1,4 @@
-import KeetaNetError from '.';
+import { KeetaNetError } from '.';
 declare const KVErrorType: "KV";
 declare const KVErrorCodes: readonly ["TTL_NOT_SUPPORTED"];
 export type KVErrorCode = `${typeof KVErrorType}_${typeof KVErrorCodes[number]}`;

package/lib/error/ledger.d.ts

@@ -1,4 +1,4 @@
-import KeetaNetError from '.';
+import { KeetaNetError } from '.';
 declare const LedgerErrorType: "LEDGER";
 declare const LedgerErrorCodes: readonly ["TRANSACTION_ABORTED", "INVALID_CHAIN", "INVALID_NETWORK", "INVALID_SUBNET", "NOT_EMPTY", "NOT_OPENING", "NOT_SUCCESSOR", "INVALID_PERMISSIONS", "INVALID_OWNER_COUNT", "INVALID_BALANCE", "PREVIOUS_ALREADY_USED", "PREVIOUS_NOT_SEEN", "SUCCESSOR_VOTE_EXISTS", "INSUFFICIENT_VOTING_WEIGHT", "INVALID_ACCOUNT_INFO_KEY", "RECEIVE_NOT_MET", "DUPLICATE_VOTE_FOUND", "CANNOT_EXCHANGE_PERM_VOTE", "BLOCKS_DIFFER_FROM_VOTED_ON", "NO_PERM_WITHOUT_SELF_TEMP", "DUPLICATE_VOTE_ISSUER_FOUND", "OTHER"];
 export type LedgerErrorCode = `${typeof LedgerErrorType}_${typeof LedgerErrorCodes[number]}`;

package/lib/error/permissions.d.ts

@@ -1,4 +1,4 @@
-import KeetaNetError from '.';
+import { KeetaNetError } from '.';
 declare const PermissionsErrorType: "PERMISSIONS";
 declare const PermissionsErrorCodes: readonly ["CANNOT_MIX_FLAGS_AND_TYPES", "EXTERNAL_OFFSET_TOO_LARGE", "INVALID_EXTERNAL_FLAG", "INVALID_FLAG", "INVALID_FLAG_ASSERTION"];
 export type PermissionsErrorCode = `${typeof PermissionsErrorType}_${typeof PermissionsErrorCodes[number]}`;

package/lib/error/vote.d.ts

@@ -1,4 +1,4 @@
-import KeetaNetError from '.';
+import { KeetaNetError } from '.';
 declare const VoteErrorType: "VOTE";
 declare const VoteErrorCodes: readonly ["SERIAL_MISMATCH", "INVALID_VERSION", "INVALID_CONSTRUCTION", "INVALID_CONSTRUCTION_JSON", "SIGNATURE_INVALID", "EXPIRED", "INVALID_VALIDITY", "MOMENT_BEFORE_VALIDITY_FROM", "STAPLE_INVALID_CONSTRUCTION", "STAPLE_ALL_VOTES_MUST_HAVE_SAME_BLOCKS_COUNT", "STAPLE_ALL_VOTES_MUST_HAVE_SAME_BLOCKS_MISSING", "STAPLE_ALL_VOTES_MUST_HAVE_SAME_BLOCKS_ORDER", "STAPLE_DUPLICATE_VOTE_ISSUER", "STAPLE_PERMANENCE_MISMATCH", "BUILDER_INVALID_CONSTRUCTION", "BUILDER_INVALID_BLOCK_TYPE", "BUILDER_INVALID_SERIAL", "BUILDER_INVALID_VALID_TO_FROM", "MALFORMED_WRAPPER", "MALFORMED_VOTE_WRAPPER", "MALFORMED_VOTE_CONTENT", "MALFORMED_VOTE_CONTENT_EXTRA_DATA", "MALFORMED_VOTE_VERSION", "MALFORMED_VOTE_SERIAL", "MALFORMED_VOTE_SIGNATURE_INFORMATION", "MALFORMED_VOTE_ISSUER_INFORMATION", "MALFORMED_VOTE_SUBJECT_INFORMATION", "MALFORMED_VOTE_VALIDITY_INFORMATION", "MALFORMED_VOTE_SERIAL", "MALFORMED_VOTE_EXTENSIONS", "MALFORMED_VOTE_EXTENSIONS_VALUE", "MALFORMED_VOTE_EXTENSIONS_VALUE_OID", "MALFORMED_VOTE_EXTENSIONS_VALUE_CRITICAL", "MALFORMED_VOTE_EXTENSIONS_VALUE_CRITICAL_TYPE", "MALFORMED_VOTE_EXTENSIONS_VALUE_HASH_DATA", "MALFORMED_VOTE_SIGNATURE_SCHEME_DOES_NOT_MATCH_ISSUER", "MALFORMED_VOTE_SIGNATURE_SCHEME_DOES_NOT_MATCH_WRAPPER", "MALFORMED_VOTE_SIGNATURE_SCHEME_ECDSA_INVALID_CURVE", "MALFORMED_VOTE_SIGNATURE_UNSUPPORTED_SCHEME", "MALFORMED_VOTE_SUBJECT_PUBLIC_KEY_INFORMATION", "MALFORMED_VOTE_SIGNATURE_VALUE", "MALFORMED_VOTE_NO_BLOCKS_FOUND", "MALFORMED_STAPLE", "MALFORMED_STAPLE_BLOCKS", "MALFORMED_STAPLE_BLOCKS_AT_LEAST_ONE", "MALFORMED_STAPLE_VOTES", "MALFORMED_STAPLE_VOTES_AT_LEAST_ONE", "MALFORMED_FIND_RDN_INVALID_TYPE", "MALFORMED_FIND_RDN_MUST_HAVE_ONE", "MALFORMED_FIND_RDN_PART_WELL_FORMED", "MALFORMED_FIND_RDN_MUST_BE_SET", "MALFORMED_FIND_RDN_TYPE_MUST_BE_OID", "MALFORMED_HASHES_FROM_VOTE_INVALID_INPUT", "MALFORMED_HASHES_FROM_VOTE_INVALID_TYPE", "MALFORMED_HASHES_FROM_VOTE_INVALID_CONTEXT_SPECIFIC", "MALFORMED_HASHES_FROM_VOTE_DATA_NEEDS_OID", "MALFORMED_HASHES_FROM_VOTE_DATA_HASH_DATA_MUST_BE_SEQUENCE", "MALFORMED_HASHES_FROM_VOTE_DATA_NOT_TWO_ITEMS", "MALFORMED_HASHES_FROM_VOTE_DATA_UNSUPPORTED_HASH_FUNC", "MALFORMED_HASHES_FROM_VOTE_DATA_UNSUPPORTED_HASH_TYPE", "MALFORMED_HASHES_FROM_VOTE_DATA_SECOND_MUST_BE_SEQUENCE"];
 export type VoteErrorCode = `${typeof VoteErrorType}_${typeof VoteErrorCodes[number]}`;

package/lib/index.d.ts

@@ -4,9 +4,9 @@ import Ledger from './ledger';
 import Node from './node';
 import P2P from './p2p';
 import Stats from './stats';
-import Permissions from './permissions';
+import { Permissions } from './permissions';
 import Vote from './vote';
-import Error from './error';
+import { KeetaNetError as Error } from './error';
 import * as ASN1 from './utils/asn1';
 import * as Bloom from './utils/bloom';
 import * as Buffer from './utils/buffer';
@@ -16,6 +16,10 @@ import * as Initial from './utils/initial';
 import * as Conversion from './utils/conversion';
 import * as Certificate from './utils/certificate';
 declare const _default: {
+    /**
+     * The `Account` module provides functionality for managing key pairs
+     * as well as `identifier` accounts such as tokens.
+     */
     Account: typeof Account;
     Block: typeof Block;
     Error: typeof Error;

package/lib/kv/index.d.ts

@@ -1,6 +1,5 @@
-import type BufferStorage from '../utils/buffer';
+import type { BufferStorage } from '../utils/buffer';
 import type { JSONSerializable } from '../utils/conversion';
-import type KVStorageProviders from './providers';
 export interface KVSetOptionsType {
     exclusiveCreate?: boolean;
     ttl?: number;
@@ -16,7 +15,7 @@ export interface KVStorageProviderAPI {
     xor(arena: null, key: string, change: BufferStorage): Promise<void>;
     destroy?: () => Promise<void>;
 }
-export type KVStorageProvider = InstanceType<typeof KVStorageProviders[keyof typeof KVStorageProviders]>;
+export type KVStorageProvider = KVStorageProviderAPI;
 export declare class KVStorageProviderBase {
     xor(_ignored_arena: null, key: string, _ignored_change: BufferStorage): Promise<void>;
 }

package/lib/kv/kv_dynamodb.d.ts

@@ -1,7 +1,7 @@
 import type { KVStorageProviderAPI, KVSetOptionsType } from './';
 import { KVStorageProviderBase } from './';
 import type { JSONSerializable } from '../utils/conversion';
-import BufferStorage from '../utils/buffer';
+import { BufferStorage } from '../utils/buffer';
 import { DynamoDB } from '@aws-sdk/client-dynamodb';
 export declare class KVStorageProviderDynamoDB extends KVStorageProviderBase implements KVStorageProviderAPI {
     #private;

package/lib/kv/kv_memory.d.ts

@@ -1,7 +1,7 @@
 import type { KVStorageProviderAPI, KVSetOptionsType } from './';
 import { KVStorageProviderBase } from './';
 import type { JSONSerializable } from '../utils/conversion';
-import BufferStorage from '../utils/buffer';
+import { BufferStorage } from '../utils/buffer';
 export declare class KVStorageProviderMemory extends KVStorageProviderBase implements KVStorageProviderAPI {
     #private;
     constructor();

package/lib/kv/kv_redis.d.ts

@@ -1,14 +1,11 @@
 import type { KVStorageProviderAPI, KVSetOptionsType } from './';
 import { KVStorageProviderBase } from './';
 import type { JSONSerializable } from '../utils/conversion';
-import type BufferStorage from '../utils/buffer';
-import { RedisClient } from '../utils/redis';
+import type { BufferStorage } from '../utils/buffer';
 export declare class KVStorageProviderRedis extends KVStorageProviderBase implements KVStorageProviderAPI {
     #private;
     constructor(host: string, password: string, port?: number);
     destroy(): Promise<void>;
-    private deleteExpiredKeys;
-    _testingDeleteExpiredKeys(): Promise<void>;
     set(arena: string, key: string, value: JSONSerializable | undefined, opt?: KVSetOptionsType): Promise<void>;
     get(arena: string | null, key: string): Promise<JSONSerializable | undefined>;
     getAll(arena: string): Promise<{
@@ -17,6 +14,5 @@ export declare class KVStorageProviderRedis extends KVStorageProviderBase implem
     list(arena: string): Promise<string[]>;
     incr(arena: string, key: string, change: number): Promise<bigint>;
     xor(arena: null, key: string, change: BufferStorage): Promise<void>;
-    get _testingClient(): RedisClient;
 }
 export default KVStorageProviderRedis;

package/lib/ledger/db_spanner_helper.d.ts

@@ -458,7 +458,7 @@ export declare class Helper {
     static getPrimaryKeyNames<X extends TableIndexName>(table: X): string[];
     static getNameFromType(filterType: 'INDEX'): IndexName[];
     static getNameFromType(filterType: 'TABLE'): TableName[];
-    static getAllTables(): ("permissions" | "blocks" | "votes" | "ledger" | "history" | "weight" | "chain" | "accountInfo" | "heapBlocks" | "heapStorage" | "delegation" | "voteBlocks")[];
+    static getAllTables(): ("permissions" | "blocks" | "votes" | "ledger" | "chain" | "history" | "weight" | "accountInfo" | "heapBlocks" | "heapStorage" | "delegation" | "voteBlocks")[];
     static IsTable(name: TableIndexName): name is TableName;
     static IsIndex(name: TableIndexName): name is IndexName;
     static getIndexParent(index: IndexName): TableName;

package/lib/ledger/types.d.ts

@@ -1,39 +1,91 @@
 import type { GenericAccount, TokenAddress } from '../account';
 import type { AdjustMethod } from '../block';
-import type Permissions from '../permissions';
+import type { Permissions } from '../permissions';
 import type { TimeStats } from '../stats';
 /**
  * Account info entry
  */
 export interface AccountInfo {
+    /**
+     * A name for the account
+     */
     name: string;
+    /**
+     * A description for the account
+     */
     description: string;
+    /**
+     * Arbitrary metadata for the account
+     */
     metadata: string;
+    /**
+     * If the account is a token, the supply of the token
+     */
     supply?: bigint;
+    /**
+     * The default permissions for the account
+     */
     defaultPermission?: Permissions;
 }
 /**
  * Permissions types
  */
 export interface ACLRow {
+    /**
+     * The account that these permissions apply to
+     */
     principal: GenericAccount;
+    /**
+     * The account that this row is for
+     */
     entity: GenericAccount;
+    /**
+     * An optional target account which, depending on the permissions, may be targeted by the permission
+     */
     target: GenericAccount;
+    /**
+     * The permissions for which this row grants
+     */
     permissions: Permissions;
 }
+/**
+ * An entry for the ACL
+ * @expandType ACLRow
+ */
 export interface ACLEntry extends Omit<ACLRow, 'target'> {
     target?: GenericAccount;
     method?: AdjustMethod.SET;
 }
+/**
+ * Update an ACL for an account
+ * @expandType ACLEntry
+ */
 export interface ACLUpdate extends Omit<ACLEntry, 'method' | 'permissions'> {
+    /**
+     * The method to use to update the ACL
+     */
     method: AdjustMethod;
+    /**
+     * The permissions to set for the ACL
+     *
+     * If this is set to null, the permissions will be unset
+     */
     permissions: Permissions | null;
 }
 /**
  * All balances for each token on an account
  */
 export type GetAllBalancesResponse = {
+    /**
+     * The account balance of the specified token
+     *
+     * This is in raw units, and not the display units
+     * that the token uses
+     */
     balance: bigint;
+    /**
+     * The account of the token
+     */
     token: TokenAddress;
 }[];
 /**

package/lib/p2p.d.ts

@@ -172,7 +172,7 @@ export interface P2PConnection {
      * If this connection can be serialized to our KV store,
      * return the type.
      *
-     * @see P2PSwitch.RegisterP2PConnectionDeserializer
+     * See {@link P2PSwitch.RegisterP2PConnectionDeserializer}
      * for registering a handler to convert it back
      */
     serialize?: () => SerializedConnection;

package/lib/permissions.d.ts

@@ -97,7 +97,7 @@ export type AcceptedPermissionTypes = Permissions | [string, number[]] | [string
 /**
  * Class to hold a Base and External permission set
  */
-export default class Permissions {
+export declare class Permissions {
     #private;
     static isInstance: (obj: any, strict?: boolean) => obj is Permissions;
     static BaseSet: typeof BaseSet;

package/lib/stats.d.ts

@@ -1,5 +1,5 @@
 import type { KVStorageProvider } from './kv';
-import BufferStorage from './utils/buffer';
+import { BufferStorage } from './utils/buffer';
 import type { BlockHash } from './block';
 export interface StatsConfig {
     kv: KVStorageProvider | null;

package/lib/utils/asn1.d.ts

@@ -189,17 +189,3 @@ export declare class BufferStorageASN1<T extends ASN1AnyJS | Readonly<ASN1AnyJS>
     getASN1(): S extends undefined ? Mutable<T> : Mutable<ValidateASN1.SchemaMap<Exclude<S, undefined>>>;
 }
 export { ASN1toJS, JStoASN1, ASN1IntegerToBigInt, ASN1BigIntToBuffer };
-export declare const _Testing: {
-    native: {
-        ASN1toJS: typeof jsASN1toJS;
-        JStoASN1: typeof jsJStoASN1;
-        ASN1BigIntToBuffer: typeof jsBigIntToBuffer;
-        ASN1IntegerToBigInt: typeof jsIntegerToBigInt;
-    } | undefined;
-    js: {
-        ASN1toJS: typeof jsASN1toJS;
-        JStoASN1: typeof jsJStoASN1;
-        ASN1BigIntToBuffer: typeof jsBigIntToBuffer;
-        ASN1IntegerToBigInt: typeof jsIntegerToBigInt;
-    };
-};

package/lib/utils/buffer.d.ts

@@ -24,4 +24,3 @@ export declare class BufferStorage {
     compare(compareWith: typeof this | undefined | null): boolean;
     compareHexString(compareWith: BufferStorage | string | undefined | null): boolean;
 }
-export default BufferStorage;

package/lib/utils/certificate.d.ts

@@ -235,7 +235,7 @@ export declare class Certificate {
      */
     protected issuerDN: CertificateSchema[0][3];
     /**
-     * Object type ID for @see Certificate.isCertificate
+     * Object type ID for {@link Certificate.isCertificate}
      */
     private static certificateObjectTypeID;
     /**
@@ -337,4 +337,4 @@ export declare class Certificate {
      */
     toJSON(includeChain?: boolean): any;
 }
-export default Certificate;
+export {};

package/lib/utils/conversion.d.ts

@@ -1,7 +1,7 @@
 import type { Vote, VoteStaple } from '../vote';
 import type Account from '../account';
 import type { Block, BlockHash } from '../block';
-import type Permissions from '../permissions';
+import type { Permissions } from '../permissions';
 export type JSONSerializable = string | number | boolean | null | JSONSerializable[] | {
     [key: string]: JSONSerializable;
 };

package/lib/utils/hash.d.ts

@@ -14,4 +14,3 @@ export declare namespace Hash {
     var functionName: string;
     var functionLength: number;
 }
-export default Hash;

package/lib/vote.d.ts

@@ -3,7 +3,7 @@ import type { BlockJSON, BlockJSONOutput } from './block';
 import Account from './account';
 import type { ASN1Date } from './utils/asn1';
 import type { JSONSupported, ToJSONSerializableOptions } from './utils/conversion';
-import BufferStorage from './utils/buffer';
+import { BufferStorage } from './utils/buffer';
 /**
  * Representation of the vote
  */

package/package.json

@@ -1,11 +1,13 @@
 {
 	"name": "@keetanetwork/keetanet-client",
 	"repository": "https://github.com/keetanetwork/node.git",
-	"version": "0.10.3",
+	"version": "0.10.4",
 	"description": "KeetaNet Client TypeScript Reference Implementation",
 	"files": [
 		"**/*.js",
-		"**/*.d.ts"
+		"**/*.d.ts",
+		"examples/**",
+		"docs/**"
 	],
 	"types": "./client/index.d.ts",
 	"author": "Keeta Token Genesis LLC",
@@ -17,6 +19,7 @@
 		"ecies-25519": "1.3.1",
 		"ecies-geth": "1.7.3",
 		"elliptic": "6.6.0",
+		"extract-zip": "2.0.1",
 		"futoin-hkdf": "1.5.3",
 		"isomorphic-ws": "5.0.0",
 		"node-fetch": "2.7.0",

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const version = "0.10.3";
+export declare const version = "0.10.4";
 export default version;