@keetanetwork/keetanet-client 0.10.2 → 0.10.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -0
- package/api/node.d.ts +2 -0
- package/client/builder.d.ts +42 -2
- package/client/client_common_tests.d.ts +6 -5
- package/client/index-browser.d.ts +908 -27
- package/client/index-browser.js +3075 -1723
- package/client/index.d.ts +908 -27
- package/client/index.js +85673 -83037
- package/config/index.d.ts +16 -0
- package/docs/assets/fonts/Surt-Expanded-Bold.woff2 +0 -0
- package/docs/assets/fonts/Surt-Expanded-Medium.woff2 +0 -0
- package/docs/assets/fonts/Surt-Expanded-Regular.woff2 +0 -0
- package/docs/assets/fonts/Surt-Expanded-Semibold.woff2 +0 -0
- package/docs/assets/fonts/Surt-Normal-Bold.woff2 +0 -0
- package/docs/assets/fonts/Surt-Normal-Medium.woff2 +0 -0
- package/docs/assets/fonts/Surt-Normal-Regular.woff2 +0 -0
- package/docs/assets/fonts/Surt-Normal-Semibold.woff2 +0 -0
- package/docs/assets/fonts/UbuntuMono-Regular.ttf +0 -0
- package/docs/assets/hierarchy.js +1 -0
- package/docs/assets/highlight.css +134 -0
- package/docs/assets/icons.js +18 -0
- package/docs/assets/icons.svg +1 -0
- package/docs/assets/logo-keeta-dark.svg +14 -0
- package/docs/assets/logo-keeta-light.svg +14 -0
- package/docs/assets/main.js +60 -0
- package/docs/assets/navigation.js +1 -0
- package/docs/assets/search.js +1 -0
- package/docs/assets/style.css +1640 -0
- package/docs/assets/typedoc-github-style.css +557 -0
- package/docs/classes/KeetaNetSDK.Client.html +288 -0
- package/docs/classes/KeetaNetSDK.Referenced.Account.html +107 -0
- package/docs/classes/KeetaNetSDK.Referenced.BaseSet.html +13 -0
- package/docs/classes/KeetaNetSDK.Referenced.Block.html +36 -0
- package/docs/classes/KeetaNetSDK.Referenced.BlockBuilder.html +26 -0
- package/docs/classes/KeetaNetSDK.Referenced.BlockHash.html +18 -0
- package/docs/classes/KeetaNetSDK.Referenced.BlockOperation.html +6 -0
- package/docs/classes/KeetaNetSDK.Referenced.BlockOperationCREATE_IDENTIFIER.html +10 -0
- package/docs/classes/KeetaNetSDK.Referenced.BlockOperationMODIFY_PERMISSIONS.html +13 -0
- package/docs/classes/KeetaNetSDK.Referenced.BlockOperationRECEIVE.html +13 -0
- package/docs/classes/KeetaNetSDK.Referenced.BlockOperationSEND.html +12 -0
- package/docs/classes/KeetaNetSDK.Referenced.BlockOperationSET_INFO.html +13 -0
- package/docs/classes/KeetaNetSDK.Referenced.BlockOperationSET_REP.html +10 -0
- package/docs/classes/KeetaNetSDK.Referenced.BlockOperationTOKEN_ADMIN_MODIFY_BALANCE.html +11 -0
- package/docs/classes/KeetaNetSDK.Referenced.BlockOperationTOKEN_ADMIN_SUPPLY.html +11 -0
- package/docs/classes/KeetaNetSDK.Referenced.ECDSAKeyPair.html +30 -0
- package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256K1KeyPair.html +33 -0
- package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256K1PrivateKey.html +12 -0
- package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256K1PublicKey.html +13 -0
- package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256K1Signature.html +12 -0
- package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256R1KeyPair.html +34 -0
- package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256R1PrivateKey.html +12 -0
- package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256R1PublicKey.html +13 -0
- package/docs/classes/KeetaNetSDK.Referenced.ECDSASECP256R1Signature.html +12 -0
- package/docs/classes/KeetaNetSDK.Referenced.ED25519KeyPair.html +28 -0
- package/docs/classes/KeetaNetSDK.Referenced.ED25519PrivateKey.html +12 -0
- package/docs/classes/KeetaNetSDK.Referenced.ED25519PublicKey.html +13 -0
- package/docs/classes/KeetaNetSDK.Referenced.ED25519Signature.html +12 -0
- package/docs/classes/KeetaNetSDK.Referenced.ExternalKeyPair.html +28 -0
- package/docs/classes/KeetaNetSDK.Referenced.ExternalSet.html +16 -0
- package/docs/classes/KeetaNetSDK.Referenced.IdentifierKey.html +13 -0
- package/docs/classes/KeetaNetSDK.Referenced.IdentifierKeyPair.html +28 -0
- package/docs/classes/KeetaNetSDK.Referenced.KeetaNetError.html +5 -0
- package/docs/classes/KeetaNetSDK.Referenced.KeyInterface.html +26 -0
- package/docs/classes/KeetaNetSDK.Referenced.KeyStorage.html +12 -0
- package/docs/classes/KeetaNetSDK.Referenced.Ledger.html +41 -0
- package/docs/classes/KeetaNetSDK.Referenced.LedgerAtomicInterface.html +27 -0
- package/docs/classes/KeetaNetSDK.Referenced.LedgerRequestCache.html +7 -0
- package/docs/classes/KeetaNetSDK.Referenced.Node.html +21 -0
- package/docs/classes/KeetaNetSDK.Referenced.P2PSwitch.html +40 -0
- package/docs/classes/KeetaNetSDK.Referenced.PendingAccount.html +5 -0
- package/docs/classes/KeetaNetSDK.Referenced.PermissionSetHolder.html +6 -0
- package/docs/classes/KeetaNetSDK.Referenced.Permissions.html +20 -0
- package/docs/classes/KeetaNetSDK.Referenced.PossiblyExpiredVote.html +26 -0
- package/docs/classes/KeetaNetSDK.Referenced.PublicKeyString.html +8 -0
- package/docs/classes/KeetaNetSDK.Referenced.RequestTiming.html +8 -0
- package/docs/classes/KeetaNetSDK.Referenced.SignatureStorage.html +12 -0
- package/docs/classes/KeetaNetSDK.Referenced.Stats.html +13 -0
- package/docs/classes/KeetaNetSDK.Referenced.UserClientBuilder.html +29 -0
- package/docs/classes/KeetaNetSDK.Referenced.Vote.html +31 -0
- package/docs/classes/KeetaNetSDK.Referenced.VoteBlockHash.html +20 -0
- package/docs/classes/KeetaNetSDK.Referenced.VoteBlockHashMap.html +26 -0
- package/docs/classes/KeetaNetSDK.Referenced.VoteBuilder.html +8 -0
- package/docs/classes/KeetaNetSDK.Referenced.VoteHash.html +11 -0
- package/docs/classes/KeetaNetSDK.Referenced.VoteStaple.html +40 -0
- package/docs/classes/KeetaNetSDK.Referenced.VoteStapleHash.html +14 -0
- package/docs/classes/KeetaNetSDK.Referenced.default.html +9 -0
- package/docs/classes/KeetaNetSDK.Referenced.src_lib_utils_asn1.BufferStorageASN1.html +9 -0
- package/docs/classes/KeetaNetSDK.Referenced.src_lib_utils_asn1.ValidateASN1.html +19 -0
- package/docs/classes/KeetaNetSDK.Referenced.src_lib_utils_buffer.BufferStorage.html +11 -0
- package/docs/classes/KeetaNetSDK.Referenced.src_lib_utils_certificate.Certificate.html +79 -0
- package/docs/classes/KeetaNetSDK.Referenced.src_lib_utils_certificate.CertificateBuilder.html +9 -0
- package/docs/classes/KeetaNetSDK.UserClient.html +254 -0
- package/docs/documents/GETTING-STARTED.html +268 -0
- package/docs/enums/KeetaNetSDK.Referenced.AccountKeyAlgorithm.html +9 -0
- package/docs/enums/KeetaNetSDK.Referenced.AdjustMethod.html +4 -0
- package/docs/enums/KeetaNetSDK.Referenced.BaseFlag.html +15 -0
- package/docs/enums/KeetaNetSDK.Referenced.BasePermissionGroup.html +9 -0
- package/docs/enums/KeetaNetSDK.Referenced.LedgerKind.html +4 -0
- package/docs/enums/KeetaNetSDK.Referenced.NodeKind.html +5 -0
- package/docs/enums/KeetaNetSDK.Referenced.OperationType.html +10 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_config.getDefaultConfig.html +2 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_config.getNetworkAlias.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_config.getValidation.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_config.isNetwork.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_asn1.isValidSequenceSchema.html +2 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_bloom.deserializeBloomFilter.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_bloom.serializeBloomFilter.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_buffer.DecodeBase32.html +2 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_buffer.DecodeBase64.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_buffer.EncodeBase32.html +2 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_buffer.EncodeBase64.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_buffer.ZlibDeflate.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_buffer.ZlibInflate.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_conversion.RegisterSerializable.html +2 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_conversion.objectToBuffer.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_conversion.parseHexBigIntString.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_conversion.toJSONSerializable.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_hash.Hash.html +4 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_helper.arrayRepeat.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_helper.asleep.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_helper.bufferToArrayBuffer.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_helper.checkableGenerator.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_helper.debugPrintableObject.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_helper.env.html +3 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_helper.internalLogger.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_helper.isBuffer.html +6 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_helper.isIntegerOrBigInt.html +2 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_helper.objectToBuffer.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_helper.promiseGenerator.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_helper.randomInt.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_helper.randomString.html +2 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_helper.setGenerator.html +1 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_helper.waitTicks.html +2 -0
- package/docs/functions/KeetaNetSDK.Referenced.src_lib_utils_initial.generateInitialVoteStaple.html +1 -0
- package/docs/hierarchy.html +1 -0
- package/docs/index.html +4 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.ACLEntry.html +10 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.ACLRow.html +10 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.ACLUpdate.html +12 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.APIOptions.html +10 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.ASN1ExplicitContextTag.html +5 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.ASN1ImplicitContextTag.html +5 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.ASN1Object.html +2 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.AccountInfo.html +12 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.AccountSignerOptions.html +3 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.AccountSignerOptionsJSON.html +3 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.AllPendingJSON.html +5 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.BaseExternalKeyPairFunctions.html +6 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.BaseFlagRule.html +5 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.BaseGenerationConfig.html +4 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockCanonical.html +10 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSON.html +11 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperation.html +2 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationCREATE_IDENTIFIER.html +4 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationMODIFY_PERMISSIONS.html +7 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationRECEIVE.html +7 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationSEND.html +6 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationSET_INFO.html +7 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationSET_REP.html +4 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationTOKEN_ADMIN_MODIFY_BALANCE.html +5 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOperationTOKEN_ADMIN_SUPPLY.html +5 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockJSONOutput.html +5 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockOperationValidateContext.html +3 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.BlockUnsignedCanonical.html +11 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.ComputeBlocksResponse.html +3 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.ComputedBlockEffect.html +4 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.ComputedBlocksEffectFields.html +8 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.ComputedBlocksEffectTokenChangesField.html +1 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.Constructor.html +2 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.ExternalKeyPairFunctionsNoEncryption.html +6 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.ExternalKeyPairFunctionsSupportsEncryption.html +8 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.GetPeersAPIResponse.html +9 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.GetPeersOptions.html +11 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.GetRepresentativeAPIResponse.html +5 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.HTTPConfig.html +2 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.IdentifierCreateRequest.html +3 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.InitialConfigSupply.html +5 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.KVSetOptionsType.html +3 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.KVStorageProviderAPI.html +8 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.LedgerConfig.html +21 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.LedgerStatistics.html +8 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.LedgerStorageAPI.html +69 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.ModifyTokenBalanceEntry.html +6 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.NodeConfig.html +32 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.NumericValueEntry.html +2 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.P2PConfig.html +24 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.P2PConnection.html +27 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.P2PPeerBase.html +4 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.P2PPeerListener.html +5 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.P2PPeerRepBase.html +7 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.P2PSwitchStatistics.html +7 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.PeerInfo.html +10 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.PendingOperations.html +9 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.PendingOperationsJSON.html +9 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.PrincipalACLWithInfoParsed.html +24 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.PublicKeyStorage.html +11 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.PublicKeyStringMapping.html +7 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.RenderOptions.html +3 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.RepresentativeInfo.html +5 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.RequestTokenReceiveEntry.html +5 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.StatsConfig.html +2 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.TextValidationRule.html +4 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.TokenNumericEntry.html +4 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.UserClientConfig.html +26 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.UserClientListenerTypes.html +2 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.UserClientOptions.html +16 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.ValidationOptions.html +3 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.VoteJSON.html +8 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.VoteJSONOutput.html +4 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.VoteStapleJSON.html +3 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.WithConversionClass.html +6 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.WithIsInstance.html +3 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.signOptionsType.html +9 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.src_config.ValidationConfig.html +4 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1BitString.html +4 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1Date.html +4 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1OID.html +3 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1Set.html +4 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1String.html +4 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_helper.InstanceSet.html +10 -0
- package/docs/interfaces/KeetaNetSDK.Referenced.src_lib_utils_helper.InstanceSetConstructor.html +2 -0
- package/docs/media/index-1.js +517 -0
- package/docs/media/index.js +82 -0
- package/docs/modules/KeetaNetSDK.Referenced.html +1 -0
- package/docs/modules/KeetaNetSDK.Referenced.src_config.html +1 -0
- package/docs/modules/KeetaNetSDK.Referenced.src_lib_utils_asn1.ValidateASN1.html +1 -0
- package/docs/modules/KeetaNetSDK.Referenced.src_lib_utils_asn1.html +1 -0
- package/docs/modules/KeetaNetSDK.Referenced.src_lib_utils_bloom.html +1 -0
- package/docs/modules/KeetaNetSDK.Referenced.src_lib_utils_buffer.html +1 -0
- package/docs/modules/KeetaNetSDK.Referenced.src_lib_utils_certificate.html +1 -0
- package/docs/modules/KeetaNetSDK.Referenced.src_lib_utils_conversion.html +1 -0
- package/docs/modules/KeetaNetSDK.Referenced.src_lib_utils_hash.html +1 -0
- package/docs/modules/KeetaNetSDK.Referenced.src_lib_utils_helper.html +1 -0
- package/docs/modules/KeetaNetSDK.Referenced.src_lib_utils_initial.html +1 -0
- package/docs/modules/KeetaNetSDK.html +8 -0
- package/docs/modules.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.ACLEntryUnparsed.html +5 -0
- package/docs/types/KeetaNetSDK.Referenced.ASN1AnyASN.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.AcceptedPermissionTypes.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.AccountBalancesUnparsed.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.AccountErrorCode.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.AccountInfoResponse.html +6 -0
- package/docs/types/KeetaNetSDK.Referenced.AccountOrPending.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.AccountPrefix.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.AccountPublicKeyString.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.AllPending.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.BaseFlagName.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.BaseFlagNames.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.BasePermissionOffsetSet.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.BasicSchemaMap.html +14 -0
- package/docs/types/KeetaNetSDK.Referenced.BlockErrorCode.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.BlockJSONIncomplete.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.BlockOperations.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.BlocksAlwaysReturn.html +4 -0
- package/docs/types/KeetaNetSDK.Referenced.BlocksWithAddSupply.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.BuilderOptions.html +2 -0
- package/docs/types/KeetaNetSDK.Referenced.CanBeArray.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.CertificateBuilderParams.html +23 -0
- package/docs/types/KeetaNetSDK.Referenced.CertificateExtensions.html +5 -0
- package/docs/types/KeetaNetSDK.Referenced.CertificateIssuerOrSubject.html +4 -0
- package/docs/types/KeetaNetSDK.Referenced.CertificateOID.html +3 -0
- package/docs/types/KeetaNetSDK.Referenced.CertificateOptions.html +15 -0
- package/docs/types/KeetaNetSDK.Referenced.CertificatePublicKeyInfo.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.CertificateSchema.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.CertificateValidity.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.CertificateVersionInfo.html +5 -0
- package/docs/types/KeetaNetSDK.Referenced.ClientErrorCode.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.ClientRepresentative.html +3 -0
- package/docs/types/KeetaNetSDK.Referenced.ComputedEffectOfBlocks.html +4 -0
- package/docs/types/KeetaNetSDK.Referenced.ComputedEffectOfBlocksByAccount.html +2 -0
- package/docs/types/KeetaNetSDK.Referenced.CreateIdentifierRequest.html +6 -0
- package/docs/types/KeetaNetSDK.Referenced.DecodeFunc.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.DelegationUpdate.html +2 -0
- package/docs/types/KeetaNetSDK.Referenced.DeserializerCallback.html +2 -0
- package/docs/types/KeetaNetSDK.Referenced.DurationBreakdowns.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.ED25519PublicKeyString.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.EncodeFunc.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.ErrorCode.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.ExternalFlagName.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.ExternalKeyPairFunctions.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.ExternalPermissionOffsetSet.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.FlagGroupType.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.FlagOrExternalName.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.FlagOrExternalNames.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.GenericAccount.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.GetAccountStateAPIResponse.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.GetAccountStateAPIResponseFailure.html +3 -0
- package/docs/types/KeetaNetSDK.Referenced.GetAccountStateAPIResponseFormatted.html +28 -0
- package/docs/types/KeetaNetSDK.Referenced.GetAccountStateAPIResponseSuccess.html +6 -0
- package/docs/types/KeetaNetSDK.Referenced.GetAllBalancesResponse.html +6 -0
- package/docs/types/KeetaNetSDK.Referenced.GetPrevFunction.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.GetVotesAfterOptions.html +8 -0
- package/docs/types/KeetaNetSDK.Referenced.IdentifierAddress.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.IdentifierKeyAlgorithm.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.IdentifierPublicKeyString.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.InitialGenResponse.html +3 -0
- package/docs/types/KeetaNetSDK.Referenced.JSONMessage.html +7 -0
- package/docs/types/KeetaNetSDK.Referenced.JSONSupportedObject.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.JSONSupportedValue.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.JSONUnsupportedTypes.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.KVErrorCode.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.KeyPairTypes.html +2 -0
- package/docs/types/KeetaNetSDK.Referenced.LedgerErrorCode.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.LedgerSelector.html +2 -0
- package/docs/types/KeetaNetSDK.Referenced.LedgerStorage.html +2 -0
- package/docs/types/KeetaNetSDK.Referenced.Mutable.html +4 -0
- package/docs/types/KeetaNetSDK.Referenced.NetworkAddress.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.NetworkPublicKeyString.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.NodeLike.html +2 -0
- package/docs/types/KeetaNetSDK.Referenced.P2PPeer.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.P2PPeerRep.html +4 -0
- package/docs/types/KeetaNetSDK.Referenced.PaginatedVotes.html +4 -0
- package/docs/types/KeetaNetSDK.Referenced.PerAccount.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.PermissionOffsetSet.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.PermissionsErrorCode.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.PublicKeyStringPrefixed.html +4 -0
- package/docs/types/KeetaNetSDK.Referenced.Secp256K1PublicKeyString.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.Secp256R1PublicKeyString.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.SerializedConnection.html +3 -0
- package/docs/types/KeetaNetSDK.Referenced.StoragePublicKeyString.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.TimeStat.html +3 -0
- package/docs/types/KeetaNetSDK.Referenced.TimeStats.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.TokenAddress.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.TokenEntry.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.TokenOrPending.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.TokenPublicKeyString.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.UserClientIntervals.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.UserClientListeners.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.UserClientOptionsReadOnly.html +2 -0
- package/docs/types/KeetaNetSDK.Referenced.UserClientOrClientAndNetwork.html +5 -0
- package/docs/types/KeetaNetSDK.Referenced.Vote.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.VoteErrorCode.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.VoteJSONOutput.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.VoteOptions.html +4 -0
- package/docs/types/KeetaNetSDK.Referenced.decryptFunctionType.html +2 -0
- package/docs/types/KeetaNetSDK.Referenced.encryptFunctionType.html +2 -0
- package/docs/types/KeetaNetSDK.Referenced.fromSeedFunctionType.html +2 -0
- package/docs/types/KeetaNetSDK.Referenced.publicKeyASN1.html +3 -0
- package/docs/types/KeetaNetSDK.Referenced.seedDerivationFunction.html +2 -0
- package/docs/types/KeetaNetSDK.Referenced.signFunctionType.html +2 -0
- package/docs/types/KeetaNetSDK.Referenced.src_config.Endpoints.html +6 -0
- package/docs/types/KeetaNetSDK.Referenced.src_config.NetworkConfig.html +11 -0
- package/docs/types/KeetaNetSDK.Referenced.src_config.NetworkOrID.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.src_config.Networks.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.src_config.Representative.html +9 -0
- package/docs/types/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1AnyJS.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1ContextTag.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1SequenceValidation.html +2 -0
- package/docs/types/KeetaNetSDK.Referenced.src_lib_utils_asn1.ValidateASN1.Schema.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.src_lib_utils_asn1.ValidateASN1.SchemaMap.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.src_lib_utils_conversion.JSONSerializable.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.src_lib_utils_conversion.JSONSerializableObject.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.src_lib_utils_conversion.JSONSupported.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.src_lib_utils_conversion.ToJSONSerializable.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.src_lib_utils_conversion.ToJSONSerializableOptions.html +3 -0
- package/docs/types/KeetaNetSDK.Referenced.src_lib_utils_helper.DeepMutable.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.src_lib_utils_helper.DistributiveOmit.html +1 -0
- package/docs/types/KeetaNetSDK.Referenced.verifyFunctionType.html +2 -0
- package/docs/variables/KeetaNetSDK.Referenced.AccountErrorCodes.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.AccountErrorType.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.AccountPrefixes.html +2 -0
- package/docs/variables/KeetaNetSDK.Referenced.BlockErrorCodes.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.BlockErrorType.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.ClientErrorCodes.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.ClientErrorType.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.KVErrorCodes.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.KVErrorType.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.LedgerErrorCodes.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.LedgerErrorType.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.Operation.html +2 -0
- package/docs/variables/KeetaNetSDK.Referenced.PermissionsErrorCodes.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.PermissionsErrorType.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.VoteErrorCodes.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.VoteErrorType.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.default.html +3 -0
- package/docs/variables/KeetaNetSDK.Referenced.durationRanges.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.externalFlagPrefix.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.identifierKeyTypes.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.src_config.NetworkIDs.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.src_config.baseValidationConfig.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.src_config.networksArray.html +2 -0
- package/docs/variables/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1BigIntToBuffer.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1IntegerToBigInt.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.src_lib_utils_asn1.ASN1toJS.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.src_lib_utils_asn1.JStoASN1.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.src_lib_utils_asn1.asn1.html +1 -0
- package/docs/variables/KeetaNetSDK.Referenced.src_lib_utils_hash.HashFunctionLength.html +2 -0
- package/docs/variables/KeetaNetSDK.Referenced.src_lib_utils_hash.HashFunctionName.html +2 -0
- package/docs/variables/KeetaNetSDK.lib.html +4 -0
- package/examples/basic/index.js +82 -0
- package/examples/basic/package-lock.json +126 -0
- package/examples/basic/package.json +14 -0
- package/examples/rwa-nft/index.js +517 -0
- package/examples/rwa-nft/package-lock.json +126 -0
- package/examples/rwa-nft/package.json +14 -0
- package/lib/account.d.ts +2 -2
- package/lib/block/index.d.ts +1 -1
- package/lib/block/operations.d.ts +1 -1
- package/lib/error/account.d.ts +1 -1
- package/lib/error/block.d.ts +1 -1
- package/lib/error/client.d.ts +2 -2
- package/lib/error/index.d.ts +1 -1
- package/lib/error/kv.d.ts +1 -1
- package/lib/error/ledger.d.ts +1 -1
- package/lib/error/permissions.d.ts +1 -1
- package/lib/error/vote.d.ts +1 -1
- package/lib/index.d.ts +6 -2
- package/lib/kv/index.d.ts +2 -3
- package/lib/kv/kv_dynamodb.d.ts +1 -1
- package/lib/kv/kv_memory.d.ts +1 -1
- package/lib/kv/kv_redis.d.ts +1 -5
- package/lib/ledger/common.d.ts +2 -0
- package/lib/ledger/db_dynamodb.d.ts +2 -2
- package/lib/ledger/db_postgres.d.ts +1 -1
- package/lib/ledger/db_spanner.d.ts +5 -4
- package/lib/ledger/db_spanner_helper.d.ts +1 -2
- package/lib/ledger/db_sqlite.d.ts +1 -1
- package/lib/ledger/index.d.ts +6 -5
- package/lib/ledger/types.d.ts +53 -1
- package/lib/p2p.d.ts +1 -1
- package/lib/permissions.d.ts +1 -1
- package/lib/stats.d.ts +1 -1
- package/lib/utils/asn1.d.ts +0 -14
- package/lib/utils/buffer.d.ts +0 -1
- package/lib/utils/certificate.d.ts +2 -2
- package/lib/utils/conversion.d.ts +1 -1
- package/lib/utils/hash.d.ts +0 -1
- package/lib/vote.d.ts +1 -1
- package/package.json +5 -2
- package/version.d.ts +1 -1
- package/._version.d.ts +0 -0
|
@@ -0,0 +1,288 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Client | @keetanetwork/keetanet-client</title><meta name="description" content="Documentation for @keetanetwork/keetanet-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script><link rel="stylesheet" href="../assets/typedoc-github-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title"><img src="../assets/logo-keeta-light.svg" alt="Keeta Logo" class="keeta-logo-light" width="50" height="20"/><img src="../assets/logo-keeta-dark.svg" alt="Keeta Logo" class="keeta-logo-dark" width="50" height="20"/>@keetanetwork/keetanet-client</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M17.9421 17.0578L14.0304 13.1469C15.1642 11.7857 15.7295 10.0398 15.6089 8.27245C15.4882 6.50506 14.6908 4.85223 13.3825 3.65779C12.0743 2.46335 10.3559 1.81926 8.58486 1.85951C6.81382 1.89976 5.12647 2.62125 3.87383 3.87389C2.62118 5.12653 1.89969 6.81388 1.85944 8.58493C1.8192 10.356 2.46328 12.0744 3.65772 13.3826C4.85217 14.6909 6.50499 15.4883 8.27238 15.6089C10.0398 15.7296 11.7856 15.1642 13.1468 14.0305L17.0577 17.9422C17.1158 18.0003 17.1848 18.0463 17.2606 18.0777C17.3365 18.1092 17.4178 18.1253 17.4999 18.1253C17.5821 18.1253 17.6634 18.1092 17.7392 18.0777C17.8151 18.0463 17.8841 18.0003 17.9421 17.9422C18.0002 17.8841 18.0463 17.8152 18.0777 17.7393C18.1091 17.6634 18.1253 17.5821 18.1253 17.5C18.1253 17.4179 18.1091 17.3366 18.0777 17.2607C18.0463 17.1848 18.0002 17.1159 17.9421 17.0578ZM3.12493 8.75C3.12493 7.63748 3.45483 6.54994 4.07292 5.62492C4.691 4.69989 5.56951 3.97892 6.59734 3.55318C7.62517 3.12743 8.75617 3.01604 9.84732 3.23308C10.9385 3.45012 11.9407 3.98585 12.7274 4.77252C13.5141 5.55919 14.0498 6.56147 14.2669 7.65262C14.4839 8.74376 14.3725 9.87476 13.9468 10.9026C13.521 11.9304 12.8 12.8089 11.875 13.427C10.95 14.0451 9.86245 14.375 8.74993 14.375C7.2586 14.3733 5.82882 13.7802 4.77429 12.7256C3.71975 11.6711 3.12659 10.2413 3.12493 8.75Z" fill="var(--color-icon-text)"></path></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><rect x="1" y="3" width="14" height="2" fill="var(--color-icon-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-icon-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-icon-text)"></rect></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/KeetaNetSDK.html">KeetaNetSDK</a></li><li><a href="" aria-current="page">Client</a></li></ul><h1>Class Client</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The Client class provides a low-level interface to the KeetaNet network.
|
|
2
|
+
It handles sending messages to the KeetaNet representatives and parsing
|
|
3
|
+
the responses.</p>
|
|
4
|
+
<p>It does not handle any of the higher-level logic of the KeetaNet network,
|
|
5
|
+
for that there is the <a href="KeetaNetSDK.UserClient.html" class="tsd-kind-class">UserClient</a> class.</p>
|
|
6
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" 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></h4><pre><code class="typescript"><span class="hl-1"> </span><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-5">Client</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">'@keetanetwork/keetanet-client'</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-11">client</span><span class="hl-1"> = </span><span class="hl-5">Client</span><span class="hl-1">.</span><span class="hl-0">fromNetwork</span><span class="hl-1">(</span><span class="hl-2">'test'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-11">blocks</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-0">getChain</span><span class="hl-1">(</span><span class="hl-2">'keeta_...'</span><span class="hl-1">);</span>
|
|
7
|
+
</code><button type="button">Copy</button></pre>
|
|
8
|
+
|
|
9
|
+
</div></div></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><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><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">C</text></svg><span>constructor</span></a>
|
|
10
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#logger" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">P</text></svg><span>logger</span></a>
|
|
11
|
+
<a href="#stats" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">P</text></svg><span>stats</span></a>
|
|
12
|
+
<a href="#builder" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">P</text></svg><span>Builder</span></a>
|
|
13
|
+
<a href="#config" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">P</text></svg><span>Config</span></a>
|
|
14
|
+
<a href="#defaultlogger" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">P</text></svg><span>Default<wbr/>Logger</span></a>
|
|
15
|
+
<a href="#isinstance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">P</text></svg><span>is<wbr/>Instance</span></a>
|
|
16
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="#representatives" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">A</text></svg><span>representatives</span></a>
|
|
17
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#computebuilderblocks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>compute<wbr/>Builder<wbr/>Blocks</span></a>
|
|
18
|
+
<a href="#destroy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>destroy</span></a>
|
|
19
|
+
<a href="#getaccountinfo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Account<wbr/>Info</span></a>
|
|
20
|
+
<a href="#getaccountsinfo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Accounts<wbr/>Info</span></a>
|
|
21
|
+
<a href="#getallbalances" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>All<wbr/>Balances</span></a>
|
|
22
|
+
<a href="#getallrepresentativeinfo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>All<wbr/>Representative<wbr/>Info</span></a>
|
|
23
|
+
<a href="#getbalance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Balance</span></a>
|
|
24
|
+
<a href="#getblock" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Block</span></a>
|
|
25
|
+
<a href="#getchain" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Chain</span></a>
|
|
26
|
+
<a href="#getheadblock" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Head<wbr/>Block</span></a>
|
|
27
|
+
<a href="#gethistory" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>History</span></a>
|
|
28
|
+
<a href="#getledgerchecksum" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Ledger<wbr/>Checksum</span></a>
|
|
29
|
+
<a href="#getnetworkstatus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Network<wbr/>Status</span></a>
|
|
30
|
+
<a href="#getnodestats" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Node<wbr/>Stats</span></a>
|
|
31
|
+
<a href="#getpeers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Peers</span></a>
|
|
32
|
+
<a href="#getpendingblock" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Pending<wbr/>Block</span></a>
|
|
33
|
+
<a href="#getsinglerepresentativeinfo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Single<wbr/>Representative<wbr/>Info</span></a>
|
|
34
|
+
<a href="#gettokensupply" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Token<wbr/>Supply</span></a>
|
|
35
|
+
<a href="#getversion" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Version</span></a>
|
|
36
|
+
<a href="#getvotestaple" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Vote<wbr/>Staple</span></a>
|
|
37
|
+
<a href="#getvotestaplesafter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Vote<wbr/>Staples<wbr/>After</span></a>
|
|
38
|
+
<a href="#listaclsbyentity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>list<wbr/>AC<wbr/>Ls<wbr/>By<wbr/>Entity</span></a>
|
|
39
|
+
<a href="#listaclsbyprincipal" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>list<wbr/>AC<wbr/>Ls<wbr/>By<wbr/>Principal</span></a>
|
|
40
|
+
<a href="#listaclsbyprincipalwithinfo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>list<wbr/>AC<wbr/>Ls<wbr/>By<wbr/>Principal<wbr/>With<wbr/>Info</span></a>
|
|
41
|
+
<a href="#makebuilder" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>make<wbr/>Builder</span></a>
|
|
42
|
+
<a href="#recoveraccount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>recover<wbr/>Account</span></a>
|
|
43
|
+
<a href="#transmit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>transmit</span></a>
|
|
44
|
+
<a href="#transmitstaple" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>transmit<wbr/>Staple</span></a>
|
|
45
|
+
<a href="#updatereps" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>update<wbr/>Reps</span></a>
|
|
46
|
+
<a href="#fromnetwork" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>from<wbr/>Network</span></a>
|
|
47
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><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>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" 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="constructorclient"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">Client</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">reps</span><span class="tsd-signature-symbol">:</span> <a href="../types/KeetaNetSDK.Referenced.ClientRepresentative.html" class="tsd-signature-type tsd-kind-type-alias">ClientRepresentative</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Client</a><a href="#constructorclient" 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 a new instance of the <a href="#" class="tsd-kind-class">Client</a> class from the given set
|
|
48
|
+
of representatives. This is used to create a new instance of the
|
|
49
|
+
<a href="#" class="tsd-kind-class">Client</a> class with a custom set of representatives.</p>
|
|
50
|
+
<p>New instances should be cleaned up with the <a href="#destroy" class="tsd-kind-method">destroy</a>() method
|
|
51
|
+
when they are no longer needed.</p>
|
|
52
|
+
<p>In general this is not needed and the <a href="#fromnetwork" class="tsd-kind-method">Client.fromNetwork</a>()
|
|
53
|
+
method should be used instead.</p>
|
|
54
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">reps</span>: <a href="../types/KeetaNetSDK.Referenced.ClientRepresentative.html" class="tsd-signature-type tsd-kind-type-alias">ClientRepresentative</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The representatives to use for this instance of the <a href="#" class="tsd-kind-class">Client</a> class</p>
|
|
55
|
+
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">weight</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">bigint</span></h5><div class="tsd-comment tsd-typography"><p>The weight of the representative, in terms of voting power</p>
|
|
56
|
+
</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">Client</a></h4><p>A new instance of the <a href="#" class="tsd-kind-class">Client</a> class</p>
|
|
57
|
+
<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-Properties"><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>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="logger"><span>logger</span><a href="#logger" 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><div class="tsd-signature"><span class="tsd-kind-property">logger</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Console</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">"error"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"log"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"warn"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = Client.DefaultLogger</span></div><div class="tsd-comment tsd-typography"><p>The logger to use for this instance of the <a href="#" class="tsd-kind-class">Client</a> class. This
|
|
58
|
+
is defined by the <code>Client.DefaultLogger</code> property, but can be overridden
|
|
59
|
+
by the application.</p>
|
|
60
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="stats"><code class="tsd-tag">Readonly</code><span>stats</span><a href="#stats" 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><div class="tsd-signature"><span class="tsd-kind-property">stats</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">api</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">called</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">failures</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Stats for this instance of the client</p>
|
|
61
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">api</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">called</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">failures</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span></h5><div class="tsd-comment tsd-typography"><p>Breakdown of the API calls made</p>
|
|
62
|
+
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">called</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The total number of times the API was called</p>
|
|
63
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">failures</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The number of times the API failed</p>
|
|
64
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="builder"><code class="tsd-tag">Static</code> <code class="tsd-tag">Readonly</code><span>Builder</span><a href="#builder" 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><div class="tsd-signature"><span class="tsd-kind-property">Builder</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="KeetaNetSDK.Referenced.UserClientBuilder.html" class="tsd-signature-type tsd-kind-class">UserClientBuilder</a><span class="tsd-signature-symbol"> = UserClientBuilder</span></div><div class="tsd-comment tsd-typography"><p>A reference to the <a href="KeetaNetSDK.Referenced.UserClientBuilder.html" class="tsd-kind-class">UserClientBuilder</a> class, which is the high-level
|
|
65
|
+
interface to building blocks.</p>
|
|
66
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="config"><code class="tsd-tag">Static</code> <code class="tsd-tag">Readonly</code><span>Config</span><a href="#config" 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><div class="tsd-signature"><span class="tsd-kind-property">Config</span><span class="tsd-signature-symbol">:</span> <a href="../modules/KeetaNetSDK.Referenced.src_config.html" class="tsd-signature-type tsd-kind-namespace">src/config</a><span class="tsd-signature-symbol"> = Config</span></div><div class="tsd-comment tsd-typography"><p>A reference to the <a href="../modules/KeetaNetSDK.Referenced.src_config.html" class="tsd-kind-namespace">Config</a> class, which provides access to
|
|
67
|
+
the KeetaNet configuration utilities.</p>
|
|
68
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="defaultlogger"><code class="tsd-tag">Static</code><span>Default<wbr/>Logger</span><a href="#defaultlogger" 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><div class="tsd-signature"><span class="tsd-kind-property">DefaultLogger</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Console</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">"error"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"log"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"warn"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = console</span></div><div class="tsd-comment tsd-typography"><p>The default logger to use for new instances of the <a href="#" class="tsd-kind-class">Client</a> class.
|
|
69
|
+
This is set to the <code>console</code> object by default, but can be changed
|
|
70
|
+
by the application.</p>
|
|
71
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="isinstance"><code class="tsd-tag">Static</code><span>is<wbr/>Instance</span><a href="#isinstance" 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><div class="tsd-signature"><span class="tsd-kind-property">isInstance</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">strict</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> <span class="tsd-kind-parameter">obj</span> <span class="tsd-signature-keyword">is</span> <a href="" class="tsd-signature-type tsd-kind-class">Client</a><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Check if the given object is an instance of the <a href="#" class="tsd-kind-class">Client</a> class.
|
|
72
|
+
This is preferred to using the <code>instanceof</code> operator because it will
|
|
73
|
+
work across different contexts.</p>
|
|
74
|
+
</div><div class="tsd-comment tsd-typography"></div></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><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>Accessors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="representatives"><span>representatives</span><a href="#representatives" 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="representativesrepresentatives"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">representatives</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../types/KeetaNetSDK.Referenced.ClientRepresentative.html" class="tsd-signature-type tsd-kind-type-alias">ClientRepresentative</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the list of representatives that the CLIENT is aware of</p>
|
|
75
|
+
</div><h4 class="tsd-returns-title">Returns <a href="../types/KeetaNetSDK.Referenced.ClientRepresentative.html" class="tsd-signature-type tsd-kind-type-alias">ClientRepresentative</a><span class="tsd-signature-symbol">[]</span></h4><p>The list of representatives that the client is aware of</p>
|
|
76
|
+
<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="computebuilderblocks"><span>compute<wbr/>Builder<wbr/>Blocks</span><a href="#computebuilderblocks" 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="computebuilderblocks-1"><span class="tsd-kind-call-signature">computeBuilderBlocks</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">bigint</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">builder</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="../interfaces/KeetaNetSDK.Referenced.ComputeBlocksResponse.html" class="tsd-signature-type tsd-kind-interface">ComputeBlocksResponse</a><span class="tsd-signature-symbol">></span><a href="#computebuilderblocks-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>Compute the blocks for a given builder. This will take the
|
|
77
|
+
pending operations and compute the blocks for them.</p>
|
|
78
|
+
<p>This will additionally mutate the state of the builder to "seal" the
|
|
79
|
+
blocks meaning new operations will be added to new blocks.</p>
|
|
80
|
+
</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">bigint</span></span><div class="tsd-comment tsd-typography"><p>The network to use for the builder</p>
|
|
81
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">builder</span>: <a href="KeetaNetSDK.Referenced.UserClientBuilder.html" class="tsd-signature-type tsd-kind-class">UserClientBuilder</a></span><div class="tsd-comment tsd-typography"><p>The builder to use for the computation</p>
|
|
82
|
+
</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="../interfaces/KeetaNetSDK.Referenced.ComputeBlocksResponse.html" class="tsd-signature-type tsd-kind-interface">ComputeBlocksResponse</a><span class="tsd-signature-symbol">></span></h4><p>The blocks that were computed</p>
|
|
83
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="destroy"><span>destroy</span><a href="#destroy" 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="destroy-1"><span class="tsd-kind-call-signature">destroy</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="#destroy-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>Destroy this instance of the <a href="#" class="tsd-kind-class">Client</a> class. This will clean up
|
|
84
|
+
any resources used by the instance and stop any background tasks.</p>
|
|
85
|
+
</div><h4 class="tsd-returns-title">Returns <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></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getaccountinfo"><span>get<wbr/>Account<wbr/>Info</span><a href="#getaccountinfo" 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="getaccountinfo-1"><span class="tsd-kind-call-signature">getAccountInfo</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">account</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/KeetaNetSDK.Referenced.GenericAccount.html" class="tsd-signature-type tsd-kind-type-alias">GenericAccount</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="#getaccountinfo-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 the account information for a given account. This will return
|
|
86
|
+
the account information including the current head block, representative,
|
|
87
|
+
balances, and metadata.</p>
|
|
88
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">account</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</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 fetch the information for</p>
|
|
89
|
+
</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 account information</p>
|
|
90
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getaccountsinfo"><span>get<wbr/>Accounts<wbr/>Info</span><a href="#getaccountsinfo" 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="getaccountsinfo-1"><span class="tsd-kind-call-signature">getAccountsInfo</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">accounts</span><span class="tsd-signature-symbol">:</span> (<span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/KeetaNetSDK.Referenced.GenericAccount.html" class="tsd-signature-type tsd-kind-type-alias">GenericAccount</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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">account</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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><span class="tsd-signature-symbol">></span><a href="#getaccountsinfo-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 the account information for multiple accounts. This will return
|
|
91
|
+
the account information including the current head block, representative,
|
|
92
|
+
balances, and metadata for each account.</p>
|
|
93
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">accounts</span>: (<span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/KeetaNetSDK.Referenced.GenericAccount.html" class="tsd-signature-type tsd-kind-type-alias">GenericAccount</a>)<span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The accounts to fetch the information for</p>
|
|
94
|
+
</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-signature-symbol">[</span><span class="tsd-kind-index-signature">account</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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><span class="tsd-signature-symbol">></span></h4><p>The account information for each account, as an object
|
|
95
|
+
with the account as the key and the account information as the value</p>
|
|
96
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getallbalances"><span>get<wbr/>All<wbr/>Balances</span><a href="#getallbalances" 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="getallbalances-1"><span class="tsd-kind-call-signature">getAllBalances</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">account</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/KeetaNetSDK.Referenced.GenericAccount.html" class="tsd-signature-type tsd-kind-type-alias">GenericAccount</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.GetAllBalancesResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAllBalancesResponse</a><span class="tsd-signature-symbol">></span><a href="#getallbalances-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 balance of a given account for all tokens.</p>
|
|
97
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">account</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</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 get the balance for</p>
|
|
98
|
+
</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.GetAllBalancesResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAllBalancesResponse</a><span class="tsd-signature-symbol">></span></h4><p>An array of objects which specify the token and the balance
|
|
99
|
+
for each token the user holds a balance for</p>
|
|
100
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getallrepresentativeinfo"><span>get<wbr/>All<wbr/>Representative<wbr/>Info</span><a href="#getallrepresentativeinfo" 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="getallrepresentativeinfo-1"><span class="tsd-kind-call-signature">getAllRepresentativeInfo</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><a href="../interfaces/KeetaNetSDK.Referenced.RepresentativeInfo.html" class="tsd-signature-type tsd-kind-interface">RepresentativeInfo</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#getallrepresentativeinfo-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 a list of all representatives that the node is aware of
|
|
101
|
+
and their weights. This will fetch the information from all
|
|
102
|
+
representatives</p>
|
|
103
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/KeetaNetSDK.Referenced.RepresentativeInfo.html" class="tsd-signature-type tsd-kind-interface">RepresentativeInfo</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>The list of all representatives and their weights</p>
|
|
104
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getbalance"><span>get<wbr/>Balance</span><a href="#getbalance" 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="getbalance-1"><span class="tsd-kind-call-signature">getBalance</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">account</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/KeetaNetSDK.Referenced.GenericAccount.html" class="tsd-signature-type tsd-kind-type-alias">GenericAccount</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">token</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/KeetaNetSDK.Referenced.TokenAddress.html" class="tsd-signature-type tsd-kind-type-alias">TokenAddress</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">bigint</span><span class="tsd-signature-symbol">></span><a href="#getbalance-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 balance of a given account for a given token.</p>
|
|
105
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">account</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</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 get the balance for</p>
|
|
106
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">token</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/KeetaNetSDK.Referenced.TokenAddress.html" class="tsd-signature-type tsd-kind-type-alias">TokenAddress</a></span><div class="tsd-comment tsd-typography"><p>The token to get the balance of for the given account</p>
|
|
107
|
+
</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-type">bigint</span><span class="tsd-signature-symbol">></span></h4><p>The balance of the account for the given token</p>
|
|
108
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getblock"><span>get<wbr/>Block</span><a href="#getblock" 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="getblock-1"><span class="tsd-kind-call-signature">getBlock</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">blockhash</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.BlockHash.html" class="tsd-signature-type tsd-kind-class">BlockHash</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.Block.html" class="tsd-signature-type tsd-kind-class">Block</a><span class="tsd-signature-symbol">></span><a href="#getblock-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 a block from the specified representative by its block hash.</p>
|
|
109
|
+
<p>The default mode of operation will request the block from the main
|
|
110
|
+
ledger of the "best" representative.</p>
|
|
111
|
+
<p>The "side" ledger is a special ledger that is used to hold
|
|
112
|
+
unpublished blocks that the given representative has learned about
|
|
113
|
+
but which have not been published to the network. This is used as
|
|
114
|
+
part of the voting process.</p>
|
|
115
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">blockhash</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.BlockHash.html" class="tsd-signature-type tsd-kind-class">BlockHash</a></span><div class="tsd-comment tsd-typography"><p>The block hash to get the block for</p>
|
|
116
|
+
</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-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></h4><p>The block for the given block hash or null if the block does not exist on the given ledger</p>
|
|
117
|
+
<div class="tsd-comment tsd-typography"></div></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="getblock-2"><span class="tsd-kind-call-signature">getBlock</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">blockhash</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.BlockHash.html" class="tsd-signature-type tsd-kind-class">BlockHash</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">side</span><span class="tsd-signature-symbol">?:</span> <a href="../types/KeetaNetSDK.Referenced.LedgerSelector.html" class="tsd-signature-type tsd-kind-type-alias">LedgerSelector</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">rep</span><span class="tsd-signature-symbol">?:</span> <a href="../types/KeetaNetSDK.Referenced.ClientRepresentative.html" class="tsd-signature-type tsd-kind-type-alias">ClientRepresentative</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ANY"</span><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="#getblock-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">blockhash</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.BlockHash.html" class="tsd-signature-type tsd-kind-class">BlockHash</a></span><div class="tsd-comment tsd-typography"><p>The block hash to get the block for</p>
|
|
118
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">side</span>: <a href="../types/KeetaNetSDK.Referenced.LedgerSelector.html" class="tsd-signature-type tsd-kind-type-alias">LedgerSelector</a></span><div class="tsd-comment tsd-typography"><p>The side of the ledger to get the block from -- this is generally "main", but it is possible to request "side" ledger blocks</p>
|
|
119
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">rep</span>: <a href="../types/KeetaNetSDK.Referenced.ClientRepresentative.html" class="tsd-signature-type tsd-kind-type-alias">ClientRepresentative</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ANY"</span></span><div class="tsd-comment tsd-typography"><p>The representative to get the block from -- this is generally "ANY" in which case the best representative will be used, but it is possible to request a specific representative</p>
|
|
120
|
+
</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-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></h4><p>The block for the given block hash or null if the block does not exist on the given ledger</p>
|
|
121
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getchain"><span>get<wbr/>Chain</span><a href="#getchain" 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="getchain-1"><span class="tsd-kind-call-signature">getChain</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">account</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/KeetaNetSDK.Referenced.GenericAccount.html" class="tsd-signature-type tsd-kind-type-alias">GenericAccount</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">depth</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">startBlock</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.BlockHash.html" class="tsd-signature-type tsd-kind-class">BlockHash</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-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="#getchain-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 chain for a given account. This is the set of blocks that
|
|
122
|
+
the account has created. This will return the blocks in reverse
|
|
123
|
+
order, with the most recent block first.</p>
|
|
124
|
+
<p>This is a paginated request and may return only a partial set of
|
|
125
|
+
blocks for a given request if there are more blocks to be fetched
|
|
126
|
+
from the representative. The <code>startBlock</code> parameter can be used to
|
|
127
|
+
fetch the next set of blocks. Once all blocks have been fetched
|
|
128
|
+
an empty array will be returned.</p>
|
|
129
|
+
<p>The <code>depth</code> parameter can be used to limit the number of blocks
|
|
130
|
+
returned. The default is to leave it up to the representative to
|
|
131
|
+
determine the number of blocks to return. The representative
|
|
132
|
+
may return fewer than the requested number of blocks even if there
|
|
133
|
+
are more blocks available, except that it will always return at
|
|
134
|
+
least 1 block if there are any blocks available.</p>
|
|
135
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">account</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</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 get the chain for</p>
|
|
136
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">depth</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">startBlock</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.BlockHash.html" class="tsd-signature-type tsd-kind-class">BlockHash</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The options to use for the request</p>
|
|
137
|
+
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">depth</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The maximum number of blocks to return -- this is used to limit the number of blocks returned</p>
|
|
138
|
+
</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">startBlock</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.BlockHash.html" class="tsd-signature-type tsd-kind-class">BlockHash</a></h5><div class="tsd-comment tsd-typography"><p>The block hash to start from -- this is used to paginate the request</p>
|
|
139
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></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>The chain of blocks for the given account, in reverse order starting with the most recent block</p>
|
|
140
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getheadblock"><span>get<wbr/>Head<wbr/>Block</span><a href="#getheadblock" 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="getheadblock-1"><span class="tsd-kind-call-signature">getHeadBlock</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">account</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/KeetaNetSDK.Referenced.GenericAccount.html" class="tsd-signature-type tsd-kind-type-alias">GenericAccount</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.Block.html" class="tsd-signature-type tsd-kind-class">Block</a><span class="tsd-signature-symbol">></span><a href="#getheadblock-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 head block for a given account. This will return the
|
|
141
|
+
entire block, or null if the account has not created any blocks.</p>
|
|
142
|
+
<p>An account with no blocks may still have a balance because other users
|
|
143
|
+
may have sent tokens to it.</p>
|
|
144
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">account</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</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 get the head block for</p>
|
|
145
|
+
</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-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></h4><p>The head block for the account or null if the account has
|
|
146
|
+
not created any blocks</p>
|
|
147
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gethistory"><span>get<wbr/>History</span><a href="#gethistory" 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="gethistory-1"><span class="tsd-kind-call-signature">getHistory</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">account</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/KeetaNetSDK.Referenced.GenericAccount.html" class="tsd-signature-type tsd-kind-type-alias">GenericAccount</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">depth</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">startBlocksHash</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.VoteBlockHash.html" class="tsd-signature-type tsd-kind-class">VoteBlockHash</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-type">Promise</span><span class="tsd-signature-symbol"><</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><span class="tsd-signature-symbol">></span><a href="#gethistory-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 history for a given account. This is the set of vote
|
|
148
|
+
staples that have interacted with the account. This is different
|
|
149
|
+
from the chain in that it includes vote staples that have affected
|
|
150
|
+
this account but are not directly created by this account.</p>
|
|
151
|
+
<p>This is a paginated request and may return only a partial set of
|
|
152
|
+
vote staples for a given request if there are more vote staples
|
|
153
|
+
to be fetched from the representative. The <code>startBlocksHash</code>
|
|
154
|
+
parameter can be used to fetch the next set of vote staples.
|
|
155
|
+
It can be computed from the last entry in the previous
|
|
156
|
+
response's <code>blocksHash</code> field. Once all vote staples have been
|
|
157
|
+
fetched an empty array will be returned.</p>
|
|
158
|
+
<p>The <code>depth</code> parameter can be used to limit the number of vote
|
|
159
|
+
staples returned. The default is to leave it up to the
|
|
160
|
+
representative to determine the number of vote staples to return.
|
|
161
|
+
The representative may return fewer than the requested number of
|
|
162
|
+
vote staples even if there are more vote staples available, except
|
|
163
|
+
that it will always return at least 1 vote staple if there are any
|
|
164
|
+
vote staples available.</p>
|
|
165
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">account</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</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 get the history for</p>
|
|
166
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">depth</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">startBlocksHash</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.VoteBlockHash.html" class="tsd-signature-type tsd-kind-class">VoteBlockHash</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>The options to use for the request</p>
|
|
167
|
+
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">depth</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The maximum number of vote staples to return -- this is used to limit the number of vote staples returned</p>
|
|
168
|
+
</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">startBlocksHash</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.VoteBlockHash.html" class="tsd-signature-type tsd-kind-class">VoteBlockHash</a></h5><div class="tsd-comment tsd-typography"><p>The block hash to start from -- this is used to paginate the request</p>
|
|
169
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></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">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><span class="tsd-signature-symbol">></span></h4><p>The history of vote staples for the given account, in reverse order starting with the most recent vote staple</p>
|
|
170
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getledgerchecksum"><span>get<wbr/>Ledger<wbr/>Checksum</span><a href="#getledgerchecksum" 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="getledgerchecksum-1"><span class="tsd-kind-call-signature">getLedgerChecksum</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">rep</span><span class="tsd-signature-symbol">?:</span> <a href="../types/KeetaNetSDK.Referenced.ClientRepresentative.html" class="tsd-signature-type tsd-kind-type-alias">ClientRepresentative</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ANY"</span><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">checksum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">moment</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">momentRange</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><a href="#getledgerchecksum-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>Work in progress</p>
|
|
171
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">rep</span>: <a href="../types/KeetaNetSDK.Referenced.ClientRepresentative.html" class="tsd-signature-type tsd-kind-type-alias">ClientRepresentative</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ANY"</span><span class="tsd-signature-symbol"> = 'ANY'</span></span></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">checksum</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">moment</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">momentRange</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></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="getnetworkstatus"><span>get<wbr/>Network<wbr/>Status</span><a href="#getnetworkstatus" 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="getnetworkstatus-1"><span class="tsd-kind-call-signature">getNetworkStatus</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">timeout</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><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/> (<br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">online</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">rep</span><span class="tsd-signature-symbol">:</span> <a href="../types/KeetaNetSDK.Referenced.ClientRepresentative.html" class="tsd-signature-type tsd-kind-type-alias">ClientRepresentative</a> <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">ledger</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">blockCount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">moment</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-property">momentRange</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">representativeCount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">settlementTimes</span><span class="tsd-signature-symbol">:</span> <a href="../types/KeetaNetSDK.Referenced.TimeStats.html" class="tsd-signature-type tsd-kind-type-alias">TimeStats</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">transactionCount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</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">online</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">rep</span><span class="tsd-signature-symbol">:</span> <a href="../types/KeetaNetSDK.Referenced.ClientRepresentative.html" class="tsd-signature-type tsd-kind-type-alias">ClientRepresentative</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">switch</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">incomingMessages</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">outgoingMessagesPeerFailure</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">outgoingMessagesPeerFailureUngreeted</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">outgoingMessagesPeerFiltered</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">outgoingMessagesPeerSuccess</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</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><br/> )<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span><a href="#getnetworkstatus-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 network status of all representatives</p>
|
|
172
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">timeout</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 5000</span></span><div class="tsd-comment tsd-typography"><p>Maximum time to wait for a response from a representative in milliseconds</p>
|
|
173
|
+
</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/> (<br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">online</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">rep</span><span class="tsd-signature-symbol">:</span> <a href="../types/KeetaNetSDK.Referenced.ClientRepresentative.html" class="tsd-signature-type tsd-kind-type-alias">ClientRepresentative</a> <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">ledger</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">blockCount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">moment</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-property">momentRange</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">representativeCount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">settlementTimes</span><span class="tsd-signature-symbol">:</span> <a href="../types/KeetaNetSDK.Referenced.TimeStats.html" class="tsd-signature-type tsd-kind-type-alias">TimeStats</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">transactionCount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</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">online</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">rep</span><span class="tsd-signature-symbol">:</span> <a href="../types/KeetaNetSDK.Referenced.ClientRepresentative.html" class="tsd-signature-type tsd-kind-type-alias">ClientRepresentative</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">switch</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">incomingMessages</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">outgoingMessagesPeerFailure</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">outgoingMessagesPeerFailureUngreeted</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">outgoingMessagesPeerFiltered</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">outgoingMessagesPeerSuccess</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</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><br/> )<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></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="getnodestats"><span>get<wbr/>Node<wbr/>Stats</span><a href="#getnodestats" 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="getnodestats-1"><span class="tsd-kind-call-signature">getNodeStats</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><br/> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">ledger</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/KeetaNetSDK.Referenced.LedgerStatistics.html" class="tsd-signature-type tsd-kind-interface">LedgerStatistics</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">switch</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/KeetaNetSDK.Referenced.P2PSwitchStatistics.html" class="tsd-signature-type tsd-kind-interface">P2PSwitchStatistics</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span><a href="#getnodestats-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 statistics about the preferred representative</p>
|
|
174
|
+
</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">ledger</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/KeetaNetSDK.Referenced.LedgerStatistics.html" class="tsd-signature-type tsd-kind-interface">LedgerStatistics</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">switch</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/KeetaNetSDK.Referenced.P2PSwitchStatistics.html" class="tsd-signature-type tsd-kind-interface">P2PSwitchStatistics</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></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="getpeers"><span>get<wbr/>Peers</span><a href="#getpeers" 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="getpeers-1"><span class="tsd-kind-call-signature">getPeers</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><a href="../interfaces/KeetaNetSDK.Referenced.GetPeersAPIResponse.html" class="tsd-signature-type tsd-kind-interface">GetPeersAPIResponse</a><span class="tsd-signature-symbol">></span><a href="#getpeers-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 a list of peers that the node is connected to.</p>
|
|
175
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/KeetaNetSDK.Referenced.GetPeersAPIResponse.html" class="tsd-signature-type tsd-kind-interface">GetPeersAPIResponse</a><span class="tsd-signature-symbol">></span></h4><p>The list of peers that the node is connected to</p>
|
|
176
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getpendingblock"><span>get<wbr/>Pending<wbr/>Block</span><a href="#getpendingblock" 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="getpendingblock-1"><span class="tsd-kind-call-signature">getPendingBlock</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">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><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="#getpendingblock-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 pending block for a given account. This will return the
|
|
177
|
+
block on the representative's side ledger that is pending vote
|
|
178
|
+
completion. This is used to recover the pending block for an
|
|
179
|
+
account that has not been published yet.</p>
|
|
180
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><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 get the pending block for</p>
|
|
181
|
+
</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-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></h4><p>The pending block for the account or null if there is no
|
|
182
|
+
pending block</p>
|
|
183
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getsinglerepresentativeinfo"><span>get<wbr/>Single<wbr/>Representative<wbr/>Info</span><a href="#getsinglerepresentativeinfo" 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="getsinglerepresentativeinfo-1"><span class="tsd-kind-call-signature">getSingleRepresentativeInfo</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">rep</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="../modules/KeetaNetSDK.Referenced.html#ecdsa_secp256k1" class="tsd-signature-type tsd-kind-enum-member">ECDSA_SECP256K1</a> <span class="tsd-signature-symbol">|</span> <a href="../modules/KeetaNetSDK.Referenced.html#ed25519" class="tsd-signature-type tsd-kind-enum-member">ED25519</a> <span class="tsd-signature-symbol">|</span> <a href="../modules/KeetaNetSDK.Referenced.html#ecdsa_secp256r1" class="tsd-signature-type tsd-kind-enum-member">ECDSA_SECP256R1</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-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/KeetaNetSDK.Referenced.RepresentativeInfo.html" class="tsd-signature-type tsd-kind-interface">RepresentativeInfo</a><span class="tsd-signature-symbol">></span><a href="#getsinglerepresentativeinfo-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 representative information for a given representative account</p>
|
|
184
|
+
</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">rep</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="../modules/KeetaNetSDK.Referenced.html#ecdsa_secp256k1" class="tsd-signature-type tsd-kind-enum-member">ECDSA_SECP256K1</a> <span class="tsd-signature-symbol">|</span> <a href="../modules/KeetaNetSDK.Referenced.html#ed25519" class="tsd-signature-type tsd-kind-enum-member">ED25519</a> <span class="tsd-signature-symbol">|</span> <a href="../modules/KeetaNetSDK.Referenced.html#ecdsa_secp256r1" class="tsd-signature-type tsd-kind-enum-member">ECDSA_SECP256R1</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The representative account to get the information for</p>
|
|
185
|
+
</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="../interfaces/KeetaNetSDK.Referenced.RepresentativeInfo.html" class="tsd-signature-type tsd-kind-interface">RepresentativeInfo</a><span class="tsd-signature-symbol">></span></h4><p>The representative information</p>
|
|
186
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettokensupply"><span>get<wbr/>Token<wbr/>Supply</span><a href="#gettokensupply" 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="gettokensupply-1"><span class="tsd-kind-call-signature">getTokenSupply</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">token</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/KeetaNetSDK.Referenced.TokenAddress.html" class="tsd-signature-type tsd-kind-type-alias">TokenAddress</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">bigint</span><span class="tsd-signature-symbol">></span><a href="#gettokensupply-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 supply of a token. This will return the total supply of the
|
|
187
|
+
specified token.</p>
|
|
188
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">token</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/KeetaNetSDK.Referenced.TokenAddress.html" class="tsd-signature-type tsd-kind-type-alias">TokenAddress</a></span><div class="tsd-comment tsd-typography"><p>The token to get the supply for</p>
|
|
189
|
+
</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-type">bigint</span><span class="tsd-signature-symbol">></span></h4><p>The total supply of the token</p>
|
|
190
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getversion"><span>get<wbr/>Version</span><a href="#getversion" 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="getversion-1"><span class="tsd-kind-call-signature">getVersion</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">rep</span><span class="tsd-signature-symbol">?:</span> <a href="../types/KeetaNetSDK.Referenced.ClientRepresentative.html" class="tsd-signature-type tsd-kind-type-alias">ClientRepresentative</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ANY"</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-symbol">{</span> <span class="tsd-kind-property">node</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><a href="#getversion-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 version of the node for a given representative, if no
|
|
191
|
+
representative is specified then the version of the "best"
|
|
192
|
+
representative will be returned.</p>
|
|
193
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">rep</span>: <a href="../types/KeetaNetSDK.Referenced.ClientRepresentative.html" class="tsd-signature-type tsd-kind-type-alias">ClientRepresentative</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ANY"</span><span class="tsd-signature-symbol"> = 'ANY'</span></span></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">node</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></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getvotestaple"><span>get<wbr/>Vote<wbr/>Staple</span><a href="#getvotestaple" 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="getvotestaple-1"><span class="tsd-kind-call-signature">getVoteStaple</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">blockhash</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.BlockHash.html" class="tsd-signature-type tsd-kind-class">BlockHash</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="#getvotestaple-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 vote staple for a given block hash. This will return the entire
|
|
194
|
+
vote staple including the blocks whose hash has not been requested.</p>
|
|
195
|
+
<p>The default mode of operation will request the block from the main
|
|
196
|
+
ledger of the "best" representative.</p>
|
|
197
|
+
<p>The "side" ledger is a special ledger that is used to hold unpublished
|
|
198
|
+
votes and blocks that the given representative has learned about but
|
|
199
|
+
which have not been published to the network. This is used as part
|
|
200
|
+
of the voting process.</p>
|
|
201
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">blockhash</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.BlockHash.html" class="tsd-signature-type tsd-kind-class">BlockHash</a></span><div class="tsd-comment tsd-typography"><p>The block hash to get the vote staple for</p>
|
|
202
|
+
</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-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></h4><p>The vote staple for the given block hash or null if the vote staple does not exist on the given ledger</p>
|
|
203
|
+
<div class="tsd-comment tsd-typography"></div></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="getvotestaple-2"><span class="tsd-kind-call-signature">getVoteStaple</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">blockhash</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.BlockHash.html" class="tsd-signature-type tsd-kind-class">BlockHash</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">side</span><span class="tsd-signature-symbol">?:</span> <a href="../types/KeetaNetSDK.Referenced.LedgerStorage.html" class="tsd-signature-type tsd-kind-type-alias">LedgerStorage</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.VoteStaple.html" class="tsd-signature-type tsd-kind-class">VoteStaple</a><span class="tsd-signature-symbol">></span><a href="#getvotestaple-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">blockhash</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="KeetaNetSDK.Referenced.BlockHash.html" class="tsd-signature-type tsd-kind-class">BlockHash</a></span><div class="tsd-comment tsd-typography"><p>The block hash to get the vote staple for</p>
|
|
204
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">side</span>: <a href="../types/KeetaNetSDK.Referenced.LedgerStorage.html" class="tsd-signature-type tsd-kind-type-alias">LedgerStorage</a></span><div class="tsd-comment tsd-typography"><p>The side of the ledger to get the vote staple from -- this is generally "main", but it is possible to request "side" ledger blocks</p>
|
|
205
|
+
</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-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></h4><p>The vote staple for the given block hash or null if the vote staple does not exist on the given ledger</p>
|
|
206
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getvotestaplesafter"><span>get<wbr/>Vote<wbr/>Staples<wbr/>After</span><a href="#getvotestaplesafter" 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="getvotestaplesafter-1"><span class="tsd-kind-call-signature">getVoteStaplesAfter</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">moment</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">bloomFilter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><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.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="#getvotestaplesafter-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 a list of vote staples that have been added to the
|
|
207
|
+
representative's ledger since a given moment in time.</p>
|
|
208
|
+
<p>This method is used to bootstrap a new node with the
|
|
209
|
+
vote staples that have been added to the ledger since
|
|
210
|
+
the last time the node was updated.</p>
|
|
211
|
+
<p>It is a paginated request and may return only a partial set of
|
|
212
|
+
vote staples for a given request if there are more vote staples
|
|
213
|
+
to be fetched from the representative. The <code>moment</code> parameter
|
|
214
|
+
can be used to fetch the next set of vote staples, and the
|
|
215
|
+
<code>bloomFilter</code> parameter can be used to tell the server not to
|
|
216
|
+
include any duplicate vote staples that have already been sent
|
|
217
|
+
as part of the last page in the case of a <code>moment</code> overlap.
|
|
218
|
+
Once all vote staples have been fetched an empty array will be
|
|
219
|
+
returned.</p>
|
|
220
|
+
<p>The bloom filter is constructed from the bytes of the vote staples
|
|
221
|
+
to exclude.</p>
|
|
222
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">moment</span>: <span class="tsd-signature-type">Date</span></span><div class="tsd-comment tsd-typography"><p>The moment in time to get the vote staples after</p>
|
|
223
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The maximum number of vote staples to return</p>
|
|
224
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">bloomFilter</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The bloom filter to use to filter the vote staples which have already been sent</p>
|
|
225
|
+
</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.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 list of vote staples that have been added to the representative's ledger since the given moment in time</p>
|
|
226
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listaclsbyentity"><span>list<wbr/>AC<wbr/>Ls<wbr/>By<wbr/>Entity</span><a href="#listaclsbyentity" 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="listaclsbyentity-1"><span class="tsd-kind-call-signature">listACLsByEntity</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entity</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/KeetaNetSDK.Referenced.GenericAccount.html" class="tsd-signature-type tsd-kind-type-alias">GenericAccount</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><a href="../interfaces/KeetaNetSDK.Referenced.ACLRow.html" class="tsd-signature-type tsd-kind-interface">ACLRow</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#listaclsbyentity-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>List the ACLs that have been set on a given account by any other
|
|
227
|
+
account. This will return the ACLs including the principal.</p>
|
|
228
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">entity</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</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 list the ACLs for</p>
|
|
229
|
+
</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="../interfaces/KeetaNetSDK.Referenced.ACLRow.html" class="tsd-signature-type tsd-kind-interface">ACLRow</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>The ACLs for the account where the entity is the
|
|
230
|
+
specified account</p>
|
|
231
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listaclsbyprincipal"><span>list<wbr/>AC<wbr/>Ls<wbr/>By<wbr/>Principal</span><a href="#listaclsbyprincipal" 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="listaclsbyprincipal-1"><span class="tsd-kind-call-signature">listACLsByPrincipal</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">account</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/KeetaNetSDK.Referenced.GenericAccount.html" class="tsd-signature-type tsd-kind-type-alias">GenericAccount</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">entities</span><span class="tsd-signature-symbol">?:</span> (<span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/KeetaNetSDK.Referenced.GenericAccount.html" class="tsd-signature-type tsd-kind-type-alias">GenericAccount</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-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/KeetaNetSDK.Referenced.ACLRow.html" class="tsd-signature-type tsd-kind-interface">ACLRow</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#listaclsbyprincipal-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>List the ACLs that have been set for a given account that are
|
|
232
|
+
targeting a particular set of accounts. This will return the ACLs
|
|
233
|
+
including the principal, entity, and permissions for each ACL entry.</p>
|
|
234
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">account</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</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 list the ACLs for</p>
|
|
235
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">entities</span>: (<span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/KeetaNetSDK.Referenced.GenericAccount.html" class="tsd-signature-type tsd-kind-type-alias">GenericAccount</a>)<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></span><div class="tsd-comment tsd-typography"><p>The accounts to filter the ACLs by</p>
|
|
236
|
+
</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="../interfaces/KeetaNetSDK.Referenced.ACLRow.html" class="tsd-signature-type tsd-kind-interface">ACLRow</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>The ACLs for the account where the target is one of the
|
|
237
|
+
specified accounts</p>
|
|
238
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listaclsbyprincipalwithinfo"><span>list<wbr/>AC<wbr/>Ls<wbr/>By<wbr/>Principal<wbr/>With<wbr/>Info</span><a href="#listaclsbyprincipalwithinfo" 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="listaclsbyprincipalwithinfo-1"><span class="tsd-kind-call-signature">listACLsByPrincipalWithInfo</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">account</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/KeetaNetSDK.Referenced.GenericAccount.html" class="tsd-signature-type tsd-kind-type-alias">GenericAccount</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">targets</span><span class="tsd-signature-symbol">?:</span> (<span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/KeetaNetSDK.Referenced.GenericAccount.html" class="tsd-signature-type tsd-kind-type-alias">GenericAccount</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-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/KeetaNetSDK.Referenced.PrincipalACLWithInfoParsed.html" class="tsd-signature-type tsd-kind-interface">PrincipalACLWithInfoParsed</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#listaclsbyprincipalwithinfo-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>List the ACLs that have been set for a given account that are
|
|
239
|
+
targeting a particular set of accounts. This will return the ACLs
|
|
240
|
+
including the principal, entity, and permissions for each ACL entry.</p>
|
|
241
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">account</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</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 list the ACLs for</p>
|
|
242
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">targets</span>: (<span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/KeetaNetSDK.Referenced.GenericAccount.html" class="tsd-signature-type tsd-kind-type-alias">GenericAccount</a>)<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></span><div class="tsd-comment tsd-typography"><p>The accounts to filter the ACLs by</p>
|
|
243
|
+
</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="../interfaces/KeetaNetSDK.Referenced.PrincipalACLWithInfoParsed.html" class="tsd-signature-type tsd-kind-interface">PrincipalACLWithInfoParsed</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>The ACLs for the account where the target is one of the
|
|
244
|
+
specified accounts with additional information</p>
|
|
245
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="makebuilder"><span>make<wbr/>Builder</span><a href="#makebuilder" 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="makebuilder-1"><span class="tsd-kind-call-signature">makeBuilder</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../types/KeetaNetSDK.Referenced.BuilderOptions.html" class="tsd-signature-type tsd-kind-type-alias">BuilderOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="KeetaNetSDK.Referenced.UserClientBuilder.html" class="tsd-signature-type tsd-kind-class">UserClientBuilder</a><a href="#makebuilder-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 a new instance of the <a href="KeetaNetSDK.Referenced.UserClientBuilder.html" class="tsd-kind-class">UserClientBuilder</a> class. This
|
|
246
|
+
is a convenience method to create a new instance of the builder
|
|
247
|
+
class.</p>
|
|
248
|
+
<p>The builder class is used to create blocks in a high-level way.</p>
|
|
249
|
+
</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.BuilderOptions.html" class="tsd-signature-type tsd-kind-type-alias">BuilderOptions</a></span><div class="tsd-comment tsd-typography"><p>The options to use for the builder</p>
|
|
250
|
+
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">userClient</span><span class="tsd-signature-symbol">?: </span><a href="../types/KeetaNetSDK.Referenced.UserClientOrClientAndNetwork.html" class="tsd-signature-type tsd-kind-type-alias">UserClientOrClientAndNetwork</a></h5><div class="tsd-comment tsd-typography"><p>User Client or object with a client and network</p>
|
|
251
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></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><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="recoveraccount"><span>recover<wbr/>Account</span><a href="#recoveraccount" 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="recoveraccount-1"><span class="tsd-kind-call-signature">recoverAccount</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">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><span class="tsd-signature-symbol">,</span><br/> <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><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.VoteStaple.html" class="tsd-signature-type tsd-kind-class">VoteStaple</a><span class="tsd-signature-symbol">></span><a href="#recoveraccount-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>Recover any unpublished or half-publish account artifacts</p>
|
|
252
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><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>Account to recover</p>
|
|
253
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">publish</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>Publish the recovered staple to the network (default is true)</p>
|
|
254
|
+
</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-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></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="transmit"><span>transmit</span><a href="#transmit" 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="transmit-1"><span class="tsd-kind-call-signature">transmit</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">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><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="#transmit-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>Transmit a set of blocks to the network. This will request short
|
|
255
|
+
votes and permanent votes for the blocks and then publish them to
|
|
256
|
+
the network.</p>
|
|
257
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">blocks</span>: <a href="KeetaNetSDK.Referenced.Block.html" class="tsd-signature-type tsd-kind-class">Block</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The blocks or UserClientBuilder to transmit</p>
|
|
258
|
+
</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 result of the publish operation</p>
|
|
259
|
+
<div class="tsd-comment tsd-typography"></div></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="transmit-2"><span class="tsd-kind-call-signature">transmit</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">blocks</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-kind-parameter">network</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> <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="#transmit-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>Transmit a set of blocks to the network. This will request short
|
|
260
|
+
votes and permanent votes for the blocks and then publish them to
|
|
261
|
+
the network.</p>
|
|
262
|
+
<p>The <code>blocks</code> builder will be computed using <a href="#computebuilderblocks" class="tsd-kind-method">computeBuilderBlocks</a> and then transmitted.</p>
|
|
263
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">blocks</span>: <a href="KeetaNetSDK.Referenced.UserClientBuilder.html" class="tsd-signature-type tsd-kind-class">UserClientBuilder</a></span><div class="tsd-comment tsd-typography"><p>The UserClientBuilder to compute and transmit transmit</p>
|
|
264
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">network</span>: <span class="tsd-signature-type">bigint</span></span><div class="tsd-comment tsd-typography"><p>The network to use for the builder (if using a builder)</p>
|
|
265
|
+
</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 result of the publish operation</p>
|
|
266
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="transmitstaple"><span>transmit<wbr/>Staple</span><a href="#transmitstaple" 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="transmitstaple-1"><span class="tsd-kind-call-signature">transmitStaple</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">votesAndBlocks</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-kind-parameter">reps</span><span class="tsd-signature-symbol">?:</span> <a href="../types/KeetaNetSDK.Referenced.ClientRepresentative.html" class="tsd-signature-type tsd-kind-type-alias">ClientRepresentative</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-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="#transmitstaple-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>Publish a Vote Staple to the network. This will publish the votes
|
|
267
|
+
and blocks to the network.</p>
|
|
268
|
+
<p>If <code>reps</code> is not defined then the highest weight representative
|
|
269
|
+
will be used. If <code>reps</code> is defined then the votes and blocks
|
|
270
|
+
will be published to all representatives in the list.</p>
|
|
271
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">votesAndBlocks</span>: <a href="KeetaNetSDK.Referenced.VoteStaple.html" class="tsd-signature-type tsd-kind-class">VoteStaple</a></span><div class="tsd-comment tsd-typography"><p>The votes and blocks to publish</p>
|
|
272
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">reps</span>: <a href="../types/KeetaNetSDK.Referenced.ClientRepresentative.html" class="tsd-signature-type tsd-kind-type-alias">ClientRepresentative</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The representatives to publish to</p>
|
|
273
|
+
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">weight</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">bigint</span></h5><div class="tsd-comment tsd-typography"><p>The weight of the representative, in terms of voting power</p>
|
|
274
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></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 result of the publish operation as well as the vote staple</p>
|
|
275
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updatereps"><span>update<wbr/>Reps</span><a href="#updatereps" 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="updatereps-1"><span class="tsd-kind-call-signature">updateReps</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">addNewReps</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> <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="#updatereps-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>Update this client's view of the network representatives.
|
|
276
|
+
This will fetch the list of representatives from the
|
|
277
|
+
network and update the list of representatives that this
|
|
278
|
+
client will use.</p>
|
|
279
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">addNewReps</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>If true, add any new representatives to the list of representatives</p>
|
|
280
|
+
</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-type">void</span><span class="tsd-signature-symbol">></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="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><span class="tsd-kind-parameter">network</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"production"</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">"beta"</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><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Client</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">Client</a> class from the given
|
|
281
|
+
network name. This will use the default representatives for the
|
|
282
|
+
network based on the configuration.</p>
|
|
283
|
+
<p>New instances should be cleaned up with the <a href="#destroy" class="tsd-kind-method">destroy</a>() method
|
|
284
|
+
when they are no longer needed.</p>
|
|
285
|
+
<p>This is the recommended way to create a new instance of the <a href="#" class="tsd-kind-class">Client</a> class.</p>
|
|
286
|
+
</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">"production"</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">"beta"</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">Client</a> class</p>
|
|
287
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">Client</a></h4><p>A new instance of the <a href="#" class="tsd-kind-class">Client</a> class</p>
|
|
288
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><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><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><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><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><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>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">C</text></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><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>Properties</summary><div><a href="#logger"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">P</text></svg><span>logger</span></a><a href="#stats"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">P</text></svg><span>stats</span></a><a href="#builder"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">P</text></svg><span>Builder</span></a><a href="#config"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">P</text></svg><span>Config</span></a><a href="#defaultlogger"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">P</text></svg><span>Default<wbr/>Logger</span></a><a href="#isinstance"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">P</text></svg><span>is<wbr/>Instance</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><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>Accessors</summary><div><a href="#representatives"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">A</text></svg><span>representatives</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><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>Methods</summary><div><a href="#computebuilderblocks"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>compute<wbr/>Builder<wbr/>Blocks</span></a><a href="#destroy"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>destroy</span></a><a href="#getaccountinfo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Account<wbr/>Info</span></a><a href="#getaccountsinfo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Accounts<wbr/>Info</span></a><a href="#getallbalances"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>All<wbr/>Balances</span></a><a href="#getallrepresentativeinfo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>All<wbr/>Representative<wbr/>Info</span></a><a href="#getbalance"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Balance</span></a><a href="#getblock"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Block</span></a><a href="#getchain"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Chain</span></a><a href="#getheadblock"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Head<wbr/>Block</span></a><a href="#gethistory"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>History</span></a><a href="#getledgerchecksum"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Ledger<wbr/>Checksum</span></a><a href="#getnetworkstatus"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Network<wbr/>Status</span></a><a href="#getnodestats"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Node<wbr/>Stats</span></a><a href="#getpeers"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Peers</span></a><a href="#getpendingblock"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Pending<wbr/>Block</span></a><a href="#getsinglerepresentativeinfo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Single<wbr/>Representative<wbr/>Info</span></a><a href="#gettokensupply"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Token<wbr/>Supply</span></a><a href="#getversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Version</span></a><a href="#getvotestaple"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Vote<wbr/>Staple</span></a><a href="#getvotestaplesafter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>get<wbr/>Vote<wbr/>Staples<wbr/>After</span></a><a href="#listaclsbyentity"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>list<wbr/>AC<wbr/>Ls<wbr/>By<wbr/>Entity</span></a><a href="#listaclsbyprincipal"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>list<wbr/>AC<wbr/>Ls<wbr/>By<wbr/>Principal</span></a><a href="#listaclsbyprincipalwithinfo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>list<wbr/>AC<wbr/>Ls<wbr/>By<wbr/>Principal<wbr/>With<wbr/>Info</span></a><a href="#makebuilder"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>make<wbr/>Builder</span></a><a href="#recoveraccount"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>recover<wbr/>Account</span></a><a href="#transmit"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>transmit</span></a><a href="#transmitstaple"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>transmit<wbr/>Staple</span></a><a href="#updatereps"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>update<wbr/>Reps</span></a><a href="#fromnetwork"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method" stroke="black"><rect fill="var(--color-icon-background)" stroke="black" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle" stroke-width="0">M</text></svg><span>from<wbr/>Network</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@keetanetwork/keetanet-client</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">KeetaSDK Documentation</p></footer><div class="overlay"></div></body></html>
|