Stellar PHP SDK API Documentation

ClawbackOperationBuilder
in package

Builder for creating Clawback operations.

This builder implements the builder pattern to construct ClawbackOperation instances with a fluent interface. Clawback operations allow an asset issuer to burn assets from a holder's account, effectively reclaiming them.

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

Stellar developer docs

since
1.0.0
example

$operation = (new ClawbackOperationBuilder($asset, $fromAccount, '100.00')) ->setSourceAccount($issuerId) ->build();

Table of Contents

Methods

__construct()  : mixed
Creates a new Clawback operation builder.
build()  : ClawbackOperation
Builds the Clawback 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 Clawback operation builder.

public __construct(Asset $asset, MuxedAccount $from, string $amount) : mixed
Parameters
$asset : Asset

The asset to claw back

$from : MuxedAccount

The account from which to claw back the asset

$amount : string

The amount 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