ClawbackClaimableBalanceOperation
extends AbstractOperation
in package
Represents clawback claimable balance operation.
Claws back a claimable balance, returning the funds to the asset issuer and removing the claimable balance from the ledger.
Tags
Table of Contents
Methods
- __construct() : mixed
- Creates a new ClawbackClaimableBalanceOperation.
- fromXdr() : AbstractOperation
- Creates an operation from its XDR representation.
- fromXdrAmount() : string
- Converts an XDR amount (stroops) to a decimal string.
- fromXdrOperation() : ClawbackClaimableBalanceOperation
- Creates a ClawbackClaimableBalanceOperation 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 ClawbackClaimableBalanceOperation.
public
__construct(string $balanceId) : mixed
Parameters
- $balanceId : string
-
The claimable balance ID to claw back (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 ClawbackClaimableBalanceOperation from its XDR representation.
public
static fromXdrOperation(XdrClawbackClaimableBalanceOperation $xdrOp) : ClawbackClaimableBalanceOperation
Parameters
- $xdrOp : XdrClawbackClaimableBalanceOperation
-
The XDR clawback claimable balance operation to convert
Return values
ClawbackClaimableBalanceOperation —The resulting ClawbackClaimableBalanceOperation 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)