Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrEmptyUrl = errors.New("empty port and IP provided")
Functions ¶
This section is empty.
Types ¶
type Account ¶
type Account interface {
AccountChannels(req *account.AccountChannelsRequest) (*account.AccountChannelsResponse, XRPLResponse, error)
AccountCurrencies(req *account.AccountCurrenciesRequest) (*account.AccountCurrenciesResponse, XRPLResponse, error)
AccountInfo(req *account.AccountInfoRequest) (*account.AccountInfoResponse, XRPLResponse, error)
AccountLines(req *account.AccountLinesRequest) (*account.AccountLinesResponse, XRPLResponse, error)
AccountNFTs(req *account.AccountNFTsRequest) (*account.AccountNFTsResponse, XRPLResponse, error)
AccountObjects(req *account.AccountObjectsRequest) (*account.AccountObjectsResponse, XRPLResponse, error)
AccountOffers(req *account.AccountOffersRequest) (*account.AccountOffersResponse, XRPLResponse, error)
AccountTransactions(req *account.AccountTransactionsRequest) (*account.AccountTransactionsResponse, XRPLResponse, error)
}
type Channel ¶
type Channel interface {
ChannelAuthorize(req *channel.ChannelAuthorizeRequest) (*channel.ChannelAuthorizeResponse, XRPLResponse, error)
ChannelVerify(req *channel.ChannelVerifyRequest) (*channel.ChannelVerifyResponse, XRPLResponse, error)
}
type Client ¶
type Client interface {
SendRequest(req XRPLRequest) (XRPLResponse, error)
Address() string
Faucet() string
}
type Clio ¶
type Clio interface {
ServerInfo(*clio.ServerInfoRequest) (*clio.ServerInfoResponse, XRPLResponse, error)
Ledger(*clio.LedgerRequest) (*clio.LedgerResponse, XRPLResponse, error)
NFTHistory(*clio.NFTHistoryRequest) (*clio.NFTHistoryResponse, XRPLResponse, error)
NFTInfo(*clio.NFTInfoRequest) (*clio.NFTInfoResponse, XRPLResponse, error)
}
type Faucet ¶
type Faucet interface {
FundAccount(*faucet.FundAccountRequest) (*faucet.FundAccountResponse, XRPLResponse, error)
}
type JsonRpcConfig ¶
type JsonRpcConfig struct {
HTTPClient HTTPClient
Url string
Faucet string
Headers map[string][]string
}
func NewJsonRpcConfig ¶
func NewJsonRpcConfig(url string, opts ...JsonRpcConfigOpt) (*JsonRpcConfig, error)
type JsonRpcConfigOpt ¶
type JsonRpcConfigOpt func(c *JsonRpcConfig)
func WithFaucet ¶
func WithFaucet(faucet string) JsonRpcConfigOpt
func WithHttpClient ¶
func WithHttpClient(cl HTTPClient) JsonRpcConfigOpt
type Ledger ¶
type Ledger interface {
LedgerClosed(req *ledger.LedgerClosedRequest) (*ledger.LedgerClosedResponse, XRPLResponse, error)
LedgerCurrent(req *ledger.LedgerCurrentRequest) (*ledger.LedgerCurrentResponse, XRPLResponse, error)
LedgerData(req *ledger.LedgerDataRequest) (*ledger.LedgerDataResponse, XRPLResponse, error)
LedgerEntry(req *ledger.LedgerEntryRequest) (*ledger.LedgerEntryResponse, XRPLResponse, error)
Ledger(req *ledger.LedgerRequest) (*ledger.LedgerResponse, XRPLResponse, error)
}
type Path ¶
type Path interface {
BookOffers(req *path.BookOffersRequest) (*path.BookOffersResponse, XRPLResponse, error)
DepositAuthorized(req *path.DepositAuthorizedRequest) (*path.DepositAuthorizedResponse, XRPLResponse, error)
NFTokenBuyOffers(req *path.NFTokenBuyOffersRequest) (*path.NFTokenBuyOffersResponse, XRPLResponse, error)
NFTokenSellOffers(req *path.NFTokenSellOffersRequest) (*path.NFTokenSellOffersResponse, XRPLResponse, error)
PathFind(req *path.PathFindRequest) (*path.PathFindResponse, XRPLResponse, error)
RipplePathFind(req *path.RipplePathFindRequest) (*path.RipplePathFindResponse, XRPLResponse, error)
}
type Server ¶
type Server interface {
Fee(*server.FeeRequest) (*server.FeeResponse, XRPLResponse, error)
Manifest(*server.ManifestRequest) (*server.ManifestResponse, XRPLResponse, error)
ServerInfo(*server.ServerInfoRequest) (*server.ServerInfoResponse, XRPLResponse, error)
ServerState(*server.ServerStateRequest) (*server.ServerStateResponse, XRPLResponse, error)
}
type Subscription ¶
type Subscription interface {
Subscribe(*subscription.SubscribeRequest) (*subscription.SubscribeResponse, XRPLResponse, error)
Unsubscribe(*subscription.UnsubscribeRequest) (*subscription.UnsubscribeResponse, XRPLResponse, error)
}
type Transaction ¶
type Transaction interface {
SubmitMultisigned(*transactions.SubmitMultisignedRequest) (*transactions.SubmitMultisignedResponse, XRPLResponse, error)
Submit(*transactions.SubmitRequest) (*transactions.SubmitResponse, XRPLResponse, error)
TransactionEntry(*transactions.TransactionEntryRequest) (*transactions.TransactionEntryResponse, XRPLResponse, error)
Tx(*transactions.TxRequest) (*transactions.TxResponse, XRPLResponse, error)
}
type XRPLClient ¶
type XRPLClient struct {
Account Account
Channel Channel
Ledger Ledger
Path Path
Subscription Subscription
Transaction Transaction
Server Server
Clio Clio
Faucet Faucet
// contains filtered or unexported fields
}
func NewXRPLClient ¶
func NewXRPLClient(cl Client) *XRPLClient
func (*XRPLClient) AutofillTx ¶
func (c *XRPLClient) AutofillTx(acc types.Address, tx transactions.Tx) error
func (*XRPLClient) Client ¶
func (c *XRPLClient) Client() Client
type XRPLRequest ¶
type XRPLResponse ¶
type XRPLResponseWarning ¶
Source Files
¶
Click to show internal directories.
Click to hide internal directories.