Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Introduce types-kit #590

Merged
merged 4 commits into from
Sep 24, 2024
Merged

docs: Introduce types-kit #590

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
72fb607
Update imports
yagopv Sep 17, 2024
cbd9482
update migration guide
yagopv Sep 17, 2024
1977689
Merge branch 'main' into rename-sdk-types
germartinez Sep 24, 2024
c49d078
Fix types after conflicts
germartinez Sep 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pages/core-api/transaction-service-guides/delegates.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The different steps are implemented using [Curl](https://github.com/curl/curl) r
<Tabs items={['TypeScript', 'Python']}>
<Tabs.Tab>
```bash
yarn add ethers @safe-global/api-kit @safe-global/protocol-kit @safe-global/safe-core-sdk-types
yarn add ethers @safe-global/api-kit @safe-global/protocol-kit @safe-global/types-kit
```
</Tabs.Tab>
<Tabs.Tab>
Expand Down
2 changes: 1 addition & 1 deletion pages/core-api/transaction-service-guides/messages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The different steps are implemented using [Curl](https://github.com/curl/curl) r
<Tabs items={['TypeScript', 'Python']}>
<Tabs.Tab>
```bash
yarn add @safe-global/api-kit @safe-global/protocol-kit @safe-global/safe-core-sdk-types
yarn add @safe-global/api-kit @safe-global/protocol-kit @safe-global/types-kit
```
</Tabs.Tab>
<Tabs.Tab>
Expand Down
4 changes: 2 additions & 2 deletions pages/core-api/transaction-service-guides/transactions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The different steps are implemented using [Curl](https://github.com/curl/curl) r
<Tabs items={['TypeScript', 'Python']}>
<Tabs.Tab>
```bash
yarn add @safe-global/api-kit @safe-global/protocol-kit @safe-global/safe-core-sdk-types
yarn add @safe-global/api-kit @safe-global/protocol-kit @safe-global/types-kit
```
</Tabs.Tab>
<Tabs.Tab>
Expand All @@ -46,7 +46,7 @@ The different steps are implemented using [Curl](https://github.com/curl/curl) r
import {
MetaTransactionData,
OperationType
} from '@safe-global/safe-core-sdk-types'
} from '@safe-global/types-kit'
```
</Tabs.Tab>
<Tabs.Tab>
Expand Down
4 changes: 2 additions & 2 deletions pages/sdk/api-kit.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ For more detailed information, see the [API Kit Reference](./api-kit/reference.m
```bash
yarn add @safe-global/api-kit \
@safe-global/protocol-kit \
@safe-global/safe-core-sdk-types
@safe-global/types-kit
```

### Imports
Expand All @@ -49,7 +49,7 @@ For more detailed information, see the [API Kit Reference](./api-kit/reference.m
import {
MetaTransactionData,
OperationType
} from '@safe-global/safe-core-sdk-types'
} from '@safe-global/types-kit'
```

### Setup
Expand Down
4 changes: 2 additions & 2 deletions pages/sdk/protocol-kit.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ First, we need to install some dependencies.
```bash
yarn add @safe-global/protocol-kit \
@safe-global/api-kit \
@safe-global/safe-core-sdk-types
@safe-global/types-kit
```

### Initialize Signers and Providers
Expand Down Expand Up @@ -168,7 +168,7 @@ The high-level overview of a multi-sig transaction is PCE: Propose. Confirm. Exe
For more details on what to include in a transaction see [`createTransaction`](./protocol-kit/reference/safe.mdx#createtransaction) method.

```tsx
import { MetaTransactionData } from '@safe-global/safe-core-sdk-types'
import { MetaTransactionData } from '@safe-global/types-kit'

// Any address can be used. In this example you will use vitalik.eth
const destination = '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045'
Expand Down
2 changes: 1 addition & 1 deletion pages/sdk/protocol-kit/guides/migrate-to-v4.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This guide references the major changes between v3 and v4 to help those migrating an existing app.

**Note:** When upgrading to `protocol-kit` v4, it's necessary to upgrade to `safe-core-sdk-types` v5.
**Note:** When upgrading to `protocol-kit` v4, it's necessary to upgrade to `types-kit` v1.

## The create() method was renamed init() in the SafeFactory and Safe classes

Expand Down
6 changes: 3 additions & 3 deletions pages/sdk/relay-kit/guides/gelato-relay.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The [Gelato relay](https://docs.gelato.network/developer-services/relay) allows
## Install dependencies

```bash
yarn add ethers @safe-global/relay-kit @safe-global/protocol-kit @safe-global/safe-core-sdk-types
yarn add ethers @safe-global/relay-kit @safe-global/protocol-kit @safe-global/types-kit
```

## Relay Kit options
Expand Down Expand Up @@ -51,7 +51,7 @@ For the 1Balance quickstart tutorial, you will use the Gelato relayer to pay for
import {
MetaTransactionData,
MetaTransactionOptions
} from '@safe-global/safe-core-sdk-types'
} from '@safe-global/types-kit'
```

### Initialize the transaction settings
Expand Down Expand Up @@ -137,7 +137,7 @@ For the SyncFee quickstart tutorial, you will use the Gelato relayer to pay for
import { ethers } from 'ethers'
import { GelatoRelayPack } from '@safe-global/relay-kit'
import Safe from '@safe-global/protocol-kit'
import { MetaTransactionData } from '@safe-global/safe-core-sdk-types'
import { MetaTransactionData } from '@safe-global/types-kit'
```

### Initialize the transaction settings
Expand Down
Loading