ClaimClaimableBalanceOperation
extends AbstractOperation
in package
Represents <a href="https://developers.stellar.org" target="_blank">Stellar developer docs</a> operation.
Claims a claimable balance entry and adds the amount to the source account's balance.
Tags
Table of Contents
Methods
- __construct() : mixed
- Creates a new ClaimClaimableBalanceOperation.
- fromXdr() : AbstractOperation
- Creates an operation from its XDR representation.
- fromXdrAmount() : string
- Converts an XDR amount (stroops) to a decimal string.
- fromXdrOperation() : ClaimClaimableBalanceOperation
- Creates a ClaimClaimableBalanceOperation from its XDR representation.
- getBalanceId() : string
- Gets the claimable balance ID.
- getSourceAccount() : MuxedAccount|null
- Gets the source account for this operation.
- setSourceAccount() : void
- Sets the source account for this operation.
- toOperationBody() : XdrOperationBody
- Converts this operation to its XDR operation body representation.
- toXdr() : XdrOperation
- Converts this operation to its XDR representation.
- toXdrAmount() : BigInteger
- Converts a decimal amount string to XDR amount format (stroops).
Methods
__construct()
Creates a new ClaimClaimableBalanceOperation.
public
__construct(string $balanceId) : mixed
Parameters
- $balanceId : string
-
The claimable balance ID (in hex format).
fromXdr()
Creates an operation from its XDR representation.
public
static fromXdr(XdrOperation $xdrOp) : AbstractOperation
Parameters
- $xdrOp : XdrOperation
-
The XDR operation to convert
Return values
AbstractOperation —The resulting operation instance
fromXdrAmount()
Converts an XDR amount (stroops) to a decimal string.
public
static fromXdrAmount(BigInteger $stroops) : string
Parameters
- $stroops : BigInteger
-
The amount in stroops (1 stroop = 0.0000001)
Return values
string —The amount as a decimal string
fromXdrOperation()
Creates a ClaimClaimableBalanceOperation from its XDR representation.
public
static fromXdrOperation(XdrClaimClaimableBalanceOperation $xdrOp) : ClaimClaimableBalanceOperation
Parameters
- $xdrOp : XdrClaimClaimableBalanceOperation
-
The XDR claim claimable balance operation to convert
Return values
ClaimClaimableBalanceOperation —The resulting ClaimClaimableBalanceOperation instance
getBalanceId()
Gets the claimable balance ID.
public
getBalanceId() : string
Return values
string —The claimable balance ID in hex format
getSourceAccount()
Gets the source account for this operation.
public
getSourceAccount() : MuxedAccount|null
Return values
MuxedAccount|null —The source account, or null if using the transaction's source account
setSourceAccount()
Sets the source account for this operation.
public
setSourceAccount(MuxedAccount|null $sourceAccount) : void
Parameters
- $sourceAccount : MuxedAccount|null
-
The source account, or null to use the transaction's source account
toOperationBody()
Converts this operation to its XDR operation body representation.
public
toOperationBody() : XdrOperationBody
Return values
XdrOperationBody —The XDR operation body
toXdr()
Converts this operation to its XDR representation.
public
toXdr() : XdrOperation
Return values
XdrOperation —The XDR operation
toXdrAmount()
Converts a decimal amount string to XDR amount format (stroops).
public
static toXdrAmount(string $strAmount) : BigInteger
Parameters
- $strAmount : string
-
The amount as a decimal string
Return values
BigInteger —The amount in stroops (1 stroop = 0.0000001)