OZStorageAdapter

public protocol OZStorageAdapter : AnyObject, Sendable

Protocol for persisting smart account credentials and sessions.

Storage adapters provide a pluggable persistence layer for credentials and sessions. Implementations must be thread-safe and support concurrent access.

The default implementation is OZInMemoryStorageAdapter, which stores data in memory only. Platform-specific implementations can provide persistent storage.

Show on GitHub


                    
                    
                    save(credential:)

Asynchronous

Saves a credential to storage using upsert semantics.

If a credential with the same ID already exists, it is overwritten.

Throws

SmartAccountStorageException.WriteFailed if saving fails.

Declaration

Swift

func save(credential: OZStoredCredential) async throws

Parameters


                                credential

The credential to save.

Show on GitHub


                    
                    
                    get(credentialId:)

Asynchronous

Retrieves a credential by its ID.

Throws

SmartAccountStorageException.ReadFailed if reading fails.

Declaration

Swift

func get(credentialId: String) async throws -> OZStoredCredential?

Parameters


                                credentialId

The credential ID.

Return Value

The credential, or nil if not found.

Show on GitHub


                    
                    
                    getByContract(contractId:)

Asynchronous

Retrieves all credentials associated with a contract address.

Throws

SmartAccountStorageException.ReadFailed if reading fails.

Declaration

Swift

func getByContract(contractId: String) async throws -> [OZStoredCredential]

Parameters


                                contractId

The contract address.

Return Value

List of credentials (empty if none found).

Show on GitHub

getAll() Asynchronous
Retrieves all stored credentials.

Throws
SmartAccountStorageException.ReadFailed if reading fails.
Declaration
Swift

func getAll() async throws -> [OZStoredCredential]
Return Value

List of all credentials.

Show on GitHub


                    
                    
                    delete(credentialId:)

Asynchronous

Deletes a credential by its ID. Does nothing if the credential does not exist.

Throws

SmartAccountStorageException.WriteFailed if deletion fails.

Declaration

Swift

func delete(credentialId: String) async throws

Parameters


                                credentialId

The credential ID to delete.

Show on GitHub


                    
                    
                    update(credentialId:updates:)

Asynchronous

Updates a credential with partial changes. Only non-nil fields in the update are applied.

Throws

SmartAccountCredentialException.NotFound if the credential is not found; SmartAccountStorageException.WriteFailed if updating fails.

Declaration

Swift

func update(credentialId: String, updates: OZStoredCredentialUpdate) async throws

Parameters

`credentialId`	The credential ID to update.
`updates`	The partial updates to apply.

Show on GitHub

clear() Asynchronous
Clears all credentials AND the stored session from storage. Equivalent to a hard reset of the adapter’s contents.

Throws
SmartAccountStorageException.WriteFailed if clearing fails.
Declaration
Swift

func clear() async throws
Show on GitHub


                    
                    
                    saveSession(_:)

Asynchronous

Saves a session to storage. Overwrites any previously stored session.

Throws

SmartAccountStorageException.WriteFailed if saving fails.

Declaration

Swift

func saveSession(_ session: OZStoredSession) async throws

Parameters


                                session

The session to save.

Show on GitHub

getSession() Asynchronous
Retrieves the current session, returning nil when no session exists or when the stored session has expired. Expired sessions are auto-cleared on read.

Throws
SmartAccountStorageException.ReadFailed if reading fails.
Declaration
Swift

func getSession() async throws -> OZStoredSession?
Return Value

The session, or nil if no session exists or the session is expired.

Show on GitHub
clearSession() Asynchronous
Clears the current session.

Throws
SmartAccountStorageException.WriteFailed if clearing fails.
Declaration
Swift

func clearSession() async throws
Show on GitHub