RecoveryService

public final class RecoveryService : @unchecked Sendable

Implements SEP-0030 - Account Recovery: Multi-Party Recovery of Stellar Accounts.

This class provides account recovery functionality allowing users to regain access to their Stellar accounts through registered identities. Multiple recovery methods can be configured as a safety net if primary authentication is lost.

Typical Usage

let service = RecoveryService(serviceAddress: "https://recovery.example.com")

// Register account with recovery identities
let request = Sep30Request()
request.identities = [
    Sep30Identity(role: "owner", authMethods: [...])
]
let result = await service.registerAccount(
    address: accountId,
    request: request,
    jwt: jwtToken
)

// Sign transaction for recovery
let signResult = await service.signTransaction(
    address: accountId,
    signingAddress: signerAddress,
    transaction: transactionXdr,
    jwt: jwtToken
)

Declaration

Swift

public init(serviceAddress: String)

Parameters


                                serviceAddress

The URL of the SEP-30 recovery server (e.g., “https://recovery.example.com”)

Show on GitHub


                    
                    
                    registerAccount(address:request:jwt:)

Asynchronous

Registers an account with the recovery service.

See: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0030.md#post-accountsaddress

Declaration

Swift

public func registerAccount(address: String, request: Sep30Request, jwt: String) async -> Sep30AccountResponseEnum

Parameters

`address`	The Stellar account address (G…) to register
`request`	Sep30Request containing the identities and authentication methods for recovery
`jwt`	JWT token obtained from SEP-10 authentication

Return Value

Sep30AccountResponseEnum with account details, or an error

Show on GitHub


                    
                    
                    updateIdentitiesForAccount(address:request:jwt:)

Asynchronous

Updates the identities for the account.

The identities should be entirely replaced with the identities provided in the request, and not merged. Either owner or other or both should be set. If one is currently set and the request does not include it, it is removed.

See: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0030.md#put-accountsaddress

Declaration

Swift

public func updateIdentitiesForAccount(address: String, request: Sep30Request, jwt: String) async -> Sep30AccountResponseEnum

Parameters

`address`	The Stellar account address (G…) to update
`request`	Sep30Request containing the new identities to replace existing ones
`jwt`	JWT token obtained from SEP-10 authentication

Return Value

Sep30AccountResponseEnum with updated account details, or an error

Show on GitHub


                    
                    
                    signTransaction(address:signingAddress:transaction:jwt:)

Asynchronous

Signs a transaction using the recovery service’s signer.

See: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0030.md#post-accountsaddresssignsigning-address

Declaration

Swift

public func signTransaction(address: String, signingAddress: String, transaction: String, jwt: String) async -> Sep30SignatureResponseEnum

Parameters

`address`	The Stellar account address (G…) that the transaction is for
`signingAddress`	The address of the signer on the recovery service that should sign
`transaction`	The transaction envelope XDR (base64 encoded) to sign
`jwt`	JWT token obtained from SEP-10 authentication

Return Value

Sep30SignatureResponseEnum with the signature and network passphrase, or an error

Show on GitHub


                    
                    
                    accountDetails(address:jwt:)

Asynchronous

Returns the registered account’s details.

See: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0030.md#get-accountsaddress

Declaration

Swift

public func accountDetails(address: String, jwt: String) async -> Sep30AccountResponseEnum

Parameters

`address`	The Stellar account address (G…) to retrieve
`jwt`	JWT token obtained from SEP-10 authentication

Return Value

Sep30AccountResponseEnum with account details including identities and signers, or an error

Show on GitHub


                    
                    
                    deleteAccount(address:jwt:)

Asynchronous

Deletes the record for an account. This should be irrecoverable.

See: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0030.md#delete-accountsaddress

Declaration

Swift

public func deleteAccount(address: String, jwt: String) async -> Sep30AccountResponseEnum

Parameters

`address`	The Stellar account address (G…) to delete
`jwt`	JWT token obtained from SEP-10 authentication

Return Value

Sep30AccountResponseEnum with the deleted account details, or an error

Show on GitHub


                    
                    
                    accounts(jwt:after:)

Asynchronous

Returns a list of accounts that the JWT allows access to.

See: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0030.md#get-accounts

Declaration

Swift

public func accounts(jwt: String, after: String? = nil) async -> Sep30AccountsResponseEnum

Parameters

`jwt`	JWT token obtained from SEP-10 authentication
`after`	Optional account address for pagination (returns accounts after this address)

Return Value

Sep30AccountsResponseEnum with list of accessible accounts, or an error

Show on GitHub