server

Documentation

Index

• type FeatureAllRequest
  • func (*FeatureAllRequest) APIVersion() int
  • func (*FeatureAllRequest) Method() string
  • func (*FeatureAllRequest) Validate() error
• type FeatureAllResponse
• type FeatureOneRequest
  • func (*FeatureOneRequest) APIVersion() int
  • func (*FeatureOneRequest) Method() string
  • func (*FeatureOneRequest) Validate() error
• type FeatureResponse
• type FeeRequest
  • func (*FeeRequest) APIVersion() int
  • func (*FeeRequest) Method() string
  • func (*FeeRequest) Validate() error
• type FeeResponse
• type InfoRequest
  • func (*InfoRequest) APIVersion() int
  • func (*InfoRequest) Method() string
  • func (*InfoRequest) Validate() error
• type InfoResponse
• type ManifestDetails
• type ManifestRequest
  • func (*ManifestRequest) APIVersion() int
  • func (*ManifestRequest) Method() string
  • func (*ManifestRequest) Validate() error
• type ManifestResponse
• type StateRequest
  • func (*StateRequest) APIVersion() int
  • func (*StateRequest) Method() string
  • func (*StateRequest) Validate() error
• type StateResponse

Types

type FeatureAllRequest

type FeatureAllRequest struct {
	common.BaseRequest
}

The feature command returns information about amendments this server knows about, including whether they are enabled.

func (*FeatureAllRequest) APIVersion

func (*FeatureAllRequest) APIVersion() int

func (*FeatureAllRequest) Method

func (*FeatureAllRequest) Method() string

func (*FeatureAllRequest) Validate

func (*FeatureAllRequest) Validate() error

TODO: Implement V2

type FeatureAllResponse

type FeatureAllResponse struct {
	Features map[string]types.FeatureStatus `json:"features"`
}

The feature command returns information about amendments this server knows about, including whether they are enabled.

type FeatureOneRequest

type FeatureOneRequest struct {
	common.BaseRequest
	Feature string `json:"feature"`
}

func (*FeatureOneRequest) APIVersion

func (*FeatureOneRequest) APIVersion() int

func (*FeatureOneRequest) Method

func (*FeatureOneRequest) Method() string

func (*FeatureOneRequest) Validate

func (*FeatureOneRequest) Validate() error

TODO: Implement V2

type FeatureResponse

type FeatureResponse map[string]types.FeatureStatus

The expected response from the feature method.

type FeeRequest

type FeeRequest struct {
	common.BaseRequest
}

The fee command reports the current state of the open-ledger requirements for the transaction cost. This requires the FeeEscalation amendment to be enabled.

func (*FeeRequest) APIVersion

func (*FeeRequest) APIVersion() int

func (*FeeRequest) Method

func (*FeeRequest) Method() string

func (*FeeRequest) Validate

func (*FeeRequest) Validate() error

TODO: Implement V2

type FeeResponse

type FeeResponse struct {
	CurrentLedgerSize  string                `json:"current_ledger_size"`
	CurrentQueueSize   string                `json:"current_queue_size"`
	Drops              servertypes.FeeDrops  `json:"drops"`
	ExpectedLedgerSize string                `json:"expected_ledger_size"`
	LedgerCurrentIndex common.LedgerIndex    `json:"ledger_current_index"`
	Levels             servertypes.FeeLevels `json:"levels"`
	MaxQueueSize       string                `json:"max_queue_size"`
}

The expected response from the fee method.

type InfoRequest

type InfoRequest struct {
	common.BaseRequest
}

The server_info command asks the server for a human-readable version of various information about the rippled server being queried.

func (*InfoRequest) APIVersion

func (*InfoRequest) APIVersion() int

func (*InfoRequest) Method

func (*InfoRequest) Method() string

func (*InfoRequest) Validate

func (*InfoRequest) Validate() error

TODO: Implement V2

type InfoResponse

type InfoResponse struct {
	Info servertypes.Info `json:"info"`
}

The expected response from the server_info method.

type ManifestDetails

type ManifestDetails struct {
	Domain       string `json:"domain"`
	EphemeralKey string `json:"ephemeral_key"`
	MasterKey    string `json:"master_key"`
	Seq          uint   `json:"seq"`
}

type ManifestRequest

type ManifestRequest struct {
	common.BaseRequest
	PublicKey string `json:"public_key"`
}

The manifest method reports the current "manifest" information for a given validator public key. The "manifest" is the public portion of that validator's configured token.

func (*ManifestRequest) APIVersion

func (*ManifestRequest) APIVersion() int

func (*ManifestRequest) Method

func (*ManifestRequest) Method() string

func (*ManifestRequest) Validate

func (*ManifestRequest) Validate() error

TODO: Implement V2

type ManifestResponse

type ManifestResponse struct {
	Details   ManifestDetails `json:"details,omitempty"`
	Manifest  string          `json:"manifest,omitempty"`
	Requested string          `json:"requested"`
}

The expected response from the manifest method.

type StateRequest

type StateRequest struct {
	common.BaseRequest
}

The server_state command asks the server for various machine-readable information about the rippled server's current state. The response is almost the same as the server_info method, but uses units that are easier to process instead of easier to read.

func (*StateRequest) APIVersion

func (*StateRequest) APIVersion() int

func (*StateRequest) Method

func (*StateRequest) Method() string

func (*StateRequest) Validate

func (*StateRequest) Validate() error

TODO: Implement V2

type StateResponse

type StateResponse struct {
	State servertypes.State `json:"state"`
}

The expected response from the server_state method.