Stellar PHP SDK API Documentation

URISchemeError extends ErrorException

Exception thrown when SEP-7 URI validation or processing fails.

This exception extends ErrorException and uses error codes to indicate specific validation failures during SEP-7 URI processing. Each error code corresponds to a specific step in the URI validation workflow.

Error codes:

  • 0 (invalidSignature): Cryptographic signature verification failed
  • 1 (invalidOriginDomain): origin_domain is not a valid FQDN
  • 2 (missingOriginDomain): origin_domain parameter not present in URI
  • 3 (missingSignature): signature parameter not present in URI
  • 4 (tomlNotFoundOrInvalid): stellar.toml file not found or malformed
  • 5 (tomlSignatureMissing): URI_REQUEST_SIGNING_KEY not in stellar.toml

Security Note: These error codes help identify potential security issues or attacks. Always check error codes when handling URISchemeError exceptions.

Table of Contents

Constants

invalidOriginDomain  = 1
Origin domain is not a valid fully qualified domain name (code 1)
invalidSignature  = 0
Cryptographic signature verification failed (code 0)
missingOriginDomain  = 2
Required origin_domain parameter missing from URI (code 2)
missingSignature  = 3
Required signature parameter missing from URI (code 3)
tomlNotFoundOrInvalid  = 4
stellar.toml file not found at origin domain or contains invalid TOML (code 4)
tomlSignatureMissing  = 5
URI_REQUEST_SIGNING_KEY not present in stellar.toml (code 5)

Methods

toString()  : string
Returns human-readable error message for this exception.

Constants

invalidOriginDomain

Origin domain is not a valid fully qualified domain name (code 1)

public mixed invalidOriginDomain = 1

invalidSignature

Cryptographic signature verification failed (code 0)

public mixed invalidSignature = 0

missingOriginDomain

Required origin_domain parameter missing from URI (code 2)

public mixed missingOriginDomain = 2

missingSignature

Required signature parameter missing from URI (code 3)

public mixed missingSignature = 3

tomlNotFoundOrInvalid

stellar.toml file not found at origin domain or contains invalid TOML (code 4)

public mixed tomlNotFoundOrInvalid = 4

tomlSignatureMissing

URI_REQUEST_SIGNING_KEY not present in stellar.toml (code 5)

public mixed tomlSignatureMissing = 5

Methods

toString()

Returns human-readable error message for this exception.

public toString() : string

Converts the error code into a descriptive error message string.

Return values
string

Error message with "URISchemeError: " prefix


        
On this page

Search results