https://utxorpc.org/_next/static/chunks/pages/query/spec-5012afbc97b8aa1f.js

1(self.webpackChunk_N_E=self.webpackChunk_N_E||[]).push([[2806],{370:function(e,t,r){(window.__NEXT_P=window.__NEXT_P||[]).push(["/query/spec",function(){return r(5231)}])},5231:function(e,t,r){"use strict";r.r(t),r.d(t,{__toc:function(){return h}});var s=r(5893),n=r(2673),d=r(7913),a=r(2702);r(9128);var i=r(2643);let h=[{depth:3,value:"AnyChainDatum",id:"anychaindatum"},{depth:3,value:"AnyChainParams",id:"anychainparams"},{depth:3,value:"AnyUtxoData",id:"anyutxodata"},{depth:3,value:"AnyUtxoPattern",id:"anyutxopattern"},{depth:3,value:"ChainPoint",id:"chainpoint"},{depth:3,value:"ReadDataRequest",id:"readdatarequest"},{depth:3,value:"ReadDataResponse",id:"readdataresponse"},{depth:3,value:"ReadParamsRequest",id:"readparamsrequest"},{depth:3,value:"ReadParamsResponse",id:"readparamsresponse"},{depth:3,value:"ReadUtxosRequest",id:"readutxosrequest"},{depth:3,value:"ReadUtxosResponse",id:"readutxosresponse"},{depth:3,value:"SearchUtxosRequest",id:"searchutxosrequest"},{depth:3,value:"SearchUtxosResponse",id:"searchutxosresponse"},{depth:3,value:"TxoRef",id:"txoref"},{depth:3,value:"UtxoPredicate",id:"utxopredicate"},{depth:3,value:"QueryService",id:"queryservice"}];function _createMdxContent(e){let t=Object.assign({h1:"h1",h3:"h3",p:"p",table:"table",thead:"thead",tr:"tr",th:"th",tbody:"tbody",td:"td",a:"a"},(0,i.a)(),e.components);return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{children:"Query"}),"\n",(0,s.jsx)("a",{name:"utxorpc-v1alpha-query-AnyChainDatum"}),"\n",(0,s.jsx)(t.h3,{id:"anychaindatum",children:"AnyChainDatum"}),"\n",(0,s.jsx)(t.p,{children:"An evenlope that holds a datum for any of the compatible chains"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Field"}),(0,s.jsx)(t.th,{children:"Type"}),(0,s.jsx)(t.th,{children:"Label"}),(0,s.jsx)(t.th,{children:"Description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"native_bytes"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#bytes",children:"bytes"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"Original bytes as defined by the chain"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"key"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#bytes",children:"bytes"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"cardano"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-cardano-PlutusData",children:"utxorpc.v1alpha.cardano.PlutusData"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"A cardano UTxO"})]})]})]}),"\n",(0,s.jsx)("a",{name:"utxorpc-v1alpha-query-AnyChainParams"}),"\n",(0,s.jsx)(t.h3,{id:"anychainparams",children:"AnyChainParams"}),"\n",(0,s.jsx)(t.p,{children:"An evenlope that holds parameter data from any of the compatible chains"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Field"}),(0,s.jsx)(t.th,{children:"Type"}),(0,s.jsx)(t.th,{children:"Label"}),(0,s.jsx)(t.th,{children:"Description"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"cardano"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-cardano-PParams",children:"utxorpc.v1alpha.cardano.PParams"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"Cardano parameters"})]})})]}),"\n",(0,s.jsx)("a",{name:"utxorpc-v1alpha-query-AnyUtxoData"}),"\n",(0,s.jsx)(t.h3,{id:"anyutxodata",children:"AnyUtxoData"}),"\n",(0,s.jsx)(t.p,{children:"An evenlope that holds an UTxO from any of compatible chains"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Field"}),(0,s.jsx)(t.th,{children:"Type"}),(0,s.jsx)(t.th,{children:"Label"}),(0,s.jsx)(t.th,{children:"Description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"native_bytes"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#bytes",children:"bytes"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"Original bytes as defined by the chain"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"txo_ref"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-TxoRef",children:"TxoRef"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"Hash of the previous transaction."})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"cardano"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-cardano-TxOutput",children:"utxorpc.v1alpha.cardano.TxOutput"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"A cardano UTxO"})]})]})]}),"\n",(0,s.jsx)("a",{name:"utxorpc-v1alpha-query-AnyUtxoPattern"}),"\n",(0,s.jsx)(t.h3,{id:"anyutxopattern",children:"AnyUtxoPattern"}),"\n",(0,s.jsx)(t.p,{children:"An evenlope that holds an UTxO patterns from any of compatible chains"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Field"}),(0,s.jsx)(t.th,{children:"Type"}),(0,s.jsx)(t.th,{children:"Label"}),(0,s.jsx)(t.th,{children:"Description"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"cardano"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-cardano-TxOutputPattern",children:"utxorpc.v1alpha.cardano.TxOutputPattern"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{})]})})]}),"\n",(0,s.jsx)("a",{name:"utxorpc-v1alpha-query-ChainPoint"}),"\n",(0,s.jsx)(t.h3,{id:"chainpoint",children:"ChainPoint"}),"\n",(0,s.jsx)(t.p,{children:"Represents a specific point in the blockchain."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Field"}),(0,s.jsx)(t.th,{children:"Type"}),(0,s.jsx)(t.th,{children:"Label"}),(0,s.jsx)(t.th,{children:"Description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"slot"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#uint64",children:"uint64"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"Slot number."})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"hash"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#bytes",children:"bytes"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"Block hash."})]})]})]}),"\n",(0,s.jsx)("a",{name:"utxorpc-v1alpha-query-ReadDataRequest"}),"\n",(0,s.jsx)(t.h3,{id:"readdatarequest",children:"ReadDataRequest"}),"\n",(0,s.jsx)(t.p,{children:"Request to get data (as in plural of datum)"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Field"}),(0,s.jsx)(t.th,{children:"Type"}),(0,s.jsx)(t.th,{children:"Label"}),(0,s.jsx)(t.th,{children:"Description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"keys"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#bytes",children:"bytes"})}),(0,s.jsx)(t.td,{children:"repeated"}),(0,s.jsx)(t.td,{})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"field_mask"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#google-protobuf-FieldMask",children:"google.protobuf.FieldMask"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"Field mask to selectively return fields in the response."})]})]})]}),"\n",(0,s.jsx)("a",{name:"utxorpc-v1alpha-query-ReadDataResponse"}),"\n",(0,s.jsx)(t.h3,{id:"readdataresponse",children:"ReadDataResponse"}),"\n",(0,s.jsx)(t.p,{children:"Response containing data (as in plural of datum)"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Field"}),(0,s.jsx)(t.th,{children:"Type"}),(0,s.jsx)(t.th,{children:"Label"}),(0,s.jsx)(t.th,{children:"Description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"values"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-AnyChainDatum",children:"AnyChainDatum"})}),(0,s.jsx)(t.td,{children:"repeated"}),(0,s.jsx)(t.td,{children:"The value of each datum."})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"ledger_tip"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-ChainPoint",children:"ChainPoint"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"The chain point that represent the ledger current position."})]})]})]}),"\n",(0,s.jsx)("a",{name:"utxorpc-v1alpha-query-ReadParamsRequest"}),"\n",(0,s.jsx)(t.h3,{id:"readparamsrequest",children:"ReadParamsRequest"}),"\n",(0,s.jsx)(t.p,{children:"Request to get the chain parameters"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Field"}),(0,s.jsx)(t.th,{children:"Type"}),(0,s.jsx)(t.th,{children:"Label"}),(0,s.jsx)(t.th,{children:"Description"})]})}),(0,s.jsx)(t.tbody,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"field_mask"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#google-protobuf-FieldMask",children:"google.protobuf.FieldMask"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"Field mask to selectively return fields in the parsed response."})]})})]}),"\n",(0,s.jsx)("a",{name:"utxorpc-v1alpha-query-ReadParamsResponse"}),"\n",(0,s.jsx)(t.h3,{id:"readparamsresponse",children:"ReadParamsResponse"}),"\n",(0,s.jsx)(t.p,{children:"Response containing the chain parameters"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Field"}),(0,s.jsx)(t.th,{children:"Type"}),(0,s.jsx)(t.th,{children:"Label"}),(0,s.jsx)(t.th,{children:"Description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"values"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-AnyChainParams",children:"AnyChainParams"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"The value of the parameters."})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"ledger_tip"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-ChainPoint",children:"ChainPoint"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"The chain point that represent the ledger current position."})]})]})]}),"\n",(0,s.jsx)("a",{name:"utxorpc-v1alpha-query-ReadUtxosRequest"}),"\n",(0,s.jsx)(t.h3,{id:"readutxosrequest",children:"ReadUtxosRequest"}),"\n",(0,s.jsx)(t.p,{children:"Request to get specific UTxOs"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Field"}),(0,s.jsx)(t.th,{children:"Type"}),(0,s.jsx)(t.th,{children:"Label"}),(0,s.jsx)(t.th,{children:"Description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"keys"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-TxoRef",children:"TxoRef"})}),(0,s.jsx)(t.td,{children:"repeated"}),(0,s.jsx)(t.td,{children:"List of keys UTxOs."})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"field_mask"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#google-protobuf-FieldMask",children:"google.protobuf.FieldMask"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"Field mask to selectively return fields."})]})]})]}),"\n",(0,s.jsx)("a",{name:"utxorpc-v1alpha-query-ReadUtxosResponse"}),"\n",(0,s.jsx)(t.h3,{id:"readutxosresponse",children:"ReadUtxosResponse"}),"\n",(0,s.jsx)(t.p,{children:"Response containing the UTxOs associated with the requested addresses."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Field"}),(0,s.jsx)(t.th,{children:"Type"}),(0,s.jsx)(t.th,{children:"Label"}),(0,s.jsx)(t.th,{children:"Description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"items"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-AnyUtxoData",children:"AnyUtxoData"})}),(0,s.jsx)(t.td,{children:"repeated"}),(0,s.jsx)(t.td,{children:"List of UTxOs."})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"ledger_tip"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-ChainPoint",children:"ChainPoint"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"The chain point that represent the ledger current position."})]})]})]}),"\n",(0,s.jsx)("a",{name:"utxorpc-v1alpha-query-SearchUtxosRequest"}),"\n",(0,s.jsx)(t.h3,{id:"searchutxosrequest",children:"SearchUtxosRequest"}),"\n",(0,s.jsx)(t.p,{children:"Request to search for UTxO based on a pattern."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Field"}),(0,s.jsx)(t.th,{children:"Type"}),(0,s.jsx)(t.th,{children:"Label"}),(0,s.jsx)(t.th,{children:"Description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"predicate"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-UtxoPredicate",children:"UtxoPredicate"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"Pattern to match UTxOs by."})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"field_mask"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#google-protobuf-FieldMask",children:"google.protobuf.FieldMask"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"Field mask to selectively return fields."})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"max_items"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#int32",children:"int32"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"The maximum number of items to return."})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"start_token"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#string",children:"string"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"The next_page_token value returned from a previous request, if any."})]})]})]}),"\n",(0,s.jsx)("a",{name:"utxorpc-v1alpha-query-SearchUtxosResponse"}),"\n",(0,s.jsx)(t.h3,{id:"searchutxosresponse",children:"SearchUtxosResponse"}),"\n",(0,s.jsx)(t.p,{children:"Response containing the UTxOs that match the requested addresses."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Field"}),(0,s.jsx)(t.th,{children:"Type"}),(0,s.jsx)(t.th,{children:"Label"}),(0,s.jsx)(t.th,{children:"Description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"items"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-AnyUtxoData",children:"AnyUtxoData"})}),(0,s.jsx)(t.td,{children:"repeated"}),(0,s.jsx)(t.td,{children:"List of UTxOs."})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"ledger_tip"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-ChainPoint",children:"ChainPoint"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"The chain point that represent the ledger current position."})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"next_token"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#string",children:"string"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"Token to retrieve the next page of results, or empty if there are no more results."})]})]})]}),"\n",(0,s.jsx)("a",{name:"utxorpc-v1alpha-query-TxoRef"}),"\n",(0,s.jsx)(t.h3,{id:"txoref",children:"TxoRef"}),"\n",(0,s.jsx)(t.p,{children:"Represents a reference to a transaction output"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Field"}),(0,s.jsx)(t.th,{children:"Type"}),(0,s.jsx)(t.th,{children:"Label"}),(0,s.jsx)(t.th,{children:"Description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"hash"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#bytes",children:"bytes"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"Tx hash."})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"index"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#uint32",children:"uint32"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"Output index."})]})]})]}),"\n",(0,s.jsx)("a",{name:"utxorpc-v1alpha-query-UtxoPredicate"}),"\n",(0,s.jsx)(t.h3,{id:"utxopredicate",children:"UtxoPredicate"}),"\n",(0,s.jsx)(t.p,{children:"Represents a simple utxo predicate that can composed to create more complex ones"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Field"}),(0,s.jsx)(t.th,{children:"Type"}),(0,s.jsx)(t.th,{children:"Label"}),(0,s.jsx)(t.th,{children:"D

1escription"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"match"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-AnyUtxoPattern",children:"AnyUtxoPattern"})}),(0,s.jsx)(t.td,{}),(0,s.jsx)(t.td,{children:"Predicate is true if tx exhibits pattern."})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"not"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-UtxoPredicate",children:"UtxoPredicate"})}),(0,s.jsx)(t.td,{children:"repeated"}),(0,s.jsx)(t.td,{children:"Predicate is true if tx doesn't exhibit pattern."})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"all_of"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-UtxoPredicate",children:"UtxoPredicate"})}),(0,s.jsx)(t.td,{children:"repeated"}),(0,s.jsx)(t.td,{children:"Predicate is true if utxo exhibits all of the patterns."})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"any_of"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-UtxoPredicate",children:"UtxoPredicate"})}),(0,s.jsx)(t.td,{children:"repeated"}),(0,s.jsx)(t.td,{children:"Predicate is true if utxo exhibits any of the patterns."})]})]})]}),"\n",(0,s.jsx)("a",{name:"utxorpc-v1alpha-query-QueryService"}),"\n",(0,s.jsx)(t.h3,{id:"queryservice",children:"QueryService"}),"\n",(0,s.jsx)(t.p,{children:"Service definition for querying the state of the chain."}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Method Name"}),(0,s.jsx)(t.th,{children:"Request Type"}),(0,s.jsx)(t.th,{children:"Response Type"}),(0,s.jsx)(t.th,{children:"Description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"ReadParams"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-ReadParamsRequest",children:"ReadParamsRequest"})}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-ReadParamsResponse",children:"ReadParamsResponse"})}),(0,s.jsx)(t.td,{children:"Get overall chain state."})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"ReadUtxos"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-ReadUtxosRequest",children:"ReadUtxosRequest"})}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-ReadUtxosResponse",children:"ReadUtxosResponse"})}),(0,s.jsx)(t.td,{children:"Read specific UTxOs by reference."})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"SearchUtxos"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-SearchUtxosRequest",children:"SearchUtxosRequest"})}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-SearchUtxosResponse",children:"SearchUtxosResponse"})}),(0,s.jsx)(t.td,{children:"Search for UTxO based on a pattern."})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.td,{children:"ReadData"}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-ReadDataRequest",children:"ReadDataRequest"})}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.a,{href:"#utxorpc-v1alpha-query-ReadDataResponse",children:"ReadDataResponse"})}),(0,s.jsx)(t.td,{children:"Read specific datum by hash"})]})]})]})]})}let c={MDXContent:function(){let e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{},{wrapper:t}=Object.assign({},(0,i.a)(),e.components);return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(_createMdxContent,{...e})}):_createMdxContent(e)},pageOpts:{filePath:"pages/query/spec.mdx",route:"/query/spec",timestamp:1731511917e3,pageMap:[{kind:"Meta",data:{index:{title:"UTxO RPC",type:"page",display:"hidden",theme:{layout:"full"}},"-- Basics --":{type:"separator",title:"About"},introduction:"Introduction","-- Modules --":{type:"separator",title:"Specification"},query:"Query Module",submit:"Submit Module",sync:"Sync Module",watch:"Watch Module",playground:{display:"hidden",title:"Playground"},"-- Ledgers --":{type:"separator",title:"Ledgers"},cardano:"Cardano Module",bitcoin:"Bitcoin Module","-- SDK --":{type:"separator",title:"SDK"},rust:"Rust",python:"Python",go:"Go",nodejs:"NodeJS",deno:"Deno",dotnet:".NET","-- Ecosystem --":{type:"separator",title:"Ecosystem"},servers:"Servers",clients:"Clients",teams:"Teams","-- Guides --":{type:"separator",title:"Guides"},grpcurl:"Using grpcurl",blaze:"Blaze Provider"}},{kind:"MdxPage",name:"bitcoin",route:"/bitcoin"},{kind:"MdxPage",name:"blaze",route:"/blaze"},{kind:"MdxPage",name:"cardano",route:"/cardano"},{kind:"MdxPage",name:"clients",route:"/clients"},{kind:"MdxPage",name:"deno",route:"/deno"},{kind:"MdxPage",name:"dotnet",route:"/dotnet"},{kind:"MdxPage",name:"go",route:"/go"},{kind:"MdxPage",name:"grpcurl",route:"/grpcurl"},{kind:"MdxPage",name:"index",route:"/"},{kind:"MdxPage",name:"introduction",route:"/introduction"},{kind:"MdxPage",name:"nodejs",route:"/nodejs"},{kind:"MdxPage",name:"playground",route:"/playground"},{kind:"MdxPage",name:"python",route:"/python"},{kind:"Folder",name:"query",route:"/query",children:[{kind:"MdxPage",name:"intro",route:"/query/intro"},{kind:"MdxPage",name:"spec",route:"/query/spec"},{kind:"Meta",data:{intro:"Intro",spec:"Spec"}}]},{kind:"MdxPage",name:"rust",route:"/rust"},{kind:"MdxPage",name:"servers",route:"/servers"},{kind:"Folder",name:"submit",route:"/submit",children:[{kind:"MdxPage",name:"intro",route:"/submit/intro"},{kind:"MdxPage",name:"spec",route:"/submit/spec"},{kind:"Meta",data:{intro:"Intro",spec:"Spec"}}]},{kind:"Folder",name:"sync",route:"/sync",children:[{kind:"MdxPage",name:"intro",route:"/sync/intro"},{kind:"MdxPage",name:"spec",route:"/sync/spec"},{kind:"Meta",data:{intro:"Intro",spec:"Spec"}}]},{kind:"MdxPage",name:"teams",route:"/teams"},{kind:"Folder",name:"watch",route:"/watch",children:[{kind:"MdxPage",name:"intro",route:"/watch/intro"},{kind:"MdxPage",name:"spec",route:"/watch/spec"},{kind:"Meta",data:{intro:"Intro",spec:"Spec"}}]}],flexsearch:{codeblocks:!0},title:"Query",headings:h},pageNextRoute:"/query/spec",nextraLayout:d.ZP,themeConfig:a.Z};t.default=(0,n.j)(c)},2702:function(e,t,r){"use strict";var s=r(5893);t.Z={logo:(0,s.jsx)("img",{style:{height:"30px"},src:"/logo-dark.svg"}),navbar:{extraContent:(0,s.jsxs)("div",{className:"flex items-center nx-gap-2",style:{marginLeft:"4px"},children:[(0,s.jsxs)("a",{href:"/playground",rel:"noopener noreferrer",className:"nx-text-current bg-gradient-to-tl text-sm from-emerald-600 to-cyan-600 hover:from-emerald-300 hover:to-cyan-500 font-medium flex items-center justify-between gap-2",style:{padding:"6px 12px",lineHeight:1.25,borderRadius:"6px"},children:[(0,s.jsx)("span",{children:"Playground"}),(0,s.jsx)("img",{style:{height:"21.5px"},src:"/playground.svg"})]}),(0,s.jsxs)("div",{className:"flex items-center",style:{gap:"4px"},children:[(0,s.jsx)("a",{href:"https://github.com/utxorpc",target:"_blank",rel:"noopener noreferrer",className:"nx-p-1 nx-text-current",children:(0,s.jsx)("svg",{width:"24",height:"24",fill:"

1currentColor",viewBox:"0 0 24 24",children:(0,s.jsx)("path",{d:"M12 0c-6.626 0-12 5.373-12 12 0 5.302 3.438 9.8 8.207 11.387.599.111.793-.261.793-.577v-2.234c-3.338.726-4.033-1.416-4.033-1.416-.546-1.387-1.333-1.756-1.333-1.756-1.089-.745.083-.729.083-.729 1.205.084 1.839 1.237 1.839 1.237 1.07 1.834 2.807 1.304 3.492.997.107-.775.418-1.305.762-1.604-2.665-.305-5.467-1.334-5.467-5.931 0-1.311.469-2.381 1.236-3.221-.124-.303-.535-1.524.117-3.176 0 0 1.008-.322 3.301 1.23.957-.266 1.983-.399 3.003-.404 1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576 4.765-1.589 8.199-6.086 8.199-11.386 0-6.627-5.373-12-12-12z"})})}),(0,s.jsx)("a",{href:"https://discord.gg/Vc3x8N9nz2",target:"_blank",rel:"noopener noreferrer",className:"nx-p-1 nx-text-current",children:(0,s.jsx)("svg",{width:"24",height:"24",fill:"currentColor",viewBox:"0 0 24 24",children:(0,s.jsx)("path",{d:"M20.317 4.369a19.791 19.791 0 0 0-4.885-1.515.074.074 0 0 0-.079.037c-.21.375-.444.864-.608 1.25a18.27 18.27 0 0 0-5.487 0 12.64 12.64 0 0 0-.617-1.25.077.077 0 0 0-.079-.037A19.736 19.736 0 0 0 3.677 4.37.07.07 0 0 0 3.647 4.4C.533 9.046-.32 13.58.099 17.961a.082.082 0 0 0 .031.057 19.9 19.9 0 0 0 5.993 3.03.078.078 0 0 0 .084-.028c.462-.63.874-1.295 1.226-1.994a.076.076 0 0 0-.041-.106 13.107 13.107 0 0 1-1.872-.892.077.077 0 0 1-.008-.128 10.2 10.2 0 0 0 .372-.292.074.074 0 0 1 .077-.01c3.928 1.793 8.18 1.793 12.062 0a.074.074 0 0 1 .078.01c.12.098.246.198.373.292a.077.077 0 0 1-.006.127 12.299 12.299 0 0 1-1.873.892.077.077 0 0 0-.041.107c.36.698.772 1.362 1.225 1.993a.076.076 0 0 0 .084.028 19.839 19.839 0 0 0 6.002-3.03.077.077 0 0 0 .032-.054c.5-5.177-.838-9.674-3.549-13.66a.061.061 0 0 0-.031-.03zM8.02 15.33c-1.183 0-2.157-1.085-2.157-2.419 0-1.333.956-2.419 2.157-2.419 1.21 0 2.176 1.096 2.157 2.42 0 1.333-.956 2.418-2.157 2.418zm7.975 0c-1.183 0-2.157-1.085-2.157-2.419 0-1.333.955-2.419 2.157-2.419 1.21 0 2.176 1.096 2.157 2.42 0 1.333-.946 2.418-2.157 2.418z"})})})]})]})},sidebar:{defaultMenuCollapseLevel:1},head:(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("link",{rel:"icon",type:"image/x-icon",href:"/favicon.ico"}),(0,s.jsx)("meta",{name:"twitter:card",content:"summary_large_image"})]}),docsRepositoryBase:"https://github.com/utxorpc/docs/blob/main",useNextSeoProps:()=>({titleTemplate:"%s – UTxO RPC",description:"gRPC interface for UTxO blockchains",canonical:"https://utxorpc.org",siteName:"UTxO RPC",openGraph:{url:"https://utxorpc.org",title:"UTxO RPC",description:"gRPC interface for UTxO blockchains",images:[{url:"https://utxorpc.org/og-image.png",width:761,height:508,alt:"UTxO RPC",type:"image/png"}]},twitter:{site:"@utxorpc",card:"summary_large_image"}}),footer:{text:"UTxO RPC"},primaryHue:178,darkMode:!1}},5789:function(){}},function(e){e.O(0,[4543,9774,2888,179],function(){return e(e.s=370)}),_N_E=e.O()}]);