Prepare release

guides/integrating-the-safe-core-sdk.md

@@ -291,7 +291,7 @@ type SafeMultisigTransactionResponse = {
       transactionHash?: string
       confirmationType?: string
       signature: string
-      signatureType?: string
+      signatureType?: SignatureType
     },
     // ...
   ]

packages/api-kit/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@safe-global/api-kit",
-  "version": "2.5.4",
+  "version": "2.5.5",
   "description": "SDK that facilitates the interaction with the Safe Transaction Service API",
   "main": "dist/src/index.js",
   "typings": "dist/src/index.d.ts",
@@ -39,7 +39,7 @@
   ],
   "homepage": "https://github.com/safe-global/safe-core-sdk#readme",
   "devDependencies": {
-    "@safe-global/relay-kit": "^3.2.4",
+    "@safe-global/relay-kit": "^3.3.0",
     "@safe-global/testing-kit": "^0.1.1",
     "@types/chai": "^4.3.19",
     "@types/chai-as-promised": "^7.1.8",
@@ -58,8 +58,8 @@
     "web3": "^4.12.1"
   },
   "dependencies": {
-    "@safe-global/protocol-kit": "^5.0.4",
-    "@safe-global/types-kit": "^1.0.0",
+    "@safe-global/protocol-kit": "^5.1.0",
+    "@safe-global/types-kit": "^1.0.1",
     "node-fetch": "^2.7.0",
     "viem": "^2.21.8"
   }

packages/api-kit/src/SafeApiKit.ts

@@ -115,20 +115,28 @@
   /**
    * Decodes the specified Safe transaction data.
    *
-   * @param data - The Safe transaction data
+   * @param data - The Safe transaction data. '0x' prefixed hexadecimal string.
+   * @param to - The address of the receiving contract. If provided, the decoded data will be more accurate, as in case of an ABI collision the Safe Transaction Service would know which ABI to use
    * @returns The transaction data decoded
    * @throws "Invalid data"
    * @throws "Not Found"
    * @throws "Ensure this field has at least 1 hexadecimal chars (not counting 0x)."
    */
-  async decodeData(data: string): Promise<any> {
+  async decodeData(data: string, to?: string): Promise<any> {
     if (data === '') {
       throw new Error('Invalid data')
     }
+
+    const dataDecoderRequest: { data: string; to?: string } = { data }
+
+    if (to) {
+      dataDecoderRequest.to = to
+    }
+
     return sendRequest({
       url: `${this.#txServiceBaseUrl}/v1/data-decoder/`,
       method: HttpMethod.Post,
-      body: { data }
+      body: dataDecoderRequest
     })
   }
 
@@ -331,7 +339,7 @@
     const { address: delegator } = this.#getEip3770Address(delegatorAddress)
     const signature = await signDelegate(signer, delegate, this.#chainId)
 
     const body: any = {
       safe: safeAddress ? this.#getEip3770Address(safeAddress).address : null,
       delegate,
       delegator,

packages/api-kit/src/types/safeTransactionServiceTypes.ts

@@ -4,7 +4,8 @@ import {
   SafeTransactionData,
   UserOperation,
   SafeOperationResponse,
-  ListResponse
+  ListResponse,
+  SignatureType
 } from '@safe-global/types-kit'
 
 export type ListOptions = {
@@ -231,7 +232,7 @@ export type SafeMessageConfirmation = {
   readonly modified: string
   readonly owner: string
   readonly signature: string
-  readonly signatureType: string
+  readonly signatureType: SignatureType
 }
 
 export type SafeMessage = {

packages/api-kit/tests/e2e/decodeData.test.ts

@@ -45,4 +45,22 @@ describe('decodeData', () => {
       })
     )
   })
+
+  it('should decode the data and allow to specify the receiving contract', async () => {
+    const data = '0x610b592500000000000000000000000090F8bf6A479f320ead074411a4B0e7944Ea8c9C1'
+    const to = '0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1'
+    const decodedData = await safeApiKit.decodeData(data, to)
+    chai.expect(JSON.stringify(decodedData)).to.be.equal(
+      JSON.stringify({
+        method: 'enableModule',
+        parameters: [
+          {
+            name: 'module',
+            type: 'address',
+            value: '0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1'
+          }
+        ]
+      })
+    )
+  })
 })

packages/protocol-kit/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@safe-global/protocol-kit",
-  "version": "5.0.4",
+  "version": "5.1.0",
   "description": "SDK that facilitates the interaction with Safe Smart Accounts",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -66,12 +66,15 @@
     "web3": "^4.12.1"
   },
   "dependencies": {
-    "@noble/hashes": "^1.3.3",
-    "@safe-global/safe-deployments": "^1.37.14",
+    "@safe-global/safe-deployments": "^1.37.20",
     "@safe-global/safe-modules-deployments": "^2.2.4",
-    "@safe-global/types-kit": "^1.0.0",
+    "@safe-global/types-kit": "^1.0.1",
     "abitype": "^1.0.2",
     "semver": "^7.6.3",
     "viem": "^2.21.8"
+  },
+  "optionalDependencies": {
+    "@noble/curves": "^1.6.0",
+    "@peculiar/asn1-schema": "^2.3.13"
   }
 }

packages/protocol-kit/src/Safe.ts

@@ -42,7 +42,8 @@ import {
   SigningMethodType,
   SwapOwnerTxParams,
   SafeModulesPaginated,
-  RemovePasskeyOwnerTxParams
+  RemovePasskeyOwnerTxParams,
+  PasskeyArgType
 } from './types'
 import {
   EthSafeSignature,
@@ -59,7 +60,8 @@ import {
   generateSignature,
   preimageSafeMessageHash,
   preimageSafeTransactionHash,
-  adjustVInSignature
+  adjustVInSignature,
+  extractPasskeyData
 } from './utils'
 import EthSafeTransaction from './utils/transactions/SafeTransaction'
 import { SafeTransactionOptionalProps } from './utils/transactions/types'
@@ -1698,6 +1700,15 @@ class Safe {
   }): ContractInfo | undefined => {
     return getContractInfo(contractAddress)
   }
+
+  /**
+   * This method creates a signer to be used with the init method
+   * @param {Credential} credential - The credential to be used to create the signer. Can be generated in the web with navigator.credentials.create
+   * @returns {PasskeyArgType} - The signer to be used with the init method
+   */
+  static createPasskeySigner = async (credential: Credential): Promise<PasskeyArgType> => {
+    return extractPasskeyData(credential)
+  }
 }
 
 export default Safe

packages/protocol-kit/src/contracts/safeDeploymentContracts.ts

@@ -112,13 +112,15 @@ export async function getCompatibilityFallbackHandlerContract({
 export async function getMultiSendContract({
   safeProvider,
   safeVersion,
-  customContracts
+  customContracts,
+  deploymentType
 }: GetContractInstanceProps): Promise<MultiSendContractImplementationType> {
   const multiSendContract = await getMultiSendContractInstance(
     safeVersion,
     safeProvider,
     customContracts?.multiSendAddress,
-    customContracts?.multiSendAbi
+    customContracts?.multiSendAbi,
+    deploymentType
   )
 
   const isContractDeployed = await safeProvider.isContractDeployed(multiSendContract.getAddress())
@@ -131,13 +133,15 @@ export async function getMultiSendContract({
 export async function getMultiSendCallOnlyContract({
   safeProvider,
   safeVersion,
-  customContracts
+  customContracts,
+  deploymentType
 }: GetContractInstanceProps): Promise<MultiSendCallOnlyContractImplementationType> {
   const multiSendCallOnlyContract = await getMultiSendCallOnlyContractInstance(
     safeVersion,
     safeProvider,
     customContracts?.multiSendCallOnlyAddress,
-    customContracts?.multiSendCallOnlyAbi
+    customContracts?.multiSendCallOnlyAbi,
+    deploymentType
   )
 
   const isContractDeployed = await safeProvider.isContractDeployed(
@@ -152,13 +156,15 @@ export async function getMultiSendCallOnlyContract({
 export async function getSignMessageLibContract({
   safeProvider,
   safeVersion,
-  customContracts
+  customContracts,
+  deploymentType
 }: GetContractInstanceProps): Promise<SignMessageLibContractImplementationType> {
   const signMessageLibContract = await getSignMessageLibContractInstance(
     safeVersion,
     safeProvider,
     customContracts?.signMessageLibAddress,
-    customContracts?.signMessageLibAbi
+    customContracts?.signMessageLibAbi,
+    deploymentType
   )
 
   const isContractDeployed = await safeProvider.isContractDeployed(
@@ -173,13 +179,15 @@ export async function getSignMessageLibContract({
 export async function getCreateCallContract({
   safeProvider,
   safeVersion,
-  customContracts
+  customContracts,
+  deploymentType
 }: GetContractInstanceProps): Promise<CreateCallContractImplementationType> {
   const createCallContract = await getCreateCallContractInstance(
     safeVersion,
     safeProvider,
     customContracts?.createCallAddress,
-    customContracts?.createCallAbi
+    customContracts?.createCallAbi,
+    deploymentType
   )
 
   const isContractDeployed = await safeProvider.isContractDeployed(createCallContract.getAddress())
@@ -192,13 +200,15 @@ export async function getCreateCallContract({
 export async function getSimulateTxAccessorContract({
   safeProvider,
   safeVersion,
-  customContracts
+  customContracts,
+  deploymentType
 }: GetContractInstanceProps): Promise<SimulateTxAccessorContractImplementationType> {
   const simulateTxAccessorContract = await getSimulateTxAccessorContractInstance(
     safeVersion,
     safeProvider,
     customContracts?.simulateTxAccessorAddress,
-    customContracts?.simulateTxAccessorAbi
+    customContracts?.simulateTxAccessorAbi,
+    deploymentType
   )
 
   const isContractDeployed = await safeProvider.isContractDeployed(
@@ -213,13 +223,15 @@ export async function getSimulateTxAccessorContract({
 export async function getSafeWebAuthnSignerFactoryContract({
   safeProvider,
   safeVersion,
-  customContracts
+  customContracts,
+  deploymentType
 }: GetContractInstanceProps): Promise<SafeWebAuthnSignerFactoryContractImplementationType> {
   const safeWebAuthnSignerFactoryContract = await getSafeWebAuthnSignerFactoryContractInstance(
     safeVersion,
     safeProvider,
     customContracts?.safeWebAuthnSignerFactoryAddress,
-    customContracts?.safeWebAuthnSignerFactoryAbi
+    customContracts?.safeWebAuthnSignerFactoryAbi,
+    deploymentType
   )
 
   const isContractDeployed = await safeProvider.isContractDeployed(
@@ -234,13 +246,15 @@ export async function getSafeWebAuthnSignerFactoryContract({
 export async function getSafeWebAuthnSharedSignerContract({
   safeProvider,
   safeVersion,
-  customContracts
+  customContracts,
+  deploymentType
 }: GetContractInstanceProps): Promise<SafeWebAuthnSharedSignerContractImplementationType> {
   const safeWebAuthnSharedSignerContract = await getSafeWebAuthnSharedSignerContractInstance(
     safeVersion,
     safeProvider,
     customContracts?.safeWebAuthnSharedSignerAddress,
-    customContracts?.safeWebAuthnSharedSignerAbi
+    customContracts?.safeWebAuthnSharedSignerAbi,
+    deploymentType
   )
 
   const isContractDeployed = await safeProvider.isContractDeployed(

packages/protocol-kit/src/index.ts

@@ -35,7 +35,6 @@ import {
   estimateTxGas,
   estimateSafeTxGas,
   estimateSafeDeploymentGas,
-  extractPasskeyCoordinates,
   extractPasskeyData,
   validateEthereumAddress,
   validateEip3770Address
@@ -74,7 +73,6 @@ export {
   estimateSafeTxGas,
   estimateSafeDeploymentGas,
   extractPasskeyData,
-  extractPasskeyCoordinates,
   ContractManager,
   CreateCallBaseContract,
   createERC20TokenTransferTransaction,

packages/protocol-kit/src/managers/contractManager.ts

@@ -62,13 +62,15 @@ class ContractManager {
     this.#multiSendContract = await getMultiSendContract({
       safeProvider,
       safeVersion,
-      customContracts
+      customContracts,
+      deploymentType: predictedSafe?.safeDeploymentConfig?.deploymentType
     })
 
     this.#multiSendCallOnlyContract = await getMultiSendCallOnlyContract({
       safeProvider,
       safeVersion,
-      customContracts
+      customContracts,
+      deploymentType: predictedSafe?.safeDeploymentConfig?.deploymentType
     })
   }
 

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

@@ -3,8 +3,11 @@ export type PasskeyCoordinates = {
   y: string
 }
 
+export type GetPasskeyCredentialFn = (options?: CredentialRequestOptions) => Promise<Credential>
+
 export type PasskeyArgType = {
   rawId: string // required to sign data
   coordinates: PasskeyCoordinates // required to sign data
-  customVerifierAddress?: string // optional
+  customVerifierAddress?: string
+  getFn?: GetPasskeyCredentialFn
 }

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

@@ -50,7 +50,7 @@ export type HexAddress = string
 export type PrivateKey = string
 export type HttpTransport = string
 export type SocketTransport = string
-export type SafeSigner = HexAddress | PrivateKey | PasskeyClient
+export type SafeSigner = HexAddress | PrivateKey | PasskeyArgType | PasskeyClient
 
 export type SafeProviderConfig = {
   /** signerOrProvider - Ethers signer or provider */