path

Documentation

Index

• type BookOffersRequest
  • func (*BookOffersRequest) APIVersion() int
  • func (*BookOffersRequest) Method() string
  • func (*BookOffersRequest) Validate() error
• type BookOffersResponse
• type DepositAuthorizedRequest
  • func (*DepositAuthorizedRequest) APIVersion() int
  • func (*DepositAuthorizedRequest) Method() string
  • func (*DepositAuthorizedRequest) Validate() error
• type DepositAuthorizedResponse
• type FindCloseRequest
  • func (*FindCloseRequest) APIVersion() int
  • func (*FindCloseRequest) Method() string
  • func (*FindCloseRequest) Validate() error
• type FindCreateRequest
  • func (*FindCreateRequest) APIVersion() int
  • func (*FindCreateRequest) Method() string
  • func (*FindCreateRequest) Validate() error
• type FindResponse
• type FindStatusRequest
  • func (*FindStatusRequest) APIVersion() int
  • func (*FindStatusRequest) Method() string
  • func (*FindStatusRequest) Validate() error
• type RipplePathFindRequest
  • func (*RipplePathFindRequest) APIVersion() int
  • func (*RipplePathFindRequest) Method() string
  • func (*RipplePathFindRequest) Validate() error
• type RipplePathFindResponse
• type SubCommand

Types

type BookOffersRequest

type BookOffersRequest struct {
	common.BaseRequest
	TakerGets   pathtypes.BookOfferCurrency `json:"taker_gets"`
	TakerPays   pathtypes.BookOfferCurrency `json:"taker_pays"`
	Taker       types.Address               `json:"taker,omitempty"`
	LedgerHash  common.LedgerHash           `json:"ledger_hash,omitempty"`
	LedgerIndex common.LedgerIndex          `json:"ledger_index,omitempty"`
	Limit       int                         `json:"limit,omitempty"`
}

The book_offers method retrieves a list of offers, also known as the order book, between two currencies.

func (*BookOffersRequest) APIVersion

func (*BookOffersRequest) APIVersion() int

func (*BookOffersRequest) Method

func (*BookOffersRequest) Method() string

func (*BookOffersRequest) Validate

func (*BookOffersRequest) Validate() error

TODO: Implement V2

type BookOffersResponse

type BookOffersResponse struct {
	LedgerCurrentIndex common.LedgerIndex    `json:"ledger_current_index,omitempty"`
	LedgerIndex        common.LedgerIndex    `json:"ledger_index,omitempty"`
	LedgerHash         common.LedgerHash     `json:"ledger_hash,omitempty"`
	Offers             []pathtypes.BookOffer `json:"offers"`
	Validated          bool                  `json:"validated,omitempty"`
}

The expected response from the book_offers method.

type DepositAuthorizedRequest

type DepositAuthorizedRequest struct {
	common.BaseRequest
	SourceAccount      types.Address          `json:"source_account"`
	DestinationAccount types.Address          `json:"destination_account"`
	LedgerHash         common.LedgerHash      `json:"ledger_hash,omitempty"`
	LedgerIndex        common.LedgerSpecifier `json:"ledger_index,omitempty"`
}

The deposit_authorized command indicates whether one account is authorized to send payments directly to another.

func (*DepositAuthorizedRequest) APIVersion

func (*DepositAuthorizedRequest) APIVersion() int

func (*DepositAuthorizedRequest) Method

func (*DepositAuthorizedRequest) Method() string

func (*DepositAuthorizedRequest) Validate

func (*DepositAuthorizedRequest) Validate() error

TODO: Implement V2

type DepositAuthorizedResponse

type DepositAuthorizedResponse struct {
	DepositAuthorized  bool               `json:"deposit_authorized"`
	DestinationAccount types.Address      `json:"destination_account"`
	LedgerHash         common.LedgerHash  `json:"ledger_hash,omitempty"`
	LedgerIndex        common.LedgerIndex `json:"ledger_index,omitempty"`
	LedgerCurrentIndex common.LedgerIndex `json:"ledger_current_index,omitempty"`
	SourceAccount      types.Address      `json:"source_account"`
	Validated          bool               `json:"validated,omitempty"`
}

The expected response from the deposit_authorized method.

type FindCloseRequest

type FindCloseRequest struct {
	common.BaseRequest
	Subcommand SubCommand `json:"subcommand"`
}

Stop sending pathfinding information.

func (*FindCloseRequest) APIVersion

func (*FindCloseRequest) APIVersion() int

func (*FindCloseRequest) Method

func (*FindCloseRequest) Method() string

func (*FindCloseRequest) Validate

func (*FindCloseRequest) Validate() error

TODO: Implement V2

type FindCreateRequest

type FindCreateRequest struct {
	common.BaseRequest
	Subcommand         SubCommand             `json:"subcommand"`
	SourceAccount      types.Address          `json:"source_account,omitempty"`
	DestinationAccount types.Address          `json:"destination_account,omitempty"`
	DestinationAmount  types.CurrencyAmount   `json:"destination_amount,omitempty"`
	SendMax            types.CurrencyAmount   `json:"send_max,omitempty"`
	Paths              []transaction.PathStep `json:"paths,omitempty"`
}

Start sending pathfinding information.

func (*FindCreateRequest) APIVersion

func (*FindCreateRequest) APIVersion() int

func (*FindCreateRequest) Method

func (*FindCreateRequest) Method() string

func (*FindCreateRequest) Validate

func (*FindCreateRequest) Validate() error

TODO: Implement V2

type FindResponse

type FindResponse struct {
	Alternatives       []pathtypes.Alternative `json:"alternatives"`
	DestinationAccount types.Address           `json:"destination_account"`
	// DestinationAmount  types.CurrencyAmount    `json:"destination_amount"`
	DestinationAmount any           `json:"destination_amount"`
	SourceAccount     types.Address `json:"source_account"`
	FullReply         bool          `json:"full_reply"`
	Closed            bool          `json:"closed,omitempty"`
	Status            bool          `json:"status,omitempty"`
}

The expected response from the path_find method.

type FindStatusRequest

type FindStatusRequest struct {
	common.BaseRequest
	Subcommand SubCommand `json:"subcommand"`
}

Get the information of the currently-open pathfinding request.

func (*FindStatusRequest) APIVersion

func (*FindStatusRequest) APIVersion() int

func (*FindStatusRequest) Method

func (*FindStatusRequest) Method() string

func (*FindStatusRequest) Validate

func (*FindStatusRequest) Validate() error

TODO: Implement V2

type RipplePathFindRequest

type RipplePathFindRequest struct {
	common.BaseRequest
	SourceAccount      types.Address                      `json:"source_account"`
	DestinationAccount types.Address                      `json:"destination_account"`
	DestinationAmount  types.CurrencyAmount               `json:"destination_amount"`
	SendMax            types.CurrencyAmount               `json:"send_max,omitempty"`
	SourceCurrencies   []pathtypes.RipplePathFindCurrency `json:"source_currencies,omitempty"`
	LedgerHash         common.LedgerHash                  `json:"ledger_hash,omitempty"`
	LedgerIndex        common.LedgerSpecifier             `json:"ledger_index,omitempty"`
}

The ripple_path_find method is a simplified version of the path_find method that provides a single response with a payment path you can use right away.

func (*RipplePathFindRequest) APIVersion

func (*RipplePathFindRequest) APIVersion() int

func (*RipplePathFindRequest) Method

func (*RipplePathFindRequest) Method() string

func (*RipplePathFindRequest) Validate

func (*RipplePathFindRequest) Validate() error

TODO: Implement V2

type RipplePathFindResponse

type RipplePathFindResponse struct {
	Alternatives          []pathtypes.RippleAlternative `json:"alternatives"`
	DestinationAccount    types.Address                 `json:"destination_account"`
	DestinationCurrencies []string                      `json:"destination_currencies"`
	FullReply             bool                          `json:"full_reply,omitempty"`
	LedgerCurrentIndex    int                           `json:"ledger_current_index,omitempty"`
	SourceAccount         types.Address                 `json:"source_account"`
	Validated             bool                          `json:"validated"`
}

The expected response from the ripple_path_find method.

type SubCommand

type SubCommand string

const (
	Create SubCommand = "create"
	Close  SubCommand = "close"
	Status SubCommand = "status"
)