String

extension String
extension String: XDRCodable

Extension providing base32 encoding and decoding for String.

Supports both standard base32 (RFC 4648) and base32hex variants.

  • Decodes a base32-encoded string to data.

    Uses the standard base32 alphabet (A-Z, 2-7).

    Example:

    let encoded = "JBSWY3DPEBLW64TMMQ======"
if let data = encoded.base32DecodedData {
    // Use decoded data
}

    Declaration

    Swift

    public var base32DecodedData: Data? { get }
    Show on GitHub

  • Encodes the string to base32 format.

    Uses the standard base32 alphabet (A-Z, 2-7).

    Example:

    let text = "Hello"
let encoded = text.base32EncodedString

    Declaration

    Swift

    public var base32EncodedString: String { get }
    Show on GitHub

  • Decodes a base32-encoded string to a string.

    Declaration

    Swift

    public func base32DecodedString(_ encoding: String.Encoding = .utf8) -> String?

    Parameters

    encoding

    Text encoding to use (defaults to UTF-8)

    Return Value

    Decoded string, or nil if decoding fails

    Show on GitHub

  • Decodes a base32hex-encoded string to data.

    Uses the extended hex alphabet (0-9, A-V).

    Declaration

    Swift

    public var base32HexDecodedData: Data? { get }
    Show on GitHub

  • Encodes the string to base32hex format.

    Uses the extended hex alphabet (0-9, A-V).

    Declaration

    Swift

    public var base32HexEncodedString: String { get }
    Show on GitHub

  • Decodes a base32hex-encoded string to a string.

    Declaration

    Swift

    public func base32HexDecodedString(_ encoding: String.Encoding = .utf8) -> String?

    Parameters

    encoding

    Text encoding to use (defaults to UTF-8)

    Return Value

    Decoded string, or nil if decoding fails

    Show on GitHub

  • Computes the SHA-256 hash of the string.

    Declaration

    Swift

    var sha256Hash: Data { get }
    Show on GitHub

  • Encodes the string to base64 format.

    Converts the string to UTF-8 data and then encodes it as a base64 string.

    Example:

    let text = "Hello, Stellar!"
let encoded = text.base64Encoded()

    Declaration

    Swift

    public func base64Encoded() -> String?

    Return Value

    Base64-encoded string, or nil if encoding fails

    Show on GitHub

  • Decodes a base64-encoded string.

    Decodes the base64 string to data and then converts it to a UTF-8 string.

    Example:

    let encoded = "SGVsbG8sIFN0ZWxsYXIh"
let decoded = encoded.base64Decoded() // "Hello, Stellar!"

    Declaration

    Swift

    public func base64Decoded() -> String?

    Return Value

    Decoded string, or nil if decoding fails

    Show on GitHub

  • Undocumented

    Declaration

    Swift

    var urlPathEncoded: String { get }
    Show on GitHub

  • Undocumented

    Declaration

    Swift

    var urlQueryValueEncoded: String { get }
    Show on GitHub

  • URL-encodes the string for use in query parameters.

    Encodes characters that are not allowed in URL query parameters and keys.

    Example:

    let param = "Hello World & More"
let encoded = param.urlEncoded // "Hello%20World%20%26%20More"

    Declaration

    Swift

    var urlEncoded: String? { get }
    Show on GitHub

  • URL-decodes the string by removing percent encoding.

    Example:

    let encoded = "Hello%20World"
let decoded = encoded.urlDecoded // "Hello World"

    Declaration

    Swift

    var urlDecoded: String? { get }
    Show on GitHub

  • Validates if the string is a fully qualified domain name (FQDN).

    Declaration

    Swift

    var isFullyQualifiedDomainName: Bool { get }

    Return Value

    True if the string matches FQDN format, false otherwise

    Show on GitHub

  • Extended encoding types beyond standard String.Encoding.

    See more

    Declaration

    Swift

    enum ExtendedEncoding
    Show on GitHub

  • Converts the string to data using extended encoding types.

    For hexadecimal encoding, converts a hex string (with optional “0x” prefix) to binary data.

    Example:

    let hex = "0x1234abcd"
let data = hex.data(using: .hexadecimal)

    Declaration

    Swift

    func data(using encoding: ExtendedEncoding) -> Data?

    Parameters

    encoding

    Extended encoding type to use

    Return Value

    Converted data, or nil if conversion fails

    Show on GitHub

  • Reads the hexadecimal spelling of a 32 byte id.

    The string must hold exactly the 64 hexadecimal characters those 32 bytes are wide, with no “0x” prefix. A string of any other width spells an id of another size, and a character outside the hexadecimal alphabet spells no byte at all; both are refused, because a 32 byte id derived from them would name a ledger entry the caller never wrote.

    Throws

    StellarSDKError.invalidArgument if the string is not exactly 64 hexadecimal characters

    Declaration

    Swift

    func wrappedData32FromHex(idKind: String) throws -> WrappedData32

    Parameters

    idKind

    the name the id goes by in the error message, e.g. “contract id”

    Return Value

    the 32 bytes the string spells

    Show on GitHub

  • Decodes strkey ed25519 public key (“G…”) to raw data

    Declaration

    Swift

    public func decodeEd25519PublicKey() throws -> Data
    Show on GitHub

  • Returns true if the string represents a valid strkey ed25519 public key. Must start with “G”

    Declaration

    Swift

    public func isValidEd25519PublicKey() -> Bool
    Show on GitHub

  • Decodes strkey ed25519 seed (“S…”) to raw data.

    Declaration

    Swift

    public func decodeEd25519SecretSeed() throws -> Data
    Show on GitHub

  • Returns true if the string represents a valid strkey ed25519 seed. Must start with “S”

    Declaration

    Swift

    public func isValidEd25519SecretSeed() -> Bool
    Show on GitHub

  • Decodes strkey med25519 public key (“M…”) to raw data.

    Declaration

    Swift

    public func decodeMed25519PublicKey() throws -> Data
    Show on GitHub

  • Returns true if the string represents a valid strkey med25519 public key. Must start with “M”

    Declaration

    Swift

    public func isValidMed25519PublicKey() -> Bool
    Show on GitHub

  • Decodes strkey PreAuthTx (“T…”) to raw data.

    Declaration

    Swift

    public func decodePreAuthTx() throws -> Data
    Show on GitHub

  • Returns true if the string represents a valid strkey PreAuthTx . Must start with “T”

    Declaration

    Swift

    public func isValidPreAuthTx() -> Bool
    Show on GitHub

  • Decodes strkey sha256 hash (“X…”) to raw data.

    Declaration

    Swift

    public func decodeSha256Hash() throws -> Data
    Show on GitHub

  • Returns true if the string represents a valid strkey sha256 hash . Must start with “X”

    Declaration

    Swift

    public func isValidSha256Hash() -> Bool
    Show on GitHub

  • Decodes strkey signed payload (“P…”) to Ed25519SignedPayload.

    Declaration

    Swift

    public func decodeSignedPayload() throws -> Ed25519SignedPayload
    Show on GitHub

  • Returns true if the string represents a valid strkey signed payload . Must start with “P”

    Declaration

    Swift

    public func isValidSignedPayload() -> Bool
    Show on GitHub

  • Decodes strkey contract id (“C…”) to raw data.

    Declaration

    Swift

    public func decodeContractId() throws -> Data
    Show on GitHub

  • Decodes strkey contract id (“C…”) to raw data and then returns the hex encoded string representation of the raw data.

    Declaration

    Swift

    public func decodeContractIdToHex() throws -> String
    Show on GitHub

  • Returns true if the string represents a valid strkey contract id . Must start with “C”

    Declaration

    Swift

    public func isValidContractId() -> Bool
    Show on GitHub

  • Decodes strkey claimable balance id (“B…”) to raw data.

    Declaration

    Swift

    public func decodeClaimableBalanceId() throws -> Data
    Show on GitHub

  • Decodes strkey claimable balance id (“B…”) to raw data and then returns the hex encoded string representation of the raw data.

    Declaration

    Swift

    public func decodeClaimableBalanceIdToHex() throws -> String
    Show on GitHub

  • Returns true if the string represents a valid strkey claimable balance id. Must start with “B”

    Declaration

    Swift

    public func isValidClaimableBalanceId() -> Bool
    Show on GitHub

  • Decodes strkey liquidity pool id (“L…”) to raw data.

    Declaration

    Swift

    public func decodeLiquidityPoolId() throws -> Data
    Show on GitHub

  • Decodes strkey liquidity pool id (“L…”) to raw data and then returns the hex encoded string representation of the raw data.

    Declaration

    Swift

    public func decodeLiquidityPoolIdToHex() throws -> String
    Show on GitHub

  • Returns true if the string represents a valid strkey liquidity pool id. Must start with “L”

    Declaration

    Swift

    public func isValidLiquidityPoolId() -> Bool
    Show on GitHub

  • Decodes strkey muxed account id (med25519 public key - “M…”) to MuxedAccountXDR.

    Declaration

    Swift

    public func decodeMuxedAccount() throws -> MuxedAccountXDR
    Show on GitHub

  • Encodes a contract id from its hex representation into its strkey representation (“C…”).

    Throws

    StellarSDKError.invalidArgument if the string is not valid hexadecimal, or if it does not hold the 32 bytes a contract id is wide

    Declaration

    Swift

    public func encodeContractIdHex() throws -> String

    Return Value

    StrKey encoded contract id

    Show on GitHub

  • Encodes a claimable balance id from its hex representation into its strkey representation (“B…”).

    Throws

    StellarSDKError.invalidArgument if the string is not valid hexadecimal, or if it holds neither the 32 bytes an id is wide, nor the 33 bytes of a body opening with the claimable balance type discriminant, nor the 36 bytes of the XDR encoding opening with the four byte union discriminant, the shape Horizon reports

    Declaration

    Swift

    public func encodeClaimableBalanceIdHex() throws -> String

    Return Value

    StrKey encoded claimable balance id

    Show on GitHub

  • Encodes a liquidity pool id from its hex representation into its strkey representation (“L…”).

    Throws

    StellarSDKError.invalidArgument if the string is not valid hexadecimal, or if it does not hold the 32 bytes a liquidity pool id is wide

    Declaration

    Swift

    public func encodeLiquidityPoolIdHex() throws -> String

    Return Value

    StrKey encoded liquidity pool id

    Show on GitHub

  • Checks if the string is a valid hexadecimal representation of data.

    Declaration

    Swift

    public func isHexString() -> Bool

    Return Value

    True if the string is valid hexadecimal, false otherwise

    Show on GitHub

  • Encodes the string to XDR format.

    Converts to UTF-8 bytes and encodes as a variable-length array.

    Declaration

    Swift

    public func xdrEncode(to encoder: XDREncoder) throws
    Show on GitHub

  • Undocumented

    Declaration

    Swift

    public init(fromBinary decoder: XDRDecoder) throws
    Show on GitHub