transactions

Documentation

Index

• func NewHandler(appConfig *config.AppConfig, services *config.AppServices) (routes.BasicEndpointsFunc, routes.APIEndpointsFunc, ...)
• type Action
• type NewTransaction
• type RecordTransaction
• type UpdateTransaction

Functions

func NewHandler

func NewHandler(appConfig *config.AppConfig, services *config.AppServices) (routes.BasicEndpointsFunc, routes.APIEndpointsFunc, routes.CallbackEndpointsFunc)

NewHandler creates the specific package routes

Types

type Action

type Action struct {
	actions.Action
}

Action is an extension of actions.Action for this package

type NewTransaction

type NewTransaction struct {
	// Configuration of the transaction
	Config models.TransactionConfig `json:"config"`
	// Accepts a JSON object for embedding custom metadata, enabling arbitrary additional information to be associated with the resource
	Metadata engine.Metadata `json:"metadata" swaggertype:"object,string" example:"key:value,key2:value2"`
}

NewTransaction is the model for creating a new transaction

type RecordTransaction

type RecordTransaction struct {
	// Hex of the transaction
	Hex string `json:"hex" example:"0100000002..."`
	// ReferenceID which is a ID of the draft transaction
	ReferenceID string `json:"reference_id" example:"b356f7fa00cd3f20cce6c21d704cd13e871d28d714a5ebd0532f5a0e0cde63f7"`
	// Accepts a JSON object for embedding custom metadata, enabling arbitrary additional information to be associated with the resource
	Metadata engine.Metadata `json:"metadata" swaggertype:"object,string" example:"key:value,key2:value2"`
}

RecordTransaction is the model for recording a transaction

type UpdateTransaction

type UpdateTransaction struct {
	// Id of the transaction which is a hash of the transaction
	ID string `json:"id" example:"01d0d0067652f684c6acb3683763f353fce55f6496521c7d99e71e1d27e53f5c"`
	// Accepts a JSON object for embedding custom metadata, enabling arbitrary additional information to be associated with the resource
	Metadata engine.Metadata `json:"metadata" swaggertype:"object,string" example:"key:value,key2:value2"`
}

UpdateTransaction is the model for updating a transaction