web

package
v0.10.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 22, 2021 License: MIT Imports: 55 Imported by: 2

Documentation

Overview

Package web handles receiving and supplying information within the node.

AccountBalanceController

AccountBalanceController allows for the display of the active accounts ETH and LINK balances.

API

API contains logic for the web interface to display items.

BridgeTypesController

BridgeTypesController allows for the creation of BridgeTypes on the node. BridgeTypes are the external adapters which add functionality not available in the core, from outside the node.

JobRunsController

JobRunsController allows for the creation of JobRuns within a given Job on the node.

JobSpecsController

JobSpecsController allows for the creation of specs to be added to the node, and shows the current specs which have already been added.

JobSpecErrorsController

JobSpecErrorsController allows for errors to be dismissed

Router

Router defines the valid paths for the node and responds to requests.

Index

Constants

View Source 
const (
	// PaginationDefault is the number of records to supply from a paginated
	// request when no size param is supplied.
	PaginationDefault = 25

	// MediaType is the response header for JSONAPI documents.
	MediaType = "application/vnd.api+json"

	// KeyNextLink is the name of the key that contains the HREF for the next
	// document in a paginated response.
	KeyNextLink = "next"
	// KeyPreviousLink is the name of the key that contains the HREF for the
	// previous document in a paginated response.
	KeyPreviousLink = "prev"
)
View Source 
const (
	// APIKey is the header name for the API token identifier for user authentication.
	APIKey = "X-API-KEY"
	// APISecret is the header name for the API token secret for user authentication.
	APISecret = "X-API-SECRET"
)
View Source 
const (
	// SessionName is the session name
	SessionName = "clsession"
	// SessionIDKey is the session ID key in the session map
	SessionIDKey = "clsession_id"
	// SessionUserKey is the User key in the session map
	SessionUserKey = "user"
	// SessionExternalInitiatorKey is the External Initiator key in the session map
	SessionExternalInitiatorKey = "external_initiator"
)

Variables

This section is empty.

Functions

func AuthenticateBySession added in v0.8.2 

func AuthenticateBySession(store AuthStorer, c *gin.Context) error

func AuthenticateByToken added in v0.8.2 

func AuthenticateByToken(store AuthStorer, c *gin.Context) error

AuthenticateByToken authenticates a User by their API token.

func AuthenticateExternalInitiator added in v0.8.2 

func AuthenticateExternalInitiator(store AuthStorer, c *gin.Context) error

func FindSessionCookie added in v0.8.2 

func FindSessionCookie(cookies []*http.Cookie) *http.Cookie

FindSessionCookie returns the cookie with the "clsession" name

func MatchExactBoxPath 

func MatchExactBoxPath(boxList []string, path string) (matchedPath string)

MatchExactBoxPath returns the box path when there is an exact match for the resource and an empty string otherwise

func MatchWildcardBoxPath 

func MatchWildcardBoxPath(boxList []string, path string, file string) (matchedPath string)

MatchWildcardBoxPath returns the box path when there is a wildcard match and an empty string otherwise

func NewJSONAPIResponse 

func NewJSONAPIResponse(resource interface{}) ([]byte, error)

NewJSONAPIResponse returns a JSONAPI response for a single resource.

func NewPaginatedResponse 

func NewPaginatedResponse(url url.URL, size, page, count int, resource interface{}) ([]byte, error)

NewPaginatedResponse returns a jsonapi.Document with links to next and previous collection pages

func ParseJSONAPIResponse 

func ParseJSONAPIResponse(input []byte, resource interface{}) error

ParseJSONAPIResponse parses the bytes of the root document and unmarshals it into the given resource.

func ParsePaginatedRequest 

func ParsePaginatedRequest(sizeParam, pageParam string) (int, int, int, error)

ParsePaginatedRequest parses the parameters that control pagination for a collection request, returning the size and offset if specified, or a sensible default.

func ParsePaginatedResponse 

func ParsePaginatedResponse(input []byte, resource interface{}, links *jsonapi.Links) error

ParsePaginatedResponse parse a JSONAPI response for a document with links

func RequireAuth added in v0.8.2 

func RequireAuth(store AuthStorer, methods ...authType) gin.HandlerFunc

func Router 

func Router(app chainlink.Application) *gin.Engine

Router listens and responds to requests to the node for valid paths.

func StatusCodeForError 

func StatusCodeForError(err interface{}) int

StatusCodeForError returns an http status code for an error type.

Types

type AuthStorer added in v0.8.2 

type AuthStorer interface {
	AuthorizedUserWithSession(sessionID string) (models.User, error)
	FindExternalInitiator(eia *auth.Token) (*models.ExternalInitiator, error)
	FindUser() (models.User, error)
}

type BridgeTypesController 

type BridgeTypesController struct {
	App chainlink.Application
}

BridgeTypesController manages BridgeType requests in the node.

func (*BridgeTypesController) Create 

func (btc *BridgeTypesController) Create(c *gin.Context)

Create adds the BridgeType to the given context.

func (*BridgeTypesController) Destroy 

func (btc *BridgeTypesController) Destroy(c *gin.Context)

Destroy removes a specific Bridge.

func (*BridgeTypesController) Index 

func (btc *BridgeTypesController) Index(c *gin.Context, size, page, offset int)

Index lists Bridges, one page at a time.

func (*BridgeTypesController) Show 

func (btc *BridgeTypesController) Show(c *gin.Context)

Show returns the details of a specific Bridge.

func (*BridgeTypesController) Update 

func (btc *BridgeTypesController) Update(c *gin.Context)

Update can change the restricted attributes for a bridge

type BulkDeletesController 

type BulkDeletesController struct {
	App chainlink.Application
}

BulkDeletesController manages background tasks that delete resources given a query

func (*BulkDeletesController) Delete 

func (bdc *BulkDeletesController) Delete(c *gin.Context)

Delete removes all runs given a query Example: 

"<application>/bulk_delete_runs"

type Change added in v0.6.6 

type Change struct {
	From string `json:"old"`
	To   string `json:"new"`
}

Change represents the old value and the new value after a PATH request has been made

type ConfigController 

type ConfigController struct {
	App chainlink.Application
}

ConfigController manages config variables

func (*ConfigController) Patch added in v0.6.6 

func (cc *ConfigController) Patch(c *gin.Context)

Patch updates one or more configuration options

func (*ConfigController) Show 

func (cc *ConfigController) Show(c *gin.Context)

Show returns the whitelist of config variables Example: 

"<application>/config"

type ConfigPatchResponse added in v0.6.6 

type ConfigPatchResponse struct {
	EthGasPriceDefault Change `json:"ethGasPriceDefault"`
}

ConfigPatchResponse represents the change to the configuration made due to a PATCH to the config endpoint

func (ConfigPatchResponse) GetID added in v0.6.6 

func (c ConfigPatchResponse) GetID() string

GetID returns the jsonapi ID.

func (*ConfigPatchResponse) SetID added in v0.6.6 

func (*ConfigPatchResponse) SetID(string) error

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

type ETHKeysController added in v0.9.9 

type ETHKeysController struct {
	App chainlink.Application
}

KeysController manages account keys

func (*ETHKeysController) Create added in v0.9.9 

func (ekc *ETHKeysController) Create(c *gin.Context)

Create adds a new account Example: 

"<application>/keys/eth"

func (*ETHKeysController) Delete added in v0.9.9 

func (ekc *ETHKeysController) Delete(c *gin.Context)

Delete an ETH key bundle Example: "DELETE <application>/keys/eth/:keyID" "DELETE <application>/keys/eth/:keyID?hard=true"

func (*ETHKeysController) Export added in v0.9.9 

func (ekc *ETHKeysController) Export(c *gin.Context)

func (*ETHKeysController) Import added in v0.9.9 

func (ekc *ETHKeysController) Import(c *gin.Context)

func (*ETHKeysController) Index added in v0.9.9 

func (ekc *ETHKeysController) Index(c *gin.Context)

Index returns the node's Ethereum keys and the account balances of ETH & LINK. Example: 

"<application>/keys/eth"

type ExternalInitiatorsController 

type ExternalInitiatorsController struct {
	App chainlink.Application
}

ExternalInitiatorsController manages external initiators

func (*ExternalInitiatorsController) Create 

func (eic *ExternalInitiatorsController) Create(c *gin.Context)

Create builds and saves a new service agreement record.

func (*ExternalInitiatorsController) Destroy 

func (eic *ExternalInitiatorsController) Destroy(c *gin.Context)

Destroy deletes an ExternalInitiator

type GenericJobSpec added in v0.9.7 

type GenericJobSpec struct {
	Type          job.Type    `toml:"type"`
	SchemaVersion uint32      `toml:"schemaVersion"`
	Name          null.String `toml:"name"`
}

type JobRunsController 

type JobRunsController struct {
	App chainlink.Application
}

JobRunsController manages JobRun requests in the node.

func (*JobRunsController) Cancel added in v0.8.2 

func (jrc *JobRunsController) Cancel(c *gin.Context)

Cancel stops a Run from continuing. Example: 

"<application>/runs/:RunID/cancellation"

func (*JobRunsController) Create 

func (jrc *JobRunsController) Create(c *gin.Context)

Create starts a new Run for the requested JobSpec. Example: 

"<application>/specs/:SpecID/runs"

func (*JobRunsController) Index 

func (jrc *JobRunsController) Index(c *gin.Context, size, page, offset int)

Index returns paginated JobRuns for a given JobSpec Example: 

"<application>/runs?jobSpecId=:jobSpecId&size=1&page=2"

func (*JobRunsController) Show 

func (jrc *JobRunsController) Show(c *gin.Context)

Show returns the details of a JobRun. Example: 

"<application>/runs/:RunID"

func (*JobRunsController) Update 

func (jrc *JobRunsController) Update(c *gin.Context)

Update allows external adapters to resume a JobRun, reporting the result of the task and marking it no longer pending. Example: 

"<application>/runs/:RunID"

type JobSpecErrorsController added in v0.8.9 

type JobSpecErrorsController struct {
	App chainlink.Application
}

JobSpecErrorsController manages JobSpecError requests

func (*JobSpecErrorsController) Destroy added in v0.8.9 

func (jsec *JobSpecErrorsController) Destroy(c *gin.Context)

Destroy deletes a JobSpecError record from the database, effectively silencing the error notification

type JobSpecsController 

type JobSpecsController struct {
	App chainlink.Application
}

JobSpecsController manages JobSpec requests.

func (*JobSpecsController) Create 

func (jsc *JobSpecsController) Create(c *gin.Context)

Create adds validates, saves, and starts a new JobSpec. Example: 

"<application>/specs"

func (*JobSpecsController) Destroy 

func (jsc *JobSpecsController) Destroy(c *gin.Context)

Destroy soft deletes a job spec. Example: 

"<application>/specs/:SpecID"

func (*JobSpecsController) Index 

func (jsc *JobSpecsController) Index(c *gin.Context, size, page, offset int)

Index lists JobSpecs, one page at a time. Example: 

"<application>/specs?size=1&page=2"

func (*JobSpecsController) Show 

func (jsc *JobSpecsController) Show(c *gin.Context)

Show returns the details of a JobSpec. Example: 

"<application>/specs/:SpecID"

type JobsController added in v0.9.7 

type JobsController struct {
	App chainlink.Application
}

JobsController manages jobs

func (*JobsController) Create added in v0.9.7 

func (jc *JobsController) Create(c *gin.Context)

Create validates, saves and starts a new job. Example: "POST <application>/jobs"

func (*JobsController) Delete added in v0.9.7 

func (jc *JobsController) Delete(c *gin.Context)

Delete soft deletes an OCR job spec. Example: "DELETE <application>/specs/:ID"

func (*JobsController) Index added in v0.9.7 

func (jc *JobsController) Index(c *gin.Context)

Index lists all jobs Example: "GET <application>/jobs"

func (*JobsController) Show added in v0.9.7 

func (jc *JobsController) Show(c *gin.Context)

Show returns the details of a job Example: "GET <application>/jobs/:ID"

type OCRKeysController added in v0.9.9 

type OCRKeysController struct {
	App chainlink.Application
}

OCRKeysController manages OCR key bundles

func (*OCRKeysController) Create added in v0.9.9 

func (ocrkc *OCRKeysController) Create(c *gin.Context)

Create and return an OCR key bundle Example: "POST <application>/keys/ocr"

func (*OCRKeysController) Delete added in v0.9.9 

func (ocrkc *OCRKeysController) Delete(c *gin.Context)

Delete an OCR key bundle Example: "DELETE <application>/keys/ocr/:keyID" "DELETE <application>/keys/ocr/:keyID?hard=true"

func (*OCRKeysController) Export added in v0.9.9 

func (ocrkc *OCRKeysController) Export(c *gin.Context)

Export exports an OCR key bundle Example: "Post <application>/keys/ocr/export"

func (*OCRKeysController) Import added in v0.9.9 

func (ocrkc *OCRKeysController) Import(c *gin.Context)

Import imports an OCR key bundle Example: "Post <application>/keys/ocr/import"

func (*OCRKeysController) Index added in v0.9.9 

func (ocrkc *OCRKeysController) Index(c *gin.Context)

Index lists OCR key bundles Example: "GET <application>/keys/ocr"

type P2PKeysController added in v0.9.3 

type P2PKeysController struct {
	App chainlink.Application
}

P2PKeysController manages P2P keys

func (*P2PKeysController) Create added in v0.9.3 

func (p2pkc *P2PKeysController) Create(c *gin.Context)

Create and return a P2P key Example: "POST <application>/keys/p2p"

func (*P2PKeysController) Delete added in v0.9.3 

func (p2pkc *P2PKeysController) Delete(c *gin.Context)

Delete a P2P key Example: "DELETE <application>/keys/p2p/:keyID" "DELETE <application>/keys/p2p/:keyID?hard=true"

func (*P2PKeysController) Export added in v0.9.9 

func (p2pkc *P2PKeysController) Export(c *gin.Context)

Export exports a P2P key Example: "Post <application>/keys/p2p/export"

func (*P2PKeysController) Import added in v0.9.9 

func (p2pkc *P2PKeysController) Import(c *gin.Context)

Import imports a P2P key Example: "Post <application>/keys/p2p/import"

func (*P2PKeysController) Index added in v0.9.3 

func (p2pkc *P2PKeysController) Index(c *gin.Context)

Index lists P2P keys Example: "GET <application>/keys/p2p"

type PingController added in v0.6.6 

type PingController struct {
	App chainlink.Application
}

PingController has the ping endpoint.

func (*PingController) Show added in v0.6.6 

func (eic *PingController) Show(c *gin.Context)

Show returns pong.

type PipelineRunsController added in v0.9.7 

type PipelineRunsController struct {
	App chainlink.Application
}

PipelineRunsController manages V2 job run requests.

func (*PipelineRunsController) Create added in v0.9.7 

func (prc *PipelineRunsController) Create(c *gin.Context)

Create triggers a pipeline run for a job. Example: "POST <application>/jobs/:ID/runs"

func (*PipelineRunsController) Index added in v0.9.7 

func (prc *PipelineRunsController) Index(c *gin.Context, size, page, offset int)

Index returns all pipeline runs for a job. Example: "GET <application>/jobs/:ID/runs"

func (*PipelineRunsController) Show added in v0.9.7 

func (prc *PipelineRunsController) Show(c *gin.Context)

Show returns a specified pipeline run. Example: "GET <application>/jobs/:ID/runs/:runID"

type ServiceAgreementsController 

type ServiceAgreementsController struct {
	App chainlink.Application
}

ServiceAgreementsController manages service agreements.

func (*ServiceAgreementsController) Create 

func (sac *ServiceAgreementsController) Create(c *gin.Context)

Create builds and saves a new service agreement record.

func (*ServiceAgreementsController) Show 

func (sac *ServiceAgreementsController) Show(c *gin.Context)

Show returns the details of a ServiceAgreement. Example: 

"<application>/service_agreements/:SAID"

type Session 

type Session struct {
	Authenticated bool `json:"authenticated"`
}

func (Session) GetID 

func (s Session) GetID() string

GetID returns the jsonapi ID.

func (Session) GetName 

func (Session) GetName() string

GetName returns the collection name for jsonapi.

func (*Session) SetID 

func (*Session) SetID(string) error

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

type SessionsController 

type SessionsController struct {
	App chainlink.Application
}

SessionsController manages session requests.

func (*SessionsController) Create 

func (sc *SessionsController) Create(c *gin.Context)

Create creates a session ID for the given user credentials, and returns it in a cookie.

func (*SessionsController) Destroy 

func (sc *SessionsController) Destroy(c *gin.Context)

Destroy erases the session ID for the sole API user.

type TransactionsController 

type TransactionsController struct {
	App chainlink.Application
}

TransactionsController displays Ethereum transactions requests.

func (*TransactionsController) Index 

func (tc *TransactionsController) Index(c *gin.Context, size, page, offset int)

Index returns paginated transactions

func (*TransactionsController) Show 

func (tc *TransactionsController) Show(c *gin.Context)

Show returns the details of a Ethereum Transasction details. Example: 

"<application>/transactions/:TxHash"

type TransfersController 

type TransfersController struct {
	App chainlink.Application
}

TransfersController can send LINK tokens to another address

func (*TransfersController) Create 

func (tc *TransfersController) Create(c *gin.Context)

Create sends ETH from the Chainlink's account to a specified address.

Example: "<application>/withdrawals"

type TxAttemptsController 

type TxAttemptsController struct {
	App chainlink.Application
}

TxAttemptsController lists TxAttempts requests.

func (*TxAttemptsController) Index 

func (tac *TxAttemptsController) Index(c *gin.Context, size, page, offset int)

Index returns paginated transaction attempts

type UserController 

type UserController struct {
	App chainlink.Application
}

UserController manages the current Session's User User.

func (*UserController) DeleteAPIToken added in v0.8.2 

func (c *UserController) DeleteAPIToken(ctx *gin.Context)

DeleteAPIToken deletes and disables a user's API token.

func (*UserController) NewAPIToken added in v0.8.2 

func (c *UserController) NewAPIToken(ctx *gin.Context)

NewAPIToken generates a new API token for a user overwriting any pre-existing one set.

func (*UserController) UpdatePassword 

func (c *UserController) UpdatePassword(ctx *gin.Context)

UpdatePassword changes the password for the current User.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.