custodyv1alpha1

package
v2.5.2 Latest Latest
Warning

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

Go to latest
Published: Feb 28, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrInvalidLengthCustody        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowCustody          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupCustody = fmt.Errorf("proto: unexpected end of group")
)

Functions

func RegisterCustodyProtocolServiceServer

func RegisterCustodyProtocolServiceServer(s grpc1.Server, srv CustodyProtocolServiceServer)

Types

type AuthorizeRequest

type AuthorizeRequest struct {
	// The transaction plan to authorize.
	Plan *v1alpha1.TransactionPlan `protobuf:"bytes,1,opt,name=plan,proto3" json:"plan,omitempty"`
	// Optionally, pre-authorization data, if required by the custodian.
	//
	// Pre-authorization data is backend-specific, and backends are free to ignore it.
	//
	// Multiple `PreAuthorization` packets can be included in a single request,
	// to support multi-party pre-authorizations.
	PreAuthorizations []*PreAuthorization `protobuf:"bytes,3,rep,name=pre_authorizations,json=preAuthorizations,proto3" json:"pre_authorizations,omitempty"`
}

func (*AuthorizeRequest) Descriptor

func (*AuthorizeRequest) Descriptor() ([]byte, []int)

func (*AuthorizeRequest) GetPlan

func (*AuthorizeRequest) GetPreAuthorizations

func (m *AuthorizeRequest) GetPreAuthorizations() []*PreAuthorization

func (*AuthorizeRequest) Marshal

func (m *AuthorizeRequest) Marshal() (dAtA []byte, err error)

func (*AuthorizeRequest) MarshalTo

func (m *AuthorizeRequest) MarshalTo(dAtA []byte) (int, error)

func (*AuthorizeRequest) MarshalToSizedBuffer

func (m *AuthorizeRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*AuthorizeRequest) ProtoMessage

func (*AuthorizeRequest) ProtoMessage()

func (*AuthorizeRequest) Reset

func (m *AuthorizeRequest) Reset()

func (*AuthorizeRequest) Size

func (m *AuthorizeRequest) Size() (n int)

func (*AuthorizeRequest) String

func (m *AuthorizeRequest) String() string

func (*AuthorizeRequest) Unmarshal

func (m *AuthorizeRequest) Unmarshal(dAtA []byte) error

func (*AuthorizeRequest) XXX_DiscardUnknown

func (m *AuthorizeRequest) XXX_DiscardUnknown()

func (*AuthorizeRequest) XXX_Marshal

func (m *AuthorizeRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AuthorizeRequest) XXX_Merge

func (m *AuthorizeRequest) XXX_Merge(src proto.Message)

func (*AuthorizeRequest) XXX_Size

func (m *AuthorizeRequest) XXX_Size() int

func (*AuthorizeRequest) XXX_Unmarshal

func (m *AuthorizeRequest) XXX_Unmarshal(b []byte) error

type AuthorizeResponse

type AuthorizeResponse struct {
	Data *v1alpha1.AuthorizationData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
}

func (*AuthorizeResponse) Descriptor

func (*AuthorizeResponse) Descriptor() ([]byte, []int)

func (*AuthorizeResponse) GetData

func (*AuthorizeResponse) Marshal

func (m *AuthorizeResponse) Marshal() (dAtA []byte, err error)

func (*AuthorizeResponse) MarshalTo

func (m *AuthorizeResponse) MarshalTo(dAtA []byte) (int, error)

func (*AuthorizeResponse) MarshalToSizedBuffer

func (m *AuthorizeResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*AuthorizeResponse) ProtoMessage

func (*AuthorizeResponse) ProtoMessage()

func (*AuthorizeResponse) Reset

func (m *AuthorizeResponse) Reset()

func (*AuthorizeResponse) Size

func (m *AuthorizeResponse) Size() (n int)

func (*AuthorizeResponse) String

func (m *AuthorizeResponse) String() string

func (*AuthorizeResponse) Unmarshal

func (m *AuthorizeResponse) Unmarshal(dAtA []byte) error

func (*AuthorizeResponse) XXX_DiscardUnknown

func (m *AuthorizeResponse) XXX_DiscardUnknown()

func (*AuthorizeResponse) XXX_Marshal

func (m *AuthorizeResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AuthorizeResponse) XXX_Merge

func (m *AuthorizeResponse) XXX_Merge(src proto.Message)

func (*AuthorizeResponse) XXX_Size

func (m *AuthorizeResponse) XXX_Size() int

func (*AuthorizeResponse) XXX_Unmarshal

func (m *AuthorizeResponse) XXX_Unmarshal(b []byte) error

type ConfirmAddressRequest added in v2.5.0

type ConfirmAddressRequest struct {
	AddressIndex *v1alpha11.AddressIndex `protobuf:"bytes,1,opt,name=address_index,json=addressIndex,proto3" json:"address_index,omitempty"`
}

func (*ConfirmAddressRequest) Descriptor added in v2.5.0

func (*ConfirmAddressRequest) Descriptor() ([]byte, []int)

func (*ConfirmAddressRequest) GetAddressIndex added in v2.5.0

func (m *ConfirmAddressRequest) GetAddressIndex() *v1alpha11.AddressIndex

func (*ConfirmAddressRequest) Marshal added in v2.5.0

func (m *ConfirmAddressRequest) Marshal() (dAtA []byte, err error)

func (*ConfirmAddressRequest) MarshalTo added in v2.5.0

func (m *ConfirmAddressRequest) MarshalTo(dAtA []byte) (int, error)

func (*ConfirmAddressRequest) MarshalToSizedBuffer added in v2.5.0

func (m *ConfirmAddressRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ConfirmAddressRequest) ProtoMessage added in v2.5.0

func (*ConfirmAddressRequest) ProtoMessage()

func (*ConfirmAddressRequest) Reset added in v2.5.0

func (m *ConfirmAddressRequest) Reset()

func (*ConfirmAddressRequest) Size added in v2.5.0

func (m *ConfirmAddressRequest) Size() (n int)

func (*ConfirmAddressRequest) String added in v2.5.0

func (m *ConfirmAddressRequest) String() string

func (*ConfirmAddressRequest) Unmarshal added in v2.5.0

func (m *ConfirmAddressRequest) Unmarshal(dAtA []byte) error

func (*ConfirmAddressRequest) XXX_DiscardUnknown added in v2.5.0

func (m *ConfirmAddressRequest) XXX_DiscardUnknown()

func (*ConfirmAddressRequest) XXX_Marshal added in v2.5.0

func (m *ConfirmAddressRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ConfirmAddressRequest) XXX_Merge added in v2.5.0

func (m *ConfirmAddressRequest) XXX_Merge(src proto.Message)

func (*ConfirmAddressRequest) XXX_Size added in v2.5.0

func (m *ConfirmAddressRequest) XXX_Size() int

func (*ConfirmAddressRequest) XXX_Unmarshal added in v2.5.0

func (m *ConfirmAddressRequest) XXX_Unmarshal(b []byte) error

type ConfirmAddressResponse added in v2.5.0

type ConfirmAddressResponse struct {
	Address *v1alpha11.Address `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
}

func (*ConfirmAddressResponse) Descriptor added in v2.5.0

func (*ConfirmAddressResponse) Descriptor() ([]byte, []int)

func (*ConfirmAddressResponse) GetAddress added in v2.5.0

func (m *ConfirmAddressResponse) GetAddress() *v1alpha11.Address

func (*ConfirmAddressResponse) Marshal added in v2.5.0

func (m *ConfirmAddressResponse) Marshal() (dAtA []byte, err error)

func (*ConfirmAddressResponse) MarshalTo added in v2.5.0

func (m *ConfirmAddressResponse) MarshalTo(dAtA []byte) (int, error)

func (*ConfirmAddressResponse) MarshalToSizedBuffer added in v2.5.0

func (m *ConfirmAddressResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ConfirmAddressResponse) ProtoMessage added in v2.5.0

func (*ConfirmAddressResponse) ProtoMessage()

func (*ConfirmAddressResponse) Reset added in v2.5.0

func (m *ConfirmAddressResponse) Reset()

func (*ConfirmAddressResponse) Size added in v2.5.0

func (m *ConfirmAddressResponse) Size() (n int)

func (*ConfirmAddressResponse) String added in v2.5.0

func (m *ConfirmAddressResponse) String() string

func (*ConfirmAddressResponse) Unmarshal added in v2.5.0

func (m *ConfirmAddressResponse) Unmarshal(dAtA []byte) error

func (*ConfirmAddressResponse) XXX_DiscardUnknown added in v2.5.0

func (m *ConfirmAddressResponse) XXX_DiscardUnknown()

func (*ConfirmAddressResponse) XXX_Marshal added in v2.5.0

func (m *ConfirmAddressResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ConfirmAddressResponse) XXX_Merge added in v2.5.0

func (m *ConfirmAddressResponse) XXX_Merge(src proto.Message)

func (*ConfirmAddressResponse) XXX_Size added in v2.5.0

func (m *ConfirmAddressResponse) XXX_Size() int

func (*ConfirmAddressResponse) XXX_Unmarshal added in v2.5.0

func (m *ConfirmAddressResponse) XXX_Unmarshal(b []byte) error

type CustodyProtocolServiceClient

type CustodyProtocolServiceClient interface {
	// Requests authorization of the transaction with the given description.
	Authorize(ctx context.Context, in *AuthorizeRequest, opts ...grpc.CallOption) (*AuthorizeResponse, error)
	// Requests the full viewing key from the custodian.
	//
	// Custody backends should decide whether to honor this request, and how to
	// control access to it.
	ExportFullViewingKey(ctx context.Context, in *ExportFullViewingKeyRequest, opts ...grpc.CallOption) (*ExportFullViewingKeyResponse, error)
	// Displays an address to a user for confirmation.
	//
	// Custody backends with user interaction should present the address to the
	// user and wait for explicit confirmation before returning.
	//
	// Non-interactive custody backends may return immediately.
	ConfirmAddress(ctx context.Context, in *ConfirmAddressRequest, opts ...grpc.CallOption) (*ConfirmAddressResponse, error)
}

CustodyProtocolServiceClient is the client API for CustodyProtocolService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewCustodyProtocolServiceClient

func NewCustodyProtocolServiceClient(cc grpc1.ClientConn) CustodyProtocolServiceClient

type CustodyProtocolServiceServer

type CustodyProtocolServiceServer interface {
	// Requests authorization of the transaction with the given description.
	Authorize(context.Context, *AuthorizeRequest) (*AuthorizeResponse, error)
	// Requests the full viewing key from the custodian.
	//
	// Custody backends should decide whether to honor this request, and how to
	// control access to it.
	ExportFullViewingKey(context.Context, *ExportFullViewingKeyRequest) (*ExportFullViewingKeyResponse, error)
	// Displays an address to a user for confirmation.
	//
	// Custody backends with user interaction should present the address to the
	// user and wait for explicit confirmation before returning.
	//
	// Non-interactive custody backends may return immediately.
	ConfirmAddress(context.Context, *ConfirmAddressRequest) (*ConfirmAddressResponse, error)
}

CustodyProtocolServiceServer is the server API for CustodyProtocolService service.

type ExportFullViewingKeyRequest added in v2.5.0

type ExportFullViewingKeyRequest struct {
}

func (*ExportFullViewingKeyRequest) Descriptor added in v2.5.0

func (*ExportFullViewingKeyRequest) Descriptor() ([]byte, []int)

func (*ExportFullViewingKeyRequest) Marshal added in v2.5.0

func (m *ExportFullViewingKeyRequest) Marshal() (dAtA []byte, err error)

func (*ExportFullViewingKeyRequest) MarshalTo added in v2.5.0

func (m *ExportFullViewingKeyRequest) MarshalTo(dAtA []byte) (int, error)

func (*ExportFullViewingKeyRequest) MarshalToSizedBuffer added in v2.5.0

func (m *ExportFullViewingKeyRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ExportFullViewingKeyRequest) ProtoMessage added in v2.5.0

func (*ExportFullViewingKeyRequest) ProtoMessage()

func (*ExportFullViewingKeyRequest) Reset added in v2.5.0

func (m *ExportFullViewingKeyRequest) Reset()

func (*ExportFullViewingKeyRequest) Size added in v2.5.0

func (m *ExportFullViewingKeyRequest) Size() (n int)

func (*ExportFullViewingKeyRequest) String added in v2.5.0

func (m *ExportFullViewingKeyRequest) String() string

func (*ExportFullViewingKeyRequest) Unmarshal added in v2.5.0

func (m *ExportFullViewingKeyRequest) Unmarshal(dAtA []byte) error

func (*ExportFullViewingKeyRequest) XXX_DiscardUnknown added in v2.5.0

func (m *ExportFullViewingKeyRequest) XXX_DiscardUnknown()

func (*ExportFullViewingKeyRequest) XXX_Marshal added in v2.5.0

func (m *ExportFullViewingKeyRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ExportFullViewingKeyRequest) XXX_Merge added in v2.5.0

func (m *ExportFullViewingKeyRequest) XXX_Merge(src proto.Message)

func (*ExportFullViewingKeyRequest) XXX_Size added in v2.5.0

func (m *ExportFullViewingKeyRequest) XXX_Size() int

func (*ExportFullViewingKeyRequest) XXX_Unmarshal added in v2.5.0

func (m *ExportFullViewingKeyRequest) XXX_Unmarshal(b []byte) error

type ExportFullViewingKeyResponse added in v2.5.0

type ExportFullViewingKeyResponse struct {
	// The full viewing key.
	FullViewingKey *v1alpha11.FullViewingKey `protobuf:"bytes,1,opt,name=full_viewing_key,json=fullViewingKey,proto3" json:"full_viewing_key,omitempty"`
}

func (*ExportFullViewingKeyResponse) Descriptor added in v2.5.0

func (*ExportFullViewingKeyResponse) Descriptor() ([]byte, []int)

func (*ExportFullViewingKeyResponse) GetFullViewingKey added in v2.5.0

func (m *ExportFullViewingKeyResponse) GetFullViewingKey() *v1alpha11.FullViewingKey

func (*ExportFullViewingKeyResponse) Marshal added in v2.5.0

func (m *ExportFullViewingKeyResponse) Marshal() (dAtA []byte, err error)

func (*ExportFullViewingKeyResponse) MarshalTo added in v2.5.0

func (m *ExportFullViewingKeyResponse) MarshalTo(dAtA []byte) (int, error)

func (*ExportFullViewingKeyResponse) MarshalToSizedBuffer added in v2.5.0

func (m *ExportFullViewingKeyResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ExportFullViewingKeyResponse) ProtoMessage added in v2.5.0

func (*ExportFullViewingKeyResponse) ProtoMessage()

func (*ExportFullViewingKeyResponse) Reset added in v2.5.0

func (m *ExportFullViewingKeyResponse) Reset()

func (*ExportFullViewingKeyResponse) Size added in v2.5.0

func (m *ExportFullViewingKeyResponse) Size() (n int)

func (*ExportFullViewingKeyResponse) String added in v2.5.0

func (*ExportFullViewingKeyResponse) Unmarshal added in v2.5.0

func (m *ExportFullViewingKeyResponse) Unmarshal(dAtA []byte) error

func (*ExportFullViewingKeyResponse) XXX_DiscardUnknown added in v2.5.0

func (m *ExportFullViewingKeyResponse) XXX_DiscardUnknown()

func (*ExportFullViewingKeyResponse) XXX_Marshal added in v2.5.0

func (m *ExportFullViewingKeyResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ExportFullViewingKeyResponse) XXX_Merge added in v2.5.0

func (m *ExportFullViewingKeyResponse) XXX_Merge(src proto.Message)

func (*ExportFullViewingKeyResponse) XXX_Size added in v2.5.0

func (m *ExportFullViewingKeyResponse) XXX_Size() int

func (*ExportFullViewingKeyResponse) XXX_Unmarshal added in v2.5.0

func (m *ExportFullViewingKeyResponse) XXX_Unmarshal(b []byte) error

type PreAuthorization

type PreAuthorization struct {
	// Types that are valid to be assigned to PreAuthorization:
	//	*PreAuthorization_Ed25519_
	PreAuthorization isPreAuthorization_PreAuthorization `protobuf_oneof:"pre_authorization"`
}

A pre-authorization packet. This allows a custodian to delegate (partial) signing authority to other authorization mechanisms. Details of how a custodian manages those keys are out-of-scope for the custody protocol and are custodian-specific.

func (*PreAuthorization) Descriptor

func (*PreAuthorization) Descriptor() ([]byte, []int)

func (*PreAuthorization) GetEd25519

func (m *PreAuthorization) GetEd25519() *PreAuthorization_Ed25519

func (*PreAuthorization) GetPreAuthorization

func (m *PreAuthorization) GetPreAuthorization() isPreAuthorization_PreAuthorization

func (*PreAuthorization) Marshal

func (m *PreAuthorization) Marshal() (dAtA []byte, err error)

func (*PreAuthorization) MarshalTo

func (m *PreAuthorization) MarshalTo(dAtA []byte) (int, error)

func (*PreAuthorization) MarshalToSizedBuffer

func (m *PreAuthorization) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*PreAuthorization) ProtoMessage

func (*PreAuthorization) ProtoMessage()

func (*PreAuthorization) Reset

func (m *PreAuthorization) Reset()

func (*PreAuthorization) Size

func (m *PreAuthorization) Size() (n int)

func (*PreAuthorization) String

func (m *PreAuthorization) String() string

func (*PreAuthorization) Unmarshal

func (m *PreAuthorization) Unmarshal(dAtA []byte) error

func (*PreAuthorization) XXX_DiscardUnknown

func (m *PreAuthorization) XXX_DiscardUnknown()

func (*PreAuthorization) XXX_Marshal

func (m *PreAuthorization) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PreAuthorization) XXX_Merge

func (m *PreAuthorization) XXX_Merge(src proto.Message)

func (*PreAuthorization) XXX_OneofWrappers

func (*PreAuthorization) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*PreAuthorization) XXX_Size

func (m *PreAuthorization) XXX_Size() int

func (*PreAuthorization) XXX_Unmarshal

func (m *PreAuthorization) XXX_Unmarshal(b []byte) error

type PreAuthorization_Ed25519

type PreAuthorization_Ed25519 struct {
	// The Ed25519 verification key used to verify the signature.
	Vk []byte `protobuf:"bytes,1,opt,name=vk,proto3" json:"vk,omitempty"`
	// The Ed25519 signature over the `TransactionPlan`.
	Sig []byte `protobuf:"bytes,2,opt,name=sig,proto3" json:"sig,omitempty"`
}

An Ed25519-based preauthorization, containing an Ed25519 signature over the `TransactionPlan`.

func (*PreAuthorization_Ed25519) Descriptor

func (*PreAuthorization_Ed25519) Descriptor() ([]byte, []int)

func (*PreAuthorization_Ed25519) GetSig

func (m *PreAuthorization_Ed25519) GetSig() []byte

func (*PreAuthorization_Ed25519) GetVk

func (m *PreAuthorization_Ed25519) GetVk() []byte

func (*PreAuthorization_Ed25519) Marshal

func (m *PreAuthorization_Ed25519) Marshal() (dAtA []byte, err error)

func (*PreAuthorization_Ed25519) MarshalTo

func (m *PreAuthorization_Ed25519) MarshalTo(dAtA []byte) (int, error)

func (*PreAuthorization_Ed25519) MarshalToSizedBuffer

func (m *PreAuthorization_Ed25519) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*PreAuthorization_Ed25519) ProtoMessage

func (*PreAuthorization_Ed25519) ProtoMessage()

func (*PreAuthorization_Ed25519) Reset

func (m *PreAuthorization_Ed25519) Reset()

func (*PreAuthorization_Ed25519) Size

func (m *PreAuthorization_Ed25519) Size() (n int)

func (*PreAuthorization_Ed25519) String

func (m *PreAuthorization_Ed25519) String() string

func (*PreAuthorization_Ed25519) Unmarshal

func (m *PreAuthorization_Ed25519) Unmarshal(dAtA []byte) error

func (*PreAuthorization_Ed25519) XXX_DiscardUnknown

func (m *PreAuthorization_Ed25519) XXX_DiscardUnknown()

func (*PreAuthorization_Ed25519) XXX_Marshal

func (m *PreAuthorization_Ed25519) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PreAuthorization_Ed25519) XXX_Merge

func (m *PreAuthorization_Ed25519) XXX_Merge(src proto.Message)

func (*PreAuthorization_Ed25519) XXX_Size

func (m *PreAuthorization_Ed25519) XXX_Size() int

func (*PreAuthorization_Ed25519) XXX_Unmarshal

func (m *PreAuthorization_Ed25519) XXX_Unmarshal(b []byte) error

type PreAuthorization_Ed25519_

type PreAuthorization_Ed25519_ struct {
	Ed25519 *PreAuthorization_Ed25519 `protobuf:"bytes,1,opt,name=ed25519,proto3,oneof" json:"ed25519,omitempty"`
}

func (*PreAuthorization_Ed25519_) MarshalTo

func (m *PreAuthorization_Ed25519_) MarshalTo(dAtA []byte) (int, error)

func (*PreAuthorization_Ed25519_) MarshalToSizedBuffer

func (m *PreAuthorization_Ed25519_) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*PreAuthorization_Ed25519_) Size

func (m *PreAuthorization_Ed25519_) Size() (n int)

type UnimplementedCustodyProtocolServiceServer

type UnimplementedCustodyProtocolServiceServer struct {
}

UnimplementedCustodyProtocolServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedCustodyProtocolServiceServer) Authorize

func (*UnimplementedCustodyProtocolServiceServer) ConfirmAddress added in v2.5.0

func (*UnimplementedCustodyProtocolServiceServer) ExportFullViewingKey added in v2.5.0

Jump to

Keyboard shortcuts

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