Stellar PHP SDK API Documentation

CreateClaimableBalanceOperationBuilder
in package

Builder for creating CreateClaimableBalance operations.

This builder implements the builder pattern to construct CreateClaimableBalanceOperation instances with a fluent interface. This operation creates a claimable balance entry that can be claimed by authorized claimants according to defined predicates.

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

Stellar developer docs

since
1.0.0
example

$operation = (new CreateClaimableBalanceOperationBuilder($claimants, $asset, '100.00')) ->setSourceAccount($sourceId) ->build();

Table of Contents

Methods

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

public __construct(array<string|int, Claimant$claimants, Asset $asset, string $amount) : mixed
Parameters
$claimants : array<string|int, Claimant>

The claimants that can claim the claimable balance

$asset : Asset

The asset to be claimed

$amount : string

The amount of the asset

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