srv

package

v0.1.1 Latest Latest Go to latest Published: Oct 8, 2019 License: MIT Imports: 17 Imported by: 3

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/pegnet/pegnetd

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type APIServer
- func NewAPIServer(conf *viper.Viper, n *node.Pegnetd) *APIServer
- func (s *APIServer) Start(stop <-chan struct{}) (done <-chan struct{})
type Client
- func NewClient() *Client
- func (c *Client) Request(method string, params, result interface{}) error
type Params
type ParamsGetPegnetBalances
- func (p ParamsGetPegnetBalances) HasIncludePending() bool
- func (p ParamsGetPegnetBalances) IsValid() error
- func (p ParamsGetPegnetBalances) ValidChainID() *factom.Bytes32
type ParamsGetPegnetRates
- func (ParamsGetPegnetRates) HasIncludePending() bool
- func (p ParamsGetPegnetRates) IsValid() error
- func (ParamsGetPegnetRates) ValidChainID() *factom.Bytes32
type ParamsGetTransaction
- func (p ParamsGetTransaction) IsValid() error
type ParamsSendTransaction
- func (p ParamsSendTransaction) Entry() factom.Entry
- func (p *ParamsSendTransaction) IsValid() error
type ParamsToken
- func (p ParamsToken) HasIncludePending() bool
- func (p ParamsToken) IsValid() error
- func (p ParamsToken) ValidChainID() *factom.Bytes32
type ResultGetIssuance
type ResultGetSyncStatus
type ResultGetTransaction
type ResultPegnetTickerMap
- func (r ResultPegnetTickerMap) MarshalJSON() ([]byte, error)
- func (r *ResultPegnetTickerMap) UnmarshalJSON(data []byte) error

Constants ¶

View Source

const (
	PegnetdDefault = "http://localhost:8070"
)

Defaults for the factomd and factom-walletd endpoints.

Variables ¶

View Source

var (
	ErrorTokenNotFound = jrpc.NewError(-32800, "Token Not Found",
		"token may be invalid, or not yet issued or tracked")
	ErrorTransactionNotFound = jrpc.NewError(-32803, "Transaction Not Found",
		"no matching tx-id was found")
	ErrorInvalidTransaction = jrpc.NewError(-32804, "Invalid Transaction", nil)
	ErrorTokenSyncing       = jrpc.NewError(-32805, "Token Syncing",
		"token is in the process of syncing")
	ErrorNoEC = jrpc.NewError(-32806, "No Entry Credits",
		"not configured with entry credits")
	ErrorPendingDisabled = jrpc.NewError(-32807, "Pending Transactions Disabled",
		"fatd is not tracking pending transactions")
	ErrorAddressNotFound = jrpc.NewError(-32808, "Address Not Found",
		"address may be invalid, or not yet tracked")
	ErrorNotFound = jrpc.NewError(-32809, "Not Found",
		"could not find what you were looking for")
)

Functions ¶

This section is empty.

Types ¶

type APIServer ¶

type APIServer struct {
	Node   *node.Pegnetd
	Config *viper.Viper
}

APIServer is to avoid the need of keeping state objects in a global space. It can hold the full pegnet node, since that will give us complete access to not only the node related database, but also the FactomClient for factomd interaction.

func NewAPIServer ¶

func NewAPIServer(conf *viper.Viper, n *node.Pegnetd) *APIServer

func (*APIServer) Start ¶

func (s *APIServer) Start(stop <-chan struct{}) (done <-chan struct{})

Start the server in its own goroutine. If stop is closed, the server is closed and any goroutines will exit. The done channel is closed when the server exits for any reason. If the done channel is closed before the stop channel is closed, an error occurred. Errors are logged.

type Client ¶

type Client struct {
	PegnetdServer string
	jrpc.Client
}

Client makes RPC requests to pegnetd's APIs. Client embeds a jsonrpc2.Client, and thus also the http.Client. Use jsonrpc2.Client's BasicAuth settings to set up BasicAuth and http.Client's transport settings to configure TLS.

func NewClient ¶

func NewClient() *Client

NewClient returns a pointer to a Client initialized with the default localhost endpoints for factomd and factom-walletd, and 15 second timeouts for each of the http.Clients.

func (*Client) Request ¶

func (c *Client) Request(method string, params, result interface{}) error

Request makes a request to pegnetd's v1 API.

type Params ¶

type Params interface {
	IsValid() error
	ValidChainID() *factom.Bytes32
	HasIncludePending() bool
}

type ParamsGetPegnetBalances ¶

type ParamsGetPegnetBalances struct {
	Address *factom.FAAddress `json:"address,omitempty"`
}

func (ParamsGetPegnetBalances) HasIncludePending ¶

func (p ParamsGetPegnetBalances) HasIncludePending() bool

func (ParamsGetPegnetBalances) IsValid ¶

func (p ParamsGetPegnetBalances) IsValid() error

func (ParamsGetPegnetBalances) ValidChainID ¶

func (p ParamsGetPegnetBalances) ValidChainID() *factom.Bytes32

type ParamsGetPegnetRates ¶

type ParamsGetPegnetRates struct {
	Height *uint32 `json:"height,omitempty"`
}

func (ParamsGetPegnetRates) HasIncludePending ¶

func (ParamsGetPegnetRates) HasIncludePending() bool

func (ParamsGetPegnetRates) IsValid ¶

func (p ParamsGetPegnetRates) IsValid() error

func (ParamsGetPegnetRates) ValidChainID ¶

func (ParamsGetPegnetRates) ValidChainID() *factom.Bytes32

type ParamsGetTransaction ¶

type ParamsGetTransaction struct {
	ParamsToken
	Hash    *factom.Bytes32 `json:"entryhash"`
	TxIndex uint64          `json:"txindex,omitempty"`
}

ParamsGetTransaction is used to query for a single particular transaction with the given Entry Hash.

func (ParamsGetTransaction) IsValid ¶

func (p ParamsGetTransaction) IsValid() error

type ParamsSendTransaction ¶

type ParamsSendTransaction struct {
	ParamsToken
	ExtIDs  []factom.Bytes `json:"extids,omitempty"`
	Content factom.Bytes   `json:"content,omitempty"`
	Raw     factom.Bytes   `json:"raw,omitempty"`
	DryRun  bool           `json:"dryrun,omitempty"`
	// contains filtered or unexported fields
}

func (ParamsSendTransaction) Entry ¶

func (p ParamsSendTransaction) Entry() factom.Entry

func (*ParamsSendTransaction) IsValid ¶

func (p *ParamsSendTransaction) IsValid() error

type ParamsToken ¶

type ParamsToken struct {
	ChainID *factom.Bytes32 `json:"chainid,omitempty"`
}

ParamsToken scopes a request down to a single FAT token using either the ChainID or both the TokenID and the IssuerChainID.

func (ParamsToken) HasIncludePending ¶

func (p ParamsToken) HasIncludePending() bool

func (ParamsToken) IsValid ¶

func (p ParamsToken) IsValid() error

func (ParamsToken) ValidChainID ¶

func (p ParamsToken) ValidChainID() *factom.Bytes32

type ResultGetIssuance ¶ added in v0.1.1

type ResultGetIssuance struct {
	SyncStatus ResultGetSyncStatus   `json:"sync-status"`
	Issuance   ResultPegnetTickerMap `json:"issuance"`
}

type ResultGetSyncStatus ¶

type ResultGetSyncStatus struct {
	Sync    uint32 `json:"syncheight"`
	Current int32  `json:"factomheight"`
}

type ResultGetTransaction ¶

type ResultGetTransaction struct {
	Hash      *factom.Bytes32 `json:"entryhash"`
	Timestamp int64           `json:"timestamp"`
	TxIndex   uint64          `json:"txindex,omitempty"`
	Tx        interface{}     `json:"data"`
}

type ResultPegnetTickerMap ¶

type ResultPegnetTickerMap map[fat2.PTicker]uint64

TODO: This is incompatible with FAT.

func (ResultPegnetTickerMap) MarshalJSON ¶

func (r ResultPegnetTickerMap) MarshalJSON() ([]byte, error)

func (*ResultPegnetTickerMap) UnmarshalJSON ¶

func (r *ResultPegnetTickerMap) UnmarshalJSON(data []byte) error

Source Files ¶

View all Source files

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