Documentation
¶
Overview ¶
Package v3 is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Constants
- Variables
- func RegisterMlsApiHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterMlsApiHandlerClient(ctx context.Context, mux *runtime.ServeMux, client MlsApiClient) error
- func RegisterMlsApiHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterMlsApiHandlerServer(ctx context.Context, mux *runtime.ServeMux, server MlsApiServer) error
- func RegisterMlsApiServer(s grpc.ServiceRegistrar, srv MlsApiServer)
- type ConsumeKeyPackagesRequest
- func (*ConsumeKeyPackagesRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ConsumeKeyPackagesRequest) GetInstallationIds() []string
- func (*ConsumeKeyPackagesRequest) ProtoMessage()
- func (x *ConsumeKeyPackagesRequest) ProtoReflect() protoreflect.Message
- func (x *ConsumeKeyPackagesRequest) Reset()
- func (x *ConsumeKeyPackagesRequest) String() string
- type ConsumeKeyPackagesResponse
- func (*ConsumeKeyPackagesResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ConsumeKeyPackagesResponse) GetKeyPackages() []*ConsumeKeyPackagesResponse_KeyPackage
- func (*ConsumeKeyPackagesResponse) ProtoMessage()
- func (x *ConsumeKeyPackagesResponse) ProtoReflect() protoreflect.Message
- func (x *ConsumeKeyPackagesResponse) Reset()
- func (x *ConsumeKeyPackagesResponse) String() string
- type ConsumeKeyPackagesResponse_KeyPackage
- func (*ConsumeKeyPackagesResponse_KeyPackage) Descriptor() ([]byte, []int)deprecated
- func (x *ConsumeKeyPackagesResponse_KeyPackage) GetKeyPackageTlsSerialized() []byte
- func (*ConsumeKeyPackagesResponse_KeyPackage) ProtoMessage()
- func (x *ConsumeKeyPackagesResponse_KeyPackage) ProtoReflect() protoreflect.Message
- func (x *ConsumeKeyPackagesResponse_KeyPackage) Reset()
- func (x *ConsumeKeyPackagesResponse_KeyPackage) String() string
- type GetIdentityUpdatesRequest
- func (*GetIdentityUpdatesRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetIdentityUpdatesRequest) GetStartTimeNs() uint64
- func (x *GetIdentityUpdatesRequest) GetWalletAddresses() []string
- func (*GetIdentityUpdatesRequest) ProtoMessage()
- func (x *GetIdentityUpdatesRequest) ProtoReflect() protoreflect.Message
- func (x *GetIdentityUpdatesRequest) Reset()
- func (x *GetIdentityUpdatesRequest) String() string
- type GetIdentityUpdatesResponse
- func (*GetIdentityUpdatesResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetIdentityUpdatesResponse) GetUpdates() []*GetIdentityUpdatesResponse_WalletUpdates
- func (*GetIdentityUpdatesResponse) ProtoMessage()
- func (x *GetIdentityUpdatesResponse) ProtoReflect() protoreflect.Message
- func (x *GetIdentityUpdatesResponse) Reset()
- func (x *GetIdentityUpdatesResponse) String() string
- type GetIdentityUpdatesResponse_NewInstallationUpdate
- func (*GetIdentityUpdatesResponse_NewInstallationUpdate) Descriptor() ([]byte, []int)deprecated
- func (x *GetIdentityUpdatesResponse_NewInstallationUpdate) GetInstallationId() string
- func (*GetIdentityUpdatesResponse_NewInstallationUpdate) ProtoMessage()
- func (x *GetIdentityUpdatesResponse_NewInstallationUpdate) ProtoReflect() protoreflect.Message
- func (x *GetIdentityUpdatesResponse_NewInstallationUpdate) Reset()
- func (x *GetIdentityUpdatesResponse_NewInstallationUpdate) String() string
- type GetIdentityUpdatesResponse_RevokedInstallationUpdate
- func (*GetIdentityUpdatesResponse_RevokedInstallationUpdate) Descriptor() ([]byte, []int)deprecated
- func (x *GetIdentityUpdatesResponse_RevokedInstallationUpdate) GetInstallationId() string
- func (*GetIdentityUpdatesResponse_RevokedInstallationUpdate) ProtoMessage()
- func (x *GetIdentityUpdatesResponse_RevokedInstallationUpdate) ProtoReflect() protoreflect.Message
- func (x *GetIdentityUpdatesResponse_RevokedInstallationUpdate) Reset()
- func (x *GetIdentityUpdatesResponse_RevokedInstallationUpdate) String() string
- type GetIdentityUpdatesResponse_Update
- func (*GetIdentityUpdatesResponse_Update) Descriptor() ([]byte, []int)deprecated
- func (m *GetIdentityUpdatesResponse_Update) GetKind() isGetIdentityUpdatesResponse_Update_Kind
- func (x *GetIdentityUpdatesResponse_Update) GetNewInstallation() *GetIdentityUpdatesResponse_NewInstallationUpdate
- func (x *GetIdentityUpdatesResponse_Update) GetRevokedInstallation() *GetIdentityUpdatesResponse_RevokedInstallationUpdate
- func (x *GetIdentityUpdatesResponse_Update) GetTimestampNs() uint64
- func (*GetIdentityUpdatesResponse_Update) ProtoMessage()
- func (x *GetIdentityUpdatesResponse_Update) ProtoReflect() protoreflect.Message
- func (x *GetIdentityUpdatesResponse_Update) Reset()
- func (x *GetIdentityUpdatesResponse_Update) String() string
- type GetIdentityUpdatesResponse_Update_NewInstallation
- type GetIdentityUpdatesResponse_Update_RevokedInstallation
- type GetIdentityUpdatesResponse_WalletUpdates
- func (*GetIdentityUpdatesResponse_WalletUpdates) Descriptor() ([]byte, []int)deprecated
- func (x *GetIdentityUpdatesResponse_WalletUpdates) GetUpdates() []*GetIdentityUpdatesResponse_Update
- func (*GetIdentityUpdatesResponse_WalletUpdates) ProtoMessage()
- func (x *GetIdentityUpdatesResponse_WalletUpdates) ProtoReflect() protoreflect.Message
- func (x *GetIdentityUpdatesResponse_WalletUpdates) Reset()
- func (x *GetIdentityUpdatesResponse_WalletUpdates) String() string
- type MlsApiClient
- type MlsApiServer
- type PublishToGroupRequest
- func (*PublishToGroupRequest) Descriptor() ([]byte, []int)deprecated
- func (x *PublishToGroupRequest) GetMessages() []*message_contents.GroupMessage
- func (*PublishToGroupRequest) ProtoMessage()
- func (x *PublishToGroupRequest) ProtoReflect() protoreflect.Message
- func (x *PublishToGroupRequest) Reset()
- func (x *PublishToGroupRequest) String() string
- type PublishWelcomesRequest
- func (*PublishWelcomesRequest) Descriptor() ([]byte, []int)deprecated
- func (x *PublishWelcomesRequest) GetWelcomeMessages() []*PublishWelcomesRequest_WelcomeMessageRequest
- func (*PublishWelcomesRequest) ProtoMessage()
- func (x *PublishWelcomesRequest) ProtoReflect() protoreflect.Message
- func (x *PublishWelcomesRequest) Reset()
- func (x *PublishWelcomesRequest) String() string
- type PublishWelcomesRequest_WelcomeMessageRequest
- func (*PublishWelcomesRequest_WelcomeMessageRequest) Descriptor() ([]byte, []int)deprecated
- func (x *PublishWelcomesRequest_WelcomeMessageRequest) GetInstallationId() string
- func (x *PublishWelcomesRequest_WelcomeMessageRequest) GetWelcomeMessage() *message_contents.WelcomeMessage
- func (*PublishWelcomesRequest_WelcomeMessageRequest) ProtoMessage()
- func (x *PublishWelcomesRequest_WelcomeMessageRequest) ProtoReflect() protoreflect.Message
- func (x *PublishWelcomesRequest_WelcomeMessageRequest) Reset()
- func (x *PublishWelcomesRequest_WelcomeMessageRequest) String() string
- type RegisterInstallationRequest
- func (*RegisterInstallationRequest) Descriptor() ([]byte, []int)deprecated
- func (x *RegisterInstallationRequest) GetCredentialBytes() []byte
- func (x *RegisterInstallationRequest) GetSigningKeyPublic() []byte
- func (*RegisterInstallationRequest) ProtoMessage()
- func (x *RegisterInstallationRequest) ProtoReflect() protoreflect.Message
- func (x *RegisterInstallationRequest) Reset()
- func (x *RegisterInstallationRequest) String() string
- type RegisterInstallationResponse
- func (*RegisterInstallationResponse) Descriptor() ([]byte, []int)deprecated
- func (x *RegisterInstallationResponse) GetInstallationId() string
- func (*RegisterInstallationResponse) ProtoMessage()
- func (x *RegisterInstallationResponse) ProtoReflect() protoreflect.Message
- func (x *RegisterInstallationResponse) Reset()
- func (x *RegisterInstallationResponse) String() string
- type RevokeInstallationRequest
- func (*RevokeInstallationRequest) Descriptor() ([]byte, []int)deprecated
- func (x *RevokeInstallationRequest) GetInstallationId() string
- func (x *RevokeInstallationRequest) GetWalletSignature() *message_contents1.Signature
- func (*RevokeInstallationRequest) ProtoMessage()
- func (x *RevokeInstallationRequest) ProtoReflect() protoreflect.Message
- func (x *RevokeInstallationRequest) Reset()
- func (x *RevokeInstallationRequest) String() string
- type UnimplementedMlsApiServer
- func (UnimplementedMlsApiServer) ConsumeKeyPackages(context.Context, *ConsumeKeyPackagesRequest) (*ConsumeKeyPackagesResponse, error)
- func (UnimplementedMlsApiServer) GetIdentityUpdates(context.Context, *GetIdentityUpdatesRequest) (*GetIdentityUpdatesResponse, error)
- func (UnimplementedMlsApiServer) PublishToGroup(context.Context, *PublishToGroupRequest) (*emptypb.Empty, error)
- func (UnimplementedMlsApiServer) PublishWelcomes(context.Context, *PublishWelcomesRequest) (*emptypb.Empty, error)
- func (UnimplementedMlsApiServer) RegisterInstallation(context.Context, *RegisterInstallationRequest) (*RegisterInstallationResponse, error)
- func (UnimplementedMlsApiServer) RevokeInstallation(context.Context, *RevokeInstallationRequest) (*emptypb.Empty, error)
- func (UnimplementedMlsApiServer) UploadKeyPackages(context.Context, *UploadKeyPackagesRequest) (*emptypb.Empty, error)
- type UnsafeMlsApiServer
- type UploadKeyPackagesRequest
- func (*UploadKeyPackagesRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UploadKeyPackagesRequest) GetKeyPackages() []*UploadKeyPackagesRequest_KeyPackageUpload
- func (*UploadKeyPackagesRequest) ProtoMessage()
- func (x *UploadKeyPackagesRequest) ProtoReflect() protoreflect.Message
- func (x *UploadKeyPackagesRequest) Reset()
- func (x *UploadKeyPackagesRequest) String() string
- type UploadKeyPackagesRequest_KeyPackageUpload
- func (*UploadKeyPackagesRequest_KeyPackageUpload) Descriptor() ([]byte, []int)deprecated
- func (x *UploadKeyPackagesRequest_KeyPackageUpload) GetIsLastResort() bool
- func (x *UploadKeyPackagesRequest_KeyPackageUpload) GetKeyPackageTlsSerialized() []byte
- func (*UploadKeyPackagesRequest_KeyPackageUpload) ProtoMessage()
- func (x *UploadKeyPackagesRequest_KeyPackageUpload) ProtoReflect() protoreflect.Message
- func (x *UploadKeyPackagesRequest_KeyPackageUpload) Reset()
- func (x *UploadKeyPackagesRequest_KeyPackageUpload) String() string
Constants ¶
const ( MlsApi_PublishToGroup_FullMethodName = "/xmtp.message_api.v3.MlsApi/PublishToGroup" MlsApi_PublishWelcomes_FullMethodName = "/xmtp.message_api.v3.MlsApi/PublishWelcomes" MlsApi_RegisterInstallation_FullMethodName = "/xmtp.message_api.v3.MlsApi/RegisterInstallation" MlsApi_UploadKeyPackages_FullMethodName = "/xmtp.message_api.v3.MlsApi/UploadKeyPackages" MlsApi_ConsumeKeyPackages_FullMethodName = "/xmtp.message_api.v3.MlsApi/ConsumeKeyPackages" MlsApi_RevokeInstallation_FullMethodName = "/xmtp.message_api.v3.MlsApi/RevokeInstallation" MlsApi_GetIdentityUpdates_FullMethodName = "/xmtp.message_api.v3.MlsApi/GetIdentityUpdates" )
Variables ¶
var File_message_api_v3_mls_proto protoreflect.FileDescriptor
var MlsApi_ServiceDesc = grpc.ServiceDesc{ ServiceName: "xmtp.message_api.v3.MlsApi", HandlerType: (*MlsApiServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "PublishToGroup", Handler: _MlsApi_PublishToGroup_Handler, }, { MethodName: "PublishWelcomes", Handler: _MlsApi_PublishWelcomes_Handler, }, { MethodName: "RegisterInstallation", Handler: _MlsApi_RegisterInstallation_Handler, }, { MethodName: "UploadKeyPackages", Handler: _MlsApi_UploadKeyPackages_Handler, }, { MethodName: "ConsumeKeyPackages", Handler: _MlsApi_ConsumeKeyPackages_Handler, }, { MethodName: "RevokeInstallation", Handler: _MlsApi_RevokeInstallation_Handler, }, { MethodName: "GetIdentityUpdates", Handler: _MlsApi_GetIdentityUpdates_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "message_api/v3/mls.proto", }
MlsApi_ServiceDesc is the grpc.ServiceDesc for MlsApi service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterMlsApiHandler ¶
RegisterMlsApiHandler registers the http handlers for service MlsApi to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterMlsApiHandlerClient ¶
func RegisterMlsApiHandlerClient(ctx context.Context, mux *runtime.ServeMux, client MlsApiClient) error
RegisterMlsApiHandlerClient registers the http handlers for service MlsApi to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "MlsApiClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "MlsApiClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "MlsApiClient" to call the correct interceptors.
func RegisterMlsApiHandlerFromEndpoint ¶
func RegisterMlsApiHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterMlsApiHandlerFromEndpoint is same as RegisterMlsApiHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterMlsApiHandlerServer ¶
func RegisterMlsApiHandlerServer(ctx context.Context, mux *runtime.ServeMux, server MlsApiServer) error
RegisterMlsApiHandlerServer registers the http handlers for service MlsApi to "mux". UnaryRPC :call MlsApiServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterMlsApiHandlerFromEndpoint instead.
func RegisterMlsApiServer ¶
func RegisterMlsApiServer(s grpc.ServiceRegistrar, srv MlsApiServer)
Types ¶
type ConsumeKeyPackagesRequest ¶
type ConsumeKeyPackagesRequest struct { // The caller can provide an array of wallet addresses, and the API // will return one key package for each installation associated with each // wallet address InstallationIds []string `protobuf:"bytes,1,rep,name=installation_ids,json=installationIds,proto3" json:"installation_ids,omitempty"` // contains filtered or unexported fields }
Consume one or more key packages, removing them from further use
func (*ConsumeKeyPackagesRequest) Descriptor
deprecated
func (*ConsumeKeyPackagesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ConsumeKeyPackagesRequest.ProtoReflect.Descriptor instead.
func (*ConsumeKeyPackagesRequest) GetInstallationIds ¶
func (x *ConsumeKeyPackagesRequest) GetInstallationIds() []string
func (*ConsumeKeyPackagesRequest) ProtoMessage ¶
func (*ConsumeKeyPackagesRequest) ProtoMessage()
func (*ConsumeKeyPackagesRequest) ProtoReflect ¶
func (x *ConsumeKeyPackagesRequest) ProtoReflect() protoreflect.Message
func (*ConsumeKeyPackagesRequest) Reset ¶
func (x *ConsumeKeyPackagesRequest) Reset()
func (*ConsumeKeyPackagesRequest) String ¶
func (x *ConsumeKeyPackagesRequest) String() string
type ConsumeKeyPackagesResponse ¶
type ConsumeKeyPackagesResponse struct { // Returns one key package per installation in the original order of the // request. If any installations are missing key packages, KeyPackages []*ConsumeKeyPackagesResponse_KeyPackage `protobuf:"bytes,1,rep,name=key_packages,json=keyPackages,proto3" json:"key_packages,omitempty"` // contains filtered or unexported fields }
The response to a ConsumeKeyPackagesRequest
func (*ConsumeKeyPackagesResponse) Descriptor
deprecated
func (*ConsumeKeyPackagesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ConsumeKeyPackagesResponse.ProtoReflect.Descriptor instead.
func (*ConsumeKeyPackagesResponse) GetKeyPackages ¶
func (x *ConsumeKeyPackagesResponse) GetKeyPackages() []*ConsumeKeyPackagesResponse_KeyPackage
func (*ConsumeKeyPackagesResponse) ProtoMessage ¶
func (*ConsumeKeyPackagesResponse) ProtoMessage()
func (*ConsumeKeyPackagesResponse) ProtoReflect ¶
func (x *ConsumeKeyPackagesResponse) ProtoReflect() protoreflect.Message
func (*ConsumeKeyPackagesResponse) Reset ¶
func (x *ConsumeKeyPackagesResponse) Reset()
func (*ConsumeKeyPackagesResponse) String ¶
func (x *ConsumeKeyPackagesResponse) String() string
type ConsumeKeyPackagesResponse_KeyPackage ¶
type ConsumeKeyPackagesResponse_KeyPackage struct { KeyPackageTlsSerialized []byte `` /* 134-byte string literal not displayed */ // contains filtered or unexported fields }
An individual key package
func (*ConsumeKeyPackagesResponse_KeyPackage) Descriptor
deprecated
func (*ConsumeKeyPackagesResponse_KeyPackage) Descriptor() ([]byte, []int)
Deprecated: Use ConsumeKeyPackagesResponse_KeyPackage.ProtoReflect.Descriptor instead.
func (*ConsumeKeyPackagesResponse_KeyPackage) GetKeyPackageTlsSerialized ¶
func (x *ConsumeKeyPackagesResponse_KeyPackage) GetKeyPackageTlsSerialized() []byte
func (*ConsumeKeyPackagesResponse_KeyPackage) ProtoMessage ¶
func (*ConsumeKeyPackagesResponse_KeyPackage) ProtoMessage()
func (*ConsumeKeyPackagesResponse_KeyPackage) ProtoReflect ¶
func (x *ConsumeKeyPackagesResponse_KeyPackage) ProtoReflect() protoreflect.Message
func (*ConsumeKeyPackagesResponse_KeyPackage) Reset ¶
func (x *ConsumeKeyPackagesResponse_KeyPackage) Reset()
func (*ConsumeKeyPackagesResponse_KeyPackage) String ¶
func (x *ConsumeKeyPackagesResponse_KeyPackage) String() string
type GetIdentityUpdatesRequest ¶
type GetIdentityUpdatesRequest struct { WalletAddresses []string `protobuf:"bytes,1,rep,name=wallet_addresses,json=walletAddresses,proto3" json:"wallet_addresses,omitempty"` StartTimeNs uint64 `protobuf:"varint,2,opt,name=start_time_ns,json=startTimeNs,proto3" json:"start_time_ns,omitempty"` // contains filtered or unexported fields }
Get all updates for an identity since the specified time
func (*GetIdentityUpdatesRequest) Descriptor
deprecated
func (*GetIdentityUpdatesRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetIdentityUpdatesRequest.ProtoReflect.Descriptor instead.
func (*GetIdentityUpdatesRequest) GetStartTimeNs ¶
func (x *GetIdentityUpdatesRequest) GetStartTimeNs() uint64
func (*GetIdentityUpdatesRequest) GetWalletAddresses ¶
func (x *GetIdentityUpdatesRequest) GetWalletAddresses() []string
func (*GetIdentityUpdatesRequest) ProtoMessage ¶
func (*GetIdentityUpdatesRequest) ProtoMessage()
func (*GetIdentityUpdatesRequest) ProtoReflect ¶
func (x *GetIdentityUpdatesRequest) ProtoReflect() protoreflect.Message
func (*GetIdentityUpdatesRequest) Reset ¶
func (x *GetIdentityUpdatesRequest) Reset()
func (*GetIdentityUpdatesRequest) String ¶
func (x *GetIdentityUpdatesRequest) String() string
type GetIdentityUpdatesResponse ¶
type GetIdentityUpdatesResponse struct { // A list of updates (or empty objects if no changes) in the original order // of the request Updates []*GetIdentityUpdatesResponse_WalletUpdates `protobuf:"bytes,1,rep,name=updates,proto3" json:"updates,omitempty"` // contains filtered or unexported fields }
Used to get any new or revoked installations for a list of wallet addresses
func (*GetIdentityUpdatesResponse) Descriptor
deprecated
func (*GetIdentityUpdatesResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetIdentityUpdatesResponse.ProtoReflect.Descriptor instead.
func (*GetIdentityUpdatesResponse) GetUpdates ¶
func (x *GetIdentityUpdatesResponse) GetUpdates() []*GetIdentityUpdatesResponse_WalletUpdates
func (*GetIdentityUpdatesResponse) ProtoMessage ¶
func (*GetIdentityUpdatesResponse) ProtoMessage()
func (*GetIdentityUpdatesResponse) ProtoReflect ¶
func (x *GetIdentityUpdatesResponse) ProtoReflect() protoreflect.Message
func (*GetIdentityUpdatesResponse) Reset ¶
func (x *GetIdentityUpdatesResponse) Reset()
func (*GetIdentityUpdatesResponse) String ¶
func (x *GetIdentityUpdatesResponse) String() string
type GetIdentityUpdatesResponse_NewInstallationUpdate ¶
type GetIdentityUpdatesResponse_NewInstallationUpdate struct { InstallationId string `protobuf:"bytes,1,opt,name=installation_id,json=installationId,proto3" json:"installation_id,omitempty"` // contains filtered or unexported fields }
A new installation ID was seen for the first time by the nodes
func (*GetIdentityUpdatesResponse_NewInstallationUpdate) Descriptor
deprecated
func (*GetIdentityUpdatesResponse_NewInstallationUpdate) Descriptor() ([]byte, []int)
Deprecated: Use GetIdentityUpdatesResponse_NewInstallationUpdate.ProtoReflect.Descriptor instead.
func (*GetIdentityUpdatesResponse_NewInstallationUpdate) GetInstallationId ¶
func (x *GetIdentityUpdatesResponse_NewInstallationUpdate) GetInstallationId() string
func (*GetIdentityUpdatesResponse_NewInstallationUpdate) ProtoMessage ¶
func (*GetIdentityUpdatesResponse_NewInstallationUpdate) ProtoMessage()
func (*GetIdentityUpdatesResponse_NewInstallationUpdate) ProtoReflect ¶
func (x *GetIdentityUpdatesResponse_NewInstallationUpdate) ProtoReflect() protoreflect.Message
func (*GetIdentityUpdatesResponse_NewInstallationUpdate) Reset ¶
func (x *GetIdentityUpdatesResponse_NewInstallationUpdate) Reset()
func (*GetIdentityUpdatesResponse_NewInstallationUpdate) String ¶
func (x *GetIdentityUpdatesResponse_NewInstallationUpdate) String() string
type GetIdentityUpdatesResponse_RevokedInstallationUpdate ¶
type GetIdentityUpdatesResponse_RevokedInstallationUpdate struct { InstallationId string `protobuf:"bytes,1,opt,name=installation_id,json=installationId,proto3" json:"installation_id,omitempty"` // contains filtered or unexported fields }
An installation was revoked
func (*GetIdentityUpdatesResponse_RevokedInstallationUpdate) Descriptor
deprecated
func (*GetIdentityUpdatesResponse_RevokedInstallationUpdate) Descriptor() ([]byte, []int)
Deprecated: Use GetIdentityUpdatesResponse_RevokedInstallationUpdate.ProtoReflect.Descriptor instead.
func (*GetIdentityUpdatesResponse_RevokedInstallationUpdate) GetInstallationId ¶
func (x *GetIdentityUpdatesResponse_RevokedInstallationUpdate) GetInstallationId() string
func (*GetIdentityUpdatesResponse_RevokedInstallationUpdate) ProtoMessage ¶
func (*GetIdentityUpdatesResponse_RevokedInstallationUpdate) ProtoMessage()
func (*GetIdentityUpdatesResponse_RevokedInstallationUpdate) ProtoReflect ¶
func (x *GetIdentityUpdatesResponse_RevokedInstallationUpdate) ProtoReflect() protoreflect.Message
func (*GetIdentityUpdatesResponse_RevokedInstallationUpdate) Reset ¶
func (x *GetIdentityUpdatesResponse_RevokedInstallationUpdate) Reset()
func (*GetIdentityUpdatesResponse_RevokedInstallationUpdate) String ¶
func (x *GetIdentityUpdatesResponse_RevokedInstallationUpdate) String() string
type GetIdentityUpdatesResponse_Update ¶
type GetIdentityUpdatesResponse_Update struct { TimestampNs uint64 `protobuf:"varint,1,opt,name=timestamp_ns,json=timestampNs,proto3" json:"timestamp_ns,omitempty"` // Types that are assignable to Kind: // *GetIdentityUpdatesResponse_Update_NewInstallation // *GetIdentityUpdatesResponse_Update_RevokedInstallation Kind isGetIdentityUpdatesResponse_Update_Kind `protobuf_oneof:"kind"` // contains filtered or unexported fields }
A wrapper for any update to the wallet
func (*GetIdentityUpdatesResponse_Update) Descriptor
deprecated
func (*GetIdentityUpdatesResponse_Update) Descriptor() ([]byte, []int)
Deprecated: Use GetIdentityUpdatesResponse_Update.ProtoReflect.Descriptor instead.
func (*GetIdentityUpdatesResponse_Update) GetKind ¶
func (m *GetIdentityUpdatesResponse_Update) GetKind() isGetIdentityUpdatesResponse_Update_Kind
func (*GetIdentityUpdatesResponse_Update) GetNewInstallation ¶
func (x *GetIdentityUpdatesResponse_Update) GetNewInstallation() *GetIdentityUpdatesResponse_NewInstallationUpdate
func (*GetIdentityUpdatesResponse_Update) GetRevokedInstallation ¶
func (x *GetIdentityUpdatesResponse_Update) GetRevokedInstallation() *GetIdentityUpdatesResponse_RevokedInstallationUpdate
func (*GetIdentityUpdatesResponse_Update) GetTimestampNs ¶
func (x *GetIdentityUpdatesResponse_Update) GetTimestampNs() uint64
func (*GetIdentityUpdatesResponse_Update) ProtoMessage ¶
func (*GetIdentityUpdatesResponse_Update) ProtoMessage()
func (*GetIdentityUpdatesResponse_Update) ProtoReflect ¶
func (x *GetIdentityUpdatesResponse_Update) ProtoReflect() protoreflect.Message
func (*GetIdentityUpdatesResponse_Update) Reset ¶
func (x *GetIdentityUpdatesResponse_Update) Reset()
func (*GetIdentityUpdatesResponse_Update) String ¶
func (x *GetIdentityUpdatesResponse_Update) String() string
type GetIdentityUpdatesResponse_Update_NewInstallation ¶
type GetIdentityUpdatesResponse_Update_NewInstallation struct {
NewInstallation *GetIdentityUpdatesResponse_NewInstallationUpdate `protobuf:"bytes,2,opt,name=new_installation,json=newInstallation,proto3,oneof"`
}
type GetIdentityUpdatesResponse_Update_RevokedInstallation ¶
type GetIdentityUpdatesResponse_Update_RevokedInstallation struct {
RevokedInstallation *GetIdentityUpdatesResponse_RevokedInstallationUpdate `protobuf:"bytes,3,opt,name=revoked_installation,json=revokedInstallation,proto3,oneof"`
}
type GetIdentityUpdatesResponse_WalletUpdates ¶
type GetIdentityUpdatesResponse_WalletUpdates struct { Updates []*GetIdentityUpdatesResponse_Update `protobuf:"bytes,1,rep,name=updates,proto3" json:"updates,omitempty"` // contains filtered or unexported fields }
A wrapper for the updates for a single wallet
func (*GetIdentityUpdatesResponse_WalletUpdates) Descriptor
deprecated
func (*GetIdentityUpdatesResponse_WalletUpdates) Descriptor() ([]byte, []int)
Deprecated: Use GetIdentityUpdatesResponse_WalletUpdates.ProtoReflect.Descriptor instead.
func (*GetIdentityUpdatesResponse_WalletUpdates) GetUpdates ¶
func (x *GetIdentityUpdatesResponse_WalletUpdates) GetUpdates() []*GetIdentityUpdatesResponse_Update
func (*GetIdentityUpdatesResponse_WalletUpdates) ProtoMessage ¶
func (*GetIdentityUpdatesResponse_WalletUpdates) ProtoMessage()
func (*GetIdentityUpdatesResponse_WalletUpdates) ProtoReflect ¶
func (x *GetIdentityUpdatesResponse_WalletUpdates) ProtoReflect() protoreflect.Message
func (*GetIdentityUpdatesResponse_WalletUpdates) Reset ¶
func (x *GetIdentityUpdatesResponse_WalletUpdates) Reset()
func (*GetIdentityUpdatesResponse_WalletUpdates) String ¶
func (x *GetIdentityUpdatesResponse_WalletUpdates) String() string
type MlsApiClient ¶
type MlsApiClient interface { // Publish a MLS payload, that would be validated before being stored to the // network PublishToGroup(ctx context.Context, in *PublishToGroupRequest, opts ...grpc.CallOption) (*emptypb.Empty, error) // Publish a batch of welcome messages PublishWelcomes(ctx context.Context, in *PublishWelcomesRequest, opts ...grpc.CallOption) (*emptypb.Empty, error) // Register a new installation, which would be validated before storage RegisterInstallation(ctx context.Context, in *RegisterInstallationRequest, opts ...grpc.CallOption) (*RegisterInstallationResponse, error) // Upload one or more Key Packages, which would be validated before storage UploadKeyPackages(ctx context.Context, in *UploadKeyPackagesRequest, opts ...grpc.CallOption) (*emptypb.Empty, error) // Get one or more Key Packages by installation_id ConsumeKeyPackages(ctx context.Context, in *ConsumeKeyPackagesRequest, opts ...grpc.CallOption) (*ConsumeKeyPackagesResponse, error) // Would delete all key packages associated with the installation and mark // the installation as having been revoked RevokeInstallation(ctx context.Context, in *RevokeInstallationRequest, opts ...grpc.CallOption) (*emptypb.Empty, error) // Used to check for changes related to members of a group. // Would return an array of any new installations associated with the wallet // address, and any revocations that have happened. GetIdentityUpdates(ctx context.Context, in *GetIdentityUpdatesRequest, opts ...grpc.CallOption) (*GetIdentityUpdatesResponse, error) }
MlsApiClient is the client API for MlsApi service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewMlsApiClient ¶
func NewMlsApiClient(cc grpc.ClientConnInterface) MlsApiClient
type MlsApiServer ¶
type MlsApiServer interface { // Publish a MLS payload, that would be validated before being stored to the // network PublishToGroup(context.Context, *PublishToGroupRequest) (*emptypb.Empty, error) // Publish a batch of welcome messages PublishWelcomes(context.Context, *PublishWelcomesRequest) (*emptypb.Empty, error) // Register a new installation, which would be validated before storage RegisterInstallation(context.Context, *RegisterInstallationRequest) (*RegisterInstallationResponse, error) // Upload one or more Key Packages, which would be validated before storage UploadKeyPackages(context.Context, *UploadKeyPackagesRequest) (*emptypb.Empty, error) // Get one or more Key Packages by installation_id ConsumeKeyPackages(context.Context, *ConsumeKeyPackagesRequest) (*ConsumeKeyPackagesResponse, error) // Would delete all key packages associated with the installation and mark // the installation as having been revoked RevokeInstallation(context.Context, *RevokeInstallationRequest) (*emptypb.Empty, error) // Used to check for changes related to members of a group. // Would return an array of any new installations associated with the wallet // address, and any revocations that have happened. GetIdentityUpdates(context.Context, *GetIdentityUpdatesRequest) (*GetIdentityUpdatesResponse, error) // contains filtered or unexported methods }
MlsApiServer is the server API for MlsApi service. All implementations must embed UnimplementedMlsApiServer for forward compatibility
type PublishToGroupRequest ¶
type PublishToGroupRequest struct { Messages []*message_contents.GroupMessage `protobuf:"bytes,1,rep,name=messages,proto3" json:"messages,omitempty"` // contains filtered or unexported fields }
Publish a batch of MLS messages
func (*PublishToGroupRequest) Descriptor
deprecated
func (*PublishToGroupRequest) Descriptor() ([]byte, []int)
Deprecated: Use PublishToGroupRequest.ProtoReflect.Descriptor instead.
func (*PublishToGroupRequest) GetMessages ¶
func (x *PublishToGroupRequest) GetMessages() []*message_contents.GroupMessage
func (*PublishToGroupRequest) ProtoMessage ¶
func (*PublishToGroupRequest) ProtoMessage()
func (*PublishToGroupRequest) ProtoReflect ¶
func (x *PublishToGroupRequest) ProtoReflect() protoreflect.Message
func (*PublishToGroupRequest) Reset ¶
func (x *PublishToGroupRequest) Reset()
func (*PublishToGroupRequest) String ¶
func (x *PublishToGroupRequest) String() string
type PublishWelcomesRequest ¶
type PublishWelcomesRequest struct { WelcomeMessages []*PublishWelcomesRequest_WelcomeMessageRequest `protobuf:"bytes,1,rep,name=welcome_messages,json=welcomeMessages,proto3" json:"welcome_messages,omitempty"` // contains filtered or unexported fields }
Publish a batch of welcome messages
func (*PublishWelcomesRequest) Descriptor
deprecated
func (*PublishWelcomesRequest) Descriptor() ([]byte, []int)
Deprecated: Use PublishWelcomesRequest.ProtoReflect.Descriptor instead.
func (*PublishWelcomesRequest) GetWelcomeMessages ¶
func (x *PublishWelcomesRequest) GetWelcomeMessages() []*PublishWelcomesRequest_WelcomeMessageRequest
func (*PublishWelcomesRequest) ProtoMessage ¶
func (*PublishWelcomesRequest) ProtoMessage()
func (*PublishWelcomesRequest) ProtoReflect ¶
func (x *PublishWelcomesRequest) ProtoReflect() protoreflect.Message
func (*PublishWelcomesRequest) Reset ¶
func (x *PublishWelcomesRequest) Reset()
func (*PublishWelcomesRequest) String ¶
func (x *PublishWelcomesRequest) String() string
type PublishWelcomesRequest_WelcomeMessageRequest ¶
type PublishWelcomesRequest_WelcomeMessageRequest struct { // The topic will be derived from this InstallationId string `protobuf:"bytes,1,opt,name=installation_id,json=installationId,proto3" json:"installation_id,omitempty"` WelcomeMessage *message_contents.WelcomeMessage `protobuf:"bytes,2,opt,name=welcome_message,json=welcomeMessage,proto3" json:"welcome_message,omitempty"` // contains filtered or unexported fields }
An individual welcome message
func (*PublishWelcomesRequest_WelcomeMessageRequest) Descriptor
deprecated
func (*PublishWelcomesRequest_WelcomeMessageRequest) Descriptor() ([]byte, []int)
Deprecated: Use PublishWelcomesRequest_WelcomeMessageRequest.ProtoReflect.Descriptor instead.
func (*PublishWelcomesRequest_WelcomeMessageRequest) GetInstallationId ¶
func (x *PublishWelcomesRequest_WelcomeMessageRequest) GetInstallationId() string
func (*PublishWelcomesRequest_WelcomeMessageRequest) GetWelcomeMessage ¶
func (x *PublishWelcomesRequest_WelcomeMessageRequest) GetWelcomeMessage() *message_contents.WelcomeMessage
func (*PublishWelcomesRequest_WelcomeMessageRequest) ProtoMessage ¶
func (*PublishWelcomesRequest_WelcomeMessageRequest) ProtoMessage()
func (*PublishWelcomesRequest_WelcomeMessageRequest) ProtoReflect ¶
func (x *PublishWelcomesRequest_WelcomeMessageRequest) ProtoReflect() protoreflect.Message
func (*PublishWelcomesRequest_WelcomeMessageRequest) Reset ¶
func (x *PublishWelcomesRequest_WelcomeMessageRequest) Reset()
func (*PublishWelcomesRequest_WelcomeMessageRequest) String ¶
func (x *PublishWelcomesRequest_WelcomeMessageRequest) String() string
type RegisterInstallationRequest ¶
type RegisterInstallationRequest struct { CredentialBytes []byte `protobuf:"bytes,1,opt,name=credential_bytes,json=credentialBytes,proto3" json:"credential_bytes,omitempty"` SigningKeyPublic []byte `protobuf:"bytes,2,opt,name=signing_key_public,json=signingKeyPublic,proto3" json:"signing_key_public,omitempty"` // contains filtered or unexported fields }
Register a new installation
func (*RegisterInstallationRequest) Descriptor
deprecated
func (*RegisterInstallationRequest) Descriptor() ([]byte, []int)
Deprecated: Use RegisterInstallationRequest.ProtoReflect.Descriptor instead.
func (*RegisterInstallationRequest) GetCredentialBytes ¶
func (x *RegisterInstallationRequest) GetCredentialBytes() []byte
func (*RegisterInstallationRequest) GetSigningKeyPublic ¶
func (x *RegisterInstallationRequest) GetSigningKeyPublic() []byte
func (*RegisterInstallationRequest) ProtoMessage ¶
func (*RegisterInstallationRequest) ProtoMessage()
func (*RegisterInstallationRequest) ProtoReflect ¶
func (x *RegisterInstallationRequest) ProtoReflect() protoreflect.Message
func (*RegisterInstallationRequest) Reset ¶
func (x *RegisterInstallationRequest) Reset()
func (*RegisterInstallationRequest) String ¶
func (x *RegisterInstallationRequest) String() string
type RegisterInstallationResponse ¶
type RegisterInstallationResponse struct { InstallationId string `protobuf:"bytes,1,opt,name=installation_id,json=installationId,proto3" json:"installation_id,omitempty"` // contains filtered or unexported fields }
func (*RegisterInstallationResponse) Descriptor
deprecated
func (*RegisterInstallationResponse) Descriptor() ([]byte, []int)
Deprecated: Use RegisterInstallationResponse.ProtoReflect.Descriptor instead.
func (*RegisterInstallationResponse) GetInstallationId ¶
func (x *RegisterInstallationResponse) GetInstallationId() string
func (*RegisterInstallationResponse) ProtoMessage ¶
func (*RegisterInstallationResponse) ProtoMessage()
func (*RegisterInstallationResponse) ProtoReflect ¶
func (x *RegisterInstallationResponse) ProtoReflect() protoreflect.Message
func (*RegisterInstallationResponse) Reset ¶
func (x *RegisterInstallationResponse) Reset()
func (*RegisterInstallationResponse) String ¶
func (x *RegisterInstallationResponse) String() string
type RevokeInstallationRequest ¶
type RevokeInstallationRequest struct { InstallationId string `protobuf:"bytes,1,opt,name=installation_id,json=installationId,proto3" json:"installation_id,omitempty"` // All revocations must be validated with a wallet signature over the // installation_id being revoked (and some sort of standard prologue) WalletSignature *message_contents1.Signature `protobuf:"bytes,2,opt,name=wallet_signature,json=walletSignature,proto3" json:"wallet_signature,omitempty"` // contains filtered or unexported fields }
Revoke an installation
func (*RevokeInstallationRequest) Descriptor
deprecated
func (*RevokeInstallationRequest) Descriptor() ([]byte, []int)
Deprecated: Use RevokeInstallationRequest.ProtoReflect.Descriptor instead.
func (*RevokeInstallationRequest) GetInstallationId ¶
func (x *RevokeInstallationRequest) GetInstallationId() string
func (*RevokeInstallationRequest) GetWalletSignature ¶
func (x *RevokeInstallationRequest) GetWalletSignature() *message_contents1.Signature
func (*RevokeInstallationRequest) ProtoMessage ¶
func (*RevokeInstallationRequest) ProtoMessage()
func (*RevokeInstallationRequest) ProtoReflect ¶
func (x *RevokeInstallationRequest) ProtoReflect() protoreflect.Message
func (*RevokeInstallationRequest) Reset ¶
func (x *RevokeInstallationRequest) Reset()
func (*RevokeInstallationRequest) String ¶
func (x *RevokeInstallationRequest) String() string
type UnimplementedMlsApiServer ¶
type UnimplementedMlsApiServer struct { }
UnimplementedMlsApiServer must be embedded to have forward compatible implementations.
func (UnimplementedMlsApiServer) ConsumeKeyPackages ¶
func (UnimplementedMlsApiServer) ConsumeKeyPackages(context.Context, *ConsumeKeyPackagesRequest) (*ConsumeKeyPackagesResponse, error)
func (UnimplementedMlsApiServer) GetIdentityUpdates ¶
func (UnimplementedMlsApiServer) GetIdentityUpdates(context.Context, *GetIdentityUpdatesRequest) (*GetIdentityUpdatesResponse, error)
func (UnimplementedMlsApiServer) PublishToGroup ¶
func (UnimplementedMlsApiServer) PublishToGroup(context.Context, *PublishToGroupRequest) (*emptypb.Empty, error)
func (UnimplementedMlsApiServer) PublishWelcomes ¶
func (UnimplementedMlsApiServer) PublishWelcomes(context.Context, *PublishWelcomesRequest) (*emptypb.Empty, error)
func (UnimplementedMlsApiServer) RegisterInstallation ¶
func (UnimplementedMlsApiServer) RegisterInstallation(context.Context, *RegisterInstallationRequest) (*RegisterInstallationResponse, error)
func (UnimplementedMlsApiServer) RevokeInstallation ¶
func (UnimplementedMlsApiServer) RevokeInstallation(context.Context, *RevokeInstallationRequest) (*emptypb.Empty, error)
func (UnimplementedMlsApiServer) UploadKeyPackages ¶
func (UnimplementedMlsApiServer) UploadKeyPackages(context.Context, *UploadKeyPackagesRequest) (*emptypb.Empty, error)
type UnsafeMlsApiServer ¶
type UnsafeMlsApiServer interface {
// contains filtered or unexported methods
}
UnsafeMlsApiServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to MlsApiServer will result in compilation errors.
type UploadKeyPackagesRequest ¶
type UploadKeyPackagesRequest struct { KeyPackages []*UploadKeyPackagesRequest_KeyPackageUpload `protobuf:"bytes,1,rep,name=key_packages,json=keyPackages,proto3" json:"key_packages,omitempty"` // contains filtered or unexported fields }
Upload one or more key packages
func (*UploadKeyPackagesRequest) Descriptor
deprecated
func (*UploadKeyPackagesRequest) Descriptor() ([]byte, []int)
Deprecated: Use UploadKeyPackagesRequest.ProtoReflect.Descriptor instead.
func (*UploadKeyPackagesRequest) GetKeyPackages ¶
func (x *UploadKeyPackagesRequest) GetKeyPackages() []*UploadKeyPackagesRequest_KeyPackageUpload
func (*UploadKeyPackagesRequest) ProtoMessage ¶
func (*UploadKeyPackagesRequest) ProtoMessage()
func (*UploadKeyPackagesRequest) ProtoReflect ¶
func (x *UploadKeyPackagesRequest) ProtoReflect() protoreflect.Message
func (*UploadKeyPackagesRequest) Reset ¶
func (x *UploadKeyPackagesRequest) Reset()
func (*UploadKeyPackagesRequest) String ¶
func (x *UploadKeyPackagesRequest) String() string
type UploadKeyPackagesRequest_KeyPackageUpload ¶
type UploadKeyPackagesRequest_KeyPackageUpload struct { // The owner's wallet address would be extracted from the identity // credential in the key package, and all signatures would be validated. KeyPackageTlsSerialized []byte `` /* 134-byte string literal not displayed */ // The node will always treat the most recent last-resort key package as // the active one, and will ignore all others. IsLastResort bool `protobuf:"varint,2,opt,name=is_last_resort,json=isLastResort,proto3" json:"is_last_resort,omitempty"` // contains filtered or unexported fields }
An individual key package upload request
func (*UploadKeyPackagesRequest_KeyPackageUpload) Descriptor
deprecated
func (*UploadKeyPackagesRequest_KeyPackageUpload) Descriptor() ([]byte, []int)
Deprecated: Use UploadKeyPackagesRequest_KeyPackageUpload.ProtoReflect.Descriptor instead.
func (*UploadKeyPackagesRequest_KeyPackageUpload) GetIsLastResort ¶
func (x *UploadKeyPackagesRequest_KeyPackageUpload) GetIsLastResort() bool
func (*UploadKeyPackagesRequest_KeyPackageUpload) GetKeyPackageTlsSerialized ¶
func (x *UploadKeyPackagesRequest_KeyPackageUpload) GetKeyPackageTlsSerialized() []byte
func (*UploadKeyPackagesRequest_KeyPackageUpload) ProtoMessage ¶
func (*UploadKeyPackagesRequest_KeyPackageUpload) ProtoMessage()
func (*UploadKeyPackagesRequest_KeyPackageUpload) ProtoReflect ¶
func (x *UploadKeyPackagesRequest_KeyPackageUpload) ProtoReflect() protoreflect.Message
func (*UploadKeyPackagesRequest_KeyPackageUpload) Reset ¶
func (x *UploadKeyPackagesRequest_KeyPackageUpload) Reset()
func (*UploadKeyPackagesRequest_KeyPackageUpload) String ¶
func (x *UploadKeyPackagesRequest_KeyPackageUpload) String() string