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

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.

This configuration data class defines all parameters required to interact with OpenZeppelin smart accounts on Stellar/Soroban. It includes network connectivity settings, contract addresses, and operational parameters.

Example usage:

val config = OZSmartAccountConfig(
    rpcUrl = "https://soroban-testnet.stellar.org",
    networkPassphrase = "Test SDF Network ; September 2015",
    accountWasmHash = "abc123...",
    webauthnVerifierAddress = "CBCD1234..."
)

// With custom settings using builder
val customConfig = OZSmartAccountConfig.builder(
    rpcUrl = "https://soroban-testnet.stellar.org",
    networkPassphrase = "Test SDF Network ; September 2015",
    accountWasmHash = "abc123...",
    webauthnVerifierAddress = "CBCD1234..."
)
    .rpName("My Custom Wallet")
    .sessionExpiryMs(86400000L) // 1 day
    .relayerUrl("https://relayer.example.com")
    .storage(myPersistentStorage)
    .externalWallet(freighterAdapter)
    .build()

Field	Required	Default
rpcUrl	Yes	-
networkPassphrase	Yes	-
accountWasmHash	Yes	-
webauthnVerifierAddress	Yes	-
deployerKeypair	No	Deterministic deployer
rpId	No	Browser default
rpName	No	"Smart Account"
sessionExpiryMs	No	604800000 (7 days)
signatureExpirationLedgers	No	720 (~1 hour)
timeoutInSeconds	No	30
relayerUrl	No	null
indexerUrl	No	null
webauthnProvider	No	null
storage	No	InMemoryStorageAdapter
externalWallet	No	null
maxContextRuleScanId	No	50

Throws

ConfigurationException

if required parameters are blank or invalid (e.g., accountWasmHash is not a 64-character hex string, or webauthnVerifierAddress is not a valid C-address).

Constructors

OZSmartAccountConfig

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