@keetanetwork/keetanet-client 0.14.2 → 0.14.4

package/README.md

@@ -5,3 +5,7 @@ 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.
+
+## Documentation
+
+See the full documentation for the KeetaNet Client JavaScript/TypeScript SDK at [https://static.test.keeta.com/docs/](https://static.test.keeta.com/docs/).

package/api/node.d.ts

@@ -28,6 +28,7 @@ interface GetAccountChainAPIResponse {
 interface AccountState {
     account: GenericAccount;
     currentHeadBlock: BlockHash | null;
+    currentHeadBlockHeight: bigint | null;
     representative: Account | null;
     balances: GetAllBalancesResponse;
     info: AccountInfo;

package/benchmarking/test.d.ts

@@ -0,0 +1,4 @@
+declare const smallJSON = "{\"data\": [1000]}";
+declare const largeJSON: string;
+declare const smallObj: any;
+declare const largeObj: any;

package/client/index-browser.d.ts

@@ -15,6 +15,7 @@ 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 { BaseTokenInfo } from '../lib/utils/initial';
 import type { BuilderOptions, ManageCertificateMethod } from './builder';
 import { UserClientBuilder } from './builder';
 import { KeetaNetError } from '../lib/error';
@@ -42,6 +43,11 @@ type GetAccountStateAPIResponseFormatted = {
      * this will be null if the account is not open
      */
     currentHeadBlock: string | null;
+    /**
+     * The current height of the head block for the account, if there is one
+     * this will be null if the account is not open
+     */
+    currentHeadBlockHeight: string | null;
     /**
      * The current representative for the account, if there is one
      * this will be null if the account is not open or if the
@@ -403,7 +409,7 @@ export declare class Client {
      * @param account The account to fetch the information for
      * @return The account information
      */
-    getAccountInfo(account: GenericAccount | string): Promise<GetAccountStateAPIResponseFormatted>;
+    getAccountInfo(account: GenericAccount | string, rep?: ClientRepresentative | 'ANY'): Promise<GetAccountStateAPIResponseFormatted>;
     /**
      * Fetch the account information for multiple accounts.  This will return
      * the account information including the current head block, representative,
@@ -721,6 +727,13 @@ export declare class Client {
      * @param publish Publish the recovered staple to the network (default is true)
      */
     recoverAccount(account: GenericAccount, publish?: boolean): Promise<VoteStaple | null>;
+    /**
+     * Sync any partially-published account artifacts
+     *
+     * @param account Account to sync
+     * @param publish Publish the synced staple to the network (default is true)
+     */
+    syncAccount(account: GenericAccount, publish?: boolean, reps?: ClientRepresentative[]): Promise<VoteStaple | null>;
     getVoteQuotes(blocks: Block[]): Promise<VoteQuote[]>;
     /** Work in progress */
     getLedgerChecksum(rep?: ClientRepresentative | 'ANY'): Promise<{
@@ -876,6 +889,7 @@ export declare class UserClient {
         addSupplyAmount: bigint;
         delegateTo?: Account;
         voteSerial?: bigint;
+        baseTokenInfo: BaseTokenInfo;
     }, options?: UserClientOptions): Promise<{
         voteStaple: VoteStaple;
         publish: boolean;
@@ -1187,6 +1201,14 @@ export declare class UserClient {
      * @param options User client options (common options)
      */
     recover(publish?: boolean, options?: UserClientOptions): Promise<VoteStaple | null>;
+    /**
+     * Sync any partially-published account artifacts
+     *
+     * @param publish Publish the recovered staple to the network
+     *        (default: true)
+     * @param options User client options (common options)
+     */
+    sync(publish?: boolean, options?: UserClientOptions): Promise<VoteStaple | null>;
     /**
      * Register a callback for change messages and set up a websocket filtered to our account only.
      * Also set up long timeout polling for changes in case the websocket misses a change update