Make SafeProvider.init options an object

packages/protocol-kit/src/Safe.ts

@@ -124,15 +124,13 @@ class Safe {
  async #initializeProtocolKit(config: SafeConfig) {
  const { provider, signer, isL1SafeSingleton, contractNetworks, predictedSafe } = config
 
- this.#safeProvider = await SafeProvider.init(
+ this.#safeProvider = await SafeProvider.init({
  provider,
  signer,
- DEFAULT_SAFE_VERSION,
+ safeVersion: DEFAULT_SAFE_VERSION,
  contractNetworks,
- undefined,
- undefined,
- predictedSafe?.safeDeploymentConfig?.deploymentType
- )
+ deploymentType: predictedSafe?.safeDeploymentConfig?.deploymentType
+ })
 
  if (isSafeConfigWithPredictedSafe(config)) {
  this.#predictedSafe = config.predictedSafe
@@ -158,15 +156,13 @@ class Safe {
  }
 
  const safeVersion = await this.getContractVersion()
- this.#safeProvider = await SafeProvider.init(
+ this.#safeProvider = await SafeProvider.init({
  provider,
  signer,
  safeVersion,
  contractNetworks,
- undefined,
- undefined,
- this.#safeProvider.deploymentType
- )
+ deploymentType: this.#safeProvider.deploymentType
+ })
 
  this.#ownerManager = new OwnerManager(this.#safeProvider, this.#contractManager.safeContract)
  this.#moduleManager = new ModuleManager(this.#safeProvider, this.#contractManager.safeContract)
@@ -180,15 +176,15 @@ class Safe {
  if (isPasskeySigner) {
  const safeAddress = await this.getAddress()
  const owners = await this.getOwners()
- this.#safeProvider = await SafeProvider.init(
+ this.#safeProvider = await SafeProvider.init({
  provider,
  signer,
  safeVersion,
  contractNetworks,
  safeAddress,
  owners,
- this.#safeProvider.deploymentType
- )
+ deploymentType: this.#safeProvider.deploymentType
+ })
  }
  }
 

packages/protocol-kit/src/SafeFactory.ts

@@ -62,7 +62,12 @@ class SafeFactory {
  }: SafeFactoryInitConfig) {
  this.#provider = provider
  this.#signer = signer
- this.#safeProvider = await SafeProvider.init(provider, signer, safeVersion, contractNetworks)
+ this.#safeProvider = await SafeProvider.init({
+ provider,
+ signer,
+ safeVersion,
+ contractNetworks
+ })
  this.#safeVersion = safeVersion
  this.#isL1SafeSingleton = isL1SafeSingleton
  this.#contractNetworks = contractNetworks

packages/protocol-kit/src/SafeProvider.ts

@@ -13,8 +13,7 @@ import {
  EIP712TypedDataMessage,
  EIP712TypedDataTx,
  Eip3770Address,
- SafeEIP712Args,
- SafeVersion
+ SafeEIP712Args
 } from '@safe-global/types-kit'
 import {
  getCompatibilityFallbackHandlerContractInstance,
@@ -32,14 +31,13 @@ import {
  SafeProviderTransaction,
  GetContractProps,
  SafeProviderConfig,
+ SafeProviderInitOptions,
  ExternalClient,
  ExternalSigner,
  Eip1193Provider,
  HttpTransport,
  SocketTransport,
  SafeSigner,
- SafeConfig,
- ContractNetworksConfig,
  PasskeyArgType,
  PasskeyClient,
  DeploymentType
@@ -114,22 +112,26 @@ class SafeProvider {
 
  this.provider = provider
  this.signer = signer
- this.deploymentType = deploymentType
+ this.#deploymentType = deploymentType
+ }
+
+ get deploymentType(): DeploymentType | undefined {
+ return this.#deploymentType
  }
 
  getExternalProvider(): ExternalClient {
  return this.#externalProvider
  }
 
- static async init(
- provider: SafeConfig['provider'],
- signer?: SafeConfig['signer'],
- safeVersion: SafeVersion = DEFAULT_SAFE_VERSION,
- contractNetworks?: ContractNetworksConfig,
- safeAddress?: string,
- owners?: string[],
- deploymentType?: DeploymentType
- ): Promise<SafeProvider> {
+ static async init({
+ provider,
+ signer,
+ safeVersion = DEFAULT_SAFE_VERSION,
+ contractNetworks,
+ safeAddress,
+ owners,
+ deploymentType
+ }: SafeProviderInitOptions): Promise<SafeProvider> {
  const isPasskeySigner = signer && typeof signer !== 'string'
 
  if (isPasskeySigner) {

packages/protocol-kit/src/types/safeProvider.ts

@@ -10,6 +10,8 @@ import {
  WalletActions,
  Hex
 } from 'viem'
+import { SafeVersion } from '@safe-global/types-kit'
+import { SafeConfig, DeploymentType, ContractNetworksConfig } from '@safe-global/protocol-kit/types'
 
 export type RequestArguments = {
  readonly method: string
@@ -56,6 +58,16 @@ export type SafeProviderConfig = {
  signer?: HexAddress | PrivateKey | PasskeyArgType | PasskeyClient
 }
 
+export type SafeProviderInitOptions = {
+ provider: SafeConfig['provider']
+ signer?: SafeConfig['signer']
+ safeVersion?: SafeVersion
+ contractNetworks?: ContractNetworksConfig
+ safeAddress?: string
+ owners?: string[]
+ deploymentType?: DeploymentType
+}
+
 export type SafeProviderTransaction = {
  to: string
  from: string

packages/protocol-kit/src/utils/passkeys/createPasskeyDeploymentTransaction.ts

@@ -19,15 +19,15 @@ async function createPasskeyDeploymentTransaction(
  const safeAddress = await safe.getAddress()
  const owners = await safe.getOwners()
 
- const safePasskeyProvider = await SafeProvider.init(
- safe.getSafeProvider().provider,
- passkey,
+ const safePasskeyProvider = await SafeProvider.init({
+ provider: safe.getSafeProvider().provider,
+ signer: passkey,
  safeVersion,
- safe.getContractManager().contractNetworks,
+ contractNetworks: safe.getContractManager().contractNetworks,
  safeAddress,
  owners,
- safe.getSafeProvider().deploymentType
- )
+ deploymentType: safe.getSafeProvider().deploymentType
+ })
 
  const passkeySigner = (await safePasskeyProvider.getExternalSigner()) as PasskeyClient
  const passkeyAddress = passkeySigner!.account.address

packages/protocol-kit/src/utils/passkeys/getPasskeyOwnerAddress.ts

@@ -14,14 +14,14 @@ async function getPasskeyOwnerAddress(safe: Safe, passkey: PasskeyArgType): Prom
  const safeAddress = await safe.getAddress()
  const owners = await safe.getOwners()
 
- const safePasskeyProvider = await SafeProvider.init(
- safe.getSafeProvider().provider,
- passkey,
+ const safePasskeyProvider = await SafeProvider.init({
+ provider: safe.getSafeProvider().provider,
+ signer: passkey,
  safeVersion,
- safe.getContractManager().contractNetworks,
+ contractNetworks: safe.getContractManager().contractNetworks,
  safeAddress,
  owners
- )
+ })
 
  const passkeySigner = await safePasskeyProvider.getExternalSigner()
 

packages/protocol-kit/tests/e2e/passkey.test.ts

@@ -55,7 +55,7 @@ describe('Passkey', () => {
  const passkey2 = { ...(await createMockPasskey('brucelee')), customVerifierAddress }
 
  const provider = getEip1193Provider()
- const safeProvider = await SafeProvider.init(provider)
+ const safeProvider = await SafeProvider.init({ provider })
  const customContracts = contractNetworks?.[chainId.toString()]
 
  const safeWebAuthnSignerFactoryContract = await getSafeWebAuthnSignerFactoryContract({
@@ -70,8 +70,18 @@ describe('Passkey', () => {
  customContracts
  })
 
- const safeProvider1 = await SafeProvider.init(provider, passkey1, '1.4.1', contractNetworks)
- const safeProvider2 = await SafeProvider.init(provider, passkey2, '1.4.1', contractNetworks)
+ const safeProvider1 = await SafeProvider.init({
+ provider,
+ signer: passkey1,
+ safeVersion: '1.4.1',
+ contractNetworks
+ })
+ const safeProvider2 = await SafeProvider.init({
+ provider,
+ signer: passkey2,
+ safeVersion: '1.4.1',
+ contractNetworks
+ })
 
  const passkeySigner1 = await safeProvider1.getExternalSigner()
  const passkeySigner2 = await safeProvider2.getExternalSigner()

packages/protocol-kit/tests/e2e/safeProvider.test.ts

@@ -49,7 +49,9 @@ describe('Safe contracts', () => {
  const passKeySigner = await createMockPasskey('aName')
 
  chai
- .expect(SafeProvider.init(provider, passKeySigner, safeVersionDeployed))
+ .expect(
+ SafeProvider.init({ provider, signer: passKeySigner, safeVersion: safeVersionDeployed })
+ )
  .to.be.rejectedWith(
  'Current version of the Safe does not support the Passkey signer functionality'
  )

packages/relay-kit/src/packs/safe-4337/Safe4337Pack.ts

@@ -248,7 +248,7 @@ export class Safe4337Pack extends RelayKitBasePack<{
  setupTransactions.push(approveToPaymasterTransaction)
  }
 
- const safeProvider = await SafeProvider.init(provider, signer, safeVersion)
+ const safeProvider = await SafeProvider.init({ provider, signer, safeVersion })
 
  // third transaction: passkey support via shared signer SafeWebAuthnSharedSigner
  // see: https://github.com/safe-global/safe-modules/blob/main/modules/passkey/contracts/4337/experimental/README.md