paths

Documentation

Overview

Package paths provides utilities and facilities for payment paths as needed by horizon. Most importantly, it provides the Finder interface, allowing for pluggable path finding back ends.

Index

• type Finder
• type Path
• type Query

Types

type Finder

type Finder interface {
	// Returns path for a Query of a maximum length `maxLength`
	Find(q Query, maxLength uint) ([]Path, error)
}

Finder finds paths.

type Path

type Path struct {
	Path        []xdr.Asset
	Source      xdr.Asset
	Destination xdr.Asset
	// represents the source assets to be used as `sendMax` field for a `PathPaymentOp` struct
	Cost xdr.Int64
}

Path is the result returned by a path finder and is tied to the DestinationAmount used in the input query

type Query

type Query struct {
	DestinationAddress string
	DestinationAsset   xdr.Asset
	DestinationAmount  xdr.Int64
	SourceAssets       []xdr.Asset
}

Query is a query for paths