types

Documentation

Index

• Variables
• type ErrorSource
• type PocketSession
  • func (ps *PocketSession) Validate() error
• type PortalRegion
• type Relay
  • func (r *Relay) Validate() (err error)
• type ServiceRecord
  • func (sr *ServiceRecord) Validate() (err error)

Variables

var (
	ErrRepeatedSessionKey = errors.New("repeated session key")
)

Types

type ErrorSource

type ErrorSource string

const (
	ErrorSourceInternal ErrorSource = "internal"
	ErrorSourceExternal ErrorSource = "external"
)

type PocketSession

type PocketSession struct {
	SessionKey       string    `json:"sessionKey"`
	SessionHeight    int       `json:"sessionHeight"`
	PortalRegionName string    `json:"portalRegionName"`
	CreatedAt        time.Time `json:"createdAt"`
	UpdatedAt        time.Time `json:"updatedAt"`
}

func (*PocketSession) Validate

func (ps *PocketSession) Validate() error

type PortalRegion

type PortalRegion struct {
	PortalRegionName string `json:"portalRegionName"`
}

type Relay

type Relay struct {
	RelayID                  int           `json:"relayID"`
	PoktChainID              string        `json:"poktChainID"`
	EndpointID               string        `json:"endpointID"`
	SessionKey               string        `json:"sessionKey"`
	ProtocolAppPublicKey     string        `json:"protocolAppPublicKey"`
	RelaySourceURL           string        `json:"relaySourceUrl"`
	PoktNodeAddress          string        `json:"poktNodeAddress"`
	PoktNodeDomain           string        `json:"poktNodeDomain"`
	PoktNodePublicKey        string        `json:"poktNodePublicKey"`
	RelayStartDatetime       time.Time     `json:"relayStartDatetime"`
	RelayReturnDatetime      time.Time     `json:"relayReturnDatetime"`
	IsError                  bool          `json:"isError"`
	ErrorCode                int           `json:"errorCode,omitempty"`
	ErrorName                string        `json:"errorName,omitempty"`
	ErrorMessage             string        `json:"errorMessage,omitempty"`
	ErrorType                string        `json:"errorType,omitempty"`
	ErrorSource              ErrorSource   `json:"errorSource,omitempty"`
	RelayRoundtripTime       float64       `json:"relayRoundtripTime"`
	RelayChainMethodIDs      []string      `json:"relayChainMethodID"`
	RelayDataSize            int           `json:"relayDataSize"`
	RelayPortalTripTime      float64       `json:"relayPortalTripTime"`
	RelayNodeTripTime        float64       `json:"relayNodeTripTime"`
	RelayURLIsPublicEndpoint bool          `json:"relayUrlIsPublicEndpoint"`
	PortalRegionName         string        `json:"portalRegionName"`
	IsAltruistRelay          bool          `json:"isAltruistRelay"`
	IsUserRelay              bool          `json:"isUserRelay"`
	RequestID                string        `json:"requestID"`
	PoktTxID                 string        `json:"poktTxID"`
	GigastakeAppID           string        `json:"gigastakeAppID"`
	Session                  PocketSession `json:"session"`
	Region                   PortalRegion  `json:"region"`
	CreatedAt                time.Time     `json:"createdAt"`
	UpdatedAt                time.Time     `json:"updatedAt"`
	BlockingPlugin           string        `json:"blockingPlugin"`
}

TODO: consider removing this type and use portal types instead

func (*Relay) Validate

func (r *Relay) Validate() (err error)

type ServiceRecord

type ServiceRecord struct {
	ServiceRecordID        int       `json:"serviceRecordID"`
	NodePublicKey          string    `json:"nodePublicKey"`
	PoktChainID            string    `json:"poktChainID"`
	SessionKey             string    `json:"sessionKey"`
	RequestID              string    `json:"requestID"`
	PortalRegionName       string    `json:"portalRegionName"`
	Latency                float64   `json:"latency"`
	Tickets                int       `json:"tickets"`
	Result                 string    `json:"result"`
	Available              bool      `json:"available"`
	Successes              int       `json:"successes"`
	Failures               int       `json:"failures"`
	P90SuccessLatency      float64   `json:"p90SuccessLatency"`
	MedianSuccessLatency   float64   `json:"medianSuccessLatency"`
	WeightedSuccessLatency float64   `json:"weightedSuccessLatency"`
	SuccessRate            float64   `json:"successRate"`
	CreatedAt              time.Time `json:"createdAt"`
	UpdatedAt              time.Time `json:"updatedAt"`
}

func (*ServiceRecord) Validate

func (sr *ServiceRecord) Validate() (err error)