value

package

v0.2.4-0...-2c2ceb1 Latest Latest Go to latest Published: Nov 30, 2020 License: Apache-2.0, BSD-2-Clause Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

gitlab.imt-atlantique.fr/iota-imt/goshimmer

Documentation ¶

Constants ¶

View Source

const PluginName = "WebAPI Value Endpoint"

PluginName is the name of the web API DRNG endpoint plugin.

Variables ¶

View Source

var (

	// ErrMalformedInputs defines a malformed inputs error.
	ErrMalformedInputs = fmt.Errorf("malformed inputs")
	// ErrMalformedOutputs defines a malformed outputs error.
	ErrMalformedOutputs = fmt.Errorf("malformed outputs")
	// ErrMalformedData defines a malformed data error.
	ErrMalformedData = fmt.Errorf("malformed data")
	// ErrMalformedColor defines a malformed color error.
	ErrMalformedColor = fmt.Errorf("malformed color")
	// ErrMalformedPublicKey defines a malformed publicKey error.
	ErrMalformedPublicKey = fmt.Errorf("malformed publicKey")
	// ErrMalformedSignature defines a malformed signature error.
	ErrMalformedSignature = fmt.Errorf("malformed signature")
	// ErrWrongSignature defines a wrong signature error.
	ErrWrongSignature = fmt.Errorf("wrong signature")
	// ErrSignatureVersion defines a unsupported signature version error.
	ErrSignatureVersion = fmt.Errorf("unsupported signature version")
)

Functions ¶

func NewTransactionFromJSON ¶

func NewTransactionFromJSON(request SendTransactionByJSONRequest) (*transaction.Transaction, error)

NewTransactionFromJSON returns a new transaction from a given JSON request or an error.

func Plugin ¶

func Plugin() *node.Plugin

Plugin gets the plugin instance.

Types ¶

type AttachmentsResponse ¶

type AttachmentsResponse struct {
	Attachments []ValueObject `json:"attachments,omitempty"`
	Error       string        `json:"error,omitempty"`
}

AttachmentsResponse is the HTTP response from retrieving value objects.

type Balance ¶

type Balance struct {
	Value int64  `json:"value"`
	Color string `json:"color"`
}

Balance holds the value and the color of token

type GetTransactionByIDResponse ¶

type GetTransactionByIDResponse struct {
	Transaction    Transaction    `json:"transaction,omitempty"`
	InclusionState InclusionState `json:"inclusion_state,omitempty"`
	Error          string         `json:"error,omitempty"`
}

GetTransactionByIDResponse is the HTTP response from retrieving transaction.

type InclusionState ¶

type InclusionState struct {
	Solid       bool `json:"solid,omitempty"`
	Confirmed   bool `json:"confirmed,omitempty"`
	Rejected    bool `json:"rejected,omitempty"`
	Liked       bool `json:"liked,omitempty"`
	Conflicting bool `json:"conflicting,omitempty"`
	Finalized   bool `json:"finalized,omitempty"`
	Preferred   bool `json:"preferred,omitempty"`
}

InclusionState represents the different states of an OutputID

type Output ¶

type Output struct {
	Address  string    `json:"address"`
	Balances []Balance `json:"balances"`
}

Output consists an address and balances

type OutputID ¶

type OutputID struct {
	ID             string         `json:"id"`
	Balances       []Balance      `json:"balances"`
	InclusionState InclusionState `json:"inclusion_state"`
}

OutputID holds the output id and its inclusion state

type SendTransactionByJSONRequest ¶

type SendTransactionByJSONRequest struct {
	Inputs     []string    `json:"inputs"`
	Outputs    []Output    `json:"outputs"`
	Data       []byte      `json:"data,omitempty"`
	Signatures []Signature `json:"signatures"`
}

SendTransactionByJSONRequest holds the transaction object(json) to send. e.g.,

{
	"inputs": string[],
	"outputs": {
	   "address": string,
	   "balances": {
		   "value": number,
		   "color": string
	   }[];
	 }[],
	 "data": []byte,
	 "signatures": {
		"version": number,
		"publicKey": string,
		"signature": string
	   }[]
 }

type SendTransactionByJSONResponse ¶

type SendTransactionByJSONResponse struct {
	TransactionID string `json:"transaction_id,omitempty"`
	Error         string `json:"error,omitempty"`
}

SendTransactionByJSONResponse is the HTTP response from sending transaction.

type SendTransactionRequest ¶

type SendTransactionRequest struct {
	TransactionBytes []byte `json:"txn_bytes"`
}

SendTransactionRequest holds the transaction object(bytes) to send.

type SendTransactionResponse ¶

type SendTransactionResponse struct {
	TransactionID string `json:"transaction_id,omitempty"`
	Error         string `json:"error,omitempty"`
}

SendTransactionResponse is the HTTP response from sending transaction.

type Signature ¶

type Signature struct {
	Version   byte   `json:"version"`
	PublicKey string `json:"publicKey"`
	Signature string `json:"signature"`
}

Signature defines the struct of a signature.

type Transaction ¶

type Transaction struct {
	Inputs      []string `json:"inputs"`
	Outputs     []Output `json:"outputs"`
	Signature   []byte   `json:"signature"`
	DataPayload []byte   `json:"data_payload"`
}

Transaction holds the information of a transaction.

func ParseTransaction ¶

func ParseTransaction(t *transaction.Transaction) (txn Transaction)

ParseTransaction handle transaction json object.

type UnspentOutput ¶

type UnspentOutput struct {
	Address   string     `json:"address"`
	OutputIDs []OutputID `json:"output_ids"`
}

UnspentOutput holds the address and the corresponding unspent output ids

type UnspentOutputsRequest ¶

type UnspentOutputsRequest struct {
	Addresses []string `json:"addresses,omitempty"`
	Error     string   `json:"error,omitempty"`
}

UnspentOutputsRequest holds the addresses to query.

type UnspentOutputsResponse ¶

type UnspentOutputsResponse struct {
	UnspentOutputs []UnspentOutput `json:"unspent_outputs,omitempty"`
	Error          string          `json:"error,omitempty"`
}

UnspentOutputsResponse is the HTTP response from retrieving value objects.

type ValueObject ¶

type ValueObject struct {
	ID          string      `json:"id"`
	Parent1ID   string      `json:"parent1_id"`
	Parent2ID   string      `json:"parent2_id"`
	Transaction Transaction `json:"transaction"`
}

ValueObject holds the information of a value object.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL