@keetanetwork/keetanet-client 0.16.0 → 0.16.2
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.
- package/client/builder.d.ts +3 -3
- package/client/client_common_tests.d.ts +23 -4
- package/client/index-browser.d.ts +15 -13
- package/client/index-browser.js +878 -351
- package/client/index.d.ts +15 -13
- package/client/index.js +737 -253
- package/docs/assets/hierarchy.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/KeetaNetSDK.Client.html +10 -10
- package/docs/classes/KeetaNetSDK.Referenced.Account.html +34 -31
- package/docs/classes/KeetaNetSDK.Referenced.BaseSet.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.BaseVoteBuilder.html +2 -2
- package/docs/classes/KeetaNetSDK.Referenced.Block.html +3 -3
- package/docs/classes/KeetaNetSDK.Referenced.BlockBuilder.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.BlockHash.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.BlockOperation.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.BlockOperationCREATE_IDENTIFIER.html +2 -2
- package/docs/classes/KeetaNetSDK.Referenced.BlockOperationMANAGE_CERTIFICATE.html +2 -2
- package/docs/classes/KeetaNetSDK.Referenced.BlockOperationMODIFY_PERMISSIONS.html +2 -2
- package/docs/classes/KeetaNetSDK.Referenced.BlockOperationRECEIVE.html +2 -2
- package/docs/classes/KeetaNetSDK.Referenced.BlockOperationSEND.html +2 -2
- package/docs/classes/KeetaNetSDK.Referenced.BlockOperationSET_INFO.html +2 -2
- package/docs/classes/KeetaNetSDK.Referenced.BlockOperationSET_REP.html +2 -2
- package/docs/classes/KeetaNetSDK.Referenced.BlockOperationTOKEN_ADMIN_MODIFY_BALANCE.html +2 -2
- package/docs/classes/KeetaNetSDK.Referenced.BlockOperationTOKEN_ADMIN_SUPPLY.html +2 -2
- package/docs/classes/KeetaNetSDK.Referenced.Certificate.html +7 -7
- package/docs/classes/KeetaNetSDK.Referenced.CertificateBundle.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.CertificateHash.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.ECDSAKeyPair.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256K1KeyPair.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256K1PrivateKey.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256K1PublicKey.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256K1Signature.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256R1KeyPair.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256R1PrivateKey.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256R1PublicKey.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256R1Signature.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.ED25519KeyPair.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.ED25519PrivateKey.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.ED25519PublicKey.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.ED25519Signature.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.ExternalKeyPair.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.ExternalSet.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.IdempotentKey.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.IdentifierKey.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.IdentifierKeyPair.html +4 -4
- package/docs/classes/KeetaNetSDK.Referenced.KeetaNetError.html +2 -2
- package/docs/classes/KeetaNetSDK.Referenced.KeetaNetErrorBase.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.KeetaNetLedgerError.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.KeetaNetLedgerIdempotentKeyError.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.KeetaNetLedgerVoteError.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.KeyInterface.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.KeyStorage.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.Ledger.html +2 -2
- package/docs/classes/KeetaNetSDK.Referenced.LedgerAtomicInterface.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.P2PSwitch.html +2 -2
- package/docs/classes/KeetaNetSDK.Referenced.PermissionSetHolder.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.PossiblyExpiredVote.html +2 -2
- package/docs/classes/KeetaNetSDK.Referenced.PossiblyUnsignedBlock.html +3 -3
- package/docs/classes/KeetaNetSDK.Referenced.SignatureStorage.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.Stats.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.StatsPending.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.UnsignedBlock.html +3 -3
- package/docs/classes/KeetaNetSDK.Referenced.UserClientBuilder.html +11 -11
- package/docs/classes/KeetaNetSDK.Referenced.Vote.html +2 -2
- package/docs/classes/KeetaNetSDK.Referenced.VoteBlockBundle.html +4 -4
- package/docs/classes/KeetaNetSDK.Referenced.VoteBlockHash.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.VoteBuilder.html +2 -2
- package/docs/classes/KeetaNetSDK.Referenced.VoteHash.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.VoteLikeBase.html +2 -2
- package/docs/classes/KeetaNetSDK.Referenced.VoteQuote.html +2 -2
- package/docs/classes/KeetaNetSDK.Referenced.VoteQuoteBuilder.html +2 -2
- package/docs/classes/KeetaNetSDK.Referenced.VoteStaple.html +4 -4
- package/docs/classes/KeetaNetSDK.Referenced.VoteStapleHash.html +1 -1
- package/docs/classes/KeetaNetSDK.Referenced.src_lib_utils_buffer.BufferStorage.html +1 -1
- package/docs/classes/KeetaNetSDK.UserClient.html +20 -20
- package/docs/documents/GETTING-STARTED.html +1 -1
- package/docs/enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html +8 -8
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_domain-separation.applyNamespace.html +5 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_helper.getTypedObjectEntries.html +1 -0
- package/docs/hierarchy.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.ACLEntry.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.ACLUpdate.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.ASN1ExplicitContextTag.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.ASN1ImplicitContextTag.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.ASN1Object.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.BaseAccountInfo.html +10 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.BaseExternalKeyPairFunctions.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.BaseGenerationConfig.html +2 -2
- package/docs/interfaces/KeetaNetSDK.Referenced.BaseIdentifierAccountInfo.html +12 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.BaseIdentifierCreateArguments.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperation.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationCREATE_IDENTIFIER.html +2 -2
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationMANAGE_CERTIFICATE.html +2 -2
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationMODIFY_PERMISSIONS.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationRECEIVE.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationSEND.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationSET_INFO.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationSET_REP.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationTOKEN_ADMIN_MODIFY_BALANCE.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationTOKEN_ADMIN_SUPPLY.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockV1Canonical.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockV1JSON.html +2 -2
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockV2Canonical.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.BuilderBlockOptions.html +2 -2
- package/docs/interfaces/KeetaNetSDK.Referenced.Constructor.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.DisposableTimingHandle.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.ECDSA_SECP256K1AccountInfo.html +10 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.ECDSA_SECP256R1AccountInfo.html +10 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.ED25519AccountInfo.html +10 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.ExternalKeyPairFunctionsNoEncryption.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.ExternalKeyPairFunctionsSupportsEncryption.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.FeeAmountAndToken.html +2 -2
- package/docs/interfaces/KeetaNetSDK.Referenced.FeeAmountAndTokenJSON.html +2 -2
- package/docs/interfaces/KeetaNetSDK.Referenced.IdentifierCreateRequest.html +2 -2
- package/docs/interfaces/KeetaNetSDK.Referenced.InitialConfigSupply.html +2 -2
- package/docs/interfaces/KeetaNetSDK.Referenced.InstanceSet.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.KVGenericOptionsType.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.KVSetOptionsType.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.LedgerConfig.html +4 -4
- package/docs/interfaces/KeetaNetSDK.Referenced.LedgerStorageAPI.html +5 -5
- package/docs/interfaces/KeetaNetSDK.Referenced.ModifyTokenBalanceEntry.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.MultiSigIdentifierCreateArguments.html +2 -2
- package/docs/interfaces/KeetaNetSDK.Referenced.MultisigAccountInfo.html +14 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.MultisigConfig.html +2 -2
- package/docs/interfaces/KeetaNetSDK.Referenced.NetworkAccountInfo.html +12 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.NodeConfig.html +4 -4
- package/docs/interfaces/KeetaNetSDK.Referenced.NumericValueEntry.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.P2PPeerBase.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.P2PPeerListener.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.P2PPeerRepBase.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.PendingOperations.html +2 -2
- package/docs/interfaces/KeetaNetSDK.Referenced.PendingOperationsJSON.html +2 -2
- package/docs/interfaces/KeetaNetSDK.Referenced.PrincipalACLWithInfoParsed.html +3 -10
- package/docs/interfaces/KeetaNetSDK.Referenced.PublicKeyStorage.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.PublishOptions.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.RequestTokenReceiveEntry.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.StorageAccountInfo.html +12 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.TokenAccountInfo.html +14 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.TokenNumericEntry.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.UserClientConfig.html +2 -2
- package/docs/interfaces/KeetaNetSDK.Referenced.UserClientOptions.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.VoteJSON.html +2 -2
- package/docs/interfaces/KeetaNetSDK.Referenced.VoteStapleJSON.html +2 -2
- package/docs/interfaces/KeetaNetSDK.Referenced.WithIsInstance.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.signOptionsType.html +16 -3
- package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1BitString.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1Date.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1OID.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1Set.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1String.html +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1Struct.html +1 -1
- package/docs/modules/KeetaNetSDK.Referenced.html +1 -1
- package/docs/modules/KeetaNetSDK.Referenced.src_lib_utils_domain-separation.html +1 -0
- package/docs/modules/KeetaNetSDK.Referenced.src_lib_utils_helper.html +1 -1
- package/docs/types/KeetaNetSDK.Referenced.AccountInfo.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.AccountInfoForType.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.AccountInfoResponse.html +2 -2
- package/docs/types/KeetaNetSDK.Referenced.AccountInfoWithoutAccount.html +1 -0
- package/docs/types/{KeetaNetSDK.Referenced.src_lib_utils_helper.DistributiveOmit.html → KeetaNetSDK.Referenced.DistributiveOmit.html} +1 -1
- package/docs/types/KeetaNetSDK.Referenced.GetAccountStateAPIResponseFormatted.html +5 -12
- package/docs/types/KeetaNetSDK.Referenced.KeyPairAccountInfo.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.KeyPairKeyAlgorithm.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.NetworkAddress.html +1 -1
- package/docs/types/KeetaNetSDK.Referenced.StorageAddress.html +1 -1
- package/docs/types/KeetaNetSDK.Referenced.TokenAddress.html +1 -1
- package/docs/types/KeetaNetSDK.Referenced.TokenOrPending.html +1 -1
- package/docs/types/KeetaNetSDK.Referenced.UserEditableAccountInfo.html +1 -1
- package/docs/types/KeetaNetSDK.Referenced.VoteBuilderOptions.html +2 -2
- package/docs/types/KeetaNetSDK.Referenced.src_lib_utils_conversion.ToJSONSerializable.html +1 -1
- package/docs/types/KeetaNetSDK.Referenced.src_lib_utils_initial.BaseNetworkInfo.html +1 -1
- package/docs/variables/KeetaNetSDK.Referenced.allFullErrorCodes.html +1 -1
- package/docs/variables/KeetaNetSDK.Referenced.identifierKeyTypes.html +1 -1
- package/docs/variables/KeetaNetSDK.Referenced.src_lib_utils_domain-separation.KeetaNamespaceVersion.html +3 -0
- package/docs/variables/KeetaNetSDK.Referenced.src_lib_utils_domain-separation.MaxNamespaceLength.html +3 -0
- package/docs/variables/KeetaNetSDK.Referenced.src_lib_utils_domain-separation.namespacePrefixSchema.html +9 -0
- package/docs/variables/KeetaNetSDK.lib.html +2 -2
- package/lib/account.d.ts +39 -1
- package/lib/block/index.d.ts +126 -108
- package/lib/block/operations.d.ts +11 -0
- package/lib/error/account.d.ts +2 -2
- package/lib/error/index.d.ts +1 -1
- package/lib/error/vote.d.ts +2 -2
- package/lib/index.d.ts +4 -2
- package/lib/ledger/common.d.ts +15 -3
- package/lib/ledger/db_dynamodb.d.ts +6 -6
- package/lib/ledger/db_postgres.d.ts +3 -3
- package/lib/ledger/db_spanner.d.ts +4 -4
- package/lib/ledger/db_spanner_helper.d.ts +2 -2
- package/lib/ledger/db_sqlite.d.ts +3 -3
- package/lib/ledger/effects.d.ts +3 -1
- package/lib/ledger/index.d.ts +9 -9
- package/lib/ledger/types.d.ts +43 -9
- package/lib/log/target_gcp.js +3 -0
- package/lib/log/target_https.js +7 -0
- package/lib/utils/certificate.d.ts +13 -12
- package/lib/utils/conversion.d.ts +12 -3
- package/lib/utils/domain-separation.d.ts +31 -0
- package/lib/utils/external-keys/gcp-kms.d.ts +53 -0
- package/lib/utils/external-keys/gcp-kms.js +328 -0
- package/lib/utils/external-keys/passkey-prf.d.ts +1 -3
- package/lib/utils/external-keys/passkey-prf.js +6 -0
- package/lib/utils/helper.d.ts +1 -0
- package/lib/utils/initial.d.ts +3 -2
- package/lib/utils/never.d.ts +4 -0
- package/lib/vote.d.ts +96 -89
- package/npm-shrinkwrap.json +30 -12
- package/package.json +2 -2
- package/version.d.ts +1 -1
- package/docs/interfaces/KeetaNetSDK.Referenced.AccountInfo.html +0 -14
|
@@ -81,11 +81,11 @@ be affected by the blocks and transactions that are published.</p>
|
|
|
81
81
|
this instance is connected to.</p>
|
|
82
82
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">bigint</span></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="readonly"><span>readonly</span><a href="#readonly" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="readonlyreadonly"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">readonly</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Whether or not this client is "readonly". This is true if the
|
|
83
83
|
signer is null.</p>
|
|
84
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="signer"><span>signer</span><a href="#signer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="signersigner"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">signer</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.Account.html" class="tsd-signature-type tsd-kind-class">Account</a><span class="tsd-signature-symbol"><</span><a href="../
|
|
84
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="signer"><span>signer</span><a href="#signer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="signersigner"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">signer</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.Account.html" class="tsd-signature-type tsd-kind-class">Account</a><span class="tsd-signature-symbol"><</span><a href="../types/KeetaNetSDK.Referenced.KeyPairKeyAlgorithm.html" class="tsd-signature-type tsd-kind-type-alias">KeyPairKeyAlgorithm</a><span class="tsd-signature-symbol">></span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the signer for this instance, if it was set. This is the
|
|
85
85
|
account that will be used to sign blocks and transactions.
|
|
86
86
|
If this is null, then the client is readonly and will not be
|
|
87
87
|
able to publish blocks or transactions.</p>
|
|
88
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.Account.html" class="tsd-signature-type tsd-kind-class">Account</a><span class="tsd-signature-symbol"><</span><a href="../
|
|
88
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.Account.html" class="tsd-signature-type tsd-kind-class">Account</a><span class="tsd-signature-symbol"><</span><a href="../types/KeetaNetSDK.Referenced.KeyPairKeyAlgorithm.html" class="tsd-signature-type tsd-kind-type-alias">KeyPairKeyAlgorithm</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-icon-text)"></path></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="asyncdispose"><span>[async<wbr/>Dispose]</span><a href="#asyncdispose" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="asyncdispose-1"><span class="tsd-kind-call-signature">"[asyncDispose]"</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#asyncdispose-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>This enables the use of <code>using</code> to automatically clean up the
|
|
89
89
|
instance of the <a href="#" class="tsd-kind-class">UserClient</a> class when it is no longer
|
|
90
90
|
needed.</p>
|
|
91
91
|
<p>It calls the <a href="#destroy" class="tsd-kind-method">destroy</a>() method to clean up the instance when
|
|
@@ -134,14 +134,14 @@ for more information.</p>
|
|
|
134
134
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="generateidentifiercreatearguments"><span class="tsd-kind-type-parameter">CreateArguments</span> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/KeetaNetSDK.Referenced.MultiSigIdentifierCreateArguments.html" class="tsd-signature-type tsd-kind-interface">MultiSigIdentifierCreateArguments</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">toCreate</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#generateidentifiercreatearguments">CreateArguments</a></span><div class="tsd-comment tsd-typography"><p>The arguments used to create the identifier (ex: multisig configuration)</p>
|
|
135
135
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a></span><div class="tsd-comment tsd-typography"><p>The options to use for the request</p>
|
|
136
136
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="KeetaNetSDK.Referenced.PendingAccount.html" class="tsd-signature-type tsd-kind-class">PendingAccount</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#generateidentifiercreatearguments">CreateArguments</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"type"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>The identifier that was generated</p>
|
|
137
|
-
<div class="tsd-comment tsd-typography"></div></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="generateidentifier-2"><span class="tsd-kind-call-signature">generateIdentifier</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#generateidentifiercreatekeytype">CreateKeyType</a> <span class="tsd-signature-keyword">extends</span> <a href="../
|
|
138
|
-
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="generateidentifiercreatekeytype"><span class="tsd-kind-type-parameter">CreateKeyType</span> <span class="tsd-signature-keyword">extends</span> <a href="../
|
|
137
|
+
<div class="tsd-comment tsd-typography"></div></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="generateidentifier-2"><span class="tsd-kind-call-signature">generateIdentifier</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#generateidentifiercreatekeytype">CreateKeyType</a> <span class="tsd-signature-keyword">extends</span> <a href="../enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html#network" class="tsd-signature-type tsd-kind-enum-member">NETWORK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html#token" class="tsd-signature-type tsd-kind-enum-member">TOKEN</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html#storage" class="tsd-signature-type tsd-kind-enum-member">STORAGE</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#generateidentifiercreatekeytype">CreateKeyType</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="KeetaNetSDK.Referenced.PendingAccount.html" class="tsd-signature-type tsd-kind-class">PendingAccount</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#generateidentifiercreatekeytype">CreateKeyType</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#generateidentifier-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Generate a new identifier for the given type and publish the blocks</p>
|
|
138
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="generateidentifiercreatekeytype"><span class="tsd-kind-type-parameter">CreateKeyType</span> <span class="tsd-signature-keyword">extends</span> <a href="../enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html#network" class="tsd-signature-type tsd-kind-enum-member">NETWORK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html#token" class="tsd-signature-type tsd-kind-enum-member">TOKEN</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html#storage" class="tsd-signature-type tsd-kind-enum-member">STORAGE</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#generateidentifiercreatekeytype">CreateKeyType</a></span><div class="tsd-comment tsd-typography"><p>The type of identifier to generate</p>
|
|
139
139
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a></span><div class="tsd-comment tsd-typography"><p>The options to use for the request</p>
|
|
140
140
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="KeetaNetSDK.Referenced.PendingAccount.html" class="tsd-signature-type tsd-kind-class">PendingAccount</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#generateidentifiercreatekeytype">CreateKeyType</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>The identifier that was generated</p>
|
|
141
|
-
<div class="tsd-comment tsd-typography"></div></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="generateidentifier-3"><span class="tsd-kind-call-signature">generateIdentifier</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">toCreate</span><span class="tsd-signature-symbol">:</span> <a href="../
|
|
142
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">toCreate</span>: <a href="../
|
|
141
|
+
<div class="tsd-comment tsd-typography"></div></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="generateidentifier-3"><span class="tsd-kind-call-signature">generateIdentifier</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">toCreate</span><span class="tsd-signature-symbol">:</span> <a href="../enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html#network" class="tsd-signature-type tsd-kind-enum-member">NETWORK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html#token" class="tsd-signature-type tsd-kind-enum-member">TOKEN</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html#storage" class="tsd-signature-type tsd-kind-enum-member">STORAGE</a> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/KeetaNetSDK.Referenced.MultiSigIdentifierCreateArguments.html" class="tsd-signature-type tsd-kind-interface">MultiSigIdentifierCreateArguments</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="KeetaNetSDK.Referenced.PendingAccount.html" class="tsd-signature-type tsd-kind-class">PendingAccount</a><span class="tsd-signature-symbol"><</span><a href="../enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html#network" class="tsd-signature-type tsd-kind-enum-member">NETWORK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html#token" class="tsd-signature-type tsd-kind-enum-member">TOKEN</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html#storage" class="tsd-signature-type tsd-kind-enum-member">STORAGE</a> <span class="tsd-signature-symbol">|</span> <a href="../modules/KeetaNetSDK.Referenced.html#multisig" class="tsd-signature-type tsd-kind-enum-member">MULTISIG</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#generateidentifier-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Generate a new identifier and publish the blocks</p>
|
|
142
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">toCreate</span>: <a href="../enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html#network" class="tsd-signature-type tsd-kind-enum-member">NETWORK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html#token" class="tsd-signature-type tsd-kind-enum-member">TOKEN</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html#storage" class="tsd-signature-type tsd-kind-enum-member">STORAGE</a> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/KeetaNetSDK.Referenced.MultiSigIdentifierCreateArguments.html" class="tsd-signature-type tsd-kind-interface">MultiSigIdentifierCreateArguments</a></span><div class="tsd-comment tsd-typography"><p>The type of identifier or the arguments to create an identifier</p>
|
|
143
143
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a></span><div class="tsd-comment tsd-typography"><p>The options to use for the request</p>
|
|
144
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="KeetaNetSDK.Referenced.PendingAccount.html" class="tsd-signature-type tsd-kind-class">PendingAccount</a><span class="tsd-signature-symbol"><</span><a href="../
|
|
144
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="KeetaNetSDK.Referenced.PendingAccount.html" class="tsd-signature-type tsd-kind-class">PendingAccount</a><span class="tsd-signature-symbol"><</span><a href="../enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html#network" class="tsd-signature-type tsd-kind-enum-member">NETWORK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html#token" class="tsd-signature-type tsd-kind-enum-member">TOKEN</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html#storage" class="tsd-signature-type tsd-kind-enum-member">STORAGE</a> <span class="tsd-signature-symbol">|</span> <a href="../modules/KeetaNetSDK.Referenced.html#multisig" class="tsd-signature-type tsd-kind-enum-member">MULTISIG</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>The identifier that was generated</p>
|
|
145
145
|
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getblockfromidempotent"><span>get<wbr/>Block<wbr/>From<wbr/>Idempotent</span><a href="#getblockfromidempotent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getblockfromidempotent-1"><span class="tsd-kind-call-signature">getBlockFromIdempotent</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">idempotent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.Block.html" class="tsd-signature-type tsd-kind-class">Block</a><span class="tsd-signature-symbol">></span><a href="#getblockfromidempotent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetch a block from a given idempotent key</p>
|
|
146
146
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">idempotent</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">ArrayBuffer</span></span><div class="tsd-comment tsd-typography"><p>The idempotent key to check</p>
|
|
147
147
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>User client options (common options)</p>
|
|
@@ -177,14 +177,14 @@ is used to create a new builder for adding operations to which are then
|
|
|
177
177
|
converted into the appropriate set of blocks.</p>
|
|
178
178
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The options to use for the builder</p>
|
|
179
179
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="KeetaNetSDK.Referenced.UserClientBuilder.html" class="tsd-signature-type tsd-kind-class">UserClientBuilder</a></h4><p>A new <a href="KeetaNetSDK.Referenced.UserClientBuilder.html" class="tsd-kind-class">UserClientBuilder</a> instance</p>
|
|
180
|
-
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="initializenetwork"><span>initialize<wbr/>Network</span><a href="#initializenetwork" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="initializenetwork-1"><span class="tsd-kind-call-signature">initializeNetwork</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">initOpts</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">addSupplyAmount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">baseNetworkInfo</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><br/> <a href="../interfaces/KeetaNetSDK.Referenced.
|
|
180
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="initializenetwork"><span>initialize<wbr/>Network</span><a href="#initializenetwork" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="initializenetwork-1"><span class="tsd-kind-call-signature">initializeNetwork</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">initOpts</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">addSupplyAmount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">baseNetworkInfo</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><br/> <a href="../interfaces/KeetaNetSDK.Referenced.NetworkAccountInfo.html" class="tsd-signature-type tsd-kind-interface">NetworkAccountInfo</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">"name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"description"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"defaultPermission"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"metadata"</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">baseTokenInfo</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/KeetaNetSDK.Referenced.BaseTokenInfo.html" class="tsd-signature-type tsd-kind-interface">BaseTokenInfo</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">delegateTo</span><span class="tsd-signature-symbol">?:</span> <a href="KeetaNetSDK.Referenced.Account.html" class="tsd-signature-type tsd-kind-class">Account</a><span class="tsd-signature-symbol"><</span><a href="../types/KeetaNetSDK.Referenced.KeyPairKeyAlgorithm.html" class="tsd-signature-type tsd-kind-type-alias">KeyPairKeyAlgorithm</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">voteSerial</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">from</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"direct"</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">publish</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">voteStaple</span><span class="tsd-signature-symbol">:</span> <a href="KeetaNetSDK.Referenced.VoteStaple.html" class="tsd-signature-type tsd-kind-class">VoteStaple</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><a href="#initializenetwork-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Generate and publish the blocks needed to initialize a new network
|
|
181
181
|
with the given parameters.</p>
|
|
182
182
|
<p>This is generally only needed once per network and is used to
|
|
183
183
|
initialize the network with a base token and a representative
|
|
184
184
|
in order to start-up the network.</p>
|
|
185
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">initOpts</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">addSupplyAmount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">baseNetworkInfo</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><br/> <a href="../interfaces/KeetaNetSDK.Referenced.
|
|
185
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">initOpts</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">addSupplyAmount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">baseNetworkInfo</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><br/> <a href="../interfaces/KeetaNetSDK.Referenced.NetworkAccountInfo.html" class="tsd-signature-type tsd-kind-interface">NetworkAccountInfo</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">"name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"description"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"defaultPermission"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"metadata"</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">baseTokenInfo</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/KeetaNetSDK.Referenced.BaseTokenInfo.html" class="tsd-signature-type tsd-kind-interface">BaseTokenInfo</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">delegateTo</span><span class="tsd-signature-symbol">?:</span> <a href="KeetaNetSDK.Referenced.Account.html" class="tsd-signature-type tsd-kind-class">Account</a><span class="tsd-signature-symbol"><</span><a href="../types/KeetaNetSDK.Referenced.KeyPairKeyAlgorithm.html" class="tsd-signature-type tsd-kind-type-alias">KeyPairKeyAlgorithm</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">voteSerial</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>The options to use for the initialization</p>
|
|
186
186
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">addSupplyAmount</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">bigint</span></h5><div class="tsd-comment tsd-typography"><p>The amount of supply to add to the network of the base token</p>
|
|
187
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">baseNetworkInfo</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><br/> <a href="../interfaces/KeetaNetSDK.Referenced.
|
|
187
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">baseNetworkInfo</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><br/> <a href="../interfaces/KeetaNetSDK.Referenced.NetworkAccountInfo.html" class="tsd-signature-type tsd-kind-interface">NetworkAccountInfo</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">"name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"description"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"defaultPermission"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"metadata"</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">baseTokenInfo</span><span class="tsd-signature-symbol">?: </span><a href="../interfaces/KeetaNetSDK.Referenced.BaseTokenInfo.html" class="tsd-signature-type tsd-kind-interface">BaseTokenInfo</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">delegateTo</span><span class="tsd-signature-symbol">?: </span><a href="KeetaNetSDK.Referenced.Account.html" class="tsd-signature-type tsd-kind-class">Account</a><span class="tsd-signature-symbol"><</span><a href="../types/KeetaNetSDK.Referenced.KeyPairKeyAlgorithm.html" class="tsd-signature-type tsd-kind-type-alias">KeyPairKeyAlgorithm</a><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><p>The representative account to delegate the supply to</p>
|
|
188
188
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">voteSerial</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">bigint</span></h5><div class="tsd-comment tsd-typography"><p>The serial number to use for the vote -- must never be reused by the representative</p>
|
|
189
189
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The options to use for the request</p>
|
|
190
190
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">from</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"direct"</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">publish</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">voteStaple</span><span class="tsd-signature-symbol">:</span> <a href="KeetaNetSDK.Referenced.VoteStaple.html" class="tsd-signature-type tsd-kind-class">VoteStaple</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><p>The vote staple that was generated and whether it was able to be published</p>
|
|
@@ -264,15 +264,15 @@ transaction.</p>
|
|
|
264
264
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The options to use for the request</p>
|
|
265
265
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">retries</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></span><div class="tsd-comment tsd-typography"><p>The number of times the request has been retried</p>
|
|
266
266
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">from</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"direct"</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">publish</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">voteStaple</span><span class="tsd-signature-symbol">:</span> <a href="KeetaNetSDK.Referenced.VoteStaple.html" class="tsd-signature-type tsd-kind-class">VoteStaple</a> <span class="tsd-signature-symbol">}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">blocks</span><span class="tsd-signature-symbol">:</span> <a href="KeetaNetSDK.Referenced.Block.html" class="tsd-signature-type tsd-kind-class">Block</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">from</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"publish-aid"</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">publish</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span></h4><p>The vote staple that was generated and whether it was able to be published</p>
|
|
267
|
-
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setinfo"><span>set<wbr/>Info</span><a href="#setinfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setinfo-1"><span class="tsd-kind-call-signature">setInfo</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">info</span><span class="tsd-signature-symbol">:</span> <a href="../
|
|
267
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setinfo"><span>set<wbr/>Info</span><a href="#setinfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setinfo-1"><span class="tsd-kind-call-signature">setInfo</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">info</span><span class="tsd-signature-symbol">:</span> <a href="../types/KeetaNetSDK.Referenced.AccountInfoWithoutAccount.html" class="tsd-signature-type tsd-kind-type-alias">AccountInfoWithoutAccount</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">from</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"direct"</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">publish</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">voteStaple</span><span class="tsd-signature-symbol">:</span> <a href="KeetaNetSDK.Referenced.VoteStaple.html" class="tsd-signature-type tsd-kind-class">VoteStaple</a> <span class="tsd-signature-symbol">}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">blocks</span><span class="tsd-signature-symbol">:</span> <a href="KeetaNetSDK.Referenced.Block.html" class="tsd-signature-type tsd-kind-class">Block</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">from</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"publish-aid"</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">publish</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span><a href="#setinfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the metadata for an account and publish the blocks to the
|
|
268
268
|
network.</p>
|
|
269
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">info</span>: <a href="../
|
|
269
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">info</span>: <a href="../types/KeetaNetSDK.Referenced.AccountInfoWithoutAccount.html" class="tsd-signature-type tsd-kind-type-alias">AccountInfoWithoutAccount</a></span><div class="tsd-comment tsd-typography"><p>The account info to set</p>
|
|
270
270
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The options to use for the request</p>
|
|
271
271
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">from</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"direct"</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">publish</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">voteStaple</span><span class="tsd-signature-symbol">:</span> <a href="KeetaNetSDK.Referenced.VoteStaple.html" class="tsd-signature-type tsd-kind-class">VoteStaple</a> <span class="tsd-signature-symbol">}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">blocks</span><span class="tsd-signature-symbol">:</span> <a href="KeetaNetSDK.Referenced.Block.html" class="tsd-signature-type tsd-kind-class">Block</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">from</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"publish-aid"</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">publish</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span></h4><p>The vote staple that was generated and whether it was able to be published</p>
|
|
272
|
-
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="state"><span>state</span><a href="#state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="state-1"><span class="tsd-kind-call-signature">state</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/KeetaNetSDK.Referenced.UserClientOptionsReadOnly.html" class="tsd-signature-type tsd-kind-type-alias">UserClientOptionsReadOnly</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/KeetaNetSDK.Referenced.GetAccountStateAPIResponseFormatted.html" class="tsd-signature-type tsd-kind-type-alias">GetAccountStateAPIResponseFormatted</a><span class="tsd-signature-symbol">></span><a href="#state-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the current live state of the account. This will return the
|
|
272
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="state"><span>state</span><a href="#state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="state-1"><span class="tsd-kind-call-signature">state</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/KeetaNetSDK.Referenced.UserClientOptionsReadOnly.html" class="tsd-signature-type tsd-kind-type-alias">UserClientOptionsReadOnly</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/KeetaNetSDK.Referenced.GetAccountStateAPIResponseFormatted.html" class="tsd-signature-type tsd-kind-type-alias">GetAccountStateAPIResponseFormatted</a><span class="tsd-signature-symbol"><</span><a href="../enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html" class="tsd-signature-type tsd-kind-enum">AccountKeyAlgorithm</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#state-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the current live state of the account. This will return the
|
|
273
273
|
current state of the account as <a href="KeetaNetSDK.Client.html#getaccountinfo" class="tsd-kind-method">Client.getAccountInfo</a> does.</p>
|
|
274
274
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/KeetaNetSDK.Referenced.UserClientOptionsReadOnly.html" class="tsd-signature-type tsd-kind-type-alias">UserClientOptionsReadOnly</a><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The options to use for the request</p>
|
|
275
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/KeetaNetSDK.Referenced.GetAccountStateAPIResponseFormatted.html" class="tsd-signature-type tsd-kind-type-alias">GetAccountStateAPIResponseFormatted</a><span class="tsd-signature-symbol">></span></h4><p>The current state of the account</p>
|
|
275
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/KeetaNetSDK.Referenced.GetAccountStateAPIResponseFormatted.html" class="tsd-signature-type tsd-kind-type-alias">GetAccountStateAPIResponseFormatted</a><span class="tsd-signature-symbol"><</span><a href="../enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html" class="tsd-signature-type tsd-kind-enum">AccountKeyAlgorithm</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>The current state of the account</p>
|
|
276
276
|
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sync"><span>sync</span><a href="#sync" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="sync-1"><span class="tsd-kind-call-signature">sync</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">publish</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.VoteStaple.html" class="tsd-signature-type tsd-kind-class">VoteStaple</a><span class="tsd-signature-symbol">></span><a href="#sync-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sync any partially-published account artifacts</p>
|
|
277
277
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">publish</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Publish the recovered staple to the network
|
|
278
278
|
(default: true)</p>
|
|
@@ -295,9 +295,9 @@ changes to the network.</p>
|
|
|
295
295
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">method</span>: <a href="../enums/KeetaNetSDK.Referenced.AdjustMethod.html" class="tsd-signature-type tsd-kind-enum">AdjustMethod</a></span><div class="tsd-comment tsd-typography"><p>The method to use for the permission, defaults to SET</p>
|
|
296
296
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The options to use for the request</p>
|
|
297
297
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">from</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"direct"</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">publish</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">voteStaple</span><span class="tsd-signature-symbol">:</span> <a href="KeetaNetSDK.Referenced.VoteStaple.html" class="tsd-signature-type tsd-kind-class">VoteStaple</a> <span class="tsd-signature-symbol">}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">blocks</span><span class="tsd-signature-symbol">:</span> <a href="KeetaNetSDK.Referenced.Block.html" class="tsd-signature-type tsd-kind-class">Block</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">from</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"publish-aid"</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">publish</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span></h4><p>The vote staple that was generated and whether it was able to be published</p>
|
|
298
|
-
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="acceptswaprequest-2"><code class="tsd-tag">Static</code><span>accept<wbr/>Swap<wbr/>Request</span><a href="#acceptswaprequest-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="acceptswaprequest-3"><span class="tsd-kind-call-signature">acceptSwapRequest</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/KeetaNetSDK.Referenced.AcceptSwapRequest.html" class="tsd-signature-type tsd-kind-interface">AcceptSwapRequest</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">builderOrUserClient</span><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <a href="" class="tsd-signature-type tsd-kind-class">UserClient</a><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">network</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"main"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"staging"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"test"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"dev"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">signer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.Account.html" class="tsd-signature-type tsd-kind-class">Account</a><span class="tsd-signature-symbol"><</span><a href="../
|
|
298
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="acceptswaprequest-2"><code class="tsd-tag">Static</code><span>accept<wbr/>Swap<wbr/>Request</span><a href="#acceptswaprequest-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="acceptswaprequest-3"><span class="tsd-kind-call-signature">acceptSwapRequest</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/KeetaNetSDK.Referenced.AcceptSwapRequest.html" class="tsd-signature-type tsd-kind-interface">AcceptSwapRequest</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">builderOrUserClient</span><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <a href="" class="tsd-signature-type tsd-kind-class">UserClient</a><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">network</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"main"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"staging"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"test"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"dev"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">signer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.Account.html" class="tsd-signature-type tsd-kind-class">Account</a><span class="tsd-signature-symbol"><</span><a href="../types/KeetaNetSDK.Referenced.KeyPairKeyAlgorithm.html" class="tsd-signature-type tsd-kind-type-alias">KeyPairKeyAlgorithm</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="KeetaNetSDK.Referenced.Block.html" class="tsd-signature-type tsd-kind-class">Block</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#acceptswaprequest-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Finalize a swap request</p>
|
|
299
299
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">request</span>: <a href="../interfaces/KeetaNetSDK.Referenced.AcceptSwapRequest.html" class="tsd-signature-type tsd-kind-interface">AcceptSwapRequest</a></span><div class="tsd-comment tsd-typography"><p><a href="../interfaces/KeetaNetSDK.Referenced.AcceptSwapRequest.html" class="tsd-kind-interface">AcceptSwapRequest</a> initial swap request block and optional expected token and amounts</p>
|
|
300
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">builderOrUserClient</span>: <br/> <span class="tsd-signature-symbol">|</span> <a href="" class="tsd-signature-type tsd-kind-class">UserClient</a><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">network</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"main"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"staging"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"test"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"dev"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">signer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.Account.html" class="tsd-signature-type tsd-kind-class">Account</a><span class="tsd-signature-symbol"><</span><a href="../
|
|
300
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">builderOrUserClient</span>: <br/> <span class="tsd-signature-symbol">|</span> <a href="" class="tsd-signature-type tsd-kind-class">UserClient</a><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">network</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"main"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"staging"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"test"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"dev"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">signer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.Account.html" class="tsd-signature-type tsd-kind-class">Account</a><span class="tsd-signature-symbol"><</span><a href="../types/KeetaNetSDK.Referenced.KeyPairKeyAlgorithm.html" class="tsd-signature-type tsd-kind-type-alias">KeyPairKeyAlgorithm</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>User Client Options or optional builder to add the new block too</p>
|
|
301
301
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="KeetaNetSDK.Referenced.Block.html" class="tsd-signature-type tsd-kind-class">Block</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>Swap Blocks</p>
|
|
302
302
|
<div class="tsd-comment tsd-typography"></div></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="acceptswaprequest-4"><span class="tsd-kind-call-signature">acceptSwapRequest</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/KeetaNetSDK.Referenced.AcceptSwapRequest.html" class="tsd-signature-type tsd-kind-interface">AcceptSwapRequest</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">builderOrUserClient</span><span class="tsd-signature-symbol">:</span> <a href="KeetaNetSDK.Referenced.UserClientBuilder.html" class="tsd-signature-type tsd-kind-class">UserClientBuilder</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="KeetaNetSDK.Referenced.Block.html" class="tsd-signature-type tsd-kind-class">Block</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#acceptswaprequest-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Finalize a swap request</p>
|
|
303
303
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">request</span>: <a href="../interfaces/KeetaNetSDK.Referenced.AcceptSwapRequest.html" class="tsd-signature-type tsd-kind-interface">AcceptSwapRequest</a></span><div class="tsd-comment tsd-typography"><p><a href="../interfaces/KeetaNetSDK.Referenced.AcceptSwapRequest.html" class="tsd-kind-interface">AcceptSwapRequest</a> initial swap request block and optional expected token and amounts</p>
|
|
@@ -316,14 +316,14 @@ a given account.</p>
|
|
|
316
316
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">voteStaples</span>: <a href="KeetaNetSDK.Referenced.VoteStaple.html" class="tsd-signature-type tsd-kind-class">VoteStaple</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The list of vote staples to filter</p>
|
|
317
317
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">account</span>: <a href="../types/KeetaNetSDK.Referenced.GenericAccount.html" class="tsd-signature-type tsd-kind-type-alias">GenericAccount</a></span><div class="tsd-comment tsd-typography"><p>The account to search for operations related to</p>
|
|
318
318
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">stapleHash</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">block</span><span class="tsd-signature-symbol">:</span> <a href="KeetaNetSDK.Referenced.Block.html" class="tsd-signature-type tsd-kind-class">Block</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">filteredOperations</span><span class="tsd-signature-symbol">:</span> <a href="../types/KeetaNetSDK.Referenced.BlockOperations.html" class="tsd-signature-type tsd-kind-type-alias">BlockOperations</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></h4><p>An array of filtered operations for the given account, ordered by vote staple hash, then by block, and then containing each operation</p>
|
|
319
|
-
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fromnetwork"><code class="tsd-tag">Static</code><span>from<wbr/>Network</span><a href="#fromnetwork" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="fromnetwork-1"><span class="tsd-kind-call-signature">fromNetwork</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">network</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"main"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"staging"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"test"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"dev"</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.Account.html" class="tsd-signature-type tsd-kind-class">Account</a><span class="tsd-signature-symbol"><</span><a href="../
|
|
319
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fromnetwork"><code class="tsd-tag">Static</code><span>from<wbr/>Network</span><a href="#fromnetwork" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="fromnetwork-1"><span class="tsd-kind-call-signature">fromNetwork</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">network</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"main"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"staging"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"test"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"dev"</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.Account.html" class="tsd-signature-type tsd-kind-class">Account</a><span class="tsd-signature-symbol"><</span><a href="../types/KeetaNetSDK.Referenced.KeyPairKeyAlgorithm.html" class="tsd-signature-type tsd-kind-type-alias">KeyPairKeyAlgorithm</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">UserClient</a><a href="#fromnetwork-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Construct a new instance of the <a href="#" class="tsd-kind-class">UserClient</a> class from the given
|
|
320
320
|
network name. This will use the default representatives for the
|
|
321
321
|
network based on the configuration.</p>
|
|
322
322
|
<p>New instances should be cleaned up with the <a href="#destroy" class="tsd-kind-method">destroy</a>() method
|
|
323
323
|
when they are no longer needed.</p>
|
|
324
324
|
<p>This is the recommended way to create a new instance of the <a href="#" class="tsd-kind-class">UserClient</a> class.</p>
|
|
325
325
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">network</span>: <span class="tsd-signature-type">"main"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"staging"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"test"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"dev"</span></span><div class="tsd-comment tsd-typography"><p>The network to use for this instance of the <a href="#" class="tsd-kind-class">UserClient</a> class</p>
|
|
326
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">signer</span>: <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.Account.html" class="tsd-signature-type tsd-kind-class">Account</a><span class="tsd-signature-symbol"><</span><a href="../
|
|
326
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">signer</span>: <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.Account.html" class="tsd-signature-type tsd-kind-class">Account</a><span class="tsd-signature-symbol"><</span><a href="../types/KeetaNetSDK.Referenced.KeyPairKeyAlgorithm.html" class="tsd-signature-type tsd-kind-type-alias">KeyPairKeyAlgorithm</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The account to use for this instance of the <a href="#" class="tsd-kind-class">UserClient</a> class, or null if this is a read-only client</p>
|
|
327
327
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a></span><div class="tsd-comment tsd-typography"><p>The options to use for this instance of the <a href="#" class="tsd-kind-class">UserClient</a> class</p>
|
|
328
328
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5 id="account"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">account</span><span class="tsd-signature-symbol">?: </span><a href="../types/KeetaNetSDK.Referenced.GenericAccount.html" class="tsd-signature-type tsd-kind-type-alias">GenericAccount</a></h5><div class="tsd-comment tsd-typography"><p>The account to use for the user client, if this is not supplied then
|
|
329
329
|
the <code>signer</code> will be used (if available) otherwise this there will
|
|
@@ -339,14 +339,14 @@ far away from representatives because they only need to wait for
|
|
|
339
339
|
a single response instead of multiple round-trips.</p>
|
|
340
340
|
<p>The default is false.</p>
|
|
341
341
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">UserClient</a></h4><p>A new instance of the <a href="#" class="tsd-kind-class">UserClient</a> class</p>
|
|
342
|
-
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fromsimplesinglerep"><code class="tsd-tag">Static</code><span>from<wbr/>Simple<wbr/>Single<wbr/>Rep</span><a href="#fromsimplesinglerep" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="fromsimplesinglerep-1"><span class="tsd-kind-call-signature">fromSimpleSingleRep</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">hostname</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">ssl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">repKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.Account.html" class="tsd-signature-type tsd-kind-class">Account</a><span class="tsd-signature-symbol"><</span><a href="../
|
|
342
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fromsimplesinglerep"><code class="tsd-tag">Static</code><span>from<wbr/>Simple<wbr/>Single<wbr/>Rep</span><a href="#fromsimplesinglerep" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="fromsimplesinglerep-1"><span class="tsd-kind-call-signature">fromSimpleSingleRep</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">hostname</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">ssl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">repKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.Account.html" class="tsd-signature-type tsd-kind-class">Account</a><span class="tsd-signature-symbol"><</span><a href="../types/KeetaNetSDK.Referenced.KeyPairKeyAlgorithm.html" class="tsd-signature-type tsd-kind-type-alias">KeyPairKeyAlgorithm</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">networkID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">networkAlias</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"main"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"staging"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"test"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"dev"</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">signer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.Account.html" class="tsd-signature-type tsd-kind-class">Account</a><span class="tsd-signature-symbol"><</span><a href="../types/KeetaNetSDK.Referenced.KeyPairKeyAlgorithm.html" class="tsd-signature-type tsd-kind-type-alias">KeyPairKeyAlgorithm</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">UserClient</a><a href="#fromsimplesinglerep-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create an instance of the UserClient class from a specific
|
|
343
343
|
representative. This will use the given representative to
|
|
344
344
|
initialize the connection to the network, however it will
|
|
345
345
|
find other representatives to use for the network as well.</p>
|
|
346
346
|
<p>This is useful for testing and development purposes, but in
|
|
347
347
|
general it is recommended to use the <a href="#fromnetwork" class="tsd-kind-method">fromNetwork</a>
|
|
348
348
|
method to create a new instance of the UserClient class.</p>
|
|
349
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">hostname</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">ssl</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">repKey</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.Account.html" class="tsd-signature-type tsd-kind-class">Account</a><span class="tsd-signature-symbol"><</span><a href="../
|
|
349
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">hostname</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">ssl</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">repKey</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.Account.html" class="tsd-signature-type tsd-kind-class">Account</a><span class="tsd-signature-symbol"><</span><a href="../types/KeetaNetSDK.Referenced.KeyPairKeyAlgorithm.html" class="tsd-signature-type tsd-kind-type-alias">KeyPairKeyAlgorithm</a><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">networkID</span>: <span class="tsd-signature-type">bigint</span></span></li><li><span><span class="tsd-kind-parameter">networkAlias</span>: <span class="tsd-signature-type">"main"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"staging"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"test"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"dev"</span></span></li><li><span><span class="tsd-kind-parameter">signer</span>: <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.Account.html" class="tsd-signature-type tsd-kind-class">Account</a><span class="tsd-signature-symbol"><</span><a href="../types/KeetaNetSDK.Referenced.KeyPairKeyAlgorithm.html" class="tsd-signature-type tsd-kind-type-alias">KeyPairKeyAlgorithm</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">UserClient</a></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getconfigfromnetwork"><code class="tsd-tag">Static</code><span>get<wbr/>Config<wbr/>From<wbr/>Network</span><a href="#getconfigfromnetwork" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getconfigfromnetwork-1"><span class="tsd-kind-call-signature">getConfigFromNetwork</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">network</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"main"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"staging"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"test"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"dev"</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/KeetaNetSDK.Referenced.UserClientOptions.html" class="tsd-signature-type tsd-kind-interface">UserClientOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/KeetaNetSDK.Referenced.UserClientConfig.html" class="tsd-signature-type tsd-kind-interface">UserClientConfig</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">"signer"</span><span class="tsd-signature-symbol">></span><a href="#getconfigfromnetwork-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>A helper method to get the configuration from the network alias
|
|
350
350
|
and options. This will use the default representatives for the
|
|
351
351
|
network based on the <a href="../modules/KeetaNetSDK.Referenced.src_config.html" class="tsd-kind-namespace">configuration</a>.</p>
|
|
352
352
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">network</span>: <span class="tsd-signature-type">"main"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"staging"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"test"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"dev"</span></span><div class="tsd-comment tsd-typography"><p>The <a href="../types/KeetaNetSDK.Referenced.src_config.Networks.html" class="tsd-kind-type-alias">network</a> to use to generate the configuration</p>
|
|
@@ -79,7 +79,7 @@ which is a special kind of account derived from the network identifier. The
|
|
|
79
79
|
purpose of the network address is to define permissions which apply to the
|
|
80
80
|
network as a whole, such as the permission to create tokens, or create storage
|
|
81
81
|
accounts.</p>
|
|
82
|
-
<h3 id="tokens" class="tsd-anchor-link">Tokens<a href="#tokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3><p><a href="../
|
|
82
|
+
<h3 id="tokens" class="tsd-anchor-link">Tokens<a href="#tokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3><p><a href="../enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html#token" class="tsd-kind-enum-member">Tokens</a> in KeetaNet are a
|
|
83
83
|
special kind of account which is used to represent a fungible asset. Tokens can be
|
|
84
84
|
created using the <a href="../classes/KeetaNetSDK.Referenced.BlockOperationCREATE_IDENTIFIER.html" class="tsd-kind-class">Create Identifier</a>
|
|
85
85
|
method though the <a href="../classes/KeetaNetSDK.Referenced.UserClientBuilder.html#generateidentifier" class="tsd-kind-method">UserClientBuilder.generateIdentifier</a>
|