Stellar PHP SDK API Documentation

BeginSponsoringFutureReservesOperation extends AbstractOperation
in package

Represents <a href="https://developers.stellar.org" target="_blank">Stellar developer docs</a> operation.

Initiates a sponsorship relationship, where the source account will pay the base reserves for operations submitted by the sponsored account.

Tags
see

Stellar developer docs

see
EndSponsoringFutureReservesOperation

For ending the sponsorship

since
1.0.0

Table of Contents

Methods

__construct()  : mixed
Creates a new BeginSponsoringFutureReservesOperation.
fromXdr()  : AbstractOperation
Creates an operation from its XDR representation.
fromXdrAmount()  : string
Converts an XDR amount (stroops) to a decimal string.
fromXdrOperation()  : BeginSponsoringFutureReservesOperation
Creates a BeginSponsoringFutureReservesOperation from its XDR representation.
getSourceAccount()  : MuxedAccount|null
Gets the source account for this operation.
getSponsoredId()  : string
Gets the sponsored account ID.
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 BeginSponsoringFutureReservesOperation.

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

The account ID that will be sponsored.

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 BeginSponsoringFutureReservesOperation from its XDR representation.

public static fromXdrOperation(XdrBeginSponsoringFutureReservesOperation $xdrOp) : BeginSponsoringFutureReservesOperation
Parameters
$xdrOp : XdrBeginSponsoringFutureReservesOperation

The XDR begin sponsoring future reserves operation to convert

Return values
BeginSponsoringFutureReservesOperation

The resulting BeginSponsoringFutureReservesOperation instance

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

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)


        
On this page

Search results