Stellar PHP SDK API Documentation

RevokeSponsorshipOperationBuilder
in package

Builder for creating RevokeSponsorship operations.

This builder implements the builder pattern to construct RevokeSponsorshipOperation instances with a fluent interface. This operation revokes sponsorship of various ledger entries including accounts, trustlines, offers, data, claimable balances, and signers.

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

Stellar developer docs

since
1.0.0
example

$operation = (new RevokeSponsorshipOperationBuilder()) ->revokeAccountSponsorship($accountId) ->setSourceAccount($sponsorId) ->build();

Table of Contents

Methods

build()  : RevokeSponsorshipOperation
Builds the RevokeSponsorship operation.
revokeAccountSponsorship()  : $this
Revokes sponsorship of an account.
revokeClaimableBalanceSponsorship()  : $this
Revokes sponsorship of a claimable balance.
revokeDataSponsorship()  : $this
Revokes sponsorship of a data entry.
revokeEd25519Signer()  : $this
Revokes sponsorship of an Ed25519 signer.
revokeOfferSponsorship()  : $this
Revokes sponsorship of an offer.
revokePreAuthTxSigner()  : $this
Revokes sponsorship of a pre-authorized transaction signer.
revokeSha256HashSigner()  : $this
Revokes sponsorship of a SHA256 hash signer.
revokeTrustlineSponsorship()  : $this
Revokes sponsorship of a trustline.
setMuxedSourceAccount()  : $this
Sets the muxed source account for this operation.
setSourceAccount()  : $this
Sets the source account for this operation.

Methods

revokeAccountSponsorship()

Revokes sponsorship of an account.

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

The account ID for which to revoke sponsorship

Tags
throws
RuntimeException

If attempting to revoke multiple entries per builder

Return values
$this

Returns the builder instance for method chaining

revokeClaimableBalanceSponsorship()

Revokes sponsorship of a claimable balance.

public revokeClaimableBalanceSponsorship(string $balanceId) : $this
Parameters
$balanceId : string

The claimable balance ID

Tags
throws
RuntimeException

If attempting to revoke multiple entries per builder

Return values
$this

Returns the builder instance for method chaining

revokeDataSponsorship()

Revokes sponsorship of a data entry.

public revokeDataSponsorship(string $accountId, string $dataName) : $this
Parameters
$accountId : string

The account ID holding the data entry

$dataName : string

The name of the data entry

Tags
throws
RuntimeException

If attempting to revoke multiple entries per builder

Return values
$this

Returns the builder instance for method chaining

revokeEd25519Signer()

Revokes sponsorship of an Ed25519 signer.

public revokeEd25519Signer(string $signerAccountId, string $ed25519AccountId) : $this
Parameters
$signerAccountId : string

The account ID that has the signer

$ed25519AccountId : string

The Ed25519 public key of the signer

Tags
throws
RuntimeException

If attempting to revoke multiple entries per builder

Return values
$this

Returns the builder instance for method chaining

revokeOfferSponsorship()

Revokes sponsorship of an offer.

public revokeOfferSponsorship(string $accountId, int $offerId) : $this
Parameters
$accountId : string

The account ID that created the offer

$offerId : int

The offer ID

Tags
throws
RuntimeException

If attempting to revoke multiple entries per builder

Return values
$this

Returns the builder instance for method chaining

revokePreAuthTxSigner()

Revokes sponsorship of a pre-authorized transaction signer.

public revokePreAuthTxSigner(string $signerAccountId, string $preAuthTx) : $this
Parameters
$signerAccountId : string

The account ID that has the signer

$preAuthTx : string

The pre-authorized transaction hash

Tags
throws
RuntimeException

If attempting to revoke multiple entries per builder

Return values
$this

Returns the builder instance for method chaining

revokeSha256HashSigner()

Revokes sponsorship of a SHA256 hash signer.

public revokeSha256HashSigner(string $signerAccountId, string $sha256Hash) : $this
Parameters
$signerAccountId : string

The account ID that has the signer

$sha256Hash : string

The SHA256 hash value

Tags
throws
RuntimeException

If attempting to revoke multiple entries per builder

Return values
$this

Returns the builder instance for method chaining

revokeTrustlineSponsorship()

Revokes sponsorship of a trustline.

public revokeTrustlineSponsorship(string $accountId, Asset $asset) : $this
Parameters
$accountId : string

The account ID holding the trustline

$asset : Asset

The asset for the trustline

Tags
throws
RuntimeException

If attempting to revoke multiple entries per builder

Return values
$this

Returns the builder instance for method chaining

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