Thruput TypeScript protocol bindings
    Preparing search index...

    Module @thruputchain/rpc

    ONC-RPC client APIs and generated RPC protocol definitions.

    Use this package to call Thruput ONC-RPC services and to work with the RPC request and response types generated from the protocol XDR definitions.

    Enumerations

    AuthErrorCode
    BlockExecutionMode
    CoordinatorRegistrationOutcome
    DBAuthError
    DBAuthIntroOutcome
    DbSchedResult
    DbShardResult
    DogwoodTransmissionType
    ExperimentType
    GenesisCeremonyOutcome
    IntroAuthOutcome
    LoadgenRPCError
    RPCError
    SchedulerCommitOutcome
    SchedulerErrorCode
    SchedulerGetTipOutcome
    SchedulerProposalOutcome
    SchedulerTransactionErrorSource
    SchedulerTransactionStatus
    SchedulerValidationOutcome
    SCPStatementType
    SCPValidationLevel
    WalletTransactionAckType

    Classes

    RpcClient
    WebSocketTransport

    Interfaces

    AuthCard
    authdb_get_auth_data_args
    authdb_get_auth_data_batch_args
    authmempool_verify_batch_args
    authmempool_verify_transactions_args
    BatonConfig
    BlockExecutionContext
    CatchupBlock
    CatchupBlocksRequest
    CatchupBlocksResult
    CatchupConfig
    CatchupSpan
    Config
    ConsensusBasis
    ConsensusValue
    CoordCard
    CoordinatorBatonConfig
    CoordinatorConfig
    CoordinatorConsensusConfig
    CoordinatorPoolConfig
    CoordinatorRouterConfig
    DbBlockOk
    dbsched_commit_snapshot_args
    dbsched_create_snapshot_args
    dbsched_get_address_auth_data_args
    dbsched_load_genesis_configuration_args
    DbTip
    Delta
    DiscoveryConfig
    dogwoodapi_send_args
    DogwoodChunk
    DogwoodConfig
    DogwoodDelivery
    DogwoodDeliveryEnvelope
    DogwoodPackage
    DogwoodReceived
    DogwoodRoute
    DogwoodRouting
    DogwoodStandaloneConfig
    DogwoodStream
    DogwoodTransmission
    DogwoodTreeNode
    ERC20PaymentsConfig
    eventexecutor_emit_event_args
    eventexecutor_report_tx_failure_args
    eventsched_close_block_args
    eventsched_commit_block_args
    executorsched_open_proposal_block_args
    executorsched_open_validation_block_args
    executorsched_propose_batch_args
    executorsched_propose_transaction_args
    executorsched_validate_batch_args
    executorsched_validate_transaction_args
    extend_experiment_args
    GenesisCeremonyCommit
    GenesisCeremonyRequest
    KeyChange
    KeyChangeChunk
    LoadgenExtension
    LoadgenSuccessResult
    MempoolAuthIntroSuccess
    MempoolConfig
    NativeTokenAge
    NativeTokensTransferredChunk
    ParallelBatch
    PrevProposalSummary
    Proposal
    ProposalTxs
    RepairConfig
    RouterConfig
    RpcTransport
    schedulercoord_commit_block_args
    schedulercoord_propose_block_args
    schedulercoord_submit_vetted_args
    schedulercoord_validate_block_args
    SchedulerProposedBlock
    SchedulerTransactionOutcome
    SchedulerValidationBlock
    scp_control_nominate_args
    scp_control_set_state_from_envelope_args
    scp_handle_accepted_ballot_prepared_args
    scp_handle_accepted_commit_args
    scp_handle_ballot_did_hear_from_quorum_args
    scp_handle_combine_candidates_args
    scp_handle_confirmed_ballot_prepared_args
    scp_handle_extract_valid_value_args
    scp_handle_nominating_value_args
    scp_handle_started_ballot_proto_args
    scp_handle_updated_candidate_value_args
    scp_handle_validate_ballot_value_args
    scp_handle_validate_nomination_value_args
    scp_handle_value_externalized_args
    SCPBallot
    SCPConfig
    SCPEnvelope
    SCPQuorumSet
    SCPStatement
    SCPStatementConfirm
    SCPStatementExternalize
    SCPStatementNominate
    SCPStatementPrepare
    ShardCard
    SignedCatchupBlocksRequest
    SignedCatchupBlocksResult
    StorageConfig
    ValidatorConfig
    ViewingSnapshot
    WalletAck
    WalletSubmit

    Type Aliases

    AuthErrorCodeBatch
    BlockID
    Bytes
    ContractAddressBatch
    Data
    DbAddressAuthDataBatchResult
    DBAuthIntroResult
    DBAuthResult
    DBAuthResultBatch
    DbBlockResult
    DbTipResult
    DogwoodInt32
    DogwoodInt64
    DogwoodStreamID
    DogwoodTransmissionID
    DogwoodTreeHash
    DogwoodTreeNodes
    EventBlockResult
    ExecProposeBatchResult
    ExecProposeResult
    ExecValidateBatchResult
    ExpectedContract
    ExpectedDBTip
    ExpectedDeployment
    ExpectedProposalData
    ExpectedQueueEntry
    ExpectedRetrocausalQueueBlock
    ExpectedStorageCost
    ExpectedViewingSnapshot
    ExperimentConfig
    GenesisCeremonyResult
    InitializationBlock
    IntroAuthResult
    KeyChangeBatch
    LoadgenContextID
    LoadgenExtensionResult
    LoadgenResult
    Milliseconds
    NativeTokenAgeBatch
    NativeTokenAgeResult
    NativeTokenAgeResults
    OptProposal
    ParallelNondeterministicProposalDataBatch
    ParallelSignedTransactionBatch
    ParallelSignedTransactionHashBatch
    ProposalTxsHash
    SchedulerGetTipResult
    SchedulerProposalResult
    SchedulerTransactionOutcomeBatch
    SchedulerValidationResult
    SCPCount
    SCPEnvelopes
    SCPHash
    SCPNodeID
    SCPOptQuorumSet
    SCPOptValue
    SCPSlotIndex
    SCPStatement_pledges
    SCPValue
    SCPValues
    Seconds
    StorageCost
    TransactionID
    Upgrade
    WalletSubmittedTransactionID
    WalletTransactionAck

    Variables

    AuthDBProgram
    AuthMempoolProgram
    blank_rpcProgram
    CatchupProgram
    codec
    CoordSchedulerProgram
    DBAuthProgram
    DbSchedProgram
    DogwoodAPIProgram
    DogwoodProgram
    EventExecutorProgram
    EventSchedProgram
    ExecutorSchedProgram
    kNativeTokenAgeGroupAlreadyScheduled
    kNativeTokenAgeGroupReceived
    kNativeTokenAgeGroupToSchedule
    kNativeTokenAgeNumGroups
    LoadgenInterfaceProgram
    MempoolAuthProgram
    SchedDbProgram
    SchedulerCoordProgram
    SCP_ControlProgram
    SCP_HandleProgram
    WalletProgram

    Functions

    authErrorCodeBatch
    blockID
    buildCallMessage
    bytes
    contractAddressBatch
    createRpcClient
    data
    dbAuthResultBatch
    dogwoodInt32
    dogwoodInt64
    dogwoodStreamID
    dogwoodTransmissionID
    dogwoodTreeHash
    dogwoodTreeNodes
    execProposeBatchResult
    execValidateBatchResult
    initializationBlock
    keyChangeBatch
    loadgenContextID
    milliseconds
    nativeTokenAgeBatch
    nativeTokenAgeResults
    optProposal
    parallelNondeterministicProposalDataBatch
    parallelSignedTransactionBatch
    parallelSignedTransactionHashBatch
    parseReplyMessage
    proposalTxsHash
    schedulerTransactionOutcomeBatch
    scpCount
    scpEnvelopes
    scpHash
    scpNodeID
    scpOptQuorumSet
    scpOptValue
    scpSlotIndex
    scpValue
    scpValues
    seconds
    storageCost
    transactionID
    upgrade
    walletSubmittedTransactionID

    References

    AddressAndKey → AddressAndKey
    AddressAuthData → AddressAuthData
    ApprovalEvent → ApprovalEvent
    AuthClaim → AuthClaim
    AuthClaim_source_address_claim → AuthClaim_source_address_claim
    AuthClaimType → AuthClaimType
    AuthDataChangeArgs → AuthDataChangeArgs
    AuthDataChangeSigner → AuthDataChangeSigner
    AuthVerifyErrorCode → AuthVerifyErrorCode
    bitMap → bitMap
    BitMap → BitMap
    blockHeight → blockHeight
    BlockHeight → BlockHeight
    BoolCodec → BoolCodec
    bytestring → bytestring
    Bytestring → Bytestring
    calldata → calldata
    Calldata → Calldata
    configHash → configHash
    ConfigHash → ConfigHash
    ConfigHashPreimage → ConfigHashPreimage
    ConfigParam → ConfigParam
    ConfigParamID → ConfigParamID
    consensusValueHash → consensusValueHash
    ConsensusValueHash → ConsensusValueHash
    ConsumeUniquifierArgs → ConsumeUniquifierArgs
    Contract → Contract
    contractAddress → contractAddress
    ContractAddress → ContractAddress
    ContractBlob → ContractBlob
    ContractDeploymentHashPreimage → ContractDeploymentHashPreimage
    contractEntrypointID → contractEntrypointID
    ContractEntrypointID → ContractEntrypointID
    ContractRejectCode → ContractRejectCode
    ContractRejectDiagnostic → ContractRejectDiagnostic
    ContractType → ContractType
    CryptographicScheme → CryptographicScheme
    CxsReader → CxsReader
    CxsWriter → CxsWriter
    DbConflictCode → DbConflictCode
    DbConflictDiagnostic → DbConflictDiagnostic
    DbConflictResult → DbConflictResult
    DbDiagnosticLevel → DbDiagnosticLevel
    DecoratedSignature → DecoratedSignature
    DeployedContractHash → DeployedContractHash
    deserialize → deserialize
    deserializeCxs → deserializeCxs
    ed25519PublicKey → ed25519PublicKey
    Ed25519PublicKey → Ed25519PublicKey
    ed25519SecretKey → ed25519SecretKey
    Ed25519SecretKey → Ed25519SecretKey
    ed25519Signature → ed25519Signature
    Ed25519Signature → Ed25519Signature
    eventsHash → eventsHash
    EventsHash → EventsHash
    ExecResult → ExecResult
    ExtensionPoint → ExtensionPoint
    fixedArray → fixedArray
    FixedArray → FixedArray
    FixedArrayCodec → FixedArrayCodec
    fixedBytes → fixedBytes
    FixedBytes → FixedBytes
    FixedOpaqueCodec → FixedOpaqueCodec
    FlaggedStorageDelta → FlaggedStorageDelta
    fromBase58 → fromBase58
    fromHex → fromHex
    gasAmount → gasAmount
    GasAmount → GasAmount
    GenesisConfiguration → GenesisConfiguration
    GenesisContractAddresses → GenesisContractAddresses
    HogexecPrecompiledNativeContracts → HogexecPrecompiledNativeContracts
    IdentifiedEvent → IdentifiedEvent
    int128_xdr → int128_xdr
    Int128Codec → Int128Codec
    Int256Codec → Int256Codec
    Int32Codec → Int32Codec
    Int64Codec → Int64Codec
    Invocation → Invocation
    InvocationFrameOutput → InvocationFrameOutput
    InvocationFrameStatusCode → InvocationFrameStatusCode
    InvokeFlag → InvokeFlag
    invokeFlagSet → invokeFlagSet
    InvokeFlagSet → InvokeFlagSet
    IReader → IReader
    IWriter → IWriter
    kBytestringCeilingLen → kBytestringCeilingLen
    kDefaultMaxBytestringLen → kDefaultMaxBytestringLen
    kDefaultMaxContractSizeBytes → kDefaultMaxContractSizeBytes
    kDefaultNewAddressKeyID → kDefaultNewAddressKeyID
    kDefaultNewAddressRequiredWeight → kDefaultNewAddressRequiredWeight
    keyID → keyID
    KeyID → KeyID
    kMaxConcurrentRcqReadsPerTx → kMaxConcurrentRcqReadsPerTx
    kMaxEventLength → kMaxEventLength
    kMaxEventsPerTransaction → kMaxEventsPerTransaction
    kMaxSigners → kMaxSigners
    kMaxTopics → kMaxTopics
    kNativeTokenDivisibility → kNativeTokenDivisibility
    kQueueEntryMaxLen → kQueueEntryMaxLen
    kReplayCacheHeightsMaxLen → kReplayCacheHeightsMaxLen
    kReplayCacheNoncesMaxLen → kReplayCacheNoncesMaxLen
    kRetrocausalQueueBlockEntriesMaxLen → kRetrocausalQueueBlockEntriesMaxLen
    LazyCodec → LazyCodec
    MAX_PREALLOC_BYTES → MAX_PREALLOC_BYTES
    maxBase58Length → maxBase58Length
    mlDsa65PublicKey → mlDsa65PublicKey
    MlDsa65PublicKey → MlDsa65PublicKey
    mlDsa65SecretKey → mlDsa65SecretKey
    MlDsa65SecretKey → MlDsa65SecretKey
    mlDsa65Signature → mlDsa65Signature
    MlDsa65Signature → MlDsa65Signature
    NATIVE_TOKEN_ADDRESS → NATIVE_TOKEN_ADDRESS
    NetworkConfig → NetworkConfig
    NetworkConfigV0 → NetworkConfigV0
    networkHash → networkHash
    NetworkHash → NetworkHash
    NondeterministicProposalData → NondeterministicProposalData
    NonnegativeInt128SetAddArgs → NonnegativeInt128SetAddArgs
    OptionCodec → OptionCodec
    optSignedTransaction → optSignedTransaction
    OptSignedTransaction → OptSignedTransaction
    optSignedTransactionBatch → optSignedTransactionBatch
    OptSignedTransactionBatch → OptSignedTransactionBatch
    ProposalContext → ProposalContext
    ProposalHeader → ProposalHeader
    proposalHeaderHash → proposalHeaderHash
    ProposalHeaderHash → ProposalHeaderHash
    ProposedTransaction → ProposedTransaction
    proposedTransactionBatch → proposedTransactionBatch
    ProposedTransactionBatch → ProposedTransactionBatch
    protocol → protocol
    Protocol → Protocol
    protocolCommit → protocolCommit
    ProtocolCommit → ProtocolCommit
    PubkeyAccountPreimage → PubkeyAccountPreimage
    PublicKey → PublicKey
    PublicKeyConfig → PublicKeyConfig
    publicKeyConfigOpt → publicKeyConfigOpt
    PublicKeyConfigOpt → PublicKeyConfigOpt
    publicKeyHash → publicKeyHash
    PublicKeyHash → PublicKeyHash
    queueEntry → queueEntry
    QueueEntry → QueueEntry
    ReplayCacheData → ReplayCacheData
    ReplayCacheHeightCount → ReplayCacheHeightCount
    ReplayCacheMetadata → ReplayCacheMetadata
    resolve → resolve
    RetrocausalQueueBlock → RetrocausalQueueBlock
    RetrocausalQueueConsumeDelta → RetrocausalQueueConsumeDelta
    RetrocausalQueueDelta → RetrocausalQueueDelta
    RetrocausalQueueInsertDelta → RetrocausalQueueInsertDelta
    RetrocausalQueueMetadata → RetrocausalQueueMetadata
    RetrocausalQueuePastBlockConsumeDelta → RetrocausalQueuePastBlockConsumeDelta
    returnBuffer → returnBuffer
    ReturnBuffer → ReturnBuffer
    RpcMethodMeta → RpcMethodMeta
    RpcProgramMeta → RpcProgramMeta
    runtimeMemoryLength → runtimeMemoryLength
    RuntimeMemoryLength → RuntimeMemoryLength
    SecretKey → SecretKey
    serialize → serialize
    serializeCxs → serializeCxs
    serverAddress → serverAddress
    ServerAddress → ServerAddress
    sha256Hash → sha256Hash
    SHA256Hash → SHA256Hash
    Signature → Signature
    SignedTransaction → SignedTransaction
    signedTransactionBatch → signedTransactionBatch
    SignedTransactionBatch → SignedTransactionBatch
    signedTransactionHash → signedTransactionHash
    SignedTransactionHash → SignedTransactionHash
    signedTransactionHashBatch → signedTransactionHashBatch
    SignedTransactionHashBatch → SignedTransactionHashBatch
    StorageCostModelXdr → StorageCostModelXdr
    StorageDelta → StorageDelta
    StorageDeltaFlags → StorageDeltaFlags
    storageDeltaFlagSet → storageDeltaFlagSet
    StorageDeltaFlagSet → StorageDeltaFlagSet
    StorageDeltaType → StorageDeltaType
    StorageItem → StorageItem
    StorageItemType → StorageItemType
    StorageKey → StorageKey
    storageKeyContractData → storageKeyContractData
    StorageKeyContractData → StorageKeyContractData
    StorageKeyType → StorageKeyType
    storageLongHash → storageLongHash
    StorageLongHash → StorageLongHash
    storageShortHash → storageShortHash
    StorageShortHash → StorageShortHash
    SyscallErrorCode → SyscallErrorCode
    timePoint → timePoint
    TimePoint → TimePoint
    toBase58 → toBase58
    toHex → toHex
    topic → topic
    Topic → Topic
    Transaction → Transaction
    transactionBatch → transactionBatch
    TransactionBatch → TransactionBatch
    transactionHash → transactionHash
    TransactionHash → TransactionHash
    transactionHashBatch → transactionHashBatch
    TransactionHashBatch → TransactionHashBatch
    TransactionStatistic → TransactionStatistic
    TransferEvent → TransferEvent
    TxEmittedEvent → TxEmittedEvent
    TxEventLog → TxEventLog
    TxFailureCause → TxFailureCause
    TxFailureDiagnostic → TxFailureDiagnostic
    TxFailureKind → TxFailureKind
    txsHash → txsHash
    TxsHash → TxsHash
    uint128_xdr → uint128_xdr
    Uint128Codec → Uint128Codec
    Uint256Codec → Uint256Codec
    Uint32Codec → Uint32Codec
    Uint64Codec → Uint64Codec
    Uint8Codec → Uint8Codec
    Uniquifier → Uniquifier
    upid → upid
    UPID → UPID
    validatorID → validatorID
    ValidatorID → ValidatorID
    ValidatorPrivateInfo → ValidatorPrivateInfo
    ValidatorPublicInfo → ValidatorPublicInfo
    validatorPublicKey → validatorPublicKey
    ValidatorPublicKey → ValidatorPublicKey
    validatorSecretKey → validatorSecretKey
    ValidatorSecretKey → ValidatorSecretKey
    VarArray → VarArray
    VarArrayCodec → VarArrayCodec
    VarBytes → VarBytes
    VarOpaqueCodec → VarOpaqueCodec
    VarString → VarString
    VoidCodec → VoidCodec
    weight → weight
    Weight → Weight
    WireStorageItem → WireStorageItem
    XdrCodec → XdrCodec
    XdrReader → XdrReader
    XdrWriter → XdrWriter