models

type APIKey struct {
	Model
	Description sql.NullString
	ClientID    string
	Secret      string
	LastSeen    sql.NullTime
	// contains filtered or unexported fields
}

type APIKeyPage struct {
	APIKeys []*APIKey `json:"api_keys"`
	Page    *PageInfo `json:"page"`
}

type Account struct {
	Model
	CustomerID    sql.NullString  // Account ID of internal user record (optional)
	FirstName     sql.NullString  // First name (forename) of user
	LastName      sql.NullString  // Last name (surname) of user
	TravelAddress sql.NullString  // Generated TravelAddress for this user
	IVMSRecord    *ivms101.Person // IVMS101 record for the account
	// contains filtered or unexported fields
}

type AccountsPage struct {
	Accounts []*Account `json:"accounts"`
	Page     *PageInfo  `json:"page"`
}

type Counterparty struct {
	Model
	Source              string               // either directory or locally created
	DirectoryID         sql.NullString       // the directory ID associated with the counterparty (directory only)
	RegisteredDirectory sql.NullString       // the registered directory of the counterparty (directory only)
	Protocol            string               // either TRISA or TRP; the protocol to use to send travel rule information
	CommonName          string               // common name - a unique name to identify the endpoint
	Endpoint            string               // the full endpoint to connect to the counterparty on
	Name                string               // the counterparty's legal entity name
	Website             sql.NullString       // website with more information about the counterparty
	Country             sql.NullString       // country the counterparty is associated with
	BusinessCategory    sql.NullString       // the business category of the counterparty
	VASPCategories      VASPCategories       // the categories of how the VASP handles crypto assets
	VerifiedOn          sql.NullTime         // the datetime the VASP was verified in the directory (directory only)
	IVMSRecord          *ivms101.LegalPerson // IVMS101 record for the counterparty
}

type CounterpartyPage struct {
	Counterparties []*Counterparty `json:"counterparties"`
	Page           *PageInfo       `json:"page"`
}

type CounterpartySourceInfo struct {
	ID                  ulid.ULID
	Source              string         // either directory or locally created
	DirectoryID         sql.NullString // the directory ID associated with the counterparty (directory only)
	RegisteredDirectory sql.NullString // the registered directory of the counterparty (directory only)
	Protocol            string         // either TRISA or TRP; the protocol to use to send travel rule information
}

type CryptoAddress struct {
	Model
	AccountID     ulid.ULID      // Reference to account the crypto address belongs to
	CryptoAddress string         // The actual crypto address of the wallet
	Network       string         // The network associated with the crypto address in SIP0044 encoding
	AssetType     sql.NullString // The asset type with the crypto address (optional)
	Tag           sql.NullString // The memo or destination tag associated with the address (optional)
	TravelAddress sql.NullString // Generated TravelAddress for this wallet address
	// contains filtered or unexported fields
}

type CryptoAddressPage struct {
	CryptoAddresses []*CryptoAddress `json:"crypto_addresses"`
	Page            *PageInfo        `json:"page"`
}

type EnvelopeStorage interface {
	AddEnvelope(*SecureEnvelope) error
}

type Model struct {
	ID       ulid.ULID `json:"id"`
	Created  time.Time `json:"created"`
	Modified time.Time `json:"modified"`
}

type PageInfo struct {
	PageSize   uint32    `json:"page_size"`
	NextPageID ulid.ULID `json:"next_page_id"`
	PrevPageID ulid.ULID `json:"prev_page_id"`
}

type Permission struct {
	ID          int64
	Title       string
	Description string
	Created     time.Time
	Modified    time.Time
}

type PreparedTransaction interface {
	Created() bool                       // Returns true if the transaction was newly created, false if it already existed
	Fetch() (*Transaction, error)        // Fetches the current transaction record from the database
	Update(*Transaction) error           // Update the transaction with new information; e.g. data from decryption
	AddCounterparty(*Counterparty) error // Add counterparty by database ULID, counterparty name, or registered directory ID; if the counterparty doesn't exist, it is created
	AddEnvelope(*SecureEnvelope) error   // Associate a secure envelope with the prepared transaction
	Rollback() error                     // Rollback the prepared transaction and conclude it
	Commit() error                       // Commit the prepared transaction and conclude it
}

type Role struct {
	ID          int64
	Title       string
	Description string
	IsDefault   bool
	Created     time.Time
	Modified    time.Time
	// contains filtered or unexported fields
}

type Scanner interface {
	Scan(dest ...any) error
}

type SearchQuery struct {
	Query string
	Limit int
}

type SecureEnvelope struct {
	Model
	EnvelopeID    uuid.UUID           // Also a foreign key reference to the Transaction
	Direction     string              // Either "out" outgoing or "in" incoming
	Remote        sql.NullString      // The common name of the remote peer this message was going to or coming from
	ReplyTo       ulids.NullULID      // If this envelope is a response, a reference to the original request envelope
	IsError       bool                // If the envelope contains an error/rejection rather than a payload
	EncryptionKey []byte              // The encryption key, encrypted with the public key of the local node. Note this may differ from the value in the envelope for outgoing messages
	HMACSecret    []byte              // The hmac secret, encrypted with the public key of the local node. Note that this may differ from the value in the envelope for outgoing messages
	ValidHMAC     sql.NullBool        // If the hmac has been validated against the payload and non-repudiation properties are satisfied
	Timestamp     time.Time           // The timestamp of the envelope as defined by the envelope
	PublicKey     sql.NullString      // The signature of the public key that sealed the encryption key and hmac secret, may differ from the value in the envelope for ougoing envelopes.
	TransferState int32               // The transfer state of the secure envelope
	Envelope      *api.SecureEnvelope // The secure envelope protocol buffer stored as a BLOB
	// contains filtered or unexported fields
}

type SecureEnvelopePage struct {
	Envelopes []*SecureEnvelope `json:"envelopes"`
	Page      *PageInfo         `json:"page"`
}

type Transaction struct {
	ID                 uuid.UUID      // Transaction IDs are UUIDs not ULIDs per the TRISA spec, this is also used for the envelope ID
	Source             string         // Either "local" meaning the transaction was created by the user, or "remote" meaning it is an incoming message
	Status             string         // Can be "unspecified", "started", "pending", "review", "repair", "accepted", "completed", or "rejected"
	Counterparty       string         // The name of the counterparty in the transaction
	CounterpartyID     ulids.NullULID // A reference to the counterparty in the database, if any
	Originator         sql.NullString // Full name of the originator natural person or account
	OriginatorAddress  sql.NullString // The crypto address of the originator
	Beneficiary        sql.NullString // Full name of the beneficiary natural person or account
	BeneficiaryAddress sql.NullString // The crypto address of the beneficiary
	VirtualAsset       string         // A representation of the network/asset type
	Amount             float64        // The amount of the transaction
	LastUpdate         sql.NullTime   // The last time a TRISA RPC occurred for this transaction
	Created            time.Time      // Timestamp the transaction was created
	Modified           time.Time      // Timestamp the transaction was last modified, including when a new secure envelope was received
	// contains filtered or unexported fields
}

type TransactionPage struct {
	Transactions []*Transaction `json:"transactions"`
	Page         *PageInfo      `json:"page"`
}

type TravelAddressFactory func(any) (string, error)

type User struct {
	Model
	Name      sql.NullString
	Email     string
	Password  string
	RoleID    int64
	LastLogin sql.NullTime
	// contains filtered or unexported fields
}

type UserPage struct {
	Users []*User   `json:"users"`
	Page  *PageInfo `json:"page"`
}

type VASPCategories []string