Stellar PHP SDK API Documentation

ClawbackClaimableBalanceOperationBuilder
in package

Builder for creating ClawbackClaimableBalance operations.

This builder implements the builder pattern to construct ClawbackClaimableBalanceOperation instances with a fluent interface. This operation claws back a claimable balance, burning the assets and removing the balance entry from the ledger.

Tags
see
ClawbackClaimableBalanceOperation
see
https://developers.stellar.org

Stellar developer docs

since
1.0.0
example

$operation = (new ClawbackClaimableBalanceOperationBuilder($balanceId)) ->setSourceAccount($issuerId) ->build();

Table of Contents

Methods

__construct()  : mixed
Creates a new ClawbackClaimableBalance operation builder.
build()  : ClawbackClaimableBalanceOperation
Builds the ClawbackClaimableBalance operation.
setMuxedSourceAccount()  : $this
Sets the muxed source account for this operation.
setSourceAccount()  : $this
Sets the source account for this operation.

Methods

__construct()

Creates a new ClawbackClaimableBalance operation builder.

public __construct(string $balanceId) : mixed
Parameters
$balanceId : string

The claimable balance ID to claw back

setMuxedSourceAccount()

Sets the muxed source account for this operation.

public setMuxedSourceAccount(MuxedAccount $sourceAccount) : $this
Parameters
$sourceAccount : MuxedAccount

The muxed account to use as source

Return values
$this

Returns the builder instance for method chaining

setSourceAccount()

Sets the source account for this operation.

public setSourceAccount(string $accountId) : $this
Parameters
$accountId : string

The Stellar account ID (G...)

Return values
$this

Returns the builder instance for method chaining


        
On this page

Search results