stellar-sdk/com.soneso.stellar.sdk.smartaccount.oz

Package-level declarations

Types

data class AddPasskeySignerResult(val credentialId: String, val publicKey: ByteArray, val transactionResult: TransactionResult)

Result of the OZSignerManager.addNewPasskeySigner operation.

AddressLookupResponse

@Serializable

data class AddressLookupResponse(val signerAddress: String, val contracts: List<IndexedContractSummary>, val count: Int)

Response from looking up a signer address in the indexer.

AllowCredential

data class AllowCredential(val id: ByteArray, val transports: List<String>? = null)

A credential descriptor pairing a credential ID with optional transport hints.

AuthenticatePasskeyResult

data class AuthenticatePasskeyResult(val credentialId: String, val signature: WebAuthnSignature, val publicKey: ByteArray)

Result of standalone passkey authentication.

ConnectedWallet

data class ConnectedWallet(val address: String, val walletId: String, val walletName: String)

Information about an externally connected wallet.

ConnectWalletResult

sealed class ConnectWalletResult

Result of a wallet connection operation.

ContextRuleType

sealed class ContextRuleType

Type of context rule that determines which operations it applies to.

ContractDetailsResponse

@Serializable

data class ContractDetailsResponse(val contractId: String, val summary: IndexedContractSummary, val contextRules: List<IndexedContextRule>)

Response containing full details of a smart account contract.

CreateWalletResult

data class CreateWalletResult(val credentialId: String, val contractId: String, val publicKey: ByteArray, val signedTransactionXdr: String, val transactionHash: String? = null, val nickname: String? = null)

Result of a wallet creation operation.

CredentialDeploymentStatus

enum CredentialDeploymentStatus : Enum<CredentialDeploymentStatus>

The deployment status of a smart account credential.

CredentialLookupResponse

@Serializable

data class CredentialLookupResponse(val credentialId: String, val contracts: List<IndexedContractSummary>, val count: Int)

Response from looking up a credential ID in the indexer.

DeployPendingResult

data class DeployPendingResult(val contractId: String, val signedTransactionXdr: String, val transactionHash: String? = null)

Result of deploying a pending credential.

EventTypeCount

@Serializable

data class EventTypeCount(val eventType: String, val count: Long)

Count of events by type.

ExternalSignerInfo

data class ExternalSignerInfo(val address: String, val type: ExternalSignerType, val walletName: String? = null, val walletId: String? = null)

Information about a managed external signer.

ExternalSignerType

enum ExternalSignerType : Enum<ExternalSignerType>

The type of an external signer managed by OZExternalSignerManager.

ExternalWalletAdapter

interface ExternalWalletAdapter

Protocol for integrating external wallet adapters for multi-signer support.

HealthCheckResponse

@Serializable

data class HealthCheckResponse(val status: String)

Response from the health check endpoint.

IndexedContextRule

@Serializable

data class IndexedContextRule(val contextRuleId: Int, val signers: List<IndexedSigner>, val policies: List<IndexedPolicy>)

A context rule within a smart account contract.

IndexedContractSummary

@Serializable

data class IndexedContractSummary(val contractId: String, val contextRuleCount: Int, val externalSignerCount: Int, val delegatedSignerCount: Int, val nativeSignerCount: Int, val firstSeenLedger: Int, val lastSeenLedger: Int, val contextRuleIds: List<Int>)

Summary information about a smart account contract.

IndexedPolicy

@Serializable

data class IndexedPolicy(val policyAddress: String, val installParams: JsonElement? = null)

A policy attached to a context rule.

IndexedSigner

@Serializable

data class IndexedSigner(val signerType: String, val signerAddress: String? = null, val credentialId: String? = null)

A signer within a context rule.

IndexerStats

@Serializable

data class IndexerStats(val totalEvents: Long, val uniqueContracts: Long, val uniqueCredentials: Long, val firstLedger: Long, val lastLedger: Long, val eventTypes: List<EventTypeCount>)

Statistics about the indexer state.

IndexerStatsResponse

@Serializable

data class IndexerStatsResponse(val stats: IndexerStats)

Response from the indexer stats endpoint.

InMemoryStorageAdapter

class InMemoryStorageAdapter : StorageAdapter

In-memory storage adapter for credentials and sessions.

OZBuilders

object OZBuilders

Builder utilities for OpenZeppelin smart account context rules.

OZConstants

object OZConstants

Configuration defaults and contract limits for OpenZeppelin smart account operations.

OZContextRuleManager

class OZContextRuleManager

Manages context rules for OpenZeppelin Smart Accounts.

OZCredentialManager

class OZCredentialManager

Manages the lifecycle of smart account credentials.

OZExternalSignerManager

class OZExternalSignerManager(networkPassphrase: String, walletAdapter: ExternalWalletAdapter? = null, walletConnectionStorage: WalletConnectionStorage? = null)

Manager for external (non-passkey) signers for multi-signature smart account operations.

OZIndexerClient

class OZIndexerClient(indexerUrl: String, timeoutMs: Long = OZConstants.DEFAULT_INDEXER_TIMEOUT_MS, injectedClient: HttpClient? = null) : AutoCloseable

Client for interacting with the OpenZeppelin Smart Account indexer service.

OZMultiSignerManager

class OZMultiSignerManager

Manager for multi-signature smart account operations.

OZPolicyManager

class OZPolicyManager

Manager for policy operations on OpenZeppelin Smart Accounts.

OZRelayerClient

class OZRelayerClient(relayerUrl: String, timeoutMs: Long = OZConstants.DEFAULT_RELAYER_TIMEOUT_MS, injectedClient: HttpClient? = null) : AutoCloseable

Client for submitting transactions to an OpenZeppelin Smart Account relayer.

OZSignerManager

class OZSignerManager

Manager for smart account signer operations.

OZSmartAccountConfig

data class OZSmartAccountConfig(val rpcUrl: String, val networkPassphrase: String, val accountWasmHash: String, val webauthnVerifierAddress: String, val deployerKeypair: KeyPair? = null, val rpId: String? = null, val rpName: String = "Smart Account", val sessionExpiryMs: Long = OZConstants.DEFAULT_SESSION_EXPIRY_MS, val signatureExpirationLedgers: Int = Util.LEDGERS_PER_HOUR, val timeoutInSeconds: Int = OZConstants.DEFAULT_TIMEOUT_SECONDS, val relayerUrl: String? = null, val indexerUrl: String? = null, val webauthnProvider: WebAuthnProvider? = null, val storage: StorageAdapter = InMemoryStorageAdapter(), val externalWallet: ExternalWalletAdapter? = null, val maxContextRuleScanId: UInt)

Configuration for OpenZeppelin Smart Account operations.

OZSmartAccountKit

class OZSmartAccountKit

Main orchestrator for OpenZeppelin Smart Account operations on Stellar/Soroban.

OZTransactionOperations

class OZTransactionOperations

Transaction operations for OpenZeppelin Smart Accounts.

OZWalletOperations

class OZWalletOperations

Operations for creating and connecting smart account wallets.

ParsedContextRule

data class ParsedContextRule(val id: UInt, val contextType: ContextRuleType, val name: String, val signers: List<SmartAccountSigner>, val signerIds: List<UInt>, val policies: List<String>, val policyIds: List<UInt>, val validUntil: UInt?)

Parsed representation of a context rule from on-chain data.

PolicyInstallParams

sealed class PolicyInstallParams

Policy type definitions for smart account context rules.

RelayerErrorCodes

object RelayerErrorCodes

Known error codes returned by the relayer service.

RelayerResponse

data class RelayerResponse(val success: Boolean, val transactionId: String? = null, val hash: String? = null, val status: String? = null, val error: String? = null, val errorCode: String? = null, val details: JsonElement? = null)

Response from the relayer service.

ResolveContextRuleIds

typealias ResolveContextRuleIds = suspend (entry: SorobanAuthorizationEntryXdr, index: Int) -> List<UInt>

Callback for resolving context rule IDs per auth entry.

SelectedSigner

sealed class SelectedSigner

Specifies a signer to participate in a multi-signature operation.

SignAuthEntryOptions

data class SignAuthEntryOptions(val networkPassphrase: String? = null, val address: String? = null)

Options for signing an authorization entry with an external wallet.

SignAuthEntryResult

data class SignAuthEntryResult(val signedAuthEntry: String, val signerAddress: String? = null)

Result of signing an authorization preimage with an external wallet.

SmartAccountEvent

sealed class SmartAccountEvent

Events emitted by the Smart Account Kit during wallet lifecycle operations.

SmartAccountEventEmitter

class SmartAccountEventEmitter

Event emitter for Smart Account lifecycle events.

SmartAccountEventListener

fun interface SmartAccountEventListener

Listener interface for Smart Account events.

StorageAdapter

interface StorageAdapter

Protocol for persisting smart account credentials and sessions.

StoredCredential

data class StoredCredential(val credentialId: String, val publicKey: ByteArray, val contractId: String? = null, val deploymentStatus: CredentialDeploymentStatus = CredentialDeploymentStatus.PENDING, val deploymentError: String? = null, val createdAt: Long = currentTimeMillis(), val lastUsedAt: Long? = null, val nickname: String? = null, val isPrimary: Boolean = false, val transports: List<String>? = null, val deviceType: String? = null, val backedUp: Boolean? = null)

A stored smart account credential with deployment and usage metadata.

StoredCredentialUpdate

data class StoredCredentialUpdate(val deploymentStatus: CredentialDeploymentStatus? = null, val deploymentError: String? = null, val contractId: String? = null, val lastUsedAt: Long? = null, val nickname: String? = null, val isPrimary: Boolean? = null, val transports: List<String>? = null, val deviceType: String? = null, val backedUp: Boolean? = null)

Partial updates for a stored credential.

StoredSession

data class StoredSession(val credentialId: String, val contractId: String, val connectedAt: Long, val expiresAt: Long)

A stored user session for silent reconnection.

SyncResult

data class SyncResult(val deployed: Int, val pending: Int, val failed: Int)

Result of syncing all credentials with on-chain state.

TransactionResult

data class TransactionResult(val success: Boolean, val hash: String? = null, val ledger: UInt? = null, val error: String? = null)

Result of a transaction submission and polling operation.

WalletConnectionStorage

interface WalletConnectionStorage

Simple key-value storage interface for persisting external wallet connections.

WebAuthnAuthenticationResult

data class WebAuthnAuthenticationResult(val credentialId: ByteArray, val authenticatorData: ByteArray, val clientDataJSON: ByteArray, val signature: ByteArray)

WebAuthn authentication result from a passkey ceremony.

WebAuthnProvider

interface WebAuthnProvider

Platform-specific WebAuthn provider interface.

WebAuthnRegistrationResult

data class WebAuthnRegistrationResult(val credentialId: ByteArray, val publicKey: ByteArray, val attestationObject: ByteArray, val transports: List<String>? = null, val deviceType: String? = null, val backedUp: Boolean? = null)

WebAuthn registration result from a passkey creation ceremony.

Functions

applyUpdate

fun StoredCredential.applyUpdate(updates: StoredCredentialUpdate): StoredCredential

Applies the given updates to this credential, returning a new instance. Fields in updates that are null are left unchanged.