presenters

Documentation

Overview

Package presenters allow for the specification and result of a Job, its associated TaskSpecs, and every JobRun and TaskRun to be returned in a user friendly human readable format.

Index

• func FriendlyBigInt(n *big.Int) string
• func ShowEthBalance(store *store.Store) ([]map[string]interface{}, error)
• func ShowLinkBalance(store *store.Store) ([]map[string]interface{}, error)
• type AccountBalance
  • func (a AccountBalance) GetID() string
  • func (a *AccountBalance) SetID(value string) error
• type ConfigWhitelist
  • func NewConfigWhitelist(store *store.Store) (ConfigWhitelist, error)
  • func (c ConfigWhitelist) GetID() string
  • func (c *ConfigWhitelist) SetID(value string) error
  • func (c ConfigWhitelist) String() string
• type Initiator
  • func (i Initiator) FriendlyAddress() string
  • func (i Initiator) FriendlyRunAt() string
  • func (i Initiator) MarshalJSON() ([]byte, error)
• type JobRun
  • func (jr JobRun) MarshalJSON() ([]byte, error)
• type JobSpec
  • func (job JobSpec) FriendlyCreatedAt() string
  • func (job JobSpec) FriendlyEndAt() string
  • func (job JobSpec) FriendlyInitiators() string
  • func (job JobSpec) FriendlyStartAt() string
  • func (job JobSpec) FriendlyTasks() string
  • func (job JobSpec) MarshalJSON() ([]byte, error)
• type NewAccount
  • func (a NewAccount) GetID() string
  • func (a NewAccount) GetName() string
• type ServiceAgreement
  • func (sa ServiceAgreement) FriendlyCreatedAt() string
  • func (sa ServiceAgreement) FriendlyExpiration() string
  • func (sa ServiceAgreement) FriendlyPayment() string
  • func (sa ServiceAgreement) MarshalJSON() ([]byte, error)
• type TaskSpec
  • func (t TaskSpec) FriendlyParams() (string, string)
• type Tx
  • func NewTx(tx *models.Tx) Tx
  • func NewTxFromAttempt(txAttempt models.TxAttempt) Tx
  • func (t Tx) GetID() string
  • func (Tx) GetName() string
  • func (t *Tx) SetID(hex string) error
• type UserPresenter
  • func (u UserPresenter) GetID() string
  • func (u UserPresenter) GetName() string
  • func (u UserPresenter) MarshalJSON() ([]byte, error)

Functions

func FriendlyBigInt

func FriendlyBigInt(n *big.Int) string

FriendlyBigInt returns a string printing the integer in both decimal and hexidecimal formats.

func ShowEthBalance

func ShowEthBalance(store *store.Store) ([]map[string]interface{}, error)

ShowEthBalance returns the current Eth Balance for current Account

func ShowLinkBalance

func ShowLinkBalance(store *store.Store) ([]map[string]interface{}, error)

ShowLinkBalance returns the current Link Balance for current Account

Types

type AccountBalance

type AccountBalance struct {
	Address     string       `json:"address"`
	EthBalance  *assets.Eth  `json:"ethBalance"`
	LinkBalance *assets.Link `json:"linkBalance"`
}

AccountBalance holds the hex representation of the address plus it's ETH & LINK balances

func (AccountBalance) GetID

func (a AccountBalance) GetID() string

GetID returns the ID of this structure for jsonapi serialization.

func (*AccountBalance) SetID

func (a *AccountBalance) SetID(value string) error

SetID is used to set the ID of this structure when deserializing from jsonapi documents.

type ConfigWhitelist

type ConfigWhitelist struct {
	AccountAddress string `json:"accountAddress"`
	// contains filtered or unexported fields
}

ConfigWhitelist are the non-secret values of the node

If you add an entry here, you should update NewConfigWhitelist and ConfigWhitelist#String accordingly.

func NewConfigWhitelist

func NewConfigWhitelist(store *store.Store) (ConfigWhitelist, error)

NewConfigWhitelist creates an instance of ConfigWhitelist

func (ConfigWhitelist) GetID

func (c ConfigWhitelist) GetID() string

GetID generates a new ID for jsonapi serialization.

func (*ConfigWhitelist) SetID

func (c *ConfigWhitelist) SetID(value string) error

SetID is used to conform to the UnmarshallIdentifier interface for deserializing from jsonapi documents.

func (ConfigWhitelist) String

func (c ConfigWhitelist) String() string

String returns the values as a newline delimited string

type Initiator

type Initiator struct {
	models.Initiator
}

Initiator holds the Job definition's Initiator.

func (Initiator) FriendlyAddress

func (i Initiator) FriendlyAddress() string

FriendlyAddress returns the Ethereum address if present, and a blank string if not.

func (Initiator) FriendlyRunAt

func (i Initiator) FriendlyRunAt() string

FriendlyRunAt returns a human-readable string for Cron Initiator types.

func (Initiator) MarshalJSON

func (i Initiator) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON data of the Initiator based on its Initiator Type.

type JobRun

type JobRun struct {
	models.JobRun
}

JobRun presents an API friendly version of the data.

func (JobRun) MarshalJSON

func (jr JobRun) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON data of the JobRun and its Initiator.

type JobSpec

type JobSpec struct {
	models.JobSpec
}

JobSpec holds the JobSpec definition

func (JobSpec) FriendlyCreatedAt

func (job JobSpec) FriendlyCreatedAt() string

FriendlyCreatedAt returns a human-readable string of the Job's CreatedAt field.

func (JobSpec) FriendlyEndAt

func (job JobSpec) FriendlyEndAt() string

FriendlyEndAt returns a human-readable string of the Job's EndAt field.

func (JobSpec) FriendlyInitiators

func (job JobSpec) FriendlyInitiators() string

FriendlyInitiators returns the list of Initiator types as a comma separated string.

func (JobSpec) FriendlyStartAt

func (job JobSpec) FriendlyStartAt() string

FriendlyStartAt returns a human-readable string of the Job's StartAt field.

func (JobSpec) FriendlyTasks

func (job JobSpec) FriendlyTasks() string

FriendlyTasks returns the list of Task types as a comma separated string.

func (JobSpec) MarshalJSON

func (job JobSpec) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON data of the Job and its Initiators.

type NewAccount

type NewAccount struct {
	*accounts.Account
}

NewAccount is a jsonapi wrapper for an Ethereum account.

func (NewAccount) GetID

func (a NewAccount) GetID() string

GetID returns the jsonapi ID.

func (NewAccount) GetName

func (a NewAccount) GetName() string

GetName returns the collection name for jsonapi.

type ServiceAgreement

type ServiceAgreement struct {
	models.ServiceAgreement
}

ServiceAgreement presents an API friendly version of the data.

func (ServiceAgreement) FriendlyCreatedAt

func (sa ServiceAgreement) FriendlyCreatedAt() string

FriendlyCreatedAt returns the ServiceAgreement's created at time in a human readable format.

func (ServiceAgreement) FriendlyExpiration

func (sa ServiceAgreement) FriendlyExpiration() string

FriendlyExpiration returns the ServiceAgreement's Encumbrance expiration time in a human readable format.

func (ServiceAgreement) FriendlyPayment

func (sa ServiceAgreement) FriendlyPayment() string

FriendlyPayment returns the ServiceAgreement's Encumbrance payment amount in a human readable format.

func (ServiceAgreement) MarshalJSON

func (sa ServiceAgreement) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON data of the ServiceAgreement.

type TaskSpec

type TaskSpec struct {
	models.TaskSpec
}

TaskSpec holds a task specified in the Job definition.

func (TaskSpec) FriendlyParams

func (t TaskSpec) FriendlyParams() (string, string)

FriendlyParams returns a map of the TaskSpec's parameters.

type Tx

type Tx struct {
	Confirmed bool            `json:"confirmed,omitempty"`
	Data      hexutil.Bytes   `json:"data,omitempty"`
	From      *common.Address `json:"from,omitempty"`
	GasLimit  string          `json:"gasLimit,omitempty"`
	GasPrice  string          `json:"gasPrice,omitempty"`
	Hash      common.Hash     `json:"hash,omitempty"`
	Hex       string          `json:"rawHex,omitempty"`
	Nonce     string          `json:"nonce,omitempty"`
	SentAt    string          `json:"sentAt,omitempty"`
	To        *common.Address `json:"to,omitempty"`
	Value     string          `json:"value,omitempty"`
}

Tx is a jsonapi wrapper for an Ethereum Transaction.

func NewTx

func NewTx(tx *models.Tx) Tx

NewTx builds a transaction presenter.

func NewTxFromAttempt

func NewTxFromAttempt(txAttempt models.TxAttempt) Tx

NewTxFromAttempt builds a transaction presenter from a TxAttempt

models.Tx represents a transaction in progress, with a series of models.TxAttempts, each one of these represents an ethereum transaction. A TxAttempt only stores the unique details of an ethereum transaction, with the rest of the details on its related Tx.

So for presenting a TxAttempt, we take its Hash, GasPrice etc. and get the rest of the details from its Tx.

NOTE: We take a copy here as we don't want side effects.

func (Tx) GetID

func (t Tx) GetID() string

GetID returns the jsonapi ID.

func (Tx) GetName

func (Tx) GetName() string

GetName returns the collection name for jsonapi.

func (*Tx) SetID

func (t *Tx) SetID(hex string) error

SetID is used to conform to the UnmarshallIdentifier interface for deserializing from jsonapi documents.

type UserPresenter

type UserPresenter struct {
	*models.User
}

UserPresenter wraps the user record for shipping as a jsonapi response in the API.

func (UserPresenter) GetID

func (u UserPresenter) GetID() string

GetID returns the jsonapi ID.

func (UserPresenter) GetName

func (u UserPresenter) GetName() string

GetName returns the collection name for jsonapi.

func (UserPresenter) MarshalJSON

func (u UserPresenter) MarshalJSON() ([]byte, error)

MarshalJSON returns the User as json.