SorobanCredentials
in package
Credentials for Soroban authorization
This class represents credentials used in Soroban authorization entries. There are two types: source account credentials (no addressCredentials) or address-based credentials (with addressCredentials). Source account credentials use the transaction source account for authorization.
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- Creates new Soroban credentials.
- forAddress() : SorobanCredentials
- Creates address-based credentials.
- forAddressCredentials() : SorobanCredentials
- Creates credentials from existing address credentials.
- forSourceAccount() : SorobanCredentials
- Creates source account credentials.
- fromXdr() : SorobanCredentials
- Creates SorobanCredentials from its XDR representation.
- getAddressCredentials() : SorobanAddressCredentials|null
- Returns the address credentials if using address-based authorization.
- setAddressCredentials() : void
- Sets the address credentials.
- toXdr() : XdrSorobanCredentials
- Converts this object to its XDR representation.
Properties
$addressCredentials
public
SorobanAddressCredentials|null
$addressCredentials
= null
address-based credentials or null for source account credentials
Methods
__construct()
Creates new Soroban credentials.
public
__construct([SorobanAddressCredentials|null $addressCredentials = null ]) : mixed
Parameters
- $addressCredentials : SorobanAddressCredentials|null = null
-
address credentials or null for source account
forAddress()
Creates address-based credentials.
public
static forAddress(Address $address, int $nonce, int $signatureExpirationLedger, XdrSCVal $signature) : SorobanCredentials
Parameters
- $address : Address
-
the address to authorize
- $nonce : int
-
unique nonce for replay protection
- $signatureExpirationLedger : int
-
ledger after which signatures expire
- $signature : XdrSCVal
-
the signature data
Return values
SorobanCredentials —credentials using address-based authorization
forAddressCredentials()
Creates credentials from existing address credentials.
public
static forAddressCredentials(SorobanAddressCredentials $addressCredentials) : SorobanCredentials
Parameters
- $addressCredentials : SorobanAddressCredentials
-
the address credentials to use
Return values
SorobanCredentials —credentials using the provided address credentials
forSourceAccount()
Creates source account credentials.
public
static forSourceAccount() : SorobanCredentials
Source account credentials use the transaction source account for authorization without requiring additional signatures.
Return values
SorobanCredentials —credentials using the source account
fromXdr()
Creates SorobanCredentials from its XDR representation.
public
static fromXdr(XdrSorobanCredentials $xdr) : SorobanCredentials
Parameters
- $xdr : XdrSorobanCredentials
-
the XDR object to decode
Return values
SorobanCredentials —the decoded credentials
getAddressCredentials()
Returns the address credentials if using address-based authorization.
public
getAddressCredentials() : SorobanAddressCredentials|null
Return values
SorobanAddressCredentials|null —the address credentials or null for source account
setAddressCredentials()
Sets the address credentials.
public
setAddressCredentials(SorobanAddressCredentials|null $addressCredentials) : void
Parameters
- $addressCredentials : SorobanAddressCredentials|null
-
the address credentials or null for source account
toXdr()
Converts this object to its XDR representation.
public
toXdr() : XdrSorobanCredentials
Return values
XdrSorobanCredentials —the XDR encoded credentials