Documentation GitHub npm

Class

Claimant

Claimant(destination, predicateopt)

Claimant class represents an xdr.Claimant

The claim predicate is optional, it defaults to unconditional if none is specified.

Constructor

# new Claimant(destination, predicateopt)

Parameters:
Name Type Attributes Description
destination string

The destination account ID.
predicate xdr.ClaimPredicate <optional>

The claim predicate.

View Source js-stellar-base/src/claimant.js, line 14

Classes

Claimant

Members

string

# readonly destination

View Source js-stellar-base/src/claimant.js, line 153

xdr.ClaimPredicate

# readonly predicate

View Source js-stellar-base/src/claimant.js, line 165

Methods

# toXDRObject() → {xdr.Claimant}

Returns the xdr object for this claimant.

View Source js-stellar-base/src/claimant.js, line 140

XDR Claimant object

xdr.Claimant

# static fromXDR(claimantXdr) → {Claimant}

Returns a claimant object from its XDR object representation.

Parameters:
Name Type Description
claimantXdr xdr.Claimant

The claimant xdr object.

View Source js-stellar-base/src/claimant.js, line 122

Claimant

# static predicateAnd(left, right) → {xdr.ClaimPredicate}

Returns an and claim predicate

Parameters:
Name Type Description
left xdr.ClaimPredicate

an xdr.ClaimPredicate
right xdr.ClaimPredicate

an xdr.ClaimPredicate

View Source js-stellar-base/src/claimant.js, line 44

xdr.ClaimPredicate

# static predicateBeforeAbsoluteTime(absBefore) → {xdr.ClaimPredicate}

Returns a BeforeAbsoluteTime claim predicate

This predicate will be fulfilled if the closing time of the ledger that includes the CreateClaimableBalance operation is less than this (absolute) Unix timestamp (expressed in seconds).

Parameters:
Name Type Description
absBefore string

Unix epoch (in seconds) as a string

View Source js-stellar-base/src/claimant.js, line 95

xdr.ClaimPredicate

# static predicateBeforeRelativeTime(seconds) → {xdr.ClaimPredicate}

Returns a BeforeRelativeTime claim predicate

This predicate will be fulfilled if the closing time of the ledger that includes the CreateClaimableBalance operation plus this relative time delta (in seconds) is less than the current time.

Parameters:
Name Type Description
seconds strings

seconds since closeTime of the ledger in which the ClaimableBalanceEntry was created (as string)

View Source js-stellar-base/src/claimant.js, line 111

xdr.ClaimPredicate

# static predicateNot(predicate) → {xdr.ClaimPredicate}

Returns a not claim predicate

Parameters:
Name Type Description
predicate xdr.ClaimPredicate

an xdr.ClaimPredicate

View Source js-stellar-base/src/claimant.js, line 77

xdr.ClaimPredicate

# static predicateOr(left, right) → {xdr.ClaimPredicate}

Returns an or claim predicate

Parameters:
Name Type Description
left xdr.ClaimPredicate

an xdr.ClaimPredicate
right xdr.ClaimPredicate

an xdr.ClaimPredicate

View Source js-stellar-base/src/claimant.js, line 61

xdr.ClaimPredicate

# static predicateUnconditional() → {xdr.ClaimPredicate}

Returns an unconditional claim predicate

View Source js-stellar-base/src/claimant.js, line 34

xdr.ClaimPredicate