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.

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

fix: Update broken links #636

Merged
merged 3 commits into from
Oct 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions linkchecker-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@
},
{
"pattern": "^https://trustwallet.com"
},
{
"pattern": "^https://dashboard.pimlico.io"
},
{
"pattern": "^https://api.stripe.com"
}
],
"replacementPatterns": [
Expand Down
2 changes: 1 addition & 1 deletion pages/advanced/cli-reference/unattended-commands.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Commands available in unattended mode

In addition to the use cases referenced in the sections [Common commands for both modes](./common-commands) and [Commands specific to the tx-service mode](./tx-service-commands) it is possible to execute some commands without using the interactive prompt. This facilitates the use of `safe-cli` in generating scripts or automated processes.
In addition to the use cases referenced in the sections [Common commands for both modes](./common-commands.mdx) and [Commands specific to the tx-service mode](./tx-service-commands.mdx) it is possible to execute some commands without using the interactive prompt. This facilitates the use of `safe-cli` in generating scripts or automated processes.

The commands available for direct execution without the use of the interactive prompt are:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ pnpm install viem permissionless

### Setup

These are the constants that will be used in this guide. We have selected Gnosis as the chain, but other [supported networks](../supported-networks.md) can be used. We also need the Pimlico API key and a private key we will use for the owner of the Safe.
These are the constants that will be used in this guide. We have selected Gnosis as the chain, but other [supported networks](../../smart-account-supported-networks.mdx?module=Safe+4337+Module) can be used. We also need the Pimlico API key and a private key we will use for the owner of the Safe.

{/* <!-- vale off --> */}

Expand Down
6 changes: 3 additions & 3 deletions pages/advanced/passkeys/tutorials/nuxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ An increasing number of applications rely on passkeys to authenticate users secu
Being able to unlock a Safe Smart Account with your fingerprints or Face ID, sending transactions without worrying about third-party wallet interfaces, phishing attempts, or securing seed phrases will bring new forms of ownership to the connected world.
Today, we'll learn how to make this a reality using [Safe\{Core\} SDK](../../../sdk/overview.mdx), [Pimlico](https://www.pimlico.io/), and [Nuxt](https://nuxt.com/docs/getting-started/introduction).

This tutorial will demonstrate creating a web app for using [passkeys](../passkeys-overview.mdx) in your Safe. This app will allow you to:
This tutorial will demonstrate creating a web app for using [passkeys](../overview.mdx) in your Safe. This app will allow you to:

- Create a new passkey secured by the user's device.
- Deploy a new Safe on Ethereum Sepolia for free.
Expand Down Expand Up @@ -41,7 +41,7 @@ When prompted by the CLI, select `pnpm` and `yes` to initialize a Git repository

### Install dependencies

For this project, we'll use the [Relay Kit](../../../sdk/relay-kit.mdx) and [Protocol Kit](../../../sdk/protocol-kit.mdx) from the Safe\{Core\} SDK to set up a Safe, sponsor a transaction, and use [viem](https://www.npmjs.com/package/viem) for a helper function to encode the dummy transaction. We will also use [`@pinia/nuxt`](https://pinia.vuejs.org/) for state management and node polyfills from [Vite](https://www.npmjs.com/package/vite-plugin-node-polyfillFs).
For this project, we'll use the [Relay Kit](../../../sdk/relay-kit.mdx) and [Protocol Kit](../../../sdk/protocol-kit.mdx) from the Safe\{Core\} SDK to set up a Safe, sponsor a transaction, and use [viem](https://www.npmjs.com/package/viem) for a helper function to encode the dummy transaction. We will also use [`@pinia/nuxt`](https://pinia.vuejs.org/) for state management and node polyfills from [Vite](https://www.npmjs.com/package/vite-plugin-node-polyfills).

Run the following command to add all these dependencies to the project:

Expand Down Expand Up @@ -237,6 +237,6 @@ Please be mindful of certain security considerations when dealing with passkeys.

We learned how to use passkeys (create them, store them, and use them securely) and how they can interact with a Safe (deploy it and send transactions). We hope you enjoyed this tutorial and that the combination of passkeys and the ERC-4337 will unlock new forms of ownership for your project and users.

You can now integrate passkeys with more transactions and functionalities of the Safe ecosystem. You can read more about passkeys in our [overview](../passkeys-overview.mdx) or in the [WebAuthn API documentation](https://developer.mozilla.org/en-US/docs/Web/API/Web_Authentication_API).
You can now integrate passkeys with more transactions and functionalities of the Safe ecosystem. You can read more about passkeys in our [overview](../overview.mdx) or in the [WebAuthn API documentation](https://developer.mozilla.org/en-US/docs/Web/API/Web_Authentication_API).

Did you encounter any difficulties? Let us know by opening [an issue](https://github.com/5afe/safe-passkeys-nuxt/issues/new) or asking a question on [Stack Exchange](https://ethereum.stackexchange.com/questions/tagged/safe-core) with the `safe-core` tag.
8 changes: 4 additions & 4 deletions pages/advanced/passkeys/tutorials/react.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ An increasing number of applications rely on passkeys to authenticate users secu
Being able to unlock a Safe Smart Account with your fingerprints or Face ID, sending transactions without worrying about third-party wallet interfaces, phishing attempts, or securing seed phrases will bring new forms of ownership to the connected world.
Today, we'll learn how to make this a reality using [Safe\{Core\} SDK](../../../sdk/overview.mdx), [Pimlico](https://www.pimlico.io/), and [Next.js](https://nextjs.org/docs).

This tutorial will demonstrate creating a web app for using [passkeys](../passkeys-overview.mdx) in your Safe. This app will allow you to:
This tutorial will demonstrate creating a web app for using [passkeys](../overview.mdx) in your Safe. This app will allow you to:

- Create a new passkey secured by the user's device.
- Deploy a new Safe on Ethereum Sepolia for free.
Expand Down Expand Up @@ -198,13 +198,13 @@ Still within the `app` folder, replace the existing content of the file `layout.

In the same folder, replace the `globals.css` file with this code:

```css
```tsx
// from ../../../../examples/passkeys/app/globals.css
```

To add some icons to the app, we will need to edit the `next.config.mjs` file at the root of the project to load SVG files:

```js
```tsx
// from ../../../../examples/passkeys/next.config.mjs
```

Expand Down Expand Up @@ -234,6 +234,6 @@ Please be mindful of certain security considerations when dealing with passkeys.

We learned how to use passkeys (create them, store them, and use them securely) and how they can interact with a Safe (deploy it and send transactions). We hope you enjoyed this tutorial and that the combination of passkeys and the ERC-4337 will unlock new forms of ownership for your project and users.

You can now integrate passkeys with more transactions and functionalities of the Safe ecosystem. You can read more about passkeys in our [overview](../passkeys-overview.mdx) or in the [WebAuthn API documentation](https://developer.mozilla.org/en-US/docs/Web/API/Web_Authentication_API).
You can now integrate passkeys with more transactions and functionalities of the Safe ecosystem. You can read more about passkeys in our [overview](../overview.mdx) or in the [WebAuthn API documentation](https://developer.mozilla.org/en-US/docs/Web/API/Web_Authentication_API).

Did you encounter any difficulties? Let us know by opening [an issue](https://github.com/5afe/safe-passkeys-tutorial/issues/new) or asking a question on [Stack Exchange](https://ethereum.stackexchange.com/questions/tagged/safe-core) with the `safe-core` tag.
4 changes: 2 additions & 2 deletions pages/advanced/smart-account-bug-bounty.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The scope of the bug bounty also includes officially supported Safe Modules:
* MultiSend.sol, MultiSendCallOnly.sol, CreateCall.sol
* TokenCallbackHandler.sol (formerly DefaultCallbackHandler.sol), CompatibilityFallbackHandler.sol, HandlerContext.sol

You can find addresses for deployed instances of these contracts [here](/advanced/smart-account-supported-networks?version=v1.4.1) or in the [Safe deployments](https://github.com/safe-global/safe-deployments) repository.
You can find addresses for deployed instances of these contracts [here](./smart-account-supported-networks.mdx?version=v1.4.1) or in the [Safe deployments](https://github.com/safe-global/safe-deployments) repository.

**Gnosis Safe core contracts (up to version 1.3.0)**

Expand All @@ -52,7 +52,7 @@ You can find addresses for deployed instances of these contracts [here](/advance
* CreateAndAddModules.sol, MultiSend.sol, MultiSendCallOnly.sol, CreateCall.sol
* DefaultCallbackHandler.sol, CompatibilityFallbackHandler.sol, HandlerContext.sol

You can find addresses for deployed instances of these contracts [here](/advanced/smart-account-supported-networks?version=v1.3.0) in the [Safe deployments](https://github.com/safe-global/safe-deployments) repository.
You can find addresses for deployed instances of these contracts [here](./smart-account-supported-networks.mdx?version=v1.3.0) in the [Safe deployments](https://github.com/safe-global/safe-deployments) repository.

**Safe Modules contracts**

Expand Down
6 changes: 3 additions & 3 deletions pages/home/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ A Safe Guard is a smart contract that adds restrictions on top of the n-out-of-m
See also:
- [Safe Guards documentation](../advanced/smart-account-guards.mdx) on docs.safe.global
- [Zodiac Guards](https://zodiac.wiki/index.php%3Ftitle=Introduction:_Zodiac_Protocol.html#Guards) on zodiac.wiki
- [Get the enabled Safe Guard](../sdk/protocol-kit/reference.md#getguard) and [enable a Safe Guard](../sdk/protocol-kit/reference.md#createenableguardtx) with the Safe{Core} SDK on docs.safe.global
- [Get the enabled Safe Guard](../reference-sdk-protocol-kit/safe-guards/getguard.mdx) and [enable a Safe Guard](../reference-sdk-protocol-kit/safe-guards/createenableguardtx.mdx) with the Safe{Core} SDK on docs.safe.global

## Safe Module

Expand All @@ -165,7 +165,7 @@ See also:
- [Safe Modules documentation](../advanced/smart-account-modules.mdx) on docs.safe.global
- [Safe Modules repository](https://github.com/safe-global/safe-modules) on github.com
- [Zodiac Modules](https://zodiac.wiki/index.php%3Ftitle=Introduction:_Zodiac_Protocol.html#Modules) on zodiac.wiki
- [Get the enabled Safe Modules](../sdk/protocol-kit/reference.md#getmodules) and [enable a Safe Module](../sdk/protocol-kit/reference.md#createenablemoduletx) with the Safe{Core} SDK on docs.safe.global
- [Get the enabled Safe Modules](../reference-sdk-protocol-kit/safe-modules/getmodules.mdx) and [enable a Safe Module](../reference-sdk-protocol-kit/safe-modules/createenablemoduletx.mdx) with the Safe\{Core\} SDK on docs.safe.global

## Smart Account

Expand Down Expand Up @@ -193,7 +193,7 @@ See also:
The threshold of a Safe account is a crucial configuration element that enables using Safe as a multi-signature smart account. It defines the number of required confirmations from the Safe owners a (Safe) transaction must have to be executable.

See also:
- [Get the threshold](../sdk/protocol-kit/reference.md#getthreshold) and [change the threshold](../sdk/protocol-kit/reference.md#createchangethresholdtx) of a Safe with the Safe{Core} SDK on docs.safe.global
- [Get the threshold](../reference-sdk-protocol-kit/safe-info/getthreshold.mdx) and [change the threshold](../reference-sdk-protocol-kit/safe-info/createchangethresholdtx.mdx) of a Safe with the Safe{Core} SDK on docs.safe.global

## UserOperation

Expand Down
2 changes: 1 addition & 1 deletion pages/home/safe-core.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ The Safe\{Core\} stack is categorized into three distinct groups:

## Getting started

Are you new to Safe and not sure where to get started? We recommend heading over to one of our [tutorials](/resource-hub?source=Safe+Team&tag=Tutorial).
Are you new to Safe and not sure where to get started? We recommend heading over to one of our [tutorials](../resource-hub.mdx?source=Safe+Team&tag=Tutorial).
2 changes: 1 addition & 1 deletion pages/reference-sdk-api-kit/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# API Kit Reference

The [API Kit](../sdk/api-kit.mdx) facilitates the interaction with the [Safe Transaction Service API](../core-api/transaction-service-overview).
The [API Kit](../sdk/api-kit.mdx) facilitates the interaction with the [Safe Transaction Service API](../core-api/transaction-service-overview.mdx).

## Install dependencies

Expand Down
3 changes: 1 addition & 2 deletions pages/reference-sdk-react-hooks/useconfirmtransaction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,7 @@ The configuration used instead of the one from the nearest [`SafeProvider`](./sa
import { UseConfirmTransactionReturnType } from '@safe-global/safe-react-hooks'
```

[TanStack Query mutation documentation](https://tanstack.com/mutation/v5/docs/framework/react/reference/useMutation).

[TanStack Query mutation documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation).
### `confirmTransaction`

- **Type**: `UseMutateFunction<SafeClientResult, Error, ConfirmTransactionVariables, unknown>`
Expand Down
2 changes: 1 addition & 1 deletion pages/reference-sdk-react-hooks/usesendtransaction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ The configuration used instead of the one from the nearest [`SafeProvider`](./sa
import { UseSendTransactionReturnType } from '@safe-global/safe-react-hooks'
```

[TanStack Query mutation documentation](https://tanstack.com/mutation/v5/docs/framework/react/reference/useMutation).
[TanStack Query mutation documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation).

### `sendTransaction`

Expand Down
4 changes: 2 additions & 2 deletions pages/reference-sdk-react-hooks/useupdateowners/add.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Tabs } from "nextra/components"

# `add`

Contains the `addOwner` and `addOwnerAsync` functions, which execute a Safe transaction to add a new owner to the Safe connected to the [`SafeProvider`](./safeprovider.mdx) or send it to the Safe Transaction Service if it isn't executable.
Contains the `addOwner` and `addOwnerAsync` functions, which execute a Safe transaction to add a new owner to the Safe connected to the [`SafeProvider`](../safeprovider.mdx) or send it to the Safe Transaction Service if it isn't executable.

## Usage

Expand Down Expand Up @@ -79,7 +79,7 @@ The connected Safe must be already deployed.
import { UseAddOwnerReturnType } from '@safe-global/safe-react-hooks'
```

[TanStack Query mutation documentation](https://tanstack.com/mutation/v5/docs/framework/react/reference/useMutation).
[TanStack Query mutation documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation).

### `addOwner`

Expand Down
4 changes: 2 additions & 2 deletions pages/reference-sdk-react-hooks/useupdateowners/remove.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Tabs } from "nextra/components"

# `remove`

Contains the `removeOwner` and `removeOwnerAsync` functions, which execute a Safe transaction to remove an owner of the Safe connected to the [`SafeProvider`](./safeprovider.mdx) or send it to the Safe Transaction Service if it isn't executable.
Contains the `removeOwner` and `removeOwnerAsync` functions, which execute a Safe transaction to remove an owner of the Safe connected to the [`SafeProvider`](../safeprovider.mdx) or send it to the Safe Transaction Service if it isn't executable.

## Usage

Expand Down Expand Up @@ -79,7 +79,7 @@ The connected Safe must be already deployed.
import { UseRemoveOwnerReturnType } from '@safe-global/safe-react-hooks'
```

[TanStack Query mutation documentation](https://tanstack.com/mutation/v5/docs/framework/react/reference/useMutation).
[TanStack Query mutation documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation).

### `removeOwner`

Expand Down
4 changes: 2 additions & 2 deletions pages/reference-sdk-react-hooks/useupdateowners/swap.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Tabs } from "nextra/components"

# `swap`

Contains the `swapOwner` and `swapOwnerAsync` functions, which execute a Safe transaction to swap an owner of the Safe connected to the [`SafeProvider`](./safeprovider.mdx) or send it to the Safe Transaction Service if it isn't executable.
Contains the `swapOwner` and `swapOwnerAsync` functions, which execute a Safe transaction to swap an owner of the Safe connected to the [`SafeProvider`](../safeprovider.mdx) or send it to the Safe Transaction Service if it isn't executable.

## Usage

Expand Down Expand Up @@ -79,7 +79,7 @@ The connected Safe must be already deployed.
import { UseSwapOwnerReturnType } from '@safe-global/safe-react-hooks'
```

[TanStack Query mutation documentation](https://tanstack.com/mutation/v5/docs/framework/react/reference/useMutation).
[TanStack Query mutation documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation).

### `swapOwner`

Expand Down
2 changes: 1 addition & 1 deletion pages/reference-sdk-react-hooks/useupdatethreshold.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ The configuration used instead of the one from the nearest [`SafeProvider`](./sa
import { UseUpdateThresholdReturnType } from '@safe-global/safe-react-hooks'
```

[TanStack Query mutation documentation](https://tanstack.com/mutation/v5/docs/framework/react/reference/useMutation).
[TanStack Query mutation documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation).

### `updateThreshold`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { Tabs } from 'nextra/components'

Returns an instance of the `SafeClient` class, which enables developers to configure new or existing Safe accounts and handle transactions.

The `SafeClient` class provides a mechanism to extend its functionality via the [`extend`](./extend) method.
The `SafeClient` class provides a mechanism to extend its functionality via the [`extend`](./extend.mdx) method.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion pages/sdk/api-kit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import CustomCard from '../../components/CustomCard'

# API Kit

The API Kit facilitates the interaction with the [Safe Transaction Service API](../core-api/transaction-service-overview), allowing to propose and share transactions with the other signers of a Safe, sending the signatures to the service to collect them, getting information about a Safe (like reading the transaction history, pending transactions, enabled Modules and Guards, etc.), among other features.
The API Kit facilitates the interaction with the [Safe Transaction Service API](../core-api/transaction-service-overview.mdx), allowing to propose and share transactions with the other signers of a Safe, sending the signatures to the service to collect them, getting information about a Safe (like reading the transaction history, pending transactions, enabled Modules and Guards, etc.), among other features.

<Grid item mt={3}>
<CustomCard
Expand Down
6 changes: 3 additions & 3 deletions pages/sdk/api-kit/guides/propose-and-confirm-transactions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ For more detailed information, see the [API Kit Reference](../../../reference-sd

Before a transaction can be executed, any of the Safe signers needs to initiate the process by creating a proposal of a transaction. This transaction is sent to the service to make it accessible by the other owners so they can give their approval and sign the transaction as well.

For a full list and description of the properties see [`proposeTransaction`](../../../reference-sdk-api-kit/proposetransaction) in the API Kit reference.
For a full list and description of the properties see [`proposeTransaction`](../../../reference-sdk-api-kit/proposetransaction.mdx) in the API Kit reference.

```typescript
// Create transaction
Expand Down Expand Up @@ -132,7 +132,7 @@ For more detailed information, see the [API Kit Reference](../../../reference-sd

### Confirm the transaction

In this step you need to sign the transaction with the Protocol Kit and submit the signature to the Safe Transaction Service using the [`confirmTransaction`](../../../reference-sdk-api-kit/confirmtransaction) method.
In this step you need to sign the transaction with the Protocol Kit and submit the signature to the Safe Transaction Service using the [`confirmTransaction`](../../../reference-sdk-api-kit/confirmtransaction.mdx) method.

```typescript
const protocolKitOwner2 = await Safe.init({
Expand All @@ -151,6 +151,6 @@ For more detailed information, see the [API Kit Reference](../../../reference-sd
)
```

The Safe transaction is now ready to be executed. This can be done using the [Safe\{Wallet\} web](https://app.safe.global) interface, the [Protocol Kit](../../protocol-kit/reference/safe#executetransaction), the [Safe CLI](../../../advanced/cli-reference/tx-service-commands#execute-pending-transaction) or any other tool that's available.
The Safe transaction is now ready to be executed. This can be done using the [Safe\{Wallet\} web](https://app.safe.global) interface, the [Protocol Kit](../../../reference-sdk-protocol-kit/transactions/executetransaction.mdx), the [Safe CLI](../../../advanced/cli-reference/tx-service-commands.mdx#execute-pending-transaction) or any other tool that's available.

</Steps>
Loading
Loading