ledgerstate

Documentation

Index

• Constants
• Variables
• func GetAddress(c echo.Context) error
• func GetAddressUnspentOutputs(c echo.Context) error
• func GetBranch(c echo.Context) (err error)
• func GetBranchChildren(c echo.Context) (err error)
• func GetBranchConflicts(c echo.Context) (err error)
• func GetOutput(c echo.Context) (err error)
• func GetOutputConsumers(c echo.Context) (err error)
• func GetOutputMetadata(c echo.Context) (err error)
• func GetTransaction(c echo.Context) (err error)
• func GetTransactionAttachments(c echo.Context) (err error)
• func GetTransactionConsensusMetadata(c echo.Context) (err error)
• func GetTransactionInclusionState(c echo.Context) (err error)
• func GetTransactionMetadata(c echo.Context) (err error)
• func Plugin() *node.Plugin
• func PostAddressUnspentOutputs(c echo.Context) error
• func PostTransaction(c echo.Context) error
• type DoubleSpendFilter
  • func Filter() *DoubleSpendFilter
  • func NewDoubleSpendFilter() *DoubleSpendFilter
  • func (d *DoubleSpendFilter) Add(tx *ledgerstate.Transaction)
  • func (d *DoubleSpendFilter) CleanUp()
  • func (d *DoubleSpendFilter) HasConflict(outputs ledgerstate.Inputs) (bool, ledgerstate.TransactionID)
  • func (d *DoubleSpendFilter) Remove(txID ledgerstate.TransactionID)

Constants

const (
	PluginName                       = "WebAPI ledgerstate Endpoint"
	DoubleSpendFilterCleanupInterval = 10 * time.Second
)

PluginName is the name of the web API plugin.

Variables

var ErrNotAllowedToPledgeManaToNode = errors.New("not allowed to pledge mana to node")

ErrNotAllowedToPledgeManaToNode defines an unsupported node to pledge mana to.

Functions

func GetAddress

func GetAddress(c echo.Context) error

GetAddress is the handler for the /ledgerstate/addresses/:address endpoint.

func GetAddressUnspentOutputs

func GetAddressUnspentOutputs(c echo.Context) error

GetAddressUnspentOutputs is the handler for the /ledgerstate/addresses/:address/unspentOutputs endpoint.

func GetBranch

func GetBranch(c echo.Context) (err error)

GetBranch is the handler for the /ledgerstate/branch/:branchID endpoint.

func GetBranchChildren

func GetBranchChildren(c echo.Context) (err error)

GetBranchChildren is the handler for the /ledgerstate/branch/:branchID/childBranches endpoint.

func GetBranchConflicts

func GetBranchConflicts(c echo.Context) (err error)

GetBranchConflicts is the handler for the /ledgerstate/branch/:branchID/conflicts endpoint.

func GetOutput

func GetOutput(c echo.Context) (err error)

GetOutput is the handler for the /ledgerstate/outputs/:outputID endpoint.

func GetOutputConsumers

func GetOutputConsumers(c echo.Context) (err error)

GetOutputConsumers is the handler for the /ledgerstate/outputs/:outputID/consumers endpoint.

func GetOutputMetadata

func GetOutputMetadata(c echo.Context) (err error)

GetOutputMetadata is the handler for the /ledgerstate/outputs/:outputID/metadata endpoint.

func GetTransaction

func GetTransaction(c echo.Context) (err error)

GetTransaction is the handler for the /ledgerstate/transactions/:transactionID endpoint.

func GetTransactionAttachments

func GetTransactionAttachments(c echo.Context) (err error)

GetTransactionAttachments is the handler for the ledgerstate/transactions/:transactionID/attachments endpoint.

func GetTransactionConsensusMetadata

func GetTransactionConsensusMetadata(c echo.Context) (err error)

GetTransactionConsensusMetadata is the handler for the ledgerstate/transactions/:transactionID/consensus endpoint.

func GetTransactionInclusionState

func GetTransactionInclusionState(c echo.Context) (err error)

GetTransactionInclusionState is the handler for the ledgerstate/transactions/:transactionID/inclusionState endpoint.

func GetTransactionMetadata

func GetTransactionMetadata(c echo.Context) (err error)

GetTransactionMetadata is the handler for the ledgerstate/transactions/:transactionID/metadata endpoint.

func Plugin

func Plugin() *node.Plugin

Plugin returns the plugin as a singleton.

func PostAddressUnspentOutputs

func PostAddressUnspentOutputs(c echo.Context) error

PostAddressUnspentOutputs is the handler for the /ledgerstate/addresses/unspentOutputs endpoint.

func PostTransaction

func PostTransaction(c echo.Context) error

PostTransaction sends a transaction.

Types

type DoubleSpendFilter

type DoubleSpendFilter struct {
	// contains filtered or unexported fields
}

DoubleSpendFilter keeps a log of recently submitted transactions and their consumed outputs.

func Filter

func Filter() *DoubleSpendFilter

Filter returns the double spend filter singleton.

func NewDoubleSpendFilter

func NewDoubleSpendFilter() *DoubleSpendFilter

NewDoubleSpendFilter creates a new doubleSpendFilter worker.

func (*DoubleSpendFilter) Add

func (d *DoubleSpendFilter) Add(tx *ledgerstate.Transaction)

Add adds a transaction and it's consumed inputs to the doubleSpendFilter.

func (*DoubleSpendFilter) CleanUp

func (d *DoubleSpendFilter) CleanUp()

CleanUp removes transactions from the DoubleSpendFilter if they were added more, than 30s ago.

func (*DoubleSpendFilter) HasConflict

func (d *DoubleSpendFilter) HasConflict(outputs ledgerstate.Inputs) (bool, ledgerstate.TransactionID)

HasConflict returns if there is a conflicting output in the internal map wrt to the provided inputs (outputIDs).

func (*DoubleSpendFilter) Remove

func (d *DoubleSpendFilter) Remove(txID ledgerstate.TransactionID)

Remove removes all outputs associated to the given transaction ID.