generic

package
v1.5.0 Latest Latest
Warning

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

 Go to latest Published: Jan 25, 2025 License: MIT Imports: 4 Imported by: 6

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	Identifier_name = map[int32]string{
		0: "SYMBOL",
		1: "DTI",
		2: "SLIP0044",
	}
	Identifier_value = map[string]int32{
		"SYMBOL":   0,
		"DTI":      1,
		"SLIP0044": 2,
	}
)

Enum value maps for Identifier.

View Source 
var File_trisa_data_generic_v1beta1_transaction_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Asset added in v1.5.0 

type Asset struct {
	Identifier Identifier `protobuf:"varint,1,opt,name=identifier,proto3,enum=trisa.data.generic.v1beta1.Identifier" json:"identifier,omitempty"` // the identifier being used, e.g. "DTI" or "SLIP0044"
	Symbol     string     `protobuf:"bytes,2,opt,name=symbol,proto3" json:"symbol,omitempty"`                                                     // the symbol of the asset used for the identifier
	// contains filtered or unexported fields
}

func (*Asset) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use Asset.ProtoReflect.Descriptor instead.

func (*Asset) GetIdentifier added in v1.5.0 

func (x *Asset) GetIdentifier() Identifier

func (*Asset) GetSymbol added in v1.5.0 

func (x *Asset) GetSymbol() string

func (*Asset) ProtoMessage added in v1.5.0 

func (*Asset) ProtoMessage()

func (*Asset) ProtoReflect added in v1.5.0 

func (x *Asset) ProtoReflect() protoreflect.Message

func (*Asset) Reset added in v1.5.0 

func (x *Asset) Reset()

func (*Asset) String added in v1.5.0 

func (x *Asset) String() string

type ConfirmationReceipt 

type ConfirmationReceipt struct {
	EnvelopeId       string `protobuf:"bytes,1,opt,name=envelope_id,json=envelopeId,proto3" json:"envelope_id,omitempty"`                    // the TRISA envelope ID for reference
	ReceivedBy       string `protobuf:"bytes,2,opt,name=received_by,json=receivedBy,proto3" json:"received_by,omitempty"`                    // name of the recipient or recipient VASP
	ReceivedAt       string `protobuf:"bytes,3,opt,name=received_at,json=receivedAt,proto3" json:"received_at,omitempty"`                    // RFC 3339 timestamp of the receipt of request
	Message          string `protobuf:"bytes,4,opt,name=message,proto3" json:"message,omitempty"`                                            // A generic message to respond with
	ResponseRequired bool   `protobuf:"varint,5,opt,name=response_required,json=responseRequired,proto3" json:"response_required,omitempty"` // If the message requires an additional transfer message
	// contains filtered or unexported fields
}

DEPRECATED: the ConfirmationReceipt message was deemed to cause confusion as it could signal that the confirmation payload was received and the transfer is concluded. Use the Pending message instead to signal that this is a control flow message.

func (*ConfirmationReceipt) Descriptor deprecated 

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

Deprecated: Use ConfirmationReceipt.ProtoReflect.Descriptor instead.

func (*ConfirmationReceipt) GetEnvelopeId 

func (x *ConfirmationReceipt) GetEnvelopeId() string

func (*ConfirmationReceipt) GetMessage 

func (x *ConfirmationReceipt) GetMessage() string

func (*ConfirmationReceipt) GetReceivedAt 

func (x *ConfirmationReceipt) GetReceivedAt() string

func (*ConfirmationReceipt) GetReceivedBy 

func (x *ConfirmationReceipt) GetReceivedBy() string

func (*ConfirmationReceipt) GetResponseRequired added in v0.3.1 

func (x *ConfirmationReceipt) GetResponseRequired() bool

func (*ConfirmationReceipt) ProtoMessage 

func (*ConfirmationReceipt) ProtoMessage()

func (*ConfirmationReceipt) ProtoReflect 

func (x *ConfirmationReceipt) ProtoReflect() protoreflect.Message

func (*ConfirmationReceipt) Reset 

func (x *ConfirmationReceipt) Reset()

func (*ConfirmationReceipt) String 

func (x *ConfirmationReceipt) String() string

type Identifier added in v1.5.0 

type Identifier int32
const (
	Identifier_SYMBOL   Identifier = 0 // the identifier is a coin/token symbol
	Identifier_DTI      Identifier = 1 // the Digital Token Identifier (DTI) for the asset
	Identifier_SLIP0044 Identifier = 2 // the SLIP0044 identifier for the asset
)

func (Identifier) Descriptor added in v1.5.0 

func (Identifier) Descriptor() protoreflect.EnumDescriptor

func (Identifier) Enum added in v1.5.0 

func (x Identifier) Enum() *Identifier

func (Identifier) EnumDescriptor deprecated added in v1.5.0 

func (Identifier) EnumDescriptor() ([]byte, []int)

Deprecated: Use Identifier.Descriptor instead.

func (Identifier) Number added in v1.5.0 

func (x Identifier) Number() protoreflect.EnumNumber

func (Identifier) String added in v1.5.0 

func (x Identifier) String() string

func (Identifier) Type added in v1.5.0 

func (Identifier) Type() protoreflect.EnumType

type Pending added in v0.3.2 

type Pending struct {
	EnvelopeId     string       `protobuf:"bytes,1,opt,name=envelope_id,json=envelopeId,proto3" json:"envelope_id,omitempty"`               // the TRISA envelope ID that refers to the compliance communication
	ReceivedBy     string       `protobuf:"bytes,2,opt,name=received_by,json=receivedBy,proto3" json:"received_by,omitempty"`               // the name of the recipient or recipient VASP
	ReceivedAt     string       `protobuf:"bytes,3,opt,name=received_at,json=receivedAt,proto3" json:"received_at,omitempty"`               // the RFC3339 formatted timestamp when the request was received
	Message        string       `protobuf:"bytes,4,opt,name=message,proto3" json:"message,omitempty"`                                       // an optional message to respond with to the counterparty
	ReplyNotAfter  string       `protobuf:"bytes,5,opt,name=reply_not_after,json=replyNotAfter,proto3" json:"reply_not_after,omitempty"`    // the RFC3339 formatted timestamp when the response will be returned by
	ReplyNotBefore string       `protobuf:"bytes,6,opt,name=reply_not_before,json=replyNotBefore,proto3" json:"reply_not_before,omitempty"` // the RFC339 formatted timestamp that the response will not be sent before
	ExtraJson      string       `protobuf:"bytes,7,opt,name=extra_json,json=extraJson,proto3" json:"extra_json,omitempty"`                  // any extra data as a JSON formatted object
	Transaction    *Transaction `protobuf:"bytes,15,opt,name=transaction,proto3" json:"transaction,omitempty"`                              // the original transaction for reference
	// contains filtered or unexported fields
}

A control flow message to support asynchronous TRISA transfers. Pending messages can be returned as an intermediate response during a compliance transfer if further processing is required before a response can be sent. The Pending message should provide information to the originator about when they can expect a response via the reply_not_before and reply_not_after timestamps. The Pending message should also provide collation information such as the envelope_id and original transaction so that the response message can be matched to the original request.

func (*Pending) Descriptor deprecated added in v0.3.2 

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

Deprecated: Use Pending.ProtoReflect.Descriptor instead.

func (*Pending) GetEnvelopeId added in v0.3.2 

func (x *Pending) GetEnvelopeId() string

func (*Pending) GetExtraJson added in v0.3.2 

func (x *Pending) GetExtraJson() string

func (*Pending) GetMessage added in v0.3.2 

func (x *Pending) GetMessage() string

func (*Pending) GetReceivedAt added in v0.3.2 

func (x *Pending) GetReceivedAt() string

func (*Pending) GetReceivedBy added in v0.3.2 

func (x *Pending) GetReceivedBy() string

func (*Pending) GetReplyNotAfter added in v0.3.2 

func (x *Pending) GetReplyNotAfter() string

func (*Pending) GetReplyNotBefore added in v0.3.2 

func (x *Pending) GetReplyNotBefore() string

func (*Pending) GetTransaction added in v0.3.2 

func (x *Pending) GetTransaction() *Transaction

func (*Pending) ProtoMessage added in v0.3.2 

func (*Pending) ProtoMessage()

func (*Pending) ProtoReflect added in v0.3.2 

func (x *Pending) ProtoReflect() protoreflect.Message

func (*Pending) Reset added in v0.3.2 

func (x *Pending) Reset()

func (*Pending) String added in v0.3.2 

func (x *Pending) String() string

type Sunrise added in v1.5.0 

type Sunrise struct {
	EnvelopeId   string            `protobuf:"bytes,1,opt,name=envelope_id,json=envelopeId,proto3" json:"envelope_id,omitempty"` // the TRISA envelope ID for reference
	Counterparty string            `protobuf:"bytes,2,opt,name=counterparty,proto3" json:"counterparty,omitempty"`               // the name of the counterparty or counterparty VASP the messages were sent to
	Messages     []*SunriseMessage `protobuf:"bytes,3,rep,name=messages,proto3" json:"messages,omitempty"`                       // the list of recipients that the message was sent to
	ExtraJson    string            `protobuf:"bytes,14,opt,name=extra_json,json=extraJson,proto3" json:"extra_json,omitempty"`   // any extra data as a JSON formatted object
	Transaction  *Transaction      `protobuf:"bytes,15,opt,name=transaction,proto3" json:"transaction,omitempty"`                // the original transaction for reference
	// contains filtered or unexported fields
}

Sunrise is a control flow message to indicate that the message was sent over a side channel to the TRISA protocol such as via email or phone. The Sunrise message is only saved locally to indicate a record of an out-of-band communication and is not sent in a TRISA payload.

func (*Sunrise) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use Sunrise.ProtoReflect.Descriptor instead.

func (*Sunrise) GetCounterparty added in v1.5.0 

func (x *Sunrise) GetCounterparty() string

func (*Sunrise) GetEnvelopeId added in v1.5.0 

func (x *Sunrise) GetEnvelopeId() string

func (*Sunrise) GetExtraJson added in v1.5.0 

func (x *Sunrise) GetExtraJson() string

func (*Sunrise) GetMessages added in v1.5.0 

func (x *Sunrise) GetMessages() []*SunriseMessage

func (*Sunrise) GetTransaction added in v1.5.0 

func (x *Sunrise) GetTransaction() *Transaction

func (*Sunrise) ProtoMessage added in v1.5.0 

func (*Sunrise) ProtoMessage()

func (*Sunrise) ProtoReflect added in v1.5.0 

func (x *Sunrise) ProtoReflect() protoreflect.Message

func (*Sunrise) Reset added in v1.5.0 

func (x *Sunrise) Reset()

func (*Sunrise) String added in v1.5.0 

func (x *Sunrise) String() string

type SunriseMessage added in v1.5.0 

type SunriseMessage struct {
	Recipient      string `protobuf:"bytes,1,opt,name=recipient,proto3" json:"recipient,omitempty"`                                   // the name of the recipient or recipient VASP
	Email          string `protobuf:"bytes,2,opt,name=email,proto3" json:"email,omitempty"`                                           // the email address of the recipient
	Phone          string `protobuf:"bytes,3,opt,name=phone,proto3" json:"phone,omitempty"`                                           // the phone number of the recipient
	Channel        string `protobuf:"bytes,4,opt,name=channel,proto3" json:"channel,omitempty"`                                       // the name of the method or channel the message was sent over (e.g. email or phone)
	SentAt         string `protobuf:"bytes,5,opt,name=sent_at,json=sentAt,proto3" json:"sent_at,omitempty"`                           // the RFC3339 formatted timestamp when the message was sent
	ReplyNotBefore string `protobuf:"bytes,6,opt,name=reply_not_before,json=replyNotBefore,proto3" json:"reply_not_before,omitempty"` // the RFC339 formatted timestamp that the response is expected before message expiration
	// contains filtered or unexported fields
}

SunriseMessages may be sent to multiple contacts via different channels (e.g. via an email or phone call to the compliance officer and general contact).

func (*SunriseMessage) Descriptor deprecated added in v1.5.0 

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

Deprecated: Use SunriseMessage.ProtoReflect.Descriptor instead.

func (*SunriseMessage) GetChannel added in v1.5.0 

func (x *SunriseMessage) GetChannel() string

func (*SunriseMessage) GetEmail added in v1.5.0 

func (x *SunriseMessage) GetEmail() string

func (*SunriseMessage) GetPhone added in v1.5.0 

func (x *SunriseMessage) GetPhone() string

func (*SunriseMessage) GetRecipient added in v1.5.0 

func (x *SunriseMessage) GetRecipient() string

func (*SunriseMessage) GetReplyNotBefore added in v1.5.0 

func (x *SunriseMessage) GetReplyNotBefore() string

func (*SunriseMessage) GetSentAt added in v1.5.0 

func (x *SunriseMessage) GetSentAt() string

func (*SunriseMessage) ProtoMessage added in v1.5.0 

func (*SunriseMessage) ProtoMessage()

func (*SunriseMessage) ProtoReflect added in v1.5.0 

func (x *SunriseMessage) ProtoReflect() protoreflect.Message

func (*SunriseMessage) Reset added in v1.5.0 

func (x *SunriseMessage) Reset()

func (*SunriseMessage) String added in v1.5.0 

func (x *SunriseMessage) String() string

type Transaction 

type Transaction struct {
	Txid        string  `protobuf:"bytes,1,opt,name=txid,proto3" json:"txid,omitempty"`                            // a transaction ID unique to the chain/network
	Originator  string  `protobuf:"bytes,2,opt,name=originator,proto3" json:"originator,omitempty"`                // crypto address of the originator
	Beneficiary string  `protobuf:"bytes,3,opt,name=beneficiary,proto3" json:"beneficiary,omitempty"`              // crypto address of the beneficiary
	Amount      float64 `protobuf:"fixed64,4,opt,name=amount,proto3" json:"amount,omitempty"`                      // amount of the transaction
	Network     string  `protobuf:"bytes,5,opt,name=network,proto3" json:"network,omitempty"`                      // the chain/network of the transaction
	Timestamp   string  `protobuf:"bytes,6,opt,name=timestamp,proto3" json:"timestamp,omitempty"`                  // RFC 3339 timestamp of the transaction
	ExtraJson   string  `protobuf:"bytes,7,opt,name=extra_json,json=extraJson,proto3" json:"extra_json,omitempty"` // any extra data as a JSON formatted object
	AssetType   string  `protobuf:"bytes,8,opt,name=asset_type,json=assetType,proto3" json:"asset_type,omitempty"` // the type of virtual asset for multi-asset chains
	Tag         string  `protobuf:"bytes,9,opt,name=tag,proto3" json:"tag,omitempty"`                              // optional memo/destination-tag required by some ledgers to identify transactions
	// contains filtered or unexported fields
}

Generic Transaction message for TRISA transaction payloads. The goal of this payload is to provide enough information to link Travel Rule Compliance information in the identity payload with a transaction on the blockchain or network. All fields are optional, this message serves as a convenience for parsing transaction payloads.

func (*Transaction) Descriptor deprecated 

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

Deprecated: Use Transaction.ProtoReflect.Descriptor instead.

func (*Transaction) GetAmount 

func (x *Transaction) GetAmount() float64

func (*Transaction) GetAssetType added in v0.3.1 

func (x *Transaction) GetAssetType() string

func (*Transaction) GetBeneficiary 

func (x *Transaction) GetBeneficiary() string

func (*Transaction) GetExtraJson 

func (x *Transaction) GetExtraJson() string

func (*Transaction) GetNetwork 

func (x *Transaction) GetNetwork() string

func (*Transaction) GetOriginator 

func (x *Transaction) GetOriginator() string

func (*Transaction) GetTag added in v0.3.2 

func (x *Transaction) GetTag() string

func (*Transaction) GetTimestamp 

func (x *Transaction) GetTimestamp() string

func (*Transaction) GetTxid 

func (x *Transaction) GetTxid() string

func (*Transaction) ProtoMessage 

func (*Transaction) ProtoMessage()

func (*Transaction) ProtoReflect 

func (x *Transaction) ProtoReflect() protoreflect.Message

func (*Transaction) Reset 

func (x *Transaction) Reset()

func (*Transaction) String 

func (x *Transaction) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.