@keetanetwork/keetanet-client 0.14.0 → 0.14.3

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 (147) hide show
  1. package/README.md +4 -0
  2. package/api/node.d.ts +1 -0
  3. package/client/builder.d.ts +8 -3
  4. package/client/index-browser.d.ts +6 -1
  5. package/client/index-browser.js +1852 -1723
  6. package/client/index.d.ts +6 -1
  7. package/client/index.js +248 -148
  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 +4 -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 +1 -1
  45. package/docs/classes/KeetaNetSDK.Referenced.KeyInterface.html +1 -1
  46. package/docs/classes/KeetaNetSDK.Referenced.KeyStorage.html +1 -1
  47. package/docs/classes/KeetaNetSDK.Referenced.Ledger.html +3 -2
  48. package/docs/classes/KeetaNetSDK.Referenced.LedgerAtomicInterface.html +2 -1
  49. package/docs/classes/KeetaNetSDK.Referenced.LedgerStorageTransactionBase.html +8 -0
  50. package/docs/classes/KeetaNetSDK.Referenced.PermissionSetHolder.html +1 -1
  51. package/docs/classes/KeetaNetSDK.Referenced.PossiblyExpiredVote.html +1 -1
  52. package/docs/classes/KeetaNetSDK.Referenced.SignatureStorage.html +1 -1
  53. package/docs/classes/KeetaNetSDK.Referenced.Stats.html +10 -4
  54. package/docs/classes/KeetaNetSDK.Referenced.StatsPending.html +10 -0
  55. package/docs/classes/KeetaNetSDK.Referenced.UserClientBuilder.html +2 -2
  56. package/docs/classes/KeetaNetSDK.Referenced.Vote.html +1 -1
  57. package/docs/classes/KeetaNetSDK.Referenced.VoteBlockBundle.html +1 -1
  58. package/docs/classes/KeetaNetSDK.Referenced.VoteBlockHash.html +1 -1
  59. package/docs/classes/KeetaNetSDK.Referenced.VoteBuilder.html +1 -1
  60. package/docs/classes/KeetaNetSDK.Referenced.VoteHash.html +1 -1
  61. package/docs/classes/KeetaNetSDK.Referenced.VoteLikeBase.html +1 -1
  62. package/docs/classes/KeetaNetSDK.Referenced.VoteQuote.html +1 -1
  63. package/docs/classes/KeetaNetSDK.Referenced.VoteQuoteBuilder.html +1 -1
  64. package/docs/classes/KeetaNetSDK.Referenced.VoteStaple.html +1 -1
  65. package/docs/classes/KeetaNetSDK.Referenced.VoteStapleHash.html +1 -1
  66. package/docs/classes/KeetaNetSDK.Referenced.src_lib_utils_buffer.BufferStorage.html +1 -1
  67. package/docs/classes/KeetaNetSDK.UserClient.html +2 -2
  68. package/docs/documents/GETTING-STARTED.html +3 -2
  69. package/docs/hierarchy.html +1 -1
  70. package/docs/index.html +2 -1
  71. package/docs/interfaces/KeetaNetSDK.Referenced.ACLEntry.html +1 -1
  72. package/docs/interfaces/KeetaNetSDK.Referenced.ACLUpdate.html +1 -1
  73. package/docs/interfaces/KeetaNetSDK.Referenced.ASN1ExplicitContextTag.html +1 -1
  74. package/docs/interfaces/KeetaNetSDK.Referenced.ASN1ImplicitContextTag.html +1 -1
  75. package/docs/interfaces/KeetaNetSDK.Referenced.ASN1Object.html +1 -1
  76. package/docs/interfaces/KeetaNetSDK.Referenced.BaseExternalKeyPairFunctions.html +1 -1
  77. package/docs/interfaces/KeetaNetSDK.Referenced.BaseGenerationConfig.html +1 -1
  78. package/docs/interfaces/KeetaNetSDK.Referenced.BaseIdentifierCreateArguments.html +1 -1
  79. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperation.html +1 -1
  80. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationCREATE_IDENTIFIER.html +1 -1
  81. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationMANAGE_CERTIFICATE.html +1 -1
  82. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationMANAGE_CERTIFICATESerializable.html +1 -1
  83. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationMODIFY_PERMISSIONS.html +1 -1
  84. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationRECEIVE.html +1 -1
  85. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationSEND.html +1 -1
  86. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationSET_INFO.html +1 -1
  87. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationSET_REP.html +1 -1
  88. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationTOKEN_ADMIN_MODIFY_BALANCE.html +1 -1
  89. package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationTOKEN_ADMIN_SUPPLY.html +1 -1
  90. package/docs/interfaces/KeetaNetSDK.Referenced.BlockV1Canonical.html +1 -1
  91. package/docs/interfaces/KeetaNetSDK.Referenced.BlockV2Canonical.html +1 -1
  92. package/docs/interfaces/KeetaNetSDK.Referenced.BuilderBlockOptions.html +3 -0
  93. package/docs/interfaces/KeetaNetSDK.Referenced.Constructor.html +1 -1
  94. package/docs/interfaces/KeetaNetSDK.Referenced.DisposableTimingHandle.html +1 -1
  95. package/docs/interfaces/KeetaNetSDK.Referenced.ExternalKeyPairFunctionsNoEncryption.html +1 -1
  96. package/docs/interfaces/KeetaNetSDK.Referenced.ExternalKeyPairFunctionsSupportsEncryption.html +1 -1
  97. package/docs/interfaces/KeetaNetSDK.Referenced.InitialConfigSupply.html +1 -1
  98. package/docs/interfaces/KeetaNetSDK.Referenced.InstanceSet.html +1 -1
  99. package/docs/interfaces/KeetaNetSDK.Referenced.KVGenericOptionsType.html +1 -1
  100. package/docs/interfaces/KeetaNetSDK.Referenced.KVSetOptionsType.html +1 -1
  101. package/docs/interfaces/KeetaNetSDK.Referenced.LedgerStorageAPI.html +6 -3
  102. package/docs/interfaces/KeetaNetSDK.Referenced.LedgerStorageTransactionBaseOptions.html +6 -0
  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.PublishOptions.html → KeetaNetSDK.Referenced.PublishOptions.html} +1 -1
  112. package/docs/interfaces/KeetaNetSDK.Referenced.RequestTokenReceiveEntry.html +1 -1
  113. package/docs/interfaces/KeetaNetSDK.Referenced.TokenNumericEntry.html +1 -1
  114. package/docs/interfaces/KeetaNetSDK.Referenced.UserClientConfig.html +1 -1
  115. package/docs/interfaces/KeetaNetSDK.Referenced.UserClientOptions.html +1 -1
  116. package/docs/interfaces/KeetaNetSDK.Referenced.WithIsInstance.html +1 -1
  117. package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1BitString.html +1 -1
  118. package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1Date.html +1 -1
  119. package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1OID.html +1 -1
  120. package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1Set.html +1 -1
  121. package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1String.html +1 -1
  122. package/docs/modules/KeetaNetSDK.Referenced.html +1 -1
  123. package/docs/modules/KeetaNetSDK.Referenced.src_lib_utils_asn1.html +1 -1
  124. package/docs/modules/KeetaNetSDK.html +2 -2
  125. package/docs/types/KeetaNetSDK.Referenced.GetAccountStateAPIResponseFormatted.html +5 -2
  126. package/docs/types/KeetaNetSDK.Referenced.GetAccountStateAPIResponseSuccess.html +3 -2
  127. package/docs/types/KeetaNetSDK.Referenced.src_lib_utils_asn1.ValidateASN1.SchemaMap.html +1 -1
  128. package/docs/variables/KeetaNetSDK.Referenced.BlockErrorCodes-1.html +1 -1
  129. package/docs/variables/KeetaNetSDK.Referenced.LedgerErrorCodes.html +1 -1
  130. package/docs/variables/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1CheckUtilities.html +1 -0
  131. package/lib/error/certificate.d.ts +1 -1
  132. package/lib/error/ledger.d.ts +1 -1
  133. package/lib/ledger/common.d.ts +9 -0
  134. package/lib/ledger/db_dynamodb.d.ts +5 -9
  135. package/lib/ledger/db_postgres.d.ts +11 -3
  136. package/lib/ledger/db_spanner.d.ts +5 -12
  137. package/lib/ledger/db_spanner_helper.d.ts +1 -1
  138. package/lib/ledger/db_sqlite.d.ts +11 -3
  139. package/lib/ledger/index.d.ts +34 -2
  140. package/lib/p2p.d.ts +1 -1
  141. package/lib/stats.d.ts +22 -3
  142. package/lib/utils/asn1.d.ts +18 -1
  143. package/lib/utils/static-types.d.ts +11 -0
  144. package/package.json +1 -1
  145. package/version.d.ts +1 -1
  146. package/benchmarking/test.d.ts +0 -4
  147. package/docs/interfaces/KeetaNetSDK.Referenced.LedgerStorageTransactionBase.html +0 -6
package/README.md CHANGED
@@ -5,3 +5,7 @@ This package implements KeetaNet Client SDK in JavaScript
5
5
 
6
6
  See the [Getting Started](docs/GETTING-STARTED.md) Guide for more
7
7
  information on first steps with the KeetaNet SDK.
8
+
9
+ ## Documentation
10
+
11
+ 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 CHANGED
@@ -28,6 +28,7 @@ interface GetAccountChainAPIResponse {
28
28
  interface AccountState {
29
29
  account: GenericAccount;
30
30
  currentHeadBlock: BlockHash | null;
31
+ currentHeadBlockHeight: bigint | null;
31
32
  representative: Account | null;
32
33
  balances: GetAllBalancesResponse;
33
34
  info: AccountInfo;
@@ -5,11 +5,13 @@ import { Block } from '../lib/block';
5
5
  import { type BlockJSONOperations } from '../lib/block/operations';
6
6
  import type { AccountInfo } from '../lib/ledger/types';
7
7
  import type { AcceptedPermissionTypes } from '../lib/permissions';
8
- import type { UserClient, PublishOptions } from '.';
8
+ import type { UserClient, Client } from '.';
9
9
  import { Permissions } from '../lib/permissions';
10
10
  import { Certificate, CertificateBundle } from '../lib/utils/certificate';
11
11
  import type { VoteStaple } from '../lib/vote';
12
12
  type GetPrevFunction = (acct: GenericAccount | string) => Promise<BlockHash | string | null | undefined>;
13
+ type PublishOptions = NonNullable<Parameters<Client['transmit']>[1]>;
14
+ /** @expand */
13
15
  interface AccountSignerOptions {
14
16
  account: GenericAccount;
15
17
  signer: Account;
@@ -19,8 +21,11 @@ interface RenderOptions {
19
21
  network: bigint;
20
22
  getPrevious: GetPrevFunction;
21
23
  }
22
- /** @useDeclaredType */
23
- type BuilderBlockOptions = Partial<AccountSignerOptions>;
24
+ /** @expand */
25
+ interface BuilderBlockOptions {
26
+ account?: AccountSignerOptions['account'];
27
+ signer?: AccountSignerOptions['signer'];
28
+ }
24
29
  /**
25
30
  * Either a UserClient or an object with a client and network
26
31
  *
@@ -42,6 +42,11 @@ type GetAccountStateAPIResponseFormatted = {
42
42
  * this will be null if the account is not open
43
43
  */
44
44
  currentHeadBlock: string | null;
45
+ /**
46
+ * The current height of the head block for the account, if there is one
47
+ * this will be null if the account is not open
48
+ */
49
+ currentHeadBlockHeight: string | null;
45
50
  /**
46
51
  * The current representative for the account, if there is one
47
52
  * this will be null if the account is not open or if the
@@ -119,7 +124,7 @@ interface CertificateWithIntermediatesResponse {
119
124
  certificate: Certificate;
120
125
  intermediates: CertificateBundle | null;
121
126
  }
122
- export interface PublishOptions {
127
+ interface PublishOptions {
123
128
  /**
124
129
  * Client provided function to compute the fee block associated with any transactions
125
130
  */