-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Improve documentation and move it to package description * Move description back to README to gain markdown support * Remove markdown style header from package description
- Loading branch information
Showing
2 changed files
with
32 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,33 @@ | ||
# UTxO RPC | ||
|
||
This package contains the generated code from [the UTxO RPC specification](https://utxorpc.org/). Codegen was performed using `proto-lens-protoc` and contains `Message` types useful for serde. | ||
This package is generated by `proto-lens-protoc` from the [u5c specification](https://utxorpc.org) and contains `Data.ProtoLens.Message.Message` instances useful for serde. It is designed to be used with the [client](https://hackage.haskell.org/package/utxorpc-client) or [server](https://hackage.haskell.org/package/utxorpc-server) SDK. Build a message with the `lens` library by importing the relevant `utxorpc` modules and calling `Data.ProtoLens.Message.defMessage`: | ||
|
||
Users: For more support for implementing a UTxO RPC client or service, see [the SDK](https://www.github.com/utxorpc/haskell-sdk). | ||
```haskell | ||
import Control.Lens.Operators ((&), (.~)) | ||
import Data.ProtoLens.Message (Message (defMessage)) | ||
import qualified Data.Text.Encoding as T | ||
import Proto.Utxorpc.V1.Sync.Sync (FetchBlockRequest) | ||
import Proto.Utxorpc.V1.Sync.Sync_Fields (hash, index) | ||
|
||
Maintainers: See [the UTxO spec repo README](https://github.com/utxorpc/spec#readme). | ||
fetchBlockRequest :: FetchBlockRequest | ||
fetchBlockRequest = | ||
defMessage | ||
& ref .~ | ||
[ defMessage | ||
& index .~ 116541970 | ||
& hash .~ T.encodeUtf8 "9d5abce5b1a7d94b141a597fd621a1ff9dcd46579ff1939664364311cd1be338" | ||
] | ||
``` | ||
|
||
The easieset way to send requests or run a service is through the SDKs: [utxorpc-client](https://hackage.haskell.org/package/utxorpc-client) and [utxorpc-server](https://hackage.haskell.org/package/utxorpc-server). | ||
|
||
# Generating this package from the spec | ||
Please see the u5c project [README](https://github.com/utxorpc/spec#readme) for information on how this package was generated. To generate this code yourself, please see [`proto-lens`](https://github.com/google/proto-lens#readme). | ||
|
||
NOTE: `proto-lens-protobuf-types` version >= 0.7.2 is required to build this package, as it includes support of the `FieldMask` well-known type. | ||
|
||
# Maintainers | ||
See [the UTxO spec repo README](https://github.com/utxorpc/spec#readme). | ||
|
||
> [!NOTE] | ||
> `proto-lens-protobuf-types` version >= 0.7.2 is required to build this package as it contains support for the `FieldMask` well-known type. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters