Claimant

Claimant

Claimant class represents an xdr.Claimant

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

Constructor

new Claimant(destination, predicateopt)

Source:
Parameters:
Name Type Attributes Description
destination string

The destination account ID.

predicate xdr.ClaimPredicate <optional>

The claim predicate.

Members

(readonly) destination :string

Source:
Type:
  • string

(readonly) predicate :xdr.ClaimPredicate

Source:
Type:
  • xdr.ClaimPredicate

Methods

(static) fromXDR(claimantXdr) → {Claimant}

Returns a claimant object from its XDR object representation.

Source:
Parameters:
Name Type Description
claimantXdr xdr.Claimant

The claimant xdr object.

Returns:
Type:
Claimant

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

Returns an and claim predicate

Source:
Parameters:
Name Type Description
left xdr.ClaimPredicate

an xdr.ClaimPredicate

right xdr.ClaimPredicate

an xdr.ClaimPredicate

Returns:
Type:
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.

Source:
Parameters:
Name Type Description
absBefore string

Unix epoch as a string

Returns:
Type:
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.

Source:
Parameters:
Name Type Description
seconds strings

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

Returns:
Type:
xdr.ClaimPredicate

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

Returns a not claim predicate

Source:
Parameters:
Name Type Description
predicate xdr.ClaimPredicate

an xdr.ClaimPredicate

Returns:
Type:
xdr.ClaimPredicate

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

Returns an or claim predicate

Source:
Parameters:
Name Type Description
left xdr.ClaimPredicate

an xdr.ClaimPredicate

right xdr.ClaimPredicate

an xdr.ClaimPredicate

Returns:
Type:
xdr.ClaimPredicate

(static) predicateUnconditional() → {xdr.ClaimPredicate}

Returns an unconditional claim predicate

Source:
Returns:
Type:
xdr.ClaimPredicate

toXDRObject() → {xdr.Claimant}

Returns the xdr object for this claimant.

Source:
Returns:
Type:
xdr.Claimant

XDR Claimant object