diff --git a/safe-core-sdk/api-kit/reference/migrating/v1.md b/safe-core-sdk/api-kit/reference/migrating/v1.md index 5ebbd3cf..0d581a11 100644 --- a/safe-core-sdk/api-kit/reference/migrating/v1.md +++ b/safe-core-sdk/api-kit/reference/migrating/v1.md @@ -1,20 +1,20 @@ # API Kit: Migrating from `safe-service-client` -This guide references the major changes between `safe-service-client` and `api-kit v1` to help those migrating an existing app. +This guide references the major changes between `safe-service-client` and `api-kit` v1 to help those migrating an existing application. -**It's recommended to go through this guide before migrating to `api-kit v2`** +**Note:** Follow this guide before migrating to `api-kit` v2. -You can remove `@safe-global/safe-service-client` from your `package.json` after completing this guide. +After completing this guide, you can remove `@safe-global/safe-service-client` from your package.json`. ## Adding the new dependency -To add the API Kit to your project, run: +To add the API Kit to your project, run the following: ```bash yarn add @safe-global/api-kit@1.3.1 ``` -Then change your initialization like this: +Change your initialization like this: ```typescript // old @@ -36,7 +36,7 @@ const apiKit = new SafeApiKit({ ## `getSafeDelegates()` -The `getSafeDelegates` was updated to accept more filtering parameters. Now it accepts an object with multiple properties instead of only `safeAddress` parameter. +The `getSafeDelegates` was updated to accept more filtering parameters. Now, it accepts an object with multiple properties instead of only the `safeAddress` parameter. ```typescript const delegateConfig: GetSafeDelegateProps = { @@ -77,11 +77,11 @@ await apiKit.addSafeDelegate(delegateConfig) ## `removeAllSafeDelegates()` -Method was deprecated and removed. +The method was deprecated and removed. ## `removeSafeDelegate()` -Parameter object properties were updated as follow: +Parameter object properties were updated as follows: ```typescript // old @@ -103,12 +103,12 @@ await apiKit.removeSafeDelegate(delegateConfig) ## `getBalances()` -Method was deprecated and removed. +The method was deprecated and removed. ## `getUSDBalances()` -Method was deprecated and removed. +The method was deprecated and removed. ## `getCollectibles()` -Method was deprecated and removed. \ No newline at end of file +The method was deprecated and removed. \ No newline at end of file diff --git a/safe-core-sdk/protocol-kit/reference/migrating/v1.md b/safe-core-sdk/protocol-kit/reference/migrating/v1.md index 03a23727..0a375cb1 100644 --- a/safe-core-sdk/protocol-kit/reference/migrating/v1.md +++ b/safe-core-sdk/protocol-kit/reference/migrating/v1.md @@ -1,20 +1,20 @@ # Protocol Kit: Migrating from `safe-core-sdk` -This guide references the major changes between `safe-core-sdk` and `protocol-kit v1` to help those migrating an existing app. +This guide references the major changes between `safe-core-sdk` and `protocol-kit` v1 to help those migrating an existing application. -**It's recommended to go through this guide before migrating to `protocol-kit v2`** +**Note:** Follow this guide before migrating to `protocol-kit` v2. You can remove `@safe-global/safe-core-sdk` from your `package.json` after completing this guide. ## Adding the new dependency -To add the Protocol Kit to your project, run: +To add the Protocol Kit to your project, run the following: ```bash yarn add @safe-global/protocol-kit@1.3.0 ``` -If you use the types library you will need to update to v2.3.0: +If you use the types library, you will need to update to v2.3.0: ```bash yarn add @safe-global/safe-core-sdk-types@2.3.0 @@ -24,7 +24,7 @@ yarn add @safe-global/safe-core-sdk-types@2.3.0 ### `EthersAdapter` (safe-ethers-lib) -`EthersAdapter` isn't in a separate package anymore. Now it's provided inside the `protocol-kit` package. +`EthersAdapter` isn't in a separate package anymore. Now, it's provided inside the `protocol-kit` package. **`protocol-kit v1` only supports `ethers v5`** @@ -36,13 +36,13 @@ import EthersAdapter from '@safe-global/safe-ethers-lib' import { EthersAdapter } from '@safe-global/protocol-kit' ``` -You can remove `@safe-global/safe-ethers-lib` from your `package.json` after this change. +After this change, you can remove `@safe-global/safe-ethers-lib` from your `package.json`. ### `Web3Adapter` (safe-web3-lib) -`Web3Adapter` is not in a separate package anymore. Now it's provided inside the `protocol-kit` package. +`Web3Adapter` isn't in a separate package anymore. Now, it's part of the `protocol-kit` package. -**`protocol-kit v1` only supports `Web3.js v1`** +**Note:** `protocol-kit` v1 only supports Web3.js v1. ```typescript // old @@ -52,13 +52,13 @@ import Web3Adapter from '@safe-global/safe-web3-lib' import { Web3Adapter } from '@safe-global/protocol-kit' ``` -You can remove `@safe-global/safe-web3-lib` from your `package.json` after this change. +After this change, you can remove `@safe-global/safe-web3-lib` from your `package.json`. -### Types changes +### Type changes -There are type changes affecting web3 and ethers adapter libraries. +Type changes are affecting the web3 and ethers adapter libraries. -`getSafeContract`, `getMultisendContract`, `getMultisendCallOnlyContract`, `getCompatibilityFallbackHandlerContract`, `getSafeProxyFactoryContract`, `getSignMessageLibContract` and `getCreateCallContract` don't need the `chainId` parameter any more, they will use the chain set on the provider. Also they return a `Promise` now. +`getSafeContract`, `getMultisendContract`, `getMultisendCallOnlyContract`, `getCompatibilityFallbackHandlerContract`, `getSafeProxyFactoryContract`, `getSignMessageLibContract` and `getCreateCallContract` don't need the `chainId` parameter anymore, they will use the chain set on the provider. Also, they return a `Promise` now. `estimateGas` returns now a `string` instead of a `number` @@ -87,7 +87,7 @@ const safeSdk = await safeFactory.deploySafe({ safeAccountConfig, saltNonce }) ## `getAddress()` -The get address method now returns a Promise. +The `getAddress()` method now returns a `Promise`. ```typescript // old @@ -97,6 +97,6 @@ const safeAddress = safeSdk.getAddress() const safeAddress = await protocolKit.getAddress() ``` -## General types changes +## General type changes -If you set `safeTxGas`, `baseGas`, or `gasPrice` you must use type `string` instead of `number`. \ No newline at end of file +If you set `safeTxGas`, `baseGas`, or `gasPrice`, you must use the type `string` instead of `number`. \ No newline at end of file diff --git a/safe-core-sdk/protocol-kit/reference/migrating/v2.md b/safe-core-sdk/protocol-kit/reference/migrating/v2.md index 1ad7cbc0..4d34d9ae 100644 --- a/safe-core-sdk/protocol-kit/reference/migrating/v2.md +++ b/safe-core-sdk/protocol-kit/reference/migrating/v2.md @@ -2,7 +2,7 @@ This guide references the major changes between v1 and v2 to help those migrating an existing app. -**When upgrading to `protocol-kit v2` it's necessary to upgrade `safe-core-sdk-types v3`** +**Note:** When upgrading to `protocol-kit` v2, it's necessary to upgrade to `safe-core-sdk-types` v3. ## MasterCopy to Singleton