Documentation
¶
Index ¶
- Constants
- func NewIndexerHandler(svc IndexerHandler, opts ...connect.HandlerOption) (string, http.Handler)
- type IndexerClient
- type IndexerHandler
- type UnimplementedIndexerHandler
- func (UnimplementedIndexerHandler) GetVirtualDurableNonce(context.Context, *connect.Request[v1.GetVirtualDurableNonceRequest]) (*connect.Response[v1.GetVirtualDurableNonceResponse], error)
- func (UnimplementedIndexerHandler) GetVirtualTimelockAccounts(context.Context, *connect.Request[v1.GetVirtualTimelockAccountsRequest]) (*connect.Response[v1.GetVirtualTimelockAccountsResponse], error)
- func (UnimplementedIndexerHandler) SearchVirtualTimelockAccounts(context.Context, *connect.Request[v1.SearchVirtualTimelockAccountsRequest]) (*connect.Response[v1.SearchVirtualTimelockAccountsResponse], error)
Constants ¶
const ( // IndexerGetVirtualTimelockAccountsProcedure is the fully-qualified name of the Indexer's // GetVirtualTimelockAccounts RPC. IndexerGetVirtualTimelockAccountsProcedure = "/code.vm.v1.Indexer/GetVirtualTimelockAccounts" // IndexerGetVirtualDurableNonceProcedure is the fully-qualified name of the Indexer's // GetVirtualDurableNonce RPC. IndexerGetVirtualDurableNonceProcedure = "/code.vm.v1.Indexer/GetVirtualDurableNonce" // IndexerSearchVirtualTimelockAccountsProcedure is the fully-qualified name of the Indexer's // SearchVirtualTimelockAccounts RPC. IndexerSearchVirtualTimelockAccountsProcedure = "/code.vm.v1.Indexer/SearchVirtualTimelockAccounts" )
These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the routes on ServeMux.
Note that these are different from the fully-qualified method names used by google.golang.org/grpc/reflection. To convert from a Connect procedure to a gRPC method, remove the leading slash and convert the remaining slash to a period.
const (
// IndexerName is the fully-qualified name of the Indexer service.
IndexerName = "code.vm.v1.Indexer"
)
Variables ¶
This section is empty.
Functions ¶
func NewIndexerHandler ¶
func NewIndexerHandler(svc IndexerHandler, opts ...connect.HandlerOption) (string, http.Handler)
NewIndexerHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.
By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.
Types ¶
type IndexerClient ¶
type IndexerClient interface {
// GetVirtualTimelockAccounts gets all virtual Timelock accounts for a given owner address
GetVirtualTimelockAccounts(context.Context, *connect.Request[v1.GetVirtualTimelockAccountsRequest]) (*connect.Response[v1.GetVirtualTimelockAccountsResponse], error)
// GetVirtualDurableNonce gets a virtual durable nonce for a given address
GetVirtualDurableNonce(context.Context, *connect.Request[v1.GetVirtualDurableNonceRequest]) (*connect.Response[v1.GetVirtualDurableNonceResponse], error)
// SearchVirtualTimelockAccounts gets all virtual Timelock accounts across every VM the indexer is aware of
SearchVirtualTimelockAccounts(context.Context, *connect.Request[v1.SearchVirtualTimelockAccountsRequest]) (*connect.Response[v1.SearchVirtualTimelockAccountsResponse], error)
}
IndexerClient is a client for the code.vm.v1.Indexer service.
func NewIndexerClient ¶
func NewIndexerClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) IndexerClient
NewIndexerClient constructs a client for the code.vm.v1.Indexer service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.
The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).
type IndexerHandler ¶
type IndexerHandler interface {
// GetVirtualTimelockAccounts gets all virtual Timelock accounts for a given owner address
GetVirtualTimelockAccounts(context.Context, *connect.Request[v1.GetVirtualTimelockAccountsRequest]) (*connect.Response[v1.GetVirtualTimelockAccountsResponse], error)
// GetVirtualDurableNonce gets a virtual durable nonce for a given address
GetVirtualDurableNonce(context.Context, *connect.Request[v1.GetVirtualDurableNonceRequest]) (*connect.Response[v1.GetVirtualDurableNonceResponse], error)
// SearchVirtualTimelockAccounts gets all virtual Timelock accounts across every VM the indexer is aware of
SearchVirtualTimelockAccounts(context.Context, *connect.Request[v1.SearchVirtualTimelockAccountsRequest]) (*connect.Response[v1.SearchVirtualTimelockAccountsResponse], error)
}
IndexerHandler is an implementation of the code.vm.v1.Indexer service.
type UnimplementedIndexerHandler ¶
type UnimplementedIndexerHandler struct{}
UnimplementedIndexerHandler returns CodeUnimplemented from all methods.
func (UnimplementedIndexerHandler) GetVirtualDurableNonce ¶
func (UnimplementedIndexerHandler) GetVirtualDurableNonce(context.Context, *connect.Request[v1.GetVirtualDurableNonceRequest]) (*connect.Response[v1.GetVirtualDurableNonceResponse], error)
func (UnimplementedIndexerHandler) GetVirtualTimelockAccounts ¶
func (UnimplementedIndexerHandler) GetVirtualTimelockAccounts(context.Context, *connect.Request[v1.GetVirtualTimelockAccountsRequest]) (*connect.Response[v1.GetVirtualTimelockAccountsResponse], error)
func (UnimplementedIndexerHandler) SearchVirtualTimelockAccounts ¶
func (UnimplementedIndexerHandler) SearchVirtualTimelockAccounts(context.Context, *connect.Request[v1.SearchVirtualTimelockAccountsRequest]) (*connect.Response[v1.SearchVirtualTimelockAccountsResponse], error)
Source Files