@keetanetwork/keetanet-client 0.14.2 → 0.14.4

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 (173) hide show
  1. package/README.md +4 -0
  2. package/api/node.d.ts +1 -0
  3. package/benchmarking/test.d.ts +4 -0
  4. package/client/index-browser.d.ts +23 -1
  5. package/client/index-browser.js +440 -148
  6. package/client/index.d.ts +23 -1
  7. package/client/index.js +434 -111
  8. package/docs/GETTING-STARTED.md +361 -0
  9. package/docs/assets/hierarchy.js +1 -1
  10. package/docs/assets/navigation.js +1 -1
  11. package/docs/assets/search.js +1 -1
  12. package/docs/classes/KeetaNetSDK.Client.html +8 -4
  13. package/docs/classes/KeetaNetSDK.Referenced.BaseSet.html +1 -1
  14. package/docs/classes/KeetaNetSDK.Referenced.BaseVoteBuilder.html +1 -1
  15. package/docs/classes/KeetaNetSDK.Referenced.BlockHash.html +1 -1
  16. package/docs/classes/KeetaNetSDK.Referenced.BlockOperation.html +1 -1
  17. package/docs/classes/KeetaNetSDK.Referenced.BlockOperationCREATE_IDENTIFIER.html +1 -1
  18. package/docs/classes/KeetaNetSDK.Referenced.BlockOperationMANAGE_CERTIFICATE.html +1 -1
  19. package/docs/classes/KeetaNetSDK.Referenced.BlockOperationMODIFY_PERMISSIONS.html +1 -1
  20. package/docs/classes/KeetaNetSDK.Referenced.BlockOperationRECEIVE.html +1 -1
  21. package/docs/classes/KeetaNetSDK.Referenced.BlockOperationSEND.html +1 -1
  22. package/docs/classes/KeetaNetSDK.Referenced.BlockOperationSET_INFO.html +1 -1
  23. package/docs/classes/KeetaNetSDK.Referenced.BlockOperationSET_REP.html +1 -1
  24. package/docs/classes/KeetaNetSDK.Referenced.BlockOperationTOKEN_ADMIN_MODIFY_BALANCE.html +1 -1
  25. package/docs/classes/KeetaNetSDK.Referenced.BlockOperationTOKEN_ADMIN_SUPPLY.html +1 -1
  26. package/docs/classes/KeetaNetSDK.Referenced.CertificateHash.html +1 -1
  27. package/docs/classes/KeetaNetSDK.Referenced.ECDSAKeyPair.html +1 -1
  28. package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256K1KeyPair.html +1 -1
  29. package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256K1PrivateKey.html +1 -1
  30. package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256K1PublicKey.html +1 -1
  31. package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256K1Signature.html +1 -1
  32. package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256R1KeyPair.html +1 -1
  33. package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256R1PrivateKey.html +1 -1
  34. package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256R1PublicKey.html +1 -1
  35. package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256R1Signature.html +1 -1
  36. package/docs/classes/KeetaNetSDK.Referenced.ED25519KeyPair.html +1 -1
  37. package/docs/classes/KeetaNetSDK.Referenced.ED25519PrivateKey.html +1 -1
  38. package/docs/classes/KeetaNetSDK.Referenced.ED25519PublicKey.html +1 -1
  39. package/docs/classes/KeetaNetSDK.Referenced.ED25519Signature.html +1 -1
  40. package/docs/classes/KeetaNetSDK.Referenced.ExternalKeyPair.html +1 -1
  41. package/docs/classes/KeetaNetSDK.Referenced.ExternalSet.html +1 -1
  42. package/docs/classes/KeetaNetSDK.Referenced.IdentifierKey.html +1 -1
  43. package/docs/classes/KeetaNetSDK.Referenced.IdentifierKeyPair.html +1 -1
  44. package/docs/classes/KeetaNetSDK.Referenced.KeetaNetError.html +8 -5
  45. package/docs/classes/KeetaNetSDK.Referenced.KeetaNetErrorBase.html +6 -0
  46. package/docs/classes/KeetaNetSDK.Referenced.KeetaNetLedgerError.html +9 -0
  47. package/docs/classes/KeetaNetSDK.Referenced.KeetaNetLedgerVoteError.html +9 -0
  48. package/docs/classes/KeetaNetSDK.Referenced.KeyInterface.html +1 -1
  49. package/docs/classes/KeetaNetSDK.Referenced.KeyStorage.html +1 -1
  50. package/docs/classes/KeetaNetSDK.Referenced.Ledger.html +3 -2
  51. package/docs/classes/KeetaNetSDK.Referenced.LedgerAtomicInterface.html +2 -1
  52. package/docs/classes/KeetaNetSDK.Referenced.PermissionSetHolder.html +1 -1
  53. package/docs/classes/KeetaNetSDK.Referenced.PossiblyExpiredVote.html +1 -1
  54. package/docs/classes/KeetaNetSDK.Referenced.SignatureStorage.html +1 -1
  55. package/docs/classes/KeetaNetSDK.Referenced.Stats.html +1 -1
  56. package/docs/classes/KeetaNetSDK.Referenced.StatsPending.html +1 -1
  57. package/docs/classes/KeetaNetSDK.Referenced.Vote.html +1 -1
  58. package/docs/classes/KeetaNetSDK.Referenced.VoteBlockBundle.html +1 -1
  59. package/docs/classes/KeetaNetSDK.Referenced.VoteBlockHash.html +1 -1
  60. package/docs/classes/KeetaNetSDK.Referenced.VoteBuilder.html +1 -1
  61. package/docs/classes/KeetaNetSDK.Referenced.VoteHash.html +1 -1
  62. package/docs/classes/KeetaNetSDK.Referenced.VoteLikeBase.html +1 -1
  63. package/docs/classes/KeetaNetSDK.Referenced.VoteQuote.html +1 -1
  64. package/docs/classes/KeetaNetSDK.Referenced.VoteQuoteBuilder.html +1 -1
  65. package/docs/classes/KeetaNetSDK.Referenced.VoteStaple.html +1 -1
  66. package/docs/classes/KeetaNetSDK.Referenced.VoteStapleHash.html +1 -1
  67. package/docs/classes/KeetaNetSDK.Referenced.src_lib_utils_buffer.BufferStorage.html +1 -1
  68. package/docs/classes/KeetaNetSDK.UserClient.html +11 -6
  69. package/docs/documents/GETTING-STARTED.html +3 -2
  70. package/docs/hierarchy.html +1 -1
  71. package/docs/index.html +2 -1
  72. package/docs/interfaces/KeetaNetSDK.Referenced.ACLEntry.html +1 -1
  73. package/docs/interfaces/KeetaNetSDK.Referenced.ACLUpdate.html +1 -1
  74. package/docs/interfaces/KeetaNetSDK.Referenced.ASN1ExplicitContextTag.html +1 -1
  75. package/docs/interfaces/KeetaNetSDK.Referenced.ASN1ImplicitContextTag.html +1 -1
  76. package/docs/interfaces/KeetaNetSDK.Referenced.ASN1Object.html +1 -1
  77. package/docs/interfaces/KeetaNetSDK.Referenced.BaseExternalKeyPairFunctions.html +1 -1
  78. package/docs/interfaces/KeetaNetSDK.Referenced.BaseGenerationConfig.html +3 -2
  79. package/docs/interfaces/KeetaNetSDK.Referenced.BaseIdentifierCreateArguments.html +1 -1
  80. package/docs/interfaces/KeetaNetSDK.Referenced.BaseTokenInfo.html +4 -0
  81. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperation.html +1 -1
  82. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationCREATE_IDENTIFIER.html +1 -1
  83. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationMANAGE_CERTIFICATE.html +1 -1
  84. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationMANAGE_CERTIFICATESerializable.html +1 -1
  85. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationMODIFY_PERMISSIONS.html +1 -1
  86. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationRECEIVE.html +1 -1
  87. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationSEND.html +1 -1
  88. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationSET_INFO.html +1 -1
  89. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationSET_REP.html +1 -1
  90. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationTOKEN_ADMIN_MODIFY_BALANCE.html +1 -1
  91. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationTOKEN_ADMIN_SUPPLY.html +1 -1
  92. package/docs/interfaces/KeetaNetSDK.Referenced.BlockV1Canonical.html +1 -1
  93. package/docs/interfaces/KeetaNetSDK.Referenced.BlockV2Canonical.html +1 -1
  94. package/docs/interfaces/KeetaNetSDK.Referenced.Constructor.html +1 -1
  95. package/docs/interfaces/KeetaNetSDK.Referenced.DisposableTimingHandle.html +1 -1
  96. package/docs/interfaces/KeetaNetSDK.Referenced.ExternalKeyPairFunctionsNoEncryption.html +1 -1
  97. package/docs/interfaces/KeetaNetSDK.Referenced.ExternalKeyPairFunctionsSupportsEncryption.html +1 -1
  98. package/docs/interfaces/KeetaNetSDK.Referenced.InitialConfigSupply.html +3 -2
  99. package/docs/interfaces/KeetaNetSDK.Referenced.InstanceSet.html +1 -1
  100. package/docs/interfaces/KeetaNetSDK.Referenced.KVGenericOptionsType.html +1 -1
  101. package/docs/interfaces/KeetaNetSDK.Referenced.KVSetOptionsType.html +1 -1
  102. package/docs/interfaces/KeetaNetSDK.Referenced.LedgerStorageAPI.html +5 -2
  103. package/docs/interfaces/KeetaNetSDK.Referenced.ModifyTokenBalanceEntry.html +1 -1
  104. package/docs/interfaces/KeetaNetSDK.Referenced.MultiSigIdentifierCreateArguments.html +1 -1
  105. package/docs/interfaces/KeetaNetSDK.Referenced.MultisigConfig.html +1 -1
  106. package/docs/interfaces/KeetaNetSDK.Referenced.NumericValueEntry.html +1 -1
  107. package/docs/interfaces/KeetaNetSDK.Referenced.P2PPeerBase.html +1 -1
  108. package/docs/interfaces/KeetaNetSDK.Referenced.P2PPeerListener.html +1 -1
  109. package/docs/interfaces/KeetaNetSDK.Referenced.P2PPeerRepBase.html +1 -1
  110. package/docs/interfaces/KeetaNetSDK.Referenced.PublicKeyStorage.html +1 -1
  111. package/docs/interfaces/KeetaNetSDK.Referenced.RequestTokenReceiveEntry.html +1 -1
  112. package/docs/interfaces/KeetaNetSDK.Referenced.TokenNumericEntry.html +1 -1
  113. package/docs/interfaces/KeetaNetSDK.Referenced.UserClientConfig.html +1 -1
  114. package/docs/interfaces/KeetaNetSDK.Referenced.UserClientOptions.html +1 -1
  115. package/docs/interfaces/KeetaNetSDK.Referenced.WithIsInstance.html +1 -1
  116. package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1BitString.html +1 -1
  117. package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1Date.html +1 -1
  118. package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1OID.html +1 -1
  119. package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1Set.html +1 -1
  120. package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1String.html +1 -1
  121. package/docs/modules/KeetaNetSDK.Referenced.html +1 -1
  122. package/docs/modules/KeetaNetSDK.Referenced.src_lib_utils_initial.html +1 -1
  123. package/docs/types/KeetaNetSDK.Referenced.ErrorCode.html +1 -1
  124. package/docs/types/KeetaNetSDK.Referenced.GetAccountStateAPIResponseFormatted.html +5 -2
  125. package/docs/types/KeetaNetSDK.Referenced.GetAccountStateAPIResponseSuccess.html +3 -2
  126. package/docs/types/KeetaNetSDK.Referenced.LedgerBaseErrorCode.html +1 -0
  127. package/docs/types/KeetaNetSDK.Referenced.LedgerVoteErrorCode.html +1 -0
  128. package/docs/variables/KeetaNetSDK.Referenced.FullLedgerBaseErrorCode.html +1 -0
  129. package/docs/variables/KeetaNetSDK.Referenced.FullLedgerVoteErrorCodes.html +1 -0
  130. package/docs/variables/KeetaNetSDK.Referenced.allFullErrorCodes.html +1 -0
  131. package/lib/error/account.d.ts +6 -7
  132. package/lib/error/api.d.ts +8 -0
  133. package/lib/error/base.d.ts +16 -0
  134. package/lib/error/block.d.ts +6 -7
  135. package/lib/error/certificate.d.ts +6 -7
  136. package/lib/error/client.d.ts +6 -7
  137. package/lib/error/index.d.ts +7 -18
  138. package/lib/error/kv.d.ts +6 -7
  139. package/lib/error/ledger.d.ts +28 -8
  140. package/lib/error/permissions.d.ts +6 -7
  141. package/lib/error/vote.d.ts +6 -7
  142. package/lib/ledger/common.d.ts +9 -0
  143. package/lib/ledger/index.d.ts +23 -0
  144. package/lib/node/local.d.ts +1 -2
  145. package/lib/p2p.d.ts +1 -1
  146. package/lib/utils/initial.d.ts +6 -0
  147. package/npm-shrinkwrap.json +598 -0
  148. package/package.json +3 -2
  149. package/version.d.ts +1 -1
  150. package/docs/types/KeetaNetSDK.Referenced.AccountErrorCode.html +0 -1
  151. package/docs/types/KeetaNetSDK.Referenced.BlockErrorCode.html +0 -1
  152. package/docs/types/KeetaNetSDK.Referenced.CertificateErrorCode.html +0 -1
  153. package/docs/types/KeetaNetSDK.Referenced.ClientErrorCode.html +0 -1
  154. package/docs/types/KeetaNetSDK.Referenced.KVErrorCode.html +0 -1
  155. package/docs/types/KeetaNetSDK.Referenced.LedgerErrorCode.html +0 -1
  156. package/docs/types/KeetaNetSDK.Referenced.PermissionsErrorCode.html +0 -1
  157. package/docs/types/KeetaNetSDK.Referenced.VoteErrorCode.html +0 -1
  158. package/docs/variables/KeetaNetSDK.Referenced.AccountErrorCodes.html +0 -1
  159. package/docs/variables/KeetaNetSDK.Referenced.AccountErrorType.html +0 -1
  160. package/docs/variables/KeetaNetSDK.Referenced.BlockErrorCodes-1.html +0 -1
  161. package/docs/variables/KeetaNetSDK.Referenced.BlockErrorCodes.html +0 -1
  162. package/docs/variables/KeetaNetSDK.Referenced.BlockErrorType.html +0 -1
  163. package/docs/variables/KeetaNetSDK.Referenced.CertificateErrorType.html +0 -1
  164. package/docs/variables/KeetaNetSDK.Referenced.ClientErrorCodes.html +0 -1
  165. package/docs/variables/KeetaNetSDK.Referenced.ClientErrorType.html +0 -1
  166. package/docs/variables/KeetaNetSDK.Referenced.KVErrorCodes.html +0 -1
  167. package/docs/variables/KeetaNetSDK.Referenced.KVErrorType.html +0 -1
  168. package/docs/variables/KeetaNetSDK.Referenced.LedgerErrorCodes.html +0 -1
  169. package/docs/variables/KeetaNetSDK.Referenced.LedgerErrorType.html +0 -1
  170. package/docs/variables/KeetaNetSDK.Referenced.PermissionsErrorCodes.html +0 -1
  171. package/docs/variables/KeetaNetSDK.Referenced.PermissionsErrorType.html +0 -1
  172. package/docs/variables/KeetaNetSDK.Referenced.VoteErrorCodes.html +0 -1
  173. package/docs/variables/KeetaNetSDK.Referenced.VoteErrorType.html +0 -1
package/client/index.d.ts CHANGED
@@ -15,6 +15,7 @@ import type { AdjustMethod } from '../lib/block';
15
15
  import Block, { BlockHash } from '../lib/block';
16
16
  import type { P2PSwitchStatistics } from '../lib/p2p';
17
17
  import * as Config from '../config';
18
+ import type { BaseTokenInfo } from '../lib/utils/initial';
18
19
  import type { BuilderOptions, ManageCertificateMethod } from './builder';
19
20
  import { UserClientBuilder } from './builder';
20
21
  import { KeetaNetError } from '../lib/error';
@@ -42,6 +43,11 @@ type GetAccountStateAPIResponseFormatted = {
42
43
  * this will be null if the account is not open
43
44
  */
44
45
  currentHeadBlock: string | null;
46
+ /**
47
+ * The current height of the head block for the account, if there is one
48
+ * this will be null if the account is not open
49
+ */
50
+ currentHeadBlockHeight: string | null;
45
51
  /**
46
52
  * The current representative for the account, if there is one
47
53
  * this will be null if the account is not open or if the
@@ -403,7 +409,7 @@ export declare class Client {
403
409
  * @param account The account to fetch the information for
404
410
  * @return The account information
405
411
  */
406
- getAccountInfo(account: GenericAccount | string): Promise<GetAccountStateAPIResponseFormatted>;
412
+ getAccountInfo(account: GenericAccount | string, rep?: ClientRepresentative | 'ANY'): Promise<GetAccountStateAPIResponseFormatted>;
407
413
  /**
408
414
  * Fetch the account information for multiple accounts. This will return
409
415
  * the account information including the current head block, representative,
@@ -721,6 +727,13 @@ export declare class Client {
721
727
  * @param publish Publish the recovered staple to the network (default is true)
722
728
  */
723
729
  recoverAccount(account: GenericAccount, publish?: boolean): Promise<VoteStaple | null>;
730
+ /**
731
+ * Sync any partially-published account artifacts
732
+ *
733
+ * @param account Account to sync
734
+ * @param publish Publish the synced staple to the network (default is true)
735
+ */
736
+ syncAccount(account: GenericAccount, publish?: boolean, reps?: ClientRepresentative[]): Promise<VoteStaple | null>;
724
737
  getVoteQuotes(blocks: Block[]): Promise<VoteQuote[]>;
725
738
  /** Work in progress */
726
739
  getLedgerChecksum(rep?: ClientRepresentative | 'ANY'): Promise<{
@@ -876,6 +889,7 @@ export declare class UserClient {
876
889
  addSupplyAmount: bigint;
877
890
  delegateTo?: Account;
878
891
  voteSerial?: bigint;
892
+ baseTokenInfo: BaseTokenInfo;
879
893
  }, options?: UserClientOptions): Promise<{
880
894
  voteStaple: VoteStaple;
881
895
  publish: boolean;
@@ -1187,6 +1201,14 @@ export declare class UserClient {
1187
1201
  * @param options User client options (common options)
1188
1202
  */
1189
1203
  recover(publish?: boolean, options?: UserClientOptions): Promise<VoteStaple | null>;
1204
+ /**
1205
+ * Sync any partially-published account artifacts
1206
+ *
1207
+ * @param publish Publish the recovered staple to the network
1208
+ * (default: true)
1209
+ * @param options User client options (common options)
1210
+ */
1211
+ sync(publish?: boolean, options?: UserClientOptions): Promise<VoteStaple | null>;
1190
1212
  /**
1191
1213
  * Register a callback for change messages and set up a websocket filtered to our account only.
1192
1214
  * Also set up long timeout polling for changes in case the websocket misses a change update