UTxO RPC

https://utxorpc.org
Admin
A gRPC interface for UTxO-based blockchains with focus on developer experience and performance,...
Tokens:28,107
Snippets:304
Trust Score:6.2
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install UtxoRpc Go SDK

Source: https://utxorpc.org/go

Add the UtxoRpc Golang SDK to your project using the go get command. Ensure you have Go 1.16 or higher installed.

```bash
go get -u github.com/utxorpc/go-sdk
```

--------------------------------

### Install UTxORPC Node.js SDK

Source: https://utxorpc.org/nodejs

Install the SDK using npm. Ensure Node.js version 20.0 or higher is installed.

```bash
npm install @utxorpc/sdk --save
```

--------------------------------

### Install Blaze Provider and SDK

Source: https://utxorpc.org/blaze

Install the necessary packages for the UTxORPC provider and the Blaze SDK using npm.

```bash
npm install @utxorpc/blaze-provider

You also need to install the **Blaze SDK** if you haven’t already:
```
npm install @blaze-cardano/sdk
```
```

--------------------------------

### Install Utxorpc.Sdk NuGet Package

Source: https://utxorpc.org/dotnet

Add the Utxorpc.Sdk NuGet package to your .NET project to begin using the SDK.

```bash
dotnet add package Utxorpc.Sdk
```

--------------------------------

### Install UtxoRpc Python SDK

Source: https://utxorpc.org/python

Install the UtxoRpc Python SDK using pip. This command adds the SDK to your project's dependencies.

```bash
pip install utxorpc
```

--------------------------------

### Install UTxORPC SDK with deno add

Source: https://utxorpc.org/deno

Use 'deno add' to install the UTxORPC SDK directly into your Deno project without a package.json or node_modules folder.

```bash
deno add npm:@utxorpc/sdk
```

--------------------------------

### Add UtxoRpc to requirements.txt

Source: https://utxorpc.org/python

Add the UtxoRpc SDK to your requirements.txt file for dependency management. Ensure you install with 'pip install -r requirements.txt' afterwards.

```text
utxorpc==0.1.0
```

--------------------------------

### ReadTip gRPCurl Command

Source: https://utxorpc.org/playground?method=ReadTip&service=utxorpc.v1alpha.sync.SyncService

Example of how to call the ReadTip method using gRPCurl. Ensure the request payload is correctly formatted.

```bash
grpcurl -plaintext -d '[object Object]' internal-cardano-mainnet-grpc.ext-utxorpc-m1.svc.cluster.local:50051 utxorpc.v1alpha.sync.SyncService.ReadTip
```

--------------------------------

### gRPCurl Example for ReadData

Source: https://utxorpc.org/playground?method=ReadParams&service=utxorpc.v1alpha.query.QueryService

Demonstrates how to use gRPCurl to invoke the ReadData method on the QueryService. Ensure the request payload is correctly formatted.

```bash
grpcurl -plaintext -d '[object Object]' internal-cardano-mainnet-grpc.ext-utxorpc-m1.svc.cluster.local:50051 utxorpc.v1alpha.query.QueryService.ReadData
```

--------------------------------

### Basic Go SDK Usage

Source: https://utxorpc.org/go

Import the UtxoRpc Go SDK into your main package to start interacting with the UtxoRpc API. This serves as a basic template for your client or server implementation.

```go
package main
 
import (
	"github.com/utxorpc/go-sdk"
)
 
func main() {
	// Code to interact with the UtxoRpc API
}
```

--------------------------------

### FollowTip

Source: https://utxorpc.org/sync/intro

Follows the blockchain tip with streaming updates. All byte fields in grpcurl examples must be base64 encoded.

```APIDOC
## FollowTip

### Description
Follows the blockchain tip with streaming updates.

### Method
gRPC (Streaming)

### Endpoint
utxorpc.v1alpha.sync.SyncService.FollowTip

### Parameters
#### Request Body
- **intersect** (array of objects) - Required - An array of block references to intersect with.
  - **index** (integer) - Required - The block index.
  - **hash** (string) - Required - The base64 encoded block hash.

### Request Example
```json
{
  "intersect": [
    {
      "index": 64270876,
      "hash": "Rmuje+QbnY6ARsca2HxoxeDvWCXEjOlIp3jcnKuhXPA="
    }
  ]
}
```

### Response
#### Success Response (200)
- **tip_updates** (stream) - A stream of updates to the blockchain tip.

#### Response Example
(Response details not provided in source)
```

--------------------------------

### Describe a gRPC Method with Grpcurl

Source: https://utxorpc.org/grpcurl

Use this command to get detailed information about a specific gRPC method. This helps in understanding the method's signature and parameters.

```bash
grpcurl -plaintext localhost:50051 describe utxorpc.v1alpha.sync.SyncService.FollowTip
```

--------------------------------

### CardanoSyncClient: Follow Tip

Source: https://utxorpc.org/deno

Example of how to use the CardanoSyncClient to follow the blockchain tip. This allows you to receive real-time updates on the latest blocks.

```APIDOC
## CardanoSyncClient: Follow Tip

### Description

This method allows you to subscribe to and receive updates on the latest blockchain tip. It's useful for staying synchronized with the most recent block information.

### Method

`followTip`

### Parameters

#### Path Parameters

None

#### Query Parameters

None

#### Request Body

- **tip** (Array<Object>) - Required - An array of objects, each containing `slot` and `hash` of a known block to start synchronization from.
  - **slot** (number) - Required - The slot number of the block.
  - **hash** (string) - Required - The hash of the block.

### Request Example

```javascript
import { CardanoSyncClient } from "npm:@utxorpc/sdk";

async function followTipExample() {
  const syncClient = new CardanoSyncClient({
    uri: "http://localhost:50051"
  });

  const tip = syncClient.followTip([
    { slot: 54131816, hash: "34c65aba4b299113a488b74e2efe3a3dd272d25b470d25f374b2c693d4386535" },
  ]);

  for await (const event of tip) {
    console.log(event);
  }
}

followTipExample().catch(console.error);
```

### Response

#### Success Response

- **event** (Object) - An event object representing a new block or chain update.

#### Response Example

```json
{
  "slot": 54131817,
  "hash": "...",
  "previous": {
    "slot": 54131816,
    "hash": "34c65aba4b299113a488b74e2efe3a3dd272d25b470d25f374b2c693d4386535"
  }
}
```
```

--------------------------------

### gRPCurl Example for ReadUtxos

Source: https://utxorpc.org/playground?method=ReadUtxos&service=utxorpc.v1alpha.query.QueryService

Use this gRPCurl command to directly invoke the ReadUtxos method on the specified endpoint. Ensure the request payload is correctly formatted.

```bash
grpcurl -plaintext -d '[object Object]' internal-cardano-mainnet-grpc.ext-utxorpc-m1.svc.cluster.local:50051 utxorpc.v1alpha.query.QueryService.ReadUtxos
```

--------------------------------

### gRPCurl Command for WatchTx

Source: https://utxorpc.org/playground?method=WatchTx&service=utxorpc.v1alpha.watch.WatchService

Example command to invoke the WatchTx method using gRPCurl. Ensure the request payload is correctly formatted.

```bash
grpcurl -plaintext -d '[object Object]' internal-cardano-mainnet-grpc.ext-utxorpc-m1.svc.cluster.local:50051 utxorpc.v1alpha.watch.WatchService.WatchTx

```

--------------------------------

### gRPCurl Command for FetchBlock

Source: https://utxorpc.org/playground?method=FetchBlock&service=utxorpc.v1alpha.sync.SyncService

Example of how to invoke the FetchBlock method using gRPCurl. Ensure the request payload is correctly formatted for the specific block reference.

```bash
grpcurl -plaintext -d '[object Object]' internal-cardano-mainnet-grpc.ext-utxorpc-m1.svc.cluster.local:50051 utxorpc.v1alpha.sync.SyncService.FetchBlock

```

--------------------------------

### grpcurl Command for WatchMempool

Source: https://utxorpc.org/playground?method=WatchMempool&service=utxorpc.v1alpha.submit.SubmitService

Example of how to invoke the WatchMempool method using grpcurl. Ensure the request payload is correctly formatted as JSON.

```bash
grpcurl -plaintext -d '[object Object]' internal-cardano-mainnet-grpc.ext-utxorpc-m1.svc.cluster.local:50051 utxorpc.v1alpha.submit.SubmitService.WatchMempool
```

--------------------------------

### Create Example Transaction

Source: https://utxorpc.org/blaze

Construct a new Cardano transaction using the Blaze SDK, specifying a recipient address and the amount of Lovelace to pay.

```typescript
const tx = await blaze
    .newTransaction()
    .payLovelace(
        Core.Address.fromBech32(
            "addr_test1qrnrqg4s73skqfyyj69mzr7clpe8s7ux9t8z6l55x2f2xuqra34p9pswlrq86nq63hna7p4vkrcrxznqslkta9eqs2nsmlqvnk",
        ),
        5_000_000n,
    )
    .complete();
```

--------------------------------

### grpcurl Command for ReadData

Source: https://utxorpc.org/playground

Example of how to use grpcurl to invoke the ReadData RPC method. Ensure the correct service address and method are specified.

```bash
grpcurl -plaintext -d '[object Object]' internal-cardano-mainnet-grpc.ext-utxorpc-m1.svc.cluster.local:50051 utxorpc.v1alpha.query.QueryService.ReadData

```

--------------------------------

### DumpHistory gRPCurl Command

Source: https://utxorpc.org/playground?method=DumpHistory&service=utxorpc.v1alpha.sync.SyncService

Example of how to invoke the DumpHistory RPC using gRPCurl. Ensure the request payload is correctly formatted.

```bash
grpcurl -plaintext -d '[object Object]' internal-cardano-mainnet-grpc.ext-utxorpc-m1.svc.cluster.local:50051 utxorpc.v1alpha.sync.SyncService.DumpHistory

```

--------------------------------

### CardanoQueryClient: Read Parameters

Source: https://utxorpc.org/deno

Example of how to use the CardanoQueryClient to read the current blockchain protocol parameters. This information is essential for understanding network constraints and capabilities.

```APIDOC
## CardanoQueryClient: Read Parameters

### Description

Fetches the current protocol parameters of the Cardano blockchain. This includes details like the minimum fee, pool deposit, and other network-specific configurations.

### Method

`readParams`

### Parameters

#### Path Parameters

None

#### Query Parameters

None

#### Request Body

None

### Request Example

```javascript
import { CardanoQueryClient } from "npm:@utxorpc/sdk";

async function readParamsExample() {
  const queryClient = new CardanoQueryClient({
    uri: "http://localhost:50051"
  });

  const params = await queryClient.readParams();
  console.log(params);
}

readParamsExample().catch(console.error);
```

### Response

#### Success Response (200)

- **params** (Object) - An object containing the current protocol parameters.

#### Response Example

```json
{
  "epoch": 100,
  "min_fee_a": 44,
  "min_fee_b": 155381,
  "max_block_size": 16384,
  "max_tx_size": 16384,
  "min_utxo_val": 1000000,
  "key_deposit": 2000000,
  "pool_deposit": 500000000,
  "e_max": 100,
  "n_opt": 100,
  "a0": 0.000062925,
  "ada_factor_e": 0.000000001,
  "rho": 0.000000001,
  "tau": 0.000000001
}
```
```

--------------------------------

### FetchBlock

Source: https://utxorpc.org/sync/intro

Fetches blocks by their references with optional field masking. All byte fields in grpcurl examples must be base64 encoded.

```APIDOC
## FetchBlock

### Description
Fetches blocks by their references with optional field masking.

### Method
gRPC

### Endpoint
utxorpc.v1alpha.sync.SyncService.FetchBlock

### Parameters
#### Request Body
- **ref** (array of objects) - Required - An array of block references to fetch.
  - **index** (integer) - Required - The block index.
  - **hash** (string) - Required - The base64 encoded block hash.

### Request Example
```json
{
  "ref": [
    {
      "index": 64270876,
      "hash": "Rmuje+QbnY6ARsca2HxoxeDvWCXEjOlIp3jcnKuhXPA="
    }
  ]
}
```

### Response
#### Success Response (200)
- **blocks** (array) - Description of the fetched blocks (details not provided in source).

#### Response Example
(Response details not provided in source)
```

--------------------------------

### Submit Transaction using gRPCurl

Source: https://utxorpc.org/playground?method=SubmitTx&service=utxorpc.v1alpha.submit.SubmitService

This snippet shows how to submit a transaction using the gRPCurl command-line tool. Ensure you have gRPCurl installed and are connected to the correct gRPC endpoint.

```bash
grpcurl -plaintext -d '[object Object]' internal-cardano-mainnet-grpc.ext-utxorpc-m1.svc.cluster.local:50051 utxorpc.v1alpha.submit.SubmitService.SubmitTx
```

--------------------------------

### Follow Blockchain Tip with Streaming Updates

Source: https://utxorpc.org/sync/intro

Use this command to stream updates from the current tip of the blockchain. It requires an intersection point (index and hash) to start from. Ensure byte fields are base64 encoded.

```bash
grpcurl -plaintext \
  -d '{ "intersect": [{ "index": 64270876, "hash": "Rmuje+QbnY6ARsca2HxoxeDvWCXEjOlIp3jcnKuhXPA=" }] }' \
  localhost:50051 \
  utxorpc.v1alpha.sync.SyncService.FollowTip
```

--------------------------------

### CardanoQueryClient: Search UTxOs by Address

Source: https://utxorpc.org/deno

Example of how to use the CardanoQueryClient to search for Unspent Transaction Outputs (UTxOs) associated with a specific address. This is fundamental for constructing transactions.

```APIDOC
## CardanoQueryClient: Search UTxOs by Address

### Description

Searches for and retrieves all Unspent Transaction Outputs (UTxOs) associated with a given Cardano address. This is a crucial step before constructing and submitting a transaction.

### Method

`searchUtxosByAddress`

### Parameters

#### Path Parameters

None

#### Query Parameters

None

#### Request Body

- **address** (Buffer) - Required - The Bech32 encoded address for which to search UTxOs.

### Request Example

```javascript
import { CardanoQueryClient } from "npm:@utxor/sdk";

async function searchUtxosByAddressExample() {
  const queryClient = new CardanoQueryClient({
    uri: "http://localhost:50051"
  });

  const utxos = await queryClient.searchUtxosByAddress(
    Buffer.from("705c87cbca3a88cbfee6f6ad820acea99f484b4830fc632610f2a30146", "hex")
  );

  utxos.forEach((utxo) => {
    console.log(utxo);
  });
}

searchUtxosByAddressExample().catch(console.error);
```

### Response

#### Success Response (200)

- **utxos** (Array<Object>) - An array of UTxO objects.
  - **txHash** (string) - The transaction hash where the UTxO was created.
  - **outputIndex** (number) - The index of the output within the transaction.
  - **blockHeight** (number) - The block height at which the UTxO was confirmed.
  - **amount** (Array<Object>) - The assets contained in the UTxO.
    - **unit** (string) - The asset identifier (e.g., 'lovelace').
    - **quantity** (string) - The amount of the asset.
  - **address** (string) - The address of the UTxO.

#### Response Example

```json
[
  {
    "txHash": "...",
    "outputIndex": 0,
    "blockHeight": 1000,
    "amount": [
      { "unit": "lovelace", "quantity": "2000000" }
    ],
    "address": "addr1..."
  }
]
```
```

--------------------------------

### CardanoSyncClient: Fetch Block

Source: https://utxorpc.org/deno

Example of how to use the CardanoSyncClient to fetch a specific block by its slot and hash. This is useful for retrieving detailed information about a particular block.

```APIDOC
## CardanoSyncClient: Fetch Block

### Description

Retrieves a specific block from the blockchain using its slot number and hash. This method is useful for inspecting the contents of a particular block.

### Method

`fetchBlock`

### Parameters

#### Path Parameters

None

#### Query Parameters

None

#### Request Body

- **blockIdentifier** (Object) - Required - An object specifying the block to fetch.
  - **slot** (number) - Required - The slot number of the block.
  - **hash** (string) - Required - The hash of the block.

### Request Example

```javascript
import { CardanoSyncClient } from "npm:@utxorpc/sdk";

async function fetchBlockExample() {
  const syncClient = new CardanoSyncClient({
    uri: "http://localhost:50051"
  });

  const block = await syncClient.fetchBlock({
    slot: 54131816,
    hash: "34c65aba4b299113a488b74e2efe3a3dd272d25b470d25f374b2c693d4386535",
  });

  console.log(block);
}

fetchBlockExample().catch(console.error);
```

### Response

#### Success Response (200)

- **block** (Object) - The requested block data.

#### Response Example

```json
{
  "header": {
    "slot": 54131816,
    "hash": "34c65aba4b299113a488b74e2efe3a3dd272d25b470d25f374b2c693d4386535",
    "previous": {
      "slot": 54131815,
      "hash": "..."
    }
  },
  "body": {
    "txs": [
      { ... } // Transaction data
    ]
  }
}
```
```

--------------------------------

### Submit Cardano Transaction with UTxORPC SDK

Source: https://utxorpc.org/deno

Use this snippet to submit a Cardano transaction to a UTxORPC node. Ensure the SDK is installed and the node URI is correct. The transaction is provided as a hex string.

```typescript
import { CardanoSubmitClient } from "npm:@utxorpc/sdk";

async function submitTxExample() {
  const submitClient = new CardanoSubmitClient({
    uri: "http://localhost:50051"
  });

  const txSample = "84a300d90102818258203dc5d9977e7b3d51acaea81031d2f461404536b2828549b73876a5980295f81b00018282581d60916c769efc6e2a3339594818a1d0c3998c29e3a6303d8711de8567591a004c4b4082581d60916c769efc6e2a3339594818a1d0c3998c29e3a6303d8711de8567591b0000000253bcffb3021a0002990da100d9010281825820526fa19e3694cda4f3c0d2fb2d2bb8768925eccc49a89d5f12b1972644ac769858403d6d6599193b17e67827cd9f48aaf35ac762c6fb0c5402c52724f307b69ff96f3f7e6c3fb107670c28679c148bf510f479c01a34b9d95d0dbb7e4ff6f3cb560af5f6";
  const txHash = await submitClient.submitTx(Buffer.from(txSample, "hex"));

  const txHashHex = Buffer.from(txHash).toString("hex");
  console.log(txHashHex);
}

submitTxExample().catch(console.error);
```

--------------------------------

### Initialize Deno Project

Source: https://utxorpc.org/deno

Run this command to set up a new Deno project and generate a deno.json configuration file.

```bash
deno init
```

--------------------------------

### Manual Import of UTxORPC SDK

Source: https://utxorpc.org/deno

Import SDK clients directly using the 'npm:' prefix. This works even without explicit configuration in deno.json.

```typescript
import { CardanoSyncClient, CardanoQueryClient, CardanoSubmitClient } from "npm:@utxorpc/sdk";
```

--------------------------------

### DumpHistory

Source: https://utxorpc.org/sync/spec

Dumps a portion of the block history starting from a specified token, with an option to limit the number of items returned.

```APIDOC
## DumpHistory DumpHistory

### Description
Dump the block history.

### Method
DumpHistory

### Request Type
utxorpc.v1alpha.sync.DumpHistoryRequest

### Response Type
utxorpc.v1alpha.sync.DumpHistoryResponse

### Request Body
#### Request Body
- **start_token** (BlockRef) - Optional - Starting point for the block history dump.
- **max_items** (uint32) - Optional - Maximum number of items to return.
- **field_mask** (google.protobuf.FieldMask) - Optional - Field mask to selectively return fields.

### Response
#### Success Response (200)
- **block** (AnyChainBlock) - repeated - List of blocks in the history.
- **next_token** (BlockRef) - Optional - Next token for pagination.

```

--------------------------------

### FollowTip RPC Call with grpcurl

Source: https://utxorpc.org/playground?method=FollowTip&service=utxorpc.v1alpha.sync.SyncService

Demonstrates how to invoke the FollowTip RPC method using grpcurl. Ensure the request payload is correctly formatted as JSON.

```bash
grpcurl -plaintext -d '[object Object]' internal-cardano-mainnet-grpc.ext-utxorpc-m1.svc.cluster.local:50051 utxorpc.v1alpha.sync.SyncService.FollowTip
```

--------------------------------

### DumpHistory

Source: https://utxorpc.org/sync/intro

Dumps a segment of block history from a specified point. All byte fields in grpcurl examples must be base64 encoded.

```APIDOC
## DumpHistory

### Description
Dumps a segment of block history from a specified point.

### Method
gRPC

### Endpoint
utxorpc.v1alpha.sync.SyncService.DumpHistory

### Parameters
#### Request Body
- **start_token** (object) - Required - The starting point for the history dump.
  - **index** (integer) - Required - The block index.
  - **hash** (string) - Required - The base64 encoded block hash.
- **max_items** (integer) - Optional - The maximum number of items to return.

### Request Example
```json
{
  "start_token": {
    "index": 64270876,
    "hash": "Rmuje+QbnY6ARsca2HxoxeDvWCXEjOlIp3jcnKuhXPA="
  },
  "max_items": 100
}
```

### Response
#### Success Response (200)
- **history** (array) - Description of the block history segment (details not provided in source).

#### Response Example
(Response details not provided in source)
```

--------------------------------

### Import UTxORPC SDK after deno.json configuration

Source: https://utxorpc.org/deno

Import SDK clients from the configured alias in deno.json.

```typescript
import { CardanoSyncClient, CardanoQueryClient, CardanoSubmitClient } from "@utxorpc/sdk";
```

--------------------------------

### Create U5C Provider Instance

Source: https://utxorpc.org/blaze

Instantiate the U5C provider, specifying the URL of the UTxORPC node and any required headers like an API key. Ensure the URL matches your node's configuration.

```typescript
const provider = new U5C({
    url: "http://localhost:50051",
    headers: {
        "api-key": "<api-key>",
    },
});
```

--------------------------------

### gRPCurl Command for SearchUtxos

Source: https://utxorpc.org/playground?method=SearchUtxos&service=utxorpc.v1alpha.query.QueryService

Demonstrates how to invoke the SearchUtxos method using gRPCurl. Ensure the request payload is correctly formatted.

```bash
grpcurl -plaintext -d '[object Object]' internal-cardano-mainnet-grpc.ext-utxorpc-m1.svc.cluster.local:50051 utxorpc.v1alpha.query.QueryService.SearchUtxos
```

--------------------------------

### Create Blaze Instance

Source: https://utxorpc.org/blaze

Initialize the Blaze SDK instance using the configured provider and the created wallet.

```typescript
const blaze = await Blaze.from(provider, wallet);
```

--------------------------------

### Follow Blockchain Tip with CardanoSyncClient

Source: https://utxorpc.org/nodejs

Use CardanoSyncClient to subscribe to and log new blockchain tip events. Requires a running UTxORPC node.

```typescript
import { CardanoSyncClient } from "@utxorpc/sdk";

async function followTipExample() {
  const syncClient = new CardanoSyncClient({
    uri: "http://localhost:50051"
  });

  const tip = syncClient.followTip([
    { 
        slot: 54131816, 
        hash: "34c65aba4b299113a488b74e2efe3a3dd272d25b470d25f374b2c693d4386535"
    },
  ]);

  for await (const event of tip) {
    console.log(event);
  }
}

followTipExample().catch(console.error);
```

--------------------------------

### Describe U5C SyncService FetchBlock Method

Source: https://utxorpc.org/grpcurl

Retrieves detailed information about the FetchBlock method within the U5C SyncService.

```bash
grpcurl -plaintext localhost:50051 describe utxorpc.v1alpha.sync.SyncService.FetchBlock
```

--------------------------------

### Initialize SyncServiceClient

Source: https://utxorpc.org/dotnet

Initializes the SyncServiceClient with the node URL and optional headers.

```APIDOC
## Initialize SyncServiceClient

### Description
Initializes the SyncServiceClient with the node URL and optional headers.

### Method
```csharp
SyncServiceClient(string url, Dictionary<string, string> headers)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```csharp
using Utxorpc.Sdk;

var headers = new Dictionary<string, string>
{
    { "api-key", "" },
};

var client = new SyncServiceClient(
    url: "http://localhost:50051",
    headers
);
```

### Response
None

### Error Handling
None specified.
```

--------------------------------

### Initialize SyncServiceClient

Source: https://utxorpc.org/dotnet

Initialize the SyncServiceClient with the node URL and optional headers. This client is used for interacting with UTxORPC nodes.

```csharp
using Utxorpc.Sdk;

var headers = new Dictionary<string, string>
{
    { "api-key", "" },
};

var client = new SyncServiceClient(
    url: "http://localhost:50051",
    headers
);
```

--------------------------------

### Configure UTxORPC SDK in deno.json

Source: https://utxorpc.org/deno

Manually add the UTxORPC SDK to your deno.json 'imports' section for dependency management.

```json
// deno.json
{
  "imports": {
    "@utxorpc/sdk": "npm:@utxorpc/sdk"
  }
}
```

--------------------------------

### DumpHistory

Source: https://utxorpc.org/playground?method=DumpHistory&service=utxorpc.v1alpha.sync.SyncService

Dumps the block history from the UTxORPC sync service. This method allows you to retrieve historical block data by specifying a start token, a maximum number of items, and an optional field mask.

```APIDOC
## utxorpc.v1alpha.sync.SyncService.DumpHistory

### Description

Dumps the block history. This method allows you to retrieve historical block data by specifying a start token, a maximum number of items, and an optional field mask for selective data fetching.

### Method

POST

### Endpoint

utxorpc.v1alpha.sync.SyncService.DumpHistory

### Parameters

#### Request Body

- **start_token** (utxorpc.v1alpha.sync.BlockRef) - Optional - The starting point for dumping history. If unset, the history starts from the beginning.
- **max_items** (uint32) - Optional - The maximum number of items to retrieve in this request.
- **field_mask** (google.protobuf.FieldMask) - Optional - A field mask to specify which fields of the response should be returned. If unset, all fields are returned.

### Request Example

```json
{
  "start_token": {},
  "max_items": 0,
  "field_mask": {}
}
```

### Response

#### Success Response (200)

- **history** (utxorpc.v1alpha.sync.DumpHistoryResponse) - The block history data.

#### Response Example

```json
{
  "history": {}
}
```

### gRPCurl Example

```bash
grpcurl -plaintext -d '[object Object]' internal-cardano-mainnet-grpc.ext-utxorpc-m1.svc.cluster.local:50051 utxorpc.v1alpha.sync.SyncService.DumpHistory
```
```

--------------------------------

### QueryService Definition

Source: https://utxorpc.org/playground?method=ReadUtxos&service=utxorpc.v1alpha.query.QueryService

This snippet shows the service definition for querying the state of the chain, specifically highlighting the ReadUtxos method.

```protobuf
// Service definition for querying the state of the chain.
service QueryService {
   rpc ReadUtxos ( ReadUtxosRequest ) returns ( ReadUtxosResponse ); // Read specific UTxOs by reference.
   // ... 6 more methods ...
}
```

--------------------------------

### Dump Block History Segment

Source: https://utxorpc.org/sync/intro

This command allows dumping a segment of block history starting from a specified token (index and hash) up to a maximum number of items. Ensure byte fields are base64 encoded.

```bash
grpcurl -plaintext \
-d '{ 
    "start_token": { 
      "index": 64270876, 
      "hash": "Rmuje+QbnY6ARsca2HxoxeDvWCXEjOlIp3jcnKuhXPA=" 
    },
    "max_items": 100
  }' \
  localhost:50051 \
  utxorpc.v1alpha.sync.SyncService.DumpHistory
```

--------------------------------

### Import UtxoRpc Module in Python

Source: https://utxorpc.org/python

Import the UtxoRpc module to begin using its functionalities in your Python project. This is the first step to interacting with the UtxoRpc API.

```python
import utxorpc
```

--------------------------------

### Print Wallet Address

Source: https://utxorpc.org/blaze

Log the Bech32 encoded address of the created wallet to the console.

```typescript
console.log("Wallet address", wallet.address.toBech32());
```

--------------------------------

### Fetch Specific UTxOs by Output Reference

Source: https://utxorpc.org/query/intro

Retrieves specific UTxOs using their output reference (hash and index). This is useful for directly looking up known UTxOs. Remember that byte fields in grpcurl commands must be base64 encoded.

```bash
grpcurl -plaintext \
  -d '{ \
    "keys": [{ \
      "hash": "p4WAOb31UfCR2qsqVlBLiUrsVwZoGPVOmYOjavDuEPs=", \
      "index": 0 \
    }] \
  }' \
  localhost:50051 \
  utxorpc.v1alpha.query.QueryService.ReadUtxos
```

--------------------------------

### Fetch Block by Reference

Source: https://utxorpc.org/sync/intro

Use this command to fetch a specific block using its reference (index and hash). Ensure byte fields are base64 encoded.

```bash
grpcurl -d '{ "ref": [{ "index": 64270876, "hash": "Rmuje+QbnY6ARsca2HxoxeDvWCXEjOlIp3jcnKuhXPA=" }] }' \
  localhost:50051 \
  utxorpc.v1alpha.sync.SyncService.FetchBlock
```

--------------------------------

### SubmitService Definition

Source: https://utxorpc.org/playground?method=EvalTx&service=utxorpc.v1alpha.submit.SubmitService

This Go code snippet shows the service definition for submitting transactions and checking their status within the UTxORPC specification.

```go
// Service definition for submitting transactions and checking their status.
service SubmitService {

```

```go
   rpc EvalTx ( EvalTxRequest ) returns ( EvalTxResponse ); // Evaluates a transaction without submitting it.

```

```go
} 
```

--------------------------------

### List Specific U5C Service

Source: https://utxorpc.org/grpcurl

Lists all methods within the specified U5C SyncService on a local node.

```bash
grpcurl -plaintext localhost:50051 list utxorpc.v1alpha.sync.SyncService
```

--------------------------------

### SyncService FollowTip Method Definition

Source: https://utxorpc.org/playground?method=FollowTip&service=utxorpc.v1alpha.sync.SyncService

Defines the FollowTip RPC method within the SyncService for streaming blockchain tip updates. It takes a FollowTipRequest and returns a stream of FollowTipResponse.

```proto
// Service definition for syncing chain data.
service SyncService {
   rpc FollowTip ( FollowTipRequest ) returns ( stream FollowTipResponse ); // Follow the tip of the blockchain.
   // ... 3 more methods ...
}
```

--------------------------------

### Import Blaze SDK and UTxORPC Provider

Source: https://utxorpc.org/blaze

Import core components from the Blaze SDK and the U5C provider for use in your application.

```typescript
import {
    Bip32PrivateKey,
    mnemonicToEntropy,
    wordlist,
} from "@blaze-cardano/core";
import {
    HotWallet,
    Core,
    Blaze,
} from "@blaze-cardano/sdk";
import { U5C } from "@utxorpc/blaze-provider";
```

--------------------------------

### Query Mempool with ReadMempool

Source: https://utxorpc.org/submit/intro

Use grpcurl to query the current state of the mempool. This operation is currently under development and may not be available.

```bash
grpcurl -plaintext \
  -d '{}' \
  localhost:50051 \
  utxorpc.v1alpha.submit.SubmitService.ReadMempool
```

--------------------------------

### Add UtxoRpc Rust SDK to Cargo.toml

Source: https://utxorpc.org/rust

Add this to your Cargo.toml file to include the UtxoRpc Rust SDK as a dependency in your project.

```toml
[dependencies]
utxorpc = "0.1.0"
```

--------------------------------

### QueryService Definition

Source: https://utxorpc.org/playground?method=ReadMempool&service=utxorpc.v1alpha.submit.SubmitService

This snippet shows the service definition for querying the state of the chain using the QueryService.

```protobuf
service QueryService {

```

--------------------------------

### Follow the Tip of the Blockchain

Source: https://utxorpc.org/dotnet

Receives real-time updates as the blockchain progresses using the FollowTipAsync method.

```APIDOC
## Follow the Tip of the Blockchain

### Description
Receives real-time updates as the blockchain progresses using the FollowTipAsync method. This method allows you to listen for blocks being applied, undone, or resets in the blockchain.

### Method
```csharp
Task<IAsyncEnumerable<NextResponse>> FollowTipAsync(BlockRef startBlockRef)
```

### Endpoint
N/A (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```csharp
using Utxorpc.Sdk.Models;
using Utxorpc.Sdk.Models.Enums;

await foreach (NextResponse? response in client.FollowTipAsync(
    new BlockRef
    (
        "b977e548f3364b114505f3311a10f89e5f5cf47e815765bce6750a5de48e5951",
        58717900
    )))
{
    Console.WriteLine("___________________");
    switch (response.Action)
    {
        case NextResponseAction.Apply:
            Block? applyBlock = response.AppliedBlock;
            if (applyBlock is not null)
            {
                Console.WriteLine($"Apply Block: {applyBlock.Hash} Slot: {applyBlock.Slot}");
                Console.WriteLine($"Cbor: {Convert.ToHexString(applyBlock.NativeBytes ?? [])}");
            }
            break;
        case NextResponseAction.Undo:
            Block? undoBlock = response.UndoneBlock;
            if (undoBlock is not null)
            {
                Console.WriteLine($"Undo Block: {undoBlock.Hash} Slot: {undoBlock.Slot}");
            }
            break;
        case NextResponseAction.Reset:
            BlockRef? resetRef = response.ResetRef;
            if (resetRef is not null)
            {
                Console.WriteLine($"Reset to Block: {resetRef.Hash} Slot: {resetRef.Index}");
            }
            break;
    }
    Console.WriteLine("___________________");
}
```

### Response
#### Success Response
An asynchronous stream of `NextResponse` objects, which can be `Apply`, `Undo`, or `Reset` actions.

#### Response Example
```json
{
  "action": "Apply",
  "appliedBlock": {
    "hash": "00000000000000000005d8e11f74347c1b5e1a1a1a1a1a1a1a1a1a1a1a1a1a1a",
    "slot": 58717901,
    "index": 1,
    "nativeBytes": "..."
  }
}
```

### Error Handling
None specified.
```

--------------------------------

### List Services on Local Cardano Node API

Source: https://utxorpc.org/grpcurl

Lists all available gRPC services on a local Cardano Node API running on port 9090.

```bash
grpcurl -plaintext localhost:9090 list
```

--------------------------------

### Follow Blockchain Tip Updates

Source: https://utxorpc.org/dotnet

Use FollowTipAsync to receive real-time blockchain updates. This method handles block applications, undo operations, and resets.

```csharp
using Utxorpc.Sdk.Models;
using Utxorpc.Sdk.Models.Enums;

await foreach (NextResponse? response in client.FollowTipAsync(
    new BlockRef
    (
        "b977e548f3364b114505f3311a10f89e5f5cf47e815765bce6750a5de48e5951",
        58717900
    )))
{
    Console.WriteLine("___________________");
    switch (response.Action)
    {
        case NextResponseAction.Apply:
            Block? applyBlock = response.AppliedBlock;
            if (applyBlock is not null)
            {
                Console.WriteLine($"Apply Block: {applyBlock.Hash} Slot: {applyBlock.Slot}");
                Console.WriteLine($"Cbor: {Convert.ToHexString(applyBlock.NativeBytes ?? [])}");
            }
            break;
        case NextResponseAction.Undo:
            Block? undoBlock = response.UndoneBlock;
            if (undoBlock is not null)
            {
                Console.WriteLine($"Undo Block: {undoBlock.Hash} Slot: {undoBlock.Slot}");
            }
            break;
        case NextResponseAction.Reset:
            BlockRef? resetRef = response.ResetRef;
            if (resetRef is not null)
            {
                Console.WriteLine($"Reset to Block: {resetRef.Hash} Slot: {resetRef.Index}");
            }
            break;
    }
    Console.WriteLine("___________________");
}
```

--------------------------------

### Create Wallet from Mnemonic

Source: https://utxorpc.org/blaze

Generate a hot wallet instance from a 24-word mnemonic phrase. This involves converting the mnemonic to entropy and then deriving a master key.

```typescript
const mnemonic = "your 24-word mnemonic here";
const entropy = mnemonicToEntropy(mnemonic, wordlist);
const masterkey = Bip32PrivateKey.fromBip39Entropy(Buffer.from(entropy), "");
const wallet = await HotWallet.fromMasterkey(masterkey.hex(), provider);
```

--------------------------------

### Execute a Streaming gRPC Method with Grpcurl

Source: https://utxorpc.org/grpcurl

Execute a streaming gRPC method and observe real-time responses. This is useful for services that continuously send data.

```bash
grpcurl -plaintext localhost:50051 utxorpc.v1alpha.sync.SyncService.FollowTip
```

--------------------------------

### Describe U5C FetchBlockRequest Message

Source: https://utxorpc.org/grpcurl

Shows the structure and fields of the FetchBlockRequest message used by the SyncService.

```bash
grpcurl -plaintext localhost:50051 describe utxorpc.v1alpha.sync.FetchBlockRequest
```

--------------------------------

### List Services on Local Dolos Node

Source: https://utxorpc.org/grpcurl

Lists all available gRPC services on a local Dolos node running on the default port.

```bash
grpcurl -plaintext localhost:50051 list
```

--------------------------------

### Watch Transactions by Address Delegation Part

Source: https://utxorpc.org/watch/intro

Use this command to watch transactions by only the stake credential (delegation part) of an address. This helps find all UTxOs delegated to a specific stake key. The delegation part must be base64 encoded.

```grpcurl
grpcurl -plaintext \
  -d '{
    "predicate": {
      "match": {
        "cardano": {
          "has_address": {
            "delegation_part": "p4WAOb31UfCR2qsqVlBLiUrsVwZoGPVOmYOjavDuEPs="
          }
        }
      }
    }
  }' \
  localhost:50051 \
  utxorpc.v1alpha.watch.WatchService.WatchTx
```

--------------------------------

### FetchBlock

Source: https://utxorpc.org/playground?method=FetchBlock&service=utxorpc.v1alpha.sync.SyncService

Fetches a block by its reference using the SyncService.

```APIDOC
## FetchBlock FetchBlockRequest FetchBlockResponse

### Description
Fetches a block by its reference.

### Method
FetchBlock

### Endpoint
utxorpc.v1alpha.sync.SyncService.FetchBlock

### Parameters
#### Request Body
- **ref** (repeated utxorpc.v1alpha.sync.BlockRef) - Required - The reference(s) to the block(s) to fetch.
- **field_mask** (google.protobuf.FieldMask) - Optional - A field mask to specify which fields of the block to return.
```

--------------------------------

### Read Current Blockchain Tip Information

Source: https://utxorpc.org/sync/intro

This command retrieves information about the current tip of the blockchain. Note: This operation is under development and may not be available.

```bash
grpcurl -plaintext \
  -d '{}' \
  localhost:50051 \
  utxorpc.v1alpha.sync.SyncService.ReadTip
```

--------------------------------

### FollowTip

Source: https://utxorpc.org/sync/spec

Follows the tip of the blockchain, providing actions to apply new blocks, undo blocks, or reset to a specific block reference.

```APIDOC
## FollowTip FollowTip

### Description
Follow the tip of the blockchain.

### Method
FollowTip

### Request Type
utxorpc.v1alpha.sync.FollowTipRequest

### Response Type
utxorpc.v1alpha.sync.FollowTipResponse stream

### Request Body
#### Request Body
- **intersect** (BlockRef) - repeated - List of block references to find the intersection.
- **field_mask** (google.protobuf.FieldMask) - Optional - Field mask to selectively return fields.

### Response
#### Success Response (200)
- **apply** (AnyChainBlock) - Optional - Apply this block.
- **undo** (AnyChainBlock) - Optional - Undo this block.
- **reset** (BlockRef) - Optional - Reset to this block reference.

```

--------------------------------

### ReadTip RPC Method

Source: https://utxorpc.org/playground?method=ReadTip&service=utxorpc.v1alpha.sync.SyncService

Reads the current tip of the blockchain using the SyncService.

```APIDOC
## ReadTip

### Description
Reads the current tip of the blockchain.

### Service
utxorpc.v1alpha.sync.SyncService

### Method
ReadTip

### Request Type
utxorpc.v1alpha.sync.ReadTipRequest

### Response Type
utxorpc.v1alpha.sync.ReadTipResponse

### gRPCurl Example
```
grpcurl -plaintext -d '[object Object]' internal-cardano-mainnet-grpc.ext-utxorpc-m1.svc.cluster.local:50051 utxorpc.v1alpha.sync.SyncService.ReadTip
```
```

--------------------------------

### Execute FetchBlock Request

Source: https://utxorpc.org/grpcurl

Fetches a specific block using its index and hash via the FetchBlock method. The block hash must be base64-encoded.

```bash
grpcurl -plaintext -d '{"ref": [{"index": 61724995, "hash": "1eVsN7YMlpLBKAFCNjes+zcDa/fiEtQ5d1uP6cdtj/U="}]}' localhost:50051 utxorpc.v1alpha.sync.SyncService.FetchBlock
```

--------------------------------

### Retrieve Protocol Parameters

Source: https://utxorpc.org/query/intro

Fetches the current protocol parameters for the chain. This includes essential consensus settings like fees and epoch information. Ensure the UTXO RPC node is accessible.

```bash
grpcurl -plaintext \
  localhost:50051 \
  utxorpc.v1alpha.query.QueryService.ReadParams
```

--------------------------------

### Print Wallet Balance

Source: https://utxorpc.org/blaze

Retrieve and log the current balance of the wallet to the console in its core representation.

```typescript
console.log("Wallet balance", (await wallet.getBalance()).toCore());
```

--------------------------------

### FollowTip RPC

Source: https://utxorpc.org/playground?method=FollowTip&service=utxorpc.v1alpha.sync.SyncService

The FollowTip RPC streams updates as the blockchain tip advances. It takes a FollowTipRequest and returns a stream of FollowTipResponse.

```APIDOC
## FollowTip RPC

### Description
Follow the tip of the blockchain. This RPC streams updates as the blockchain tip advances.

### Service
utxorpc.v1alpha.sync.SyncService

### Method
FollowTip

### Request Type
utxorpc.v1alpha.sync.FollowTipRequest

### Response Type
stream utxorpc.v1alpha.sync.FollowTipResponse

### Request Parameters
#### Request Body
- **intersect** (repeated utxorpc.v1alpha.sync.BlockRef) - Optional - A list of block references to intersect with. The stream will start from the first block in the chain that matches one of these references.
- **field_mask** (google.protobuf.FieldMask) - Optional - A field mask to specify which fields of the FollowTipResponse should be returned.
```

--------------------------------

### SearchUtxos

Source: https://utxorpc.org/query/spec

Searches for UTxOs based on a provided pattern.

```APIDOC
## SearchUtxos

### Description
Search for UTxO based on a pattern.

### Method
SearchUtxos

### Request Type
SearchUtxosRequest

### Response Type
SearchUtxosResponse
```

--------------------------------

### WatchTx Service Definition

Source: https://utxorpc.org/playground?method=WatchTx&service=utxorpc.v1alpha.watch.WatchService

Defines the WatchTx RPC method for the WatchService, enabling streaming of transactions based on predicates.

```proto
service WatchService {
   rpc WatchTx ( WatchTxRequest ) returns ( stream WatchTxResponse ); // Stream transactions from the chain matching the specified predicates.

```
Tokens:
Raw