@keetanetwork/keetanet-client 0.14.13 → 0.16.0

package/client/builder.d.ts

@@ -2,11 +2,12 @@ import type { GenericAccount, IdentifierKeyAlgorithm } from '../lib/account';
 import { Account, AccountKeyAlgorithm } from '../lib/account';
 import type { AdjustMethod, BlockHash } from '../lib/block';
 import { Block } from '../lib/block';
-import { type BlockJSONOperations } from '../lib/block/operations';
+import type { IdentifierCreateArguments, BlockJSONOperations } from '../lib/block/operations';
 import type { AccountInfo } from '../lib/ledger/types';
 import type { AcceptedPermissionTypes } from '../lib/permissions';
 import type { UserClient, Client } from '.';
 import { Permissions } from '../lib/permissions';
+import type { ToJSONSerializable } from '../lib/utils/conversion';
 import { Certificate, CertificateBundle } from '../lib/utils/certificate';
 import type { VoteStaple } from '../lib/vote';
 type GetPrevFunction = (acct: GenericAccount | string) => Promise<BlockHash | string | null | undefined>;
@@ -53,6 +54,7 @@ type PerAccount<T> = {
 interface IdentifierCreateRequest {
     type: IdentifierKeyAlgorithm;
     toResolve?: PendingAccount;
+    createArguments?: IdentifierCreateArguments;
 }
 type AccountOrPending<Type extends AccountKeyAlgorithm = AccountKeyAlgorithm> = Account<Type> | PendingAccount<Type>;
 type TokenOrPending = AccountOrPending<AccountKeyAlgorithm.TOKEN>;
@@ -108,6 +110,7 @@ export interface PendingOperationsJSON {
     }[];
     createIdentifiers?: {
         type: IdentifierKeyAlgorithm;
+        createArguments?: ToJSONSerializable<IdentifierCreateArguments>;
     }[];
     tokenSupply?: string;
     adminModifyBalance?: {
@@ -159,7 +162,7 @@ export declare class PendingAccount<AccountType extends AccountKeyAlgorithm = Ac
     static GetValue<T extends AccountKeyAlgorithm>(data: AccountOrPending<T>): Account<T>;
     set account(account: Account<AccountType>);
     get account(): Account<AccountType>;
-    toJSON(): Account<AccountType>;
+    toJSON(): import("../lib/account").PublicKeyStringMapping[AccountType];
 }
 type AllPending = [AccountSignerOptions, PendingOperations][];
 export declare class UserClientBuilder {
@@ -186,7 +189,30 @@ export declare class UserClientBuilder {
     modifyTokenBalance(token: TokenOrPending, amount: bigint, isSet?: boolean, options?: BuilderBlockOptions): void;
     setInfo(info: AccountInfo, options?: BuilderBlockOptions): void;
     setRep(to: Account, options?: BuilderBlockOptions): void;
-    generateIdentifier<Algo extends IdentifierKeyAlgorithm>(type: Algo, options?: BuilderBlockOptions): PendingAccount<Algo>;
+    /**
+     * Create a new identifier for the given arguments and add to the pending operations
+     *
+     * @param toCreate The arguments used to create the identifier (ex: multisig configuration)
+     * @param options The options to use for the request
+     * @return The identifier that was generated
+     */
+    generateIdentifier<CreateArguments extends IdentifierCreateArguments>(toCreate: CreateArguments, options?: BuilderBlockOptions): PendingAccount<CreateArguments['type']>;
+    /**
+     * Create a new identifier with the given type and add to the pending operations
+     *
+     * @param type The type of identifier to generate
+     * @param options The options to use for the request
+     * @return The identifier that was generated
+     */
+    generateIdentifier<CreateKeyType extends Exclude<IdentifierKeyAlgorithm, IdentifierCreateArguments['type']>>(type: CreateKeyType, options?: BuilderBlockOptions): PendingAccount<CreateKeyType>;
+    /**
+     * Create a new identifier and add to the pending operations
+     *
+     * @param toCreate The type of identifier or the arguments to create an identifier
+     * @param options The options to use for the request
+     * @return The identifier that was generated
+     */
+    generateIdentifier(toCreate: Exclude<IdentifierKeyAlgorithm, IdentifierCreateArguments['type']> | IdentifierCreateArguments, options?: BuilderBlockOptions): PendingAccount<IdentifierKeyAlgorithm>;
     get blocks(): Block[];
     get rendered(): boolean;
 }

package/client/index-browser.d.ts

@@ -10,19 +10,19 @@
  */
 import KeetaNet from '../lib';
 import type { GenericAccount, IdentifierKeyAlgorithm, NetworkAddress, TokenAddress } from '../lib/account';
-import Account, { AccountKeyAlgorithm } from '../lib/account';
+import Account from '../lib/account';
 import type { AdjustMethod } from '../lib/block';
 import Block, { BlockHash } from '../lib/block';
 import type { P2PSwitchStatistics } from '../lib/p2p';
 import * as Config from '../config';
 import type { BaseNetworkInfo, BaseTokenInfo } from '../lib/utils/initial';
-import type { BuilderOptions, ManageCertificateMethod } from './builder';
+import type { BuilderOptions, ManageCertificateMethod, PendingAccount } from './builder';
 import { UserClientBuilder } from './builder';
 import { KeetaNetError } from '../lib/error';
 import type { AccountInfo, GetAllBalancesResponse, ACLRow, LedgerStatistics } from '../lib/ledger/types';
 import type { LedgerSelector, LedgerStorage } from '../lib/ledger';
 import type { AcceptedPermissionTypes } from '../lib/permissions';
-import { type BlockOperations } from '../lib/block/operations';
+import type { IdentifierCreateArguments, BlockOperations } from '../lib/block/operations';
 import { Certificate } from '../lib/utils/certificate';
 import { CertificateBundle, type CertificateHash } from '../lib/utils/certificate';
 import { VoteStaple, type VoteQuote } from '../lib/vote';
@@ -242,7 +242,7 @@ export declare class Client {
      * is defined by the `Client.DefaultLogger` property, but can be overridden
      * by the application.
      */
-    logger: Pick<Console, "log" | "warn" | "error">;
+    logger: Pick<Console, "warn" | "error" | "log">;
     /**
      * Indication of whether or not this client has been destroyed.
      */
@@ -615,12 +615,14 @@ export declare class Client {
      * @param account The account to get the history for -- if null then the history for all accounts will be returned
      * @param options The options to use for the request
      * @param options.startBlocksHash The block hash to start from -- this is used to paginate the request
-     * @param options.depth The maximum number of vote staples to return -- this is used to limit the number of vote staples returned
+     * @param options.depth The maximum number of vote staples to return -- this is used to limit the number of vote staples returned, default is everything)
+     * @param options.pageSize How large of a page size to request at a given time (default is 200)
      * @return The history of vote staples for the given account, in reverse order starting with the most recent vote staple
      */
     getHistory(account: GenericAccount | string | null, options?: {
         startBlocksHash?: VoteBlocksHash | string;
         depth?: number;
+        pageSize?: number;
     }): Promise<{
         voteStaple: VoteStaple;
     }[]>;
@@ -1166,6 +1168,14 @@ export declare class UserClient {
      * @returns A list of quotes from representatives the client knows about
      */
     getQuotes(blocks: Block[]): Promise<VoteQuote[]>;
+    /**
+     * Generate a new identifier for the given type and publish the blocks
+     *
+     * @param toCreate The arguments used to create the identifier (ex: multisig configuration)
+     * @param options The options to use for the request
+     * @return The identifier that was generated
+     */
+    generateIdentifier<CreateArguments extends IdentifierCreateArguments>(toCreate: CreateArguments, options?: UserClientOptions): Promise<PendingAccount<CreateArguments['type']>>;
     /**
      * Generate a new identifier for the given type and publish the blocks
      *
@@ -1173,7 +1183,15 @@ export declare class UserClient {
      * @param options The options to use for the request
      * @return The identifier that was generated
      */
-    generateIdentifier(type: IdentifierKeyAlgorithm, options?: UserClientOptions): Promise<import("./builder").PendingAccount<AccountKeyAlgorithm.NETWORK | AccountKeyAlgorithm.TOKEN | AccountKeyAlgorithm.STORAGE | AccountKeyAlgorithm.MULTISIG>>;
+    generateIdentifier<CreateKeyType extends Exclude<IdentifierKeyAlgorithm, IdentifierCreateArguments['type']>>(type: CreateKeyType, options?: UserClientOptions): Promise<PendingAccount<CreateKeyType>>;
+    /**
+     * Generate a new identifier and publish the blocks
+     *
+     * @param toCreate The type of identifier or the arguments to create an identifier
+     * @param options The options to use for the request
+     * @return The identifier that was generated
+     */
+    generateIdentifier(toCreate: Exclude<IdentifierKeyAlgorithm, IdentifierCreateArguments['type']> | IdentifierCreateArguments, options?: UserClientOptions): Promise<PendingAccount<IdentifierKeyAlgorithm>>;
     /**
      * Update the permissions for a given account.  This will publish the
      * changes to the network.