admin

Documentation

Index

• func NewHandler(appConfig *config.AppConfig, services *config.AppServices) routes.AdminEndpointsFunc
• type Action
• type CreatePaymail
• type CreateXpub
• type PaymailAddress
• type RecordTransaction
• type UpdateContact

Functions

func NewHandler

func NewHandler(appConfig *config.AppConfig, services *config.AppServices) routes.AdminEndpointsFunc

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 CreatePaymail

type CreatePaymail struct {
	// 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"`
	// The xpub with which the paymail is associated
	Key string `json:"key" example:"xpub661MyMwAqRbcGpZVrSHU..."`
	// The paymail address
	Address string `json:"address" example:"test@spv-wallet.com"`
	// The public name of the paymail
	PublicName string `json:"public_name" example:"Test"`
	// The avatar of the paymail (url address)
	Avatar string `json:"avatar" example:"https://example.com/avatar.png"`
}

CreatePaymail is the model for creating a paymail

type CreateXpub

type CreateXpub struct {
	// 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"`
	// The xpub key
	Key string `json:"key" example:"xpub661MyMwAqRbcGpZVrSHU..."`
}

CreateXpub is the model for creating an xpub

type PaymailAddress

type PaymailAddress struct {
	// The paymail address
	Address string `json:"address" example:"test@spv-wallet.com"`
}

PaymailAddress is the model containing only paymail address used for getting and deleting paymail address

type RecordTransaction

type RecordTransaction struct {
	// The transaction hex
	Hex string `json:"hex" example:"0100000002..."`
}

RecordTransaction is the model for recording a transaction

type UpdateContact

type UpdateContact struct {
	// 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"`
	// New name for the contact
	FullName string `json:"fullName" example:"John Doe"`
}

UpdateContact is the model for updating a contact