Skip to content

Commit

Permalink
fix linting issues
Browse files Browse the repository at this point in the history
  • Loading branch information
dasanra committed Nov 28, 2023
1 parent 09a86b6 commit af6d717
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
16 changes: 8 additions & 8 deletions safe-core-sdk/api-kit/reference/migrating/v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ const apiKit = new SafeApiKit({
})
```

## getSafeDelegates()
## `getSafeDelegates()`

The getSafeDelegates was updated to accept more filtering parametes. 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 `safeAddress` parameter.

```typescript
const delegateConfig: GetSafeDelegateProps = {
Expand All @@ -50,7 +50,7 @@ const delegateConfig: GetSafeDelegateProps = {
const delegates: SafeDelegateListResponse = await apiKit.getSafeDelegates(delegateConfig)
```

## addSafeDelegate()
## `addSafeDelegate()`

Parameter object properties were updated as follows:

Expand All @@ -75,11 +75,11 @@ const delegateConfig: AddSafeDelegateProps = {
await apiKit.addSafeDelegate(delegateConfig)
```

## removeAllSafeDelegates()
## `removeAllSafeDelegates()`

Method was deprecated and removed.

## removeSafeDelegate()
## `removeSafeDelegate()`

Parameter object properties were updated as follow:

Expand All @@ -101,14 +101,14 @@ const delegateConfig: DeleteSafeDelegateProps = {
await apiKit.removeSafeDelegate(delegateConfig)
```

## getBalances()
## `getBalances()`

Method was deprecated and removed.

## getUSDBalances()
## `getUSDBalances()`

Method was deprecated and removed.

## getCollectibles()
## `getCollectibles()`

Method was deprecated and removed.
8 changes: 4 additions & 4 deletions safe-core-sdk/protocol-kit/reference/migrating/v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ yarn add @safe-global/safe-core-sdk-types@2.3.0

### `EthersAdapter` (safe-ethers-lib)

`EthersAdapter` is not in a separate package anymore. Now it's provided inside the `protocol-kit` package aswell.
`EthersAdapter` isn't in a separate package anymore. Now it's provided inside the `protocol-kit` package.

**`protocol-kit v1` only supports `ethers v5`**

Expand All @@ -40,7 +40,7 @@ You can remove `@safe-global/safe-ethers-lib` from your `package.json` after thi

### `Web3Adapter` (safe-web3-lib)

`Web3Adapter` is not in a separate package anymore. Now it's provided inside the `protocol-kit` package aswell.
`Web3Adapter` is not in a separate package anymore. Now it's provided inside the `protocol-kit` package.

Check failure on line 43 in safe-core-sdk/protocol-kit/reference/migrating/v1.md

View workflow job for this annotation

GitHub Actions / vale

[vale] safe-core-sdk/protocol-kit/reference/migrating/v1.md#L43

[Microsoft.Contractions] Use 'isn't' instead of 'is not'.
Raw output
{"message": "[Microsoft.Contractions] Use 'isn't' instead of 'is not'.", "location": {"path": "safe-core-sdk/protocol-kit/reference/migrating/v1.md", "range": {"start": {"line": 43, "column": 15}}}, "severity": "ERROR"}

**`protocol-kit v1` only supports `Web3.js v1`**

Expand All @@ -62,7 +62,7 @@ There are type changes affecting web3 and ethers adapter libraries.

`estimateGas` will return now a `string` instead of a `number`

## safeFactory.deploySafe()
## `safeFactory.deploySafe()`

`SafeDeploymentConfig` was simplified. If you were using a `saltNonce` you should set it like this:

Expand All @@ -85,7 +85,7 @@ const saltNonce = '<YOUR_CUSTOM_VALUE>'
const safeSdk = await safeFactory.deploySafe({ safeAccountConfig, saltNonce })
```

## getAddress()
## `getAddress()`

The get address method now returns a Promise.

Expand Down

0 comments on commit af6d717

Please sign in to comment.