OZSmartAccountAuthPayloadCodec

public enum OZSmartAccountAuthPayloadCodec

Codec for reading and writing OZSmartAccountAuthPayload to/from SCValXDR.

Handles the AuthPayload format accepted by the OpenZeppelin Smart Account contract, which is a named struct (Map-based) with fields context_rule_ids and signers. The outer struct map keys are inserted in alphabetical order (matching the Soroban Rust #[contracttype] derive convention); the inner dynamic-Map signer entries are sorted by lowercase-hex of their XDR-encoded keys so the encoding is deterministic.

Show on GitHub


                    
                    
                    read(_:)

Reads an OZSmartAccountAuthPayload from its SCValXDR representation.

Accepts SCValXDR.void (returns an empty payload) or SCValXDR.map (the full payload). Throws when the input is not Void or Map, or when a signer entry has a value that is not a Bytes ScVal.

Throws

SmartAccountTransactionException.SigningFailed when the input shape is wrong.

Declaration

Swift

public static func read(_ signatureScVal: SCValXDR) throws -> OZSmartAccountAuthPayload

Parameters


                                signatureScVal

The ScVal stored in the authorization entry credentials signature field.

Return Value

The decoded OZSmartAccountAuthPayload.

Show on GitHub


                    
                    
                    write(_:)

Writes an OZSmartAccountAuthPayload to its SCValXDR representation.

Builds the outer map with exactly two entries in alphabetical insertion order (context_rule_ids, then signers), matching the Soroban Rust #[contracttype] derive ordering for the contract’s AuthPayload struct. Inner signer entries are sorted by lowercase-hex of their XDR-encoded keys so the encoding is deterministic and the host-side dynamic-Map ordering check is satisfied.

Throws

SmartAccountTransactionException.SigningFailed when XDR encoding of a signer key fails.

Declaration

Swift

public static func write(_ payload: OZSmartAccountAuthPayload) throws -> SCValXDR

Parameters


                                payload

Payload to encode.

Return Value

The SCValXDR representation of the payload.

Show on GitHub


                    
                    
                    upsertSigner(payload:signer:signatureBytes:)

Upserts a signer entry in the payload.

If a signer matching signer already exists (compared by signer type and field values), the old entry is removed before the new one is appended. The payload’s signers list is mutated in place.

Declaration

Swift

public static func upsertSigner(
    payload: OZSmartAccountAuthPayload,
    signer: any OZSmartAccountSigner,
    signatureBytes: Data
)

Parameters

`payload`	Payload to update.
`signer`	Signer to add or replace.
`signatureBytes`	Signature bytes from `OZSmartAccountSignature.toAuthPayloadBytes()`.

Show on GitHub


                    
                    
                    signerFromScVal(_:)

Parses an OZSmartAccountSigner from its SCValXDR representation.

Supported formats:

Vec([Symbol("Delegated"), Address(...)]) returns an OZDelegatedSigner.
Vec([Symbol("External"), Address(...), Bytes(...)]) returns an OZExternalSigner.

Throws

SmartAccountTransactionException.SigningFailed when the shape is unrecognised.

Declaration

Swift

public static func signerFromScVal(_ scVal: SCValXDR) throws -> any OZSmartAccountSigner

Parameters


                                scVal

The ScVal to parse.

Return Value

The parsed signer.

Show on GitHub