Documentation
¶
Index ¶
- func CountOffers(env *jtx.TestEnv, acc *jtx.Account) uint32
- func CountOffersMatching(env *jtx.TestEnv, acc *jtx.Account, takerPays, takerGets tx.Amount) uint32
- func GetOffer(env *jtx.TestEnv, acc *jtx.Account, offerSeq uint32) *state.LedgerOffer
- func IsOffer(env *jtx.TestEnv, acc *jtx.Account, takerPays, takerGets tx.Amount) bool
- func LastClose(env *jtx.TestEnv) uint32
- func OfferInLedger(env *jtx.TestEnv, acc *jtx.Account, offerSeq uint32) bool
- func OffersOnAccount(env *jtx.TestEnv, acc *jtx.Account) []*state.LedgerOffer
- func RequireIsOffer(t *testing.T, env *jtx.TestEnv, acc *jtx.Account, ...)
- func RequireNoOffer(t *testing.T, env *jtx.TestEnv, acc *jtx.Account, ...)
- func RequireNoOfferInLedger(t *testing.T, env *jtx.TestEnv, acc *jtx.Account, offerSeq uint32)
- func RequireOfferCount(t *testing.T, env *jtx.TestEnv, acc *jtx.Account, expected uint32)
- func RequireOfferInLedger(t *testing.T, env *jtx.TestEnv, acc *jtx.Account, offerSeq uint32)
- func Reserve(env *jtx.TestEnv, count uint32) uint64
- func RippleTimeFromUnix(t time.Time) uint32
- func SortedOffersOnAccount(env *jtx.TestEnv, acc *jtx.Account) []*state.LedgerOffer
- type OfferCancelBuilder
- func (b *OfferCancelBuilder) Build() tx.Transaction
- func (b *OfferCancelBuilder) BuildOfferCancel() *offertx.OfferCancel
- func (b *OfferCancelBuilder) Fee(f uint64) *OfferCancelBuilder
- func (b *OfferCancelBuilder) Sequence(seq uint32) *OfferCancelBuilder
- func (b *OfferCancelBuilder) TicketSeq(ticketSeq uint32) *OfferCancelBuilder
- type OfferCreateBuilder
- func (b *OfferCreateBuilder) Build() tx.Transaction
- func (b *OfferCreateBuilder) BuildOfferCreate() *offertx.OfferCreate
- func (b *OfferCreateBuilder) DomainID(id [32]byte) *OfferCreateBuilder
- func (b *OfferCreateBuilder) Expiration(exp uint32) *OfferCreateBuilder
- func (b *OfferCreateBuilder) Fee(f uint64) *OfferCreateBuilder
- func (b *OfferCreateBuilder) FillOrKill() *OfferCreateBuilder
- func (b *OfferCreateBuilder) Flags(f uint32) *OfferCreateBuilder
- func (b *OfferCreateBuilder) Hybrid() *OfferCreateBuilder
- func (b *OfferCreateBuilder) ImmediateOrCancel() *OfferCreateBuilder
- func (b *OfferCreateBuilder) OfferSequence(seq uint32) *OfferCreateBuilder
- func (b *OfferCreateBuilder) Passive() *OfferCreateBuilder
- func (b *OfferCreateBuilder) Sell() *OfferCreateBuilder
- func (b *OfferCreateBuilder) Sequence(seq uint32) *OfferCreateBuilder
- func (b *OfferCreateBuilder) TicketSeq(ticketSeq uint32) *OfferCreateBuilder
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CountOffers ¶
CountOffers counts all offer entries owned by an account. Iterates the owner directory and filters for Offer type (0x006f). Equivalent to rippled's offers(account, N) require funclet.
func CountOffersMatching ¶
CountOffersMatching counts offers with specific TakerPays and TakerGets amounts. Equivalent to rippled's countOffers(env, account, takerPays, takerGets).
func GetOffer ¶
GetOffer reads and parses a specific offer from the ledger by account and sequence. Returns nil if the offer doesn't exist.
func IsOffer ¶
IsOffer checks if an offer with specific amounts exists for an account. Equivalent to rippled's isOffer(env, account, takerPays, takerGets).
func LastClose ¶
LastClose returns the parent close time in Ripple epoch seconds. Equivalent to rippled's lastClose(env) in Offer_test.cpp.
func OfferInLedger ¶
OfferInLedger checks if an offer exists in the ledger by account and sequence. Equivalent to rippled's offerInLedger / ledgerEntryOffer check.
func OffersOnAccount ¶
OffersOnAccount returns all parsed offer entries owned by an account.
func RequireIsOffer ¶
func RequireIsOffer(t *testing.T, env *jtx.TestEnv, acc *jtx.Account, takerPays, takerGets tx.Amount)
RequireIsOffer asserts that an offer with specific amounts exists.
func RequireNoOffer ¶
func RequireNoOffer(t *testing.T, env *jtx.TestEnv, acc *jtx.Account, takerPays, takerGets tx.Amount)
RequireNoOffer asserts that an offer with specific amounts does not exist.
func RequireNoOfferInLedger ¶
RequireNoOfferInLedger asserts that an offer entry does NOT exist in the ledger by sequence.
func RequireOfferCount ¶
RequireOfferCount asserts that an account has exactly the expected number of offers.
func RequireOfferInLedger ¶
RequireOfferInLedger asserts that an offer entry exists in the ledger by sequence.
func Reserve ¶
Reserve computes the account reserve for a given owner count. Equivalent to rippled's reserve(env, count) helper in Offer_test.cpp.
func RippleTimeFromUnix ¶
RippleTimeFromUnix converts a time.Time to Ripple epoch seconds.
func SortedOffersOnAccount ¶
SortedOffersOnAccount returns all offers for an account sorted by sequence number. Equivalent to rippled's sortedOffersOnAccount() in Offer_test.cpp.
Types ¶
type OfferCancelBuilder ¶
type OfferCancelBuilder struct {
// contains filtered or unexported fields
}
OfferCancelBuilder provides a fluent interface for building OfferCancel transactions.
func OfferCancel ¶
func OfferCancel(account *testing.Account, offerSeq uint32) *OfferCancelBuilder
OfferCancel creates a new OfferCancelBuilder. offerSeq is the sequence number of the OfferCreate transaction to cancel.
func (*OfferCancelBuilder) Build ¶
func (b *OfferCancelBuilder) Build() tx.Transaction
Build constructs the OfferCancel transaction.
func (*OfferCancelBuilder) BuildOfferCancel ¶
func (b *OfferCancelBuilder) BuildOfferCancel() *offertx.OfferCancel
BuildOfferCancel is a convenience method that returns the concrete *offertx.OfferCancel type.
func (*OfferCancelBuilder) Fee ¶
func (b *OfferCancelBuilder) Fee(f uint64) *OfferCancelBuilder
Fee sets the transaction fee in drops.
func (*OfferCancelBuilder) Sequence ¶
func (b *OfferCancelBuilder) Sequence(seq uint32) *OfferCancelBuilder
Sequence sets the sequence number explicitly.
func (*OfferCancelBuilder) TicketSeq ¶
func (b *OfferCancelBuilder) TicketSeq(ticketSeq uint32) *OfferCancelBuilder
TicketSeq sets the ticket sequence and sets Sequence to 0.
type OfferCreateBuilder ¶
type OfferCreateBuilder struct {
// contains filtered or unexported fields
}
OfferCreateBuilder provides a fluent interface for building OfferCreate transactions.
func OfferCreate ¶
func OfferCreate(account *testing.Account, takerPays, takerGets tx.Amount) *OfferCreateBuilder
OfferCreate creates a new OfferCreateBuilder. takerPays is what the offer creator receives, takerGets is what they pay.
func OfferCreateXRP ¶
func OfferCreateXRP(account *testing.Account, xrpAmount uint64, issuedAmount tx.Amount, buyXRP bool) *OfferCreateBuilder
OfferCreateXRP creates an offer where one side is XRP. If buyXRP is true, creates an offer to buy XRP with issued currency. If buyXRP is false, creates an offer to sell XRP for issued currency.
func (*OfferCreateBuilder) Build ¶
func (b *OfferCreateBuilder) Build() tx.Transaction
Build constructs the OfferCreate transaction.
func (*OfferCreateBuilder) BuildOfferCreate ¶
func (b *OfferCreateBuilder) BuildOfferCreate() *offertx.OfferCreate
BuildOfferCreate is a convenience method that returns the concrete *offertx.OfferCreate type.
func (*OfferCreateBuilder) DomainID ¶
func (b *OfferCreateBuilder) DomainID(id [32]byte) *OfferCreateBuilder
DomainID sets the permissioned domain ID for this offer.
func (*OfferCreateBuilder) Expiration ¶
func (b *OfferCreateBuilder) Expiration(exp uint32) *OfferCreateBuilder
Expiration sets the expiration time (in Ripple epoch seconds).
func (*OfferCreateBuilder) Fee ¶
func (b *OfferCreateBuilder) Fee(f uint64) *OfferCreateBuilder
Fee sets the transaction fee in drops.
func (*OfferCreateBuilder) FillOrKill ¶
func (b *OfferCreateBuilder) FillOrKill() *OfferCreateBuilder
FillOrKill makes the offer fill-or-kill. The offer must be fully filled or it will be cancelled entirely.
func (*OfferCreateBuilder) Flags ¶
func (b *OfferCreateBuilder) Flags(f uint32) *OfferCreateBuilder
Flags sets the raw flags value, replacing any previously set flags. Use this for testing malformed flag combinations.
func (*OfferCreateBuilder) Hybrid ¶
func (b *OfferCreateBuilder) Hybrid() *OfferCreateBuilder
Hybrid sets the tfHybrid flag (offer appears in both domain and open book). Requires DomainID to be set.
func (*OfferCreateBuilder) ImmediateOrCancel ¶
func (b *OfferCreateBuilder) ImmediateOrCancel() *OfferCreateBuilder
ImmediateOrCancel makes the offer immediate-or-cancel. The offer will only take what's available immediately and cancel the rest.
func (*OfferCreateBuilder) OfferSequence ¶
func (b *OfferCreateBuilder) OfferSequence(seq uint32) *OfferCreateBuilder
OfferSequence sets an existing offer to cancel when this one is created.
func (*OfferCreateBuilder) Passive ¶
func (b *OfferCreateBuilder) Passive() *OfferCreateBuilder
Passive makes the offer passive (won't consume matching offers).
func (*OfferCreateBuilder) Sell ¶
func (b *OfferCreateBuilder) Sell() *OfferCreateBuilder
Sell makes this a sell offer. The taker gets at least as much as TakerGets, possibly more.
func (*OfferCreateBuilder) Sequence ¶
func (b *OfferCreateBuilder) Sequence(seq uint32) *OfferCreateBuilder
Sequence sets the sequence number explicitly.
func (*OfferCreateBuilder) TicketSeq ¶
func (b *OfferCreateBuilder) TicketSeq(ticketSeq uint32) *OfferCreateBuilder
TicketSeq sets the ticket sequence and sets Sequence to 0.