transferv1connect

package
v0.9.13-RC04 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 16, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// TransferServiceCreateProcedure is the fully-qualified name of the TransferService's Create RPC.
	TransferServiceCreateProcedure = "/processing.transfer.v1.TransferService/Create"
	// TransferServiceGetByRequestIDProcedure is the fully-qualified name of the TransferService's
	// GetByRequestID RPC.
	TransferServiceGetByRequestIDProcedure = "/processing.transfer.v1.TransferService/GetByRequestID"
	// TransferServiceCancelProcedure is the fully-qualified name of the TransferService's Cancel RPC.
	TransferServiceCancelProcedure = "/processing.transfer.v1.TransferService/Cancel"
	// TransferServiceExecuteNowProcedure is the fully-qualified name of the TransferService's
	// ExecuteNow RPC.
	TransferServiceExecuteNowProcedure = "/processing.transfer.v1.TransferService/ExecuteNow"
	// TransferServiceCheckRefundProcedure is the fully-qualified name of the TransferService's
	// CheckRefund RPC.
	TransferServiceCheckRefundProcedure = "/processing.transfer.v1.TransferService/CheckRefund"
)

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 final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

View Source
const (
	// TransferServiceName is the fully-qualified name of the TransferService service.
	TransferServiceName = "processing.transfer.v1.TransferService"
)

Variables

This section is empty.

Functions

func NewTransferServiceHandler

func NewTransferServiceHandler(svc TransferServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewTransferServiceHandler 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 TransferServiceClient

type TransferServiceClient interface {
	// Create a new transfer
	Create(context.Context, *connect.Request[v1.CreateRequest]) (*connect.Response[v1.CreateResponse], error)
	// Get transfer by request ID
	GetByRequestID(context.Context, *connect.Request[v1.GetByRequestIDRequest]) (*connect.Response[v1.GetByRequestIDResponse], error)
	// Cancel a scheduled transfer before its execute_after is reached
	Cancel(context.Context, *connect.Request[v1.CancelRequest]) (*connect.Response[v1.CancelResponse], error)
	// Execute a scheduled transfer immediately, confirmed by owner's TOTP
	ExecuteNow(context.Context, *connect.Request[v1.ExecuteNowRequest]) (*connect.Response[v1.ExecuteNowResponse], error)
	// Check that a refund can be created: the deposit is valid and the hot wallet
	// pays the network fee by itself. Nothing is created, TOTP is not checked
	CheckRefund(context.Context, *connect.Request[v1.CheckRefundRequest]) (*connect.Response[v1.CheckRefundResponse], error)
}

TransferServiceClient is a client for the processing.transfer.v1.TransferService service.

func NewTransferServiceClient

func NewTransferServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) TransferServiceClient

NewTransferServiceClient constructs a client for the processing.transfer.v1.TransferService 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 TransferServiceHandler

type TransferServiceHandler interface {
	// Create a new transfer
	Create(context.Context, *connect.Request[v1.CreateRequest]) (*connect.Response[v1.CreateResponse], error)
	// Get transfer by request ID
	GetByRequestID(context.Context, *connect.Request[v1.GetByRequestIDRequest]) (*connect.Response[v1.GetByRequestIDResponse], error)
	// Cancel a scheduled transfer before its execute_after is reached
	Cancel(context.Context, *connect.Request[v1.CancelRequest]) (*connect.Response[v1.CancelResponse], error)
	// Execute a scheduled transfer immediately, confirmed by owner's TOTP
	ExecuteNow(context.Context, *connect.Request[v1.ExecuteNowRequest]) (*connect.Response[v1.ExecuteNowResponse], error)
	// Check that a refund can be created: the deposit is valid and the hot wallet
	// pays the network fee by itself. Nothing is created, TOTP is not checked
	CheckRefund(context.Context, *connect.Request[v1.CheckRefundRequest]) (*connect.Response[v1.CheckRefundResponse], error)
}

TransferServiceHandler is an implementation of the processing.transfer.v1.TransferService service.

type UnimplementedTransferServiceHandler

type UnimplementedTransferServiceHandler struct{}

UnimplementedTransferServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedTransferServiceHandler) Cancel added in v0.9.13

func (UnimplementedTransferServiceHandler) CheckRefund added in v0.9.13

func (UnimplementedTransferServiceHandler) ExecuteNow added in v0.9.13

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL