Skip to content

Commit

Permalink
chore: remove runner as contract parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
dasanra committed Sep 24, 2024
1 parent f959592 commit 2091d22
Show file tree
Hide file tree
Showing 16 changed files with 27 additions and 86 deletions.
5 changes: 2 additions & 3 deletions packages/protocol-kit/src/contracts/BaseContract.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,7 @@ class BaseContract<ContractAbiType extends Abi> {
defaultAbi: ContractAbiType,
safeVersion: SafeVersion,
customContractAddress?: string,
customContractAbi?: ContractAbiType,
runner?: ExternalClient
customContractAbi?: ContractAbiType
) {
const deployment = getContractDeployment(safeVersion, chainId, contractName)

Expand All @@ -94,7 +93,7 @@ class BaseContract<ContractAbiType extends Abi> {
(deployment?.abi as unknown as ContractAbiType) || // this cast is required because abi is set as any[] in safe-deployments
defaultAbi // if no customAbi and no abi is present in the safe-deployments we use our hardcoded abi

this.runner = runner || safeProvider.getExternalProvider()
this.runner = safeProvider.getExternalProvider()
this.safeProvider = safeProvider
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import SafeProvider from '@safe-global/protocol-kit/SafeProvider'
import BaseContract from '@safe-global/protocol-kit/contracts/BaseContract'
import { SafeVersion } from '@safe-global/types-kit'
import { contractName } from '@safe-global/protocol-kit/contracts/config'
import { ExternalClient } from '@safe-global/protocol-kit/types'

/**
* Abstract class CompatibilityFallbackHandlerBaseContract extends BaseContract to specifically integrate with the CompatibilityFallbackHandler contract.
Expand Down Expand Up @@ -41,8 +40,7 @@ abstract class CompatibilityFallbackHandlerBaseContract<
defaultAbi: CompatibilityFallbackHandlerContractAbiType,
safeVersion: SafeVersion,
customContractAddress?: string,
customContractAbi?: CompatibilityFallbackHandlerContractAbiType,
runner?: ExternalClient
customContractAbi?: CompatibilityFallbackHandlerContractAbiType
) {
const contractName = 'compatibilityFallbackHandler'

Expand All @@ -53,8 +51,7 @@ abstract class CompatibilityFallbackHandlerBaseContract<
defaultAbi,
safeVersion,
customContractAddress,
customContractAbi,
runner
customContractAbi
)

this.contractName = contractName
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import SafeProvider from '@safe-global/protocol-kit/SafeProvider'
import BaseContract from '@safe-global/protocol-kit/contracts/BaseContract'
import { SafeVersion } from '@safe-global/types-kit'
import { contractName } from '@safe-global/protocol-kit/contracts/config'
import { ExternalClient } from '@safe-global/protocol-kit/types'

/**
* Abstract class CreateCallBaseContract extends BaseContract to specifically integrate with the CreateCall contract.
Expand Down Expand Up @@ -41,8 +40,7 @@ abstract class CreateCallBaseContract<
defaultAbi: CreateCallContractAbiType,
safeVersion: SafeVersion,
customContractAddress?: string,
customContractAbi?: CreateCallContractAbiType,
runner?: ExternalClient
customContractAbi?: CreateCallContractAbiType
) {
const contractName = 'createCallVersion'

Expand All @@ -53,8 +51,7 @@ abstract class CreateCallBaseContract<
defaultAbi,
safeVersion,
customContractAddress,
customContractAbi,
runner
customContractAbi
)

this.contractName = contractName
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ class SafeContract_v1_0_0
options
))

const converted = await this.convertOptions({ ...options, gasLimit })
const converted = this.convertOptions({ ...options, gasLimit })
const txResult = await simulateContract(this.runner, {
address: this.contractAddress,
functionName: 'execTransaction',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ class SafeContract_v1_1_1
options
))

const converted = await this.convertOptions({ ...options, gasLimit })
const converted = this.convertOptions({ ...options, gasLimit })
const txResult = await simulateContract(this.runner, {
address: this.contractAddress,
functionName: 'execTransaction',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ class SafeContract_v1_2_0
options
))

const converted = await this.convertOptions({ ...options, gasLimit })
const converted = this.convertOptions({ ...options, gasLimit })
const txResult = await simulateContract(this.runner, {
address: this.contractAddress,
functionName: 'execTransaction',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ class SafeContract_v1_3_0
options
))

const converted = await this.convertOptions({ ...options, gasLimit })
const converted = this.convertOptions({ ...options, gasLimit })
const txResult = await simulateContract(this.runner, {
address: this.contractAddress,
functionName: 'execTransaction',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ class SafeContract_v1_4_1
options
))

const converted = await this.convertOptions({ ...options, gasLimit })
const converted = this.convertOptions({ ...options, gasLimit })
const txResult = await simulateContract(this.runner, {
address: this.contractAddress,
functionName: 'execTransaction',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import {
CreateProxyProps as CreateProxyPropsGeneral
} from '@safe-global/types-kit'
import { contractName } from '@safe-global/protocol-kit/contracts/config'
import { ExternalClient } from '@safe-global/protocol-kit/types'

export interface CreateProxyProps extends CreateProxyPropsGeneral {
options?: TransactionOptions
Expand Down Expand Up @@ -51,8 +50,7 @@ abstract class SafeProxyFactoryBaseContract<
defaultAbi: SafeProxyFactoryContractAbiType,
safeVersion: SafeVersion,
customContractAddress?: string,
customContractAbi?: SafeProxyFactoryContractAbiType,
runner?: ExternalClient
customContractAbi?: SafeProxyFactoryContractAbiType
) {
const contractName = 'safeProxyFactoryVersion'

Expand All @@ -63,8 +61,7 @@ abstract class SafeProxyFactoryBaseContract<
defaultAbi,
safeVersion,
customContractAddress,
customContractAbi,
runner
customContractAbi
)

this.contractName = contractName
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import {
} from '@safe-global/types-kit'
import { waitForTransactionReceipt } from '@safe-global/protocol-kit/utils'
import { asHex } from '@safe-global/protocol-kit/utils/types'
import { ExternalClient } from '@safe-global/protocol-kit/types'

/**
* SafeProxyFactoryContract_v1_0_0 is the implementation specific to the Safe Proxy Factory contract version 1.0.0.
Expand All @@ -37,21 +36,12 @@ class SafeProxyFactoryContract_v1_0_0
chainId: bigint,
safeProvider: SafeProvider,
customContractAddress?: string,
customContractAbi?: SafeProxyFactoryContract_v1_0_0_Abi,
runner?: ExternalClient
customContractAbi?: SafeProxyFactoryContract_v1_0_0_Abi
) {
const safeVersion = '1.0.0'
const defaultAbi = safeProxyFactory_1_0_0_ContractArtifacts.abi

super(
chainId,
safeProvider,
defaultAbi,
safeVersion,
customContractAddress,
customContractAbi,
runner
)
super(chainId, safeProvider, defaultAbi, safeVersion, customContractAddress, customContractAbi)
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import {
} from '@safe-global/types-kit'
import { waitForTransactionReceipt } from '@safe-global/protocol-kit/utils'
import { asHex } from '@safe-global/protocol-kit/utils/types'
import { ExternalClient } from '@safe-global/protocol-kit/types'

/**
* SafeProxyFactoryContract_v1_1_1 is the implementation specific to the Safe Proxy Factory contract version 1.1.1.
Expand All @@ -37,21 +36,12 @@ class SafeProxyFactoryContract_v1_1_1
chainId: bigint,
safeProvider: SafeProvider,
customContractAddress?: string,
customContractAbi?: SafeProxyFactoryContract_v1_1_1_Abi,
runner?: ExternalClient
customContractAbi?: SafeProxyFactoryContract_v1_1_1_Abi
) {
const safeVersion = '1.1.1'
const defaultAbi = safeProxyFactory_1_1_1_ContractArtifacts.abi

super(
chainId,
safeProvider,
defaultAbi,
safeVersion,
customContractAddress,
customContractAbi,
runner
)
super(chainId, safeProvider, defaultAbi, safeVersion, customContractAddress, customContractAbi)
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import {
} from '@safe-global/types-kit'
import { waitForTransactionReceipt } from '@safe-global/protocol-kit/utils'
import { asHex } from '@safe-global/protocol-kit/utils/types'
import { ExternalClient } from '@safe-global/protocol-kit/types'

/**
* SafeProxyFactoryContract_v1_3_0 is the implementation specific to the Safe Proxy Factory contract version 1.3.0.
Expand All @@ -37,21 +36,12 @@ class SafeProxyFactoryContract_v1_3_0
chainId: bigint,
safeProvider: SafeProvider,
customContractAddress?: string,
customContractAbi?: SafeProxyFactoryContract_v1_3_0_Abi,
runner?: ExternalClient
customContractAbi?: SafeProxyFactoryContract_v1_3_0_Abi
) {
const safeVersion = '1.3.0'
const defaultAbi = safeProxyFactory_1_3_0_ContractArtifacts.abi

super(
chainId,
safeProvider,
defaultAbi,
safeVersion,
customContractAddress,
customContractAbi,
runner
)
super(chainId, safeProvider, defaultAbi, safeVersion, customContractAddress, customContractAbi)
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import {
import SafeProvider from '@safe-global/protocol-kit/SafeProvider'
import { waitForTransactionReceipt } from '@safe-global/protocol-kit/utils'
import { asHex } from '@safe-global/protocol-kit/utils/types'
import { ExternalClient } from '@safe-global/protocol-kit/types'

/**
* SafeProxyFactoryContract_v1_4_1 is the implementation specific to the Safe Proxy Factory contract version 1.4.1.
Expand All @@ -37,21 +36,12 @@ class SafeProxyFactoryContract_v1_4_1
chainId: bigint,
safeProvider: SafeProvider,
customContractAddress?: string,
customContractAbi?: SafeProxyFactoryContract_v1_4_1_Abi,
runner?: ExternalClient
customContractAbi?: SafeProxyFactoryContract_v1_4_1_Abi
) {
const safeVersion = '1.4.1'
const defaultAbi = safeProxyFactory_1_4_1_ContractArtifacts.abi

super(
chainId,
safeProvider,
defaultAbi,
safeVersion,
customContractAddress,
customContractAbi,
runner
)
super(chainId, safeProvider, defaultAbi, safeVersion, customContractAddress, customContractAbi)
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import {
CreateProxyProps as CreateProxyPropsGeneral
} from '@safe-global/types-kit'
import { contractName } from '@safe-global/protocol-kit/contracts/config'
import { ExternalClient } from '@safe-global/protocol-kit/types'

export interface CreateProxyProps extends CreateProxyPropsGeneral {
options?: TransactionOptions
Expand Down Expand Up @@ -47,8 +46,7 @@ abstract class SafeWebAuthnSharedSignerBaseContract<
defaultAbi: SafeWebAuthnSharedSignerContractAbiType,
safeVersion: SafeVersion,
customContractAddress?: string,
customContractAbi?: SafeWebAuthnSharedSignerContractAbiType,
runner?: ExternalClient
customContractAbi?: SafeWebAuthnSharedSignerContractAbiType
) {
const contractName = 'safeWebAuthnSharedSignerVersion'

Expand All @@ -59,8 +57,7 @@ abstract class SafeWebAuthnSharedSignerBaseContract<
defaultAbi,
safeVersion,
customContractAddress,
customContractAbi,
runner
customContractAbi
)

this.contractName = contractName
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import {
CreateProxyProps as CreateProxyPropsGeneral
} from '@safe-global/types-kit'
import { contractName } from '@safe-global/protocol-kit/contracts/config'
import { ExternalClient } from '@safe-global/protocol-kit/types'

export interface CreateProxyProps extends CreateProxyPropsGeneral {
options?: TransactionOptions
Expand Down Expand Up @@ -47,8 +46,7 @@ abstract class SafeWebAuthnSignerFactoryBaseContract<
defaultAbi: SafeWebAuthnSignerFactoryContractAbiType,
safeVersion: SafeVersion,
customContractAddress?: string,
customContractAbi?: SafeWebAuthnSignerFactoryContractAbiType,
runner?: ExternalClient
customContractAbi?: SafeWebAuthnSignerFactoryContractAbiType
) {
const contractName = 'safeWebAuthnSignerFactoryVersion'

Expand All @@ -59,8 +57,7 @@ abstract class SafeWebAuthnSignerFactoryBaseContract<
defaultAbi,
safeVersion,
customContractAddress,
customContractAbi,
runner
customContractAbi
)

this.contractName = contractName
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import BaseContract from '@safe-global/protocol-kit/contracts/BaseContract'
import SafeProvider from '@safe-global/protocol-kit/SafeProvider'
import { SafeVersion } from '@safe-global/types-kit'
import { contractName } from '@safe-global/protocol-kit/contracts/config'
import { ExternalClient } from '@safe-global/protocol-kit/types'

/**
* Abstract class SimulateTxAccessorBaseContract extends BaseContract to specifically integrate with the SimulateTxAccessor contract.
Expand Down Expand Up @@ -41,8 +40,7 @@ abstract class SimulateTxAccessorBaseContract<
defaultAbi: SimulateTxAccessorContractAbiType,
safeVersion: SafeVersion,
customContractAddress?: string,
customContractAbi?: SimulateTxAccessorContractAbiType,
runner?: ExternalClient
customContractAbi?: SimulateTxAccessorContractAbiType
) {
const contractName = 'simulateTxAccessorVersion'

Expand All @@ -53,8 +51,7 @@ abstract class SimulateTxAccessorBaseContract<
defaultAbi,
safeVersion,
customContractAddress,
customContractAbi,
runner
customContractAbi
)

this.contractName = contractName
Expand Down

0 comments on commit 2091d22

Please sign in to comment.