Query

AnyChainDatum

An evenlope that holds a datum for any of the compatible chains

Field	Type	Description
key	bytes
native_bytes	bytes	An opaque bytestring corresponding to native representation in the source chain.
cardano	utxorpc.v1alpha.cardano.PlutusData	A cardano UTxO

AnyChainParams

An evenlope that holds parameter data from any of the compatible chains

Field	Type	Label	Description
cardano	utxorpc.v1alpha.cardano.PParams		Cardano parameters

AnyUtxoData

An evenlope that holds an UTxO from any of compatible chains

Field	Type	Description
txo_ref	TxoRef	Hash of the previous transaction.
native_bytes	bytes	An opaque bytestring corresponding to native representation in the source chain.
cardano	utxorpc.v1alpha.cardano.TxOutput	A cardano UTxO

AnyUtxoPattern

An evenlope that holds an UTxO patterns from any of compatible chains

Field	Type	Label	Description
cardano	utxorpc.v1alpha.cardano.TxOutputPattern

ChainPoint

Represents a specific point in the blockchain.

Field	Type	Label	Description
slot	uint64		Slot number.
hash	bytes		Block hash.

ReadDataRequest

Request to get data (as in plural of datum)

Field	Type	Label	Description
keys	bytes	repeated
field_mask	google.protobuf.FieldMask		Field mask to selectively return fields in the response.

ReadDataResponse

Response containing data (as in plural of datum)

Field	Type	Label	Description
values	AnyChainDatum	repeated	The value of each datum.
ledger_tip	ChainPoint		The chain point that represent the ledger current position.

ReadParamsRequest

Request to get the chain parameters

Field	Type	Label	Description
field_mask	google.protobuf.FieldMask		Field mask to selectively return fields in the parsed response.

ReadParamsResponse

Response containing the chain parameters

Field	Type	Label	Description
values	AnyChainParams		The value of the parameters.
ledger_tip	ChainPoint		The chain point that represent the ledger current position.

ReadUtxosRequest

Request to get specific UTxOs

Field	Type	Label	Description
keys	TxoRef	repeated	List of keys UTxOs.
field_mask	google.protobuf.FieldMask		Field mask to selectively return fields.

ReadUtxosResponse

Response containing the UTxOs associated with the requested addresses.

Field	Type	Label	Description
items	AnyUtxoData	repeated	List of UTxOs.
ledger_tip	ChainPoint		The chain point that represent the ledger current position.

SearchUtxosRequest

Reques to search for UTxO based on a pattern.

Field	Type	Label	Description
predicate	UtxoPredicate		Pattern to match UTxOs by.
field_mask	google.protobuf.FieldMask		Field mask to selectively return fields.

SearchUtxosResponse

Response containing the UTxOs that match the requested addresses.

Field	Type	Label	Description
items	AnyUtxoData	repeated	List of UTxOs.
ledger_tip	ChainPoint		The chain point that represent the ledger current position.

TxoRef

Represents a reference to a transaction output

Field	Type	Label	Description
hash	bytes		Tx hash.
index	uint32		Output index.

UtxoPredicate

Represents a simple utxo predicate that can composed to create more complex ones

Field	Type	Label	Description
match	AnyUtxoPattern		Predicate is true if tx exhibits pattern.
not	UtxoPredicate	repeated	Predicate is true if tx doesn't exhibit pattern.
all_of	UtxoPredicate	repeated	Predicate is true if utxo exhibits all of the patterns.
any_of	UtxoPredicate	repeated	Predicate is true if utxo exhibits any of the patterns.

QueryService

Service definition for querying the state of the chain.

Method Name	Request Type	Response Type	Description
ReadParams	ReadParamsRequest	ReadParamsResponse	Get overall chain state.
ReadUtxos	ReadUtxosRequest	ReadUtxosResponse	Read specific UTxOs by reference.
SearchUtxos	SearchUtxosRequest	SearchUtxosResponse	Search for UTxO based on a pattern.
ReadData	ReadDataRequest	ReadDataResponse	Read specific datum by hash

Intro Intro