@keetanetwork/keetanet-client 0.10.3 → 0.10.5

package/README.md

@@ -0,0 +1,7 @@
+KeetaNet SDK Implementation in JavaScript
+=========================================
+
+This package implements KeetaNet Client SDK in JavaScript
+
+See the [Getting Started](docs/GETTING-STARTED.md) Guide for more
+information on first steps with the KeetaNet SDK.

package/client/builder.d.ts

@@ -4,18 +4,41 @@ import type { AdjustMethod, BlockHash } from '../lib/block';
 import { Block } from '../lib/block';
 import type { AccountInfo } from '../lib/ledger/types';
 import type { AcceptedPermissionTypes } from '../lib/permissions';
-import Permissions from '../lib/permissions';
+import type { UserClient } from '.';
+import { Permissions } from '../lib/permissions';
 type GetPrevFunction = (acct: GenericAccount | string) => Promise<BlockHash | string | null | undefined>;
 interface AccountSignerOptions {
     account: GenericAccount;
     signer: Account;
 }
+/** @expandType GetPrevFunction */
 interface RenderOptions {
     network: bigint;
     getPrevious: GetPrevFunction;
 }
+/** @useDeclaredType */
 type BuilderBlockOptions = Partial<AccountSignerOptions>;
-export type BuilderOptions = Partial<AccountSignerOptions> & Pick<AccountSignerOptions, 'signer'>;
+/**
+ * Either a UserClient or an object with a client and network
+ *
+ * @example
+ * ```typescript
+ * const userClient = UserClient.fromNetwork('test');
+ * const config: UserClientOrClientAndNetwork = userClient;
+ * const alternativeConfig: UserClientOrClientAndNetwork = {
+ *     client: userClient.client,
+ *     network: userClient.network
+ * };
+ * ```
+ */
+type UserClientOrClientAndNetwork = Pick<UserClient, 'client' | 'network'> | Pick<UserClient, 'client' | 'network' | 'head' | 'publishBuilder'>;
+/** @expand */
+export type BuilderOptions = Partial<AccountSignerOptions> & Pick<AccountSignerOptions, 'signer'> & {
+    /**
+     * User Client or object with a client and network
+     */
+    userClient?: UserClientOrClientAndNetwork;
+};
 type PerAccount<T> = {
     [accountPubKey: string]: T;
 };
@@ -89,11 +112,24 @@ export interface AccountSignerOptionsJSON {
     account: string;
     signer: string;
 }
+/**
+ * @expand
+ */
 export interface AllPendingJSON {
+    /**
+     * Blocks which have been rendered
+     */
     renderedBlocks: string[];
+    /**
+     * Blocks which have not been rendered
+     */
     nonRendered: [AccountSignerOptionsJSON, PendingOperationsJSON][];
 }
+/** @expand */
 export interface ComputeBlocksResponse {
+    /**
+     * Blocks which have been computed
+     */
     blocks: Block[];
 }
 export declare class PendingAccount<AccountType extends AccountKeyAlgorithm = AccountKeyAlgorithm> {
@@ -114,6 +150,10 @@ export declare class UserClientBuilder {
     get defaultOptions(): BuilderOptions;
     updateAccounts(accountOptions: Partial<AccountSignerOptions>): void;
     clone(): Promise<UserClientBuilder>;
+    publish(): Promise<Awaited<ReturnType<UserClient['publishBuilder']>>>;
+    publish(client?: UserClientOrClientAndNetwork): Promise<Awaited<ReturnType<UserClient['publishBuilder']>>>;
+    computeBlocks(): Promise<ComputeBlocksResponse>;
+    computeBlocks(client?: UserClientOrClientAndNetwork): Promise<ComputeBlocksResponse>;
     computeBlocks(renderOptions: RenderOptions): Promise<ComputeBlocksResponse>;
     send(recipient: AccountOrPending, amount: bigint, token: TokenOrPending, external?: string, options?: BuilderBlockOptions): void;
     receive(from: AccountOrPending, amount: bigint, token: TokenOrPending, exact?: boolean, forward?: GenericAccount, options?: BuilderBlockOptions): void;

package/client/client_common_tests.d.ts

@@ -4,8 +4,9 @@ import type { Networks } from '../config';
 import { AccountKeyAlgorithm } from '../lib/account';
 import type Account from '../lib/account';
 import { UserClient } from '.';
+import { type CreateTestNodeOptions } from '../lib/utils/helper_testing';
 import { toJSONSerializable } from '../lib/utils/conversion';
-import KeetaError from '../lib/error';
+import { KeetaNetError as KeetaError } from '../lib/error';
 export type ClientParams = {
     ip?: string;
     port?: number;
@@ -21,6 +22,7 @@ export type ClientParams = {
 export type NodeCreationOptions = {
     p2pTested?: boolean;
     count?: number;
+    customNodeOptions?: Omit<CreateTestNodeOptions, 'peerNodes' | 'enableP2P' | 'initialTrustedAccount'>[];
 };
 export declare function setup(options?: NodeCreationOptions): Promise<{
     trustedKey: Account<AccountKeyAlgorithm.ECDSA_SECP256K1>;
@@ -38,6 +40,7 @@ declare function runBasicTests(nodes: LocalNode[], userClient: UserClient, trust
 declare function runBuilderStorageTests(_ignoreNodes: LocalNode[], userClient: UserClient, trustedClient: UserClient, params: ClientParams, expect: any, ExpectErrorCode: any): Promise<void>;
 declare function runRecoverAccountTest(nodes: LocalNode[], userClient: UserClient, trustedClient: UserClient, params: ClientParams, expect: any, ExpectErrorCode: any): Promise<void>;
 declare function runNonNodeTests(_ignore_nodes: LocalNode[], _ignore_userClient: UserClient, _ignore_trustedClient: UserClient, _ignore_params: ClientParams, expect: any, _ignore_ExpectErrorCode: any): Promise<void>;
+declare function runErrorTests(nodes: LocalNode[], userClientAccount1: UserClient, trustedClient: UserClient, params: ClientParams, expect: any, ExpectErrorCode: any): Promise<void>;
 export declare const clientTests: {
     'Basic Client Tests': {
         test: typeof runBasicTests;
@@ -68,6 +71,30 @@ export declare const clientTests: {
             count: number;
         };
     };
+    'Client Error Tests': {
+        test: typeof runErrorTests;
+        options: {
+            p2pTested: boolean;
+            count: number;
+            customNodeOptions: ({
+                readonly ledger: {
+                    readonly ledgerWriteMode: "no-voting";
+                };
+            } | {
+                readonly ledger: {
+                    readonly ledgerWriteMode: "read-write";
+                };
+            } | {
+                readonly ledger: {
+                    readonly ledgerWriteMode: "bootstrap-only";
+                };
+            } | {
+                readonly ledger: {
+                    readonly ledgerWriteMode: "read-only";
+                };
+            })[];
+        };
+    };
 };
 export declare const KeetaNetError: typeof KeetaError;
 export { toJSONSerializable };