utxorpc: A gRPC interface for UTxO Blockchains

[ apache, blockchain, cardano, grpc, library, network ] [ Propose Tags ]

UTxO RPC (u5c for short) is an interface tailored for interactions with UTxO-based blockchains, prioritizing performance and developer experience. By providing a common contract, a range of SDKs, and thorough documentation, UTxO RPC aims to facilitate:

  • Reusability: Enabling shared components that can be reused across different projects to simplify the integration effort.

  • Interoperability: A common interface to simplify integrations between different parties and avoid the common pitfall of vendor lock-in.

  • Performance: A serialized binary format which is compact and efficient, resulting in smaller message sizes and reduced network overhead compared to its JSON counterpart

Please note that UTxO RPC is just a specification of an interface between agents and the blockchain, it doesn't provide any concrete client / provider implementations. The primary purpose of u5c is to define a set of standardized methods, data structures, and communication patterns.


[Skip to Readme]

Modules

  • Proto
    • Utxorpc
      • V1alpha
        • Build
          • Proto.Utxorpc.V1alpha.Build.Build
          • Proto.Utxorpc.V1alpha.Build.Build_Fields
        • Cardano
          • Proto.Utxorpc.V1alpha.Cardano.Cardano
          • Proto.Utxorpc.V1alpha.Cardano.Cardano_Fields
        • Submit
          • Proto.Utxorpc.V1alpha.Submit.Submit
          • Proto.Utxorpc.V1alpha.Submit.Submit_Fields
        • Sync
          • Proto.Utxorpc.V1alpha.Sync.Sync
          • Proto.Utxorpc.V1alpha.Sync.Sync_Fields
        • Watch
          • Proto.Utxorpc.V1alpha.Watch.Watch
          • Proto.Utxorpc.V1alpha.Watch.Watch_Fields

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 0.0.3.0, 0.0.4.0, 0.0.4.1, 0.0.4.2, 0.0.4.3, 0.0.4.4, 0.0.5.0, 0.0.5.1
Dependencies base (>=4.7 && <5), proto-lens (>=0.7.1 && <0.8), proto-lens-protobuf-types (>=0.7.2 && <0.8), proto-lens-runtime (>=0.7.0 && <0.8) [details]
License Apache-2.0
Author TxPipe <registrant@txpipe.io>
Maintainer TxPipe <registrant@txpipe.io> Dominic Mayhew <dominic.j.mayhew@gmail.com>
Category Network, GRPC, Blockchain, Cardano
Home page https://github.com/utxorpc/spec#readme
Bug tracker https://github.com/utxorpc/spec/issues
Uploaded by dMayhew at 2024-02-15T19:11:51Z
Distributions NixOS:0.0.4.4
Reverse Dependencies 2 direct, 0 indirect [details]
Downloads 152 total (50 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs not available [build log]
All reported builds failed as of 2024-02-15 [all 2 reports]

Readme for utxorpc-0.0.3.0

[back to package description]

UTxO RPC

This package contains the generated code from the UTxO RPC specification. Codegen was performed using proto-lens-protoc and contains Message types useful for serde.

Users: For more support for implementing a UTxO RPC client or service, see the SDK.

Maintainers: See the UTxO spec repo README.