entity

Documentation

Index

• Constants
• Variables
• func GetTxDataStateBytes(chainId string, nonceTime Time, txData TxData) []byte
• type HexBytes
  • func (hb HexBytes) MarshalJSON() ([]byte, error)
  • func (hb HexBytes) String() string
  • func (hb *HexBytes) UnmarshalJSON(data []byte) error
• type Time
  • func GetCurrentTime() Time
  • func (t Time) MarshalJSON() ([]byte, error)
• type Tx
  • func (a Tx) MarshalJSON() ([]byte, error)
  • func (a *Tx) UnmarshalJSON(data []byte) error
• type TxAlias
• type TxData
  • func UnmarshalTxData(txDataWrapper *serializer.UnmarshalWrapper) (TxData, error)
• type TxSigner
  • func NewTxSigner(fqId string, privateKey *ed25519.PrivateKey) *TxSigner
• type UnknownTxData
  • func (utd UnknownTxData) GetNamespace() string
  • func (utd UnknownTxData) GetStateIds(signerCompanyBcId string) map[string]string
  • func (utd UnknownTxData) GetType() string

Constants

const RFC3339MicroZeroPadded = "2006-01-02T15:04:05.000000Z07:00"

Variables

var AvailableTxDataTypes = map[string]reflect.Type{
	certify.GetCertificateRawV1Type():     reflect.TypeOf(certify.CertificateRawV1{}),
	certify.GetCertificateEd25519V1Type(): reflect.TypeOf(certify.CertificateEd25519V1{}),
	certify.GetSecretNaclBoxV1Type():      reflect.TypeOf(certify.SecretNaclBoxV1{}),
	account.GetKeyCreateV1Type():          reflect.TypeOf(account.KeyCreateV1{}),
	account.GetKeyRotateV1Type():          reflect.TypeOf(account.KeyRotateV1{}),
	account.GetKeyRevokeV1Type():          reflect.TypeOf(account.KeyRevokeV1{}),
}

Functions

func GetTxDataStateBytes

func GetTxDataStateBytes(chainId string, nonceTime Time, txData TxData) []byte

GetTxDataStateBytes returns the sorted and marshaled json representation of a TxData ready to be signed.

Types

type HexBytes

type HexBytes []byte

HexBytes allows to json marshal/unmarshal a byte array into an hex encoded string.

func (HexBytes) MarshalJSON

func (hb HexBytes) MarshalJSON() ([]byte, error)

MarshalJSON encodes a byte array to an hex string.

func (HexBytes) String

func (hb HexBytes) String() string

String returns the hex string representation of a byte array.

func (*HexBytes) UnmarshalJSON

func (hb *HexBytes) UnmarshalJSON(data []byte) error

UnmarshalJSON converts an hex encoded string into a byte array.

type Time

type Time struct {
	time.Time
}

Time is a time.Time wrapper.

func GetCurrentTime

func GetCurrentTime() Time

GetCurrentTime returns a well formatted custom time.Now()

func (Time) MarshalJSON

func (t Time) MarshalJSON() ([]byte, error)

MarshalJSON converts a Time into a time.Time and marshals its UTC value with a microseconds precision.

type Tx

type Tx struct {
	// To avoid replay attack, this value is checked in the replay protector.
	NonceTime Time `json:"nonce_time" validate:"required"`

	// Transaction data, this value is handled by the application.
	Data TxData `json:"data" validate:"required"`

	// Transaction signer and signature info to identify the sender.
	SignerFqId string            `json:"signer_fqid" validate:"required,fqid"`
	Signature  ed25519.Signature `json:"signature" validate:"required,len=64"`
}

Tx wraps a TxData with its signature, its signer id and a nonce time.

func (Tx) MarshalJSON

func (a Tx) MarshalJSON() ([]byte, error)

MarshalJSON encodes a Tx to add the TxData type information.

func (*Tx) UnmarshalJSON

func (a *Tx) UnmarshalJSON(data []byte) error

UnmarshalJSON converts an encoded Tx and create the concrete TxData according to its type information.

type TxAlias

type TxAlias Tx

TxAlias is useful to avoid triggering the custom Tx MarshalJSON method.

type TxData

type TxData interface {
	// To fetch all the entity state ids a TxData can create/update/delete.
	// This is also used to index Txs.
	GetStateIds(signerCompanyBcId string) map[string]string

	// To identify which plugin should handle this TxData.
	GetNamespace() string

	// To identify its subtype.
	GetType() string
}

TxData interface defines the methods a concrete TxData must implement.

func UnmarshalTxData

func UnmarshalTxData(txDataWrapper *serializer.UnmarshalWrapper) (TxData, error)

UnmarshalTxData accepts a wrapper and tries to unmarshal its value according to its string type.

type TxSigner

type TxSigner struct {
	FqId       string
	PrivateKey *ed25519.PrivateKey
}

TxSigner contains all information about a Tx signer.

func NewTxSigner

func NewTxSigner(fqId string, privateKey *ed25519.PrivateKey) *TxSigner

TxSigner constructor.

type UnknownTxData

type UnknownTxData struct {
	Type string `json:"-"`
	json.RawMessage
}

UnknownTxData is useful to unmarshal and marshal back a tx data of unknown type.

func (UnknownTxData) GetNamespace

func (utd UnknownTxData) GetNamespace() string

func (UnknownTxData) GetStateIds

func (utd UnknownTxData) GetStateIds(signerCompanyBcId string) map[string]string

func (UnknownTxData) GetType

func (utd UnknownTxData) GetType() string