From ffb2dd99135d78228e11090beb445eb6606ce856 Mon Sep 17 00:00:00 2001 From: louis-md Date: Tue, 28 Jan 2025 16:37:46 +0100 Subject: [PATCH 01/43] Minor fixes --- pages/advanced/cli-reference/common-commands.mdx | 2 +- pages/advanced/passkeys/tutorials/react-native.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pages/advanced/cli-reference/common-commands.mdx b/pages/advanced/cli-reference/common-commands.mdx index f0cb2fab..2da9cc28 100644 --- a/pages/advanced/cli-reference/common-commands.mdx +++ b/pages/advanced/cli-reference/common-commands.mdx @@ -154,7 +154,7 @@ pip install "safe-cli[ledger]" When running on Linux, make sure the following rules have been added to `/etc/udev/rules.d/`: -```commandline +```bash SUBSYSTEMS=="usb", ATTRS{idVendor}=="2c97", ATTRS{idProduct}=="0000", MODE="0660", TAG+="uaccess", TAG+="udev-acl" OWNER="" SUBSYSTEMS=="usb", ATTRS{idVendor}=="2c97", ATTRS{idProduct}=="0001", MODE="0660", TAG+="uaccess", TAG+="udev-acl" OWNER="" SUBSYSTEMS=="usb", ATTRS{idVendor}=="2c97", ATTRS{idProduct}=="0004", MODE="0660", TAG+="uaccess", TAG+="udev-acl" OWNER="" diff --git a/pages/advanced/passkeys/tutorials/react-native.mdx b/pages/advanced/passkeys/tutorials/react-native.mdx index c174e52b..0cb70303 100644 --- a/pages/advanced/passkeys/tutorials/react-native.mdx +++ b/pages/advanced/passkeys/tutorials/react-native.mdx @@ -79,7 +79,7 @@ When [creating the emulator](https://docs.expo.dev/get-started/set-up-your-envir Create a file named `.env` in the root of your project and add the following keys: -```.env +```bash // from ../../../../examples/react-native-passkeys/.env-sample ``` From 6bdbb28400789995209d9b6ca5a2b7762f57877f Mon Sep 17 00:00:00 2001 From: louis-md Date: Wed, 29 Jan 2025 17:54:42 +0100 Subject: [PATCH 02/43] Add Config service configuration parameters --- pages/_meta.json | 10 + pages/config-service-configuration/_meta.json | 32 +++ .../add-or-edit-chain.mdx | 195 ++++++++++++++++++ .../add-or-edit-client.mdx | 15 ++ .../add-or-edit-feature.mdx | 24 +++ .../add-or-edit-gas-price.mdx | 43 ++++ .../add-or-edit-group.mdx | 17 ++ .../add-or-edit-provider.mdx | 19 ++ .../add-or-edit-safe-app-feature.mdx | 24 +++ .../add-or-edit-safe-app.mdx | 63 ++++++ .../add-or-edit-social-profile.mdx | 23 +++ .../add-or-edit-tag.mdx | 24 +++ .../add-or-edit-wallet.mdx | 24 +++ .../config-service-configuration/add-user.mdx | 27 +++ .../edit-user.mdx | 31 +++ .../config-service-configuration/overview.mdx | 11 + pages/core-api/_meta.json | 15 +- 17 files changed, 596 insertions(+), 1 deletion(-) create mode 100644 pages/config-service-configuration/_meta.json create mode 100644 pages/config-service-configuration/add-or-edit-chain.mdx create mode 100644 pages/config-service-configuration/add-or-edit-client.mdx create mode 100644 pages/config-service-configuration/add-or-edit-feature.mdx create mode 100644 pages/config-service-configuration/add-or-edit-gas-price.mdx create mode 100644 pages/config-service-configuration/add-or-edit-group.mdx create mode 100644 pages/config-service-configuration/add-or-edit-provider.mdx create mode 100644 pages/config-service-configuration/add-or-edit-safe-app-feature.mdx create mode 100644 pages/config-service-configuration/add-or-edit-safe-app.mdx create mode 100644 pages/config-service-configuration/add-or-edit-social-profile.mdx create mode 100644 pages/config-service-configuration/add-or-edit-tag.mdx create mode 100644 pages/config-service-configuration/add-or-edit-wallet.mdx create mode 100644 pages/config-service-configuration/add-user.mdx create mode 100644 pages/config-service-configuration/edit-user.mdx create mode 100644 pages/config-service-configuration/overview.mdx diff --git a/pages/_meta.json b/pages/_meta.json index c18afc06..3f195dff 100644 --- a/pages/_meta.json +++ b/pages/_meta.json @@ -31,6 +31,16 @@ "type": "page", "display": "hidden" }, + "config-service-configuration": { + "title": "Config Service Reference", + "type": "page", + "display": "hidden" + }, + "transaction-service-configuration": { + "title": "Transaction Service Configuration", + "type": "page", + "display": "hidden" + }, "core-api": { "title": "API", "type": "page" diff --git a/pages/config-service-configuration/_meta.json b/pages/config-service-configuration/_meta.json new file mode 100644 index 00000000..5b80548a --- /dev/null +++ b/pages/config-service-configuration/_meta.json @@ -0,0 +1,32 @@ +{ + "home": { + "title": "← Go Back", + "href": "/core-api/api-overview" + }, + "overview": "Overview", + "-- Authentication & Authorization": { + "type": "separator", + "title": "Authentication & Authorization" + }, + "add-or-edit-group": "Add or edit groups", + "add-user": "Add users", + "edit-user": "Edit users", + "-- Chains": { + "type": "separator", + "title": "Chains" + }, + "add-or-edit-chain": "Add or edit chains", + "add-or-edit-feature": "Add or edit features", + "add-or-edit-gas-price": "Add or edit gas prices", + "add-or-edit-wallet": "Add or edit wallets", + "-- Safe apps": { + "type": "separator", + "title": "Safe apps" + }, + "add-or-edit-safe-app": "Add or edit Safe Apps", + "add-or-edit-safe-app-feature": "Add or edit Safe App features", + "add-or-edit-tag": "Add or edit tags", + "add-or-edit-client": "Add or edit clients", + "add-or-edit-provider": "Add or edit providers", + "add-or-edit-social-profile": "Add or edit social profiles" +} diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx new file mode 100644 index 00000000..70974fcf --- /dev/null +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -0,0 +1,195 @@ +# Add or edit chain + +Add (or edit) a blockchain network. + +## Usage + +You can add a new chain by visiting this address: [`http://localhost:8000/cfg/admin/chains/chain/add/`](http://localhost:8000/cfg/admin/chains/chain/add/) + +You can edit an existing chain by visiting this address: `http://localhost:8000/cfg/admin/chains/chain/{chain index}/change/` where `{chain index}` is the index of the chain you want to edit. + +## Parameters + +### `ChainId` + +The unique identifier for the chain. + +### `Relevance` + +The relative importance of this chain for your project. You can use this value between 0 and 100 to sort chains in the UI. + +### `Chain Name` + +The name of the chain, in plain letters. + +### `EIP-3770 short name` + +The short name of the chain, as defined in [EIP-3770](https://eips.ethereum.org/EIPS/eip-3770). This corresponds to the three letters that will be prepended to all addresses on this chain. + +### `Password` + +Opens a section to set a password for the user. You can set a new password or leave it blank to keep the current one. + +### `Description` + +A brief description of the chain. + +### `Chain logo URI` + +The URI of the chain's logo. This will be displayed in the UI. + +### `L2` + +Whether this chain is a Layer 2 chain. This has important consequences on the indexing ability of the chain. If this chain is an Ethereum Layer 2, not checking this box will increase the indexing time, hence possibly missing the correct indexing of some transactions. + +### `Is testnet` + +Whether this chain is a testnet. This will be indicated in the UI. + +### `RPC authentication` + +Whether the RPC endpoint requires authentication to access its data. If `API key path` is set, the API key will be read from the RPC URI. + +### `Rpc uri` + +The URI of the chain's RPC endpoint. This is the endpoint where the Config Service will fetch the chain's data. + +### `Safe Apps RPC authentication` + +Whether the RPC endpoint dedicated to Safe Apps will require authentication. If `API key path` is set, the API key will be read from the Safe Apps RPC URI. + +### `Safe Apps rpc uri` + +The URI of the chain's RPC endpoint dedicated to Safe Apps. + +### `Public RPC authentication` + +Whether the fallback public RPC endpoint will require authentication. If `API key path` is set, the API key will be read from the Public RPC URI. + +### `Public rpc uri` + +The URI of the chain's RPC public endpoint. + +### `Block explorer uri address template` + +The URI template for the chain's block explorer addresses. This will be used to generate address links to the block explorer. For example: `https://etherscan.io/address/{{address}}`. + +### `Block explorer uri tx hash template` + +The URI template for the chain's block explorer transaction hashes. This will be used to generate `txHash` links to the block explorer. For example: `https://etherscan.io/tx/{{txHash}}`. + +### `Block explorer uri api template` + +The URI template for the chain's block explorer API. This will be used to fetch data from the block explorer. For example: `https://api.etherscan.io/api`. + +### `Beacon chain explorer uri public key template` + +The URI template for the chain's beacon chain explorer public keys. This will be used to generate public key links to the beacon chain explorer. For example: `https://beaconscan.com/validator/{{publicKey}}`. + +### `Currency name` + +The name of the chain's native currency. + +### `Currency symbol` + +The symbol of the chain's native currency. + +### `Currency decimals` + +The number of decimals of the chain's native currency. + +### `Currency logo uri` + +The URI of the chain's native currency logo. This will be displayed in the UI. + +### `Transaction service uri` + +The URI of the chain's [Transaction Service](/core-api/api-safe-transaction-service). This will be used to fetch transaction data from the chain. You will need to deploy one Transaction Service per chain, as well as one `txs-db`, `amqp` and `celery` instances. + +### `Vpc transaction service uri` + +The URI of the chain's VPC Transaction Service. If you are using a Virtual Private Cloud (VPC) to run your Transaction Service, you can set this URI to fetch transaction data from the chain. + +### `Theme text color` + +The chain color to display the text in the UI. + +### `Theme background color` + +The chain color to display the background in the UI. + +### `Ens registry address` + +The address of the chain's ENS registry. + +### `Recommended mastercopy version` + +The recommended version of the chain's mastercopy. This will be used to display a warning if the mastercopy is outdated. For example: `1.4.1`. + +### `Prices provider native coin` + +The native coin used by the chain's price provider. + +### `Prices provider chain name` + +The name of the chain's price provider. + +### `Balances provider chain name` + +The name of the chain's balances provider. + +### `Balances provider enabled` + +Whether the chain's balances provider is enabled. + +### `Hidden` + +Whether the chain is hidden in the UI. + +### `Safe singleton address` + +The address of the chain's Safe Singleton. + +### `Safe proxy factory address` + +The address of the chain's Safe Proxy + +### `Multisend address` + +The address of the chain's multisend contract. + +### `Multisand call only address` + +The address of the chain's multisend call only contract. + +### `Fallback handler address` + +The address of the chain's fallback handler contract. + +### `Sign message lib address` + +The address of the chain's sign message library contract. + +### `Create call address` + +The address of the chain's create call contract. + +### `Simulate tx accessor address` + +The address of the chain's simulate transaction accessor contract. + +### `Safe web authn signer factory address` + +The address of the chain's Safe WebAuthn Signer Factory contract. + +### Features enabled on this chain + +A list of [features](./add-or-edit-feature.mdx) enabled on this chain. You can select as many as you want by clicking `+ Add another Feature-chain relationship`. + +### Gas prices set for this chain + +A list of [gas prices](./add-or-edit-gas-price.mdx) set for this chain. You can select as many as you want by clicking `+ Add another Gas price`. + +### Wallets enabled for this chain + +A list of [wallets](./add-or-edit-wallet.mdx) enabled for this chain. You can select as many as you want by clicking `+ Add another Wallet-chain relationship`. diff --git a/pages/config-service-configuration/add-or-edit-client.mdx b/pages/config-service-configuration/add-or-edit-client.mdx new file mode 100644 index 00000000..798370ab --- /dev/null +++ b/pages/config-service-configuration/add-or-edit-client.mdx @@ -0,0 +1,15 @@ +# Add or edit clients + +Add (or edit) a new client to the configuration, so they can be attributed to Safe Apps. + +## Usage + +You can add a new client by visiting this address: `http://localhost:8000/cfg/admin/safe_apps/client/add/` + +You can edit an existing client by visiting this address: `http://localhost:8000/cfg/admin/safe_apps/client/{client index}/change/` where `{client index}` is the index of the client you want to edit. + +## Parameters + +### `Url` + +The URL the client is hosted at. diff --git a/pages/config-service-configuration/add-or-edit-feature.mdx b/pages/config-service-configuration/add-or-edit-feature.mdx new file mode 100644 index 00000000..dbd53490 --- /dev/null +++ b/pages/config-service-configuration/add-or-edit-feature.mdx @@ -0,0 +1,24 @@ +# Add or edit features + +Add (or edit) a new feature to the configuration, so they can be attributed to chains. + +## Usage + +You can add a new feature by visiting this address: `http://localhost:8000/cfg/admin/chains/feature/add/` + +You can edit an existing feature by visiting this address: `http://localhost:8000/cfg/admin/chains/feature/{feature index}/change/` where `{feature index}` is the index of the feature you want to edit. + +## Parameters + +### `Chains` + +Select the chains that will have this feature enabled. + +### `Key` + +The key of the feature. This is the unique identifier for the feature. + +### `Description` + +A brief description of the feature. + diff --git a/pages/config-service-configuration/add-or-edit-gas-price.mdx b/pages/config-service-configuration/add-or-edit-gas-price.mdx new file mode 100644 index 00000000..af2ed1ea --- /dev/null +++ b/pages/config-service-configuration/add-or-edit-gas-price.mdx @@ -0,0 +1,43 @@ +# Add or edit gas prices + +Add (or edit) a new gas price to the configuration, so they can be attributed to chains. + +## Usage + +You can add a new gas price by visiting this address: `http://localhost:8000/cfg/admin/chains/gasprice/add/` + +You can edit an existing gas price by visiting this address: `http://localhost:8000/cfg/admin/chains/gasprice/{gasprice index}/change/` where `{gasprice index}` is the index of the gas price you want to edit. + +## Parameters + +### `Chain` + +The chain that will have this gas price enabled. + +### `Oracle uri` + +The URI of the oracle that will provide the gas price. + +### `Oracle parameter` + +The parameter that will be used to fetch the gas price from the oracle. + +### `Gwei multiplier factor` + +The factor that will be used to multiply the fetched gas price. This is useful when the oracle returns the gas price in a different unit than Gwei. + +### `Fixed gas price (wei)` + +A fixed gas price that will be used instead of fetching it from the oracle. This is useful when the oracle is not available. + +### `Rank` + +The relative importance of this gas price to your project. You can use this value between 0 and 100 to sort gas prices by priority. + +### `Max fee per gas (wei)` + +The maximum fee per gas that will be used to calculate the gas price. This is useful when the oracle returns a gas price that is too high. + +### `Max priority fee per gas (wei)` + +The maximum priority fee per gas that will be used to calculate the gas price. This is useful when the oracle returns a gas price that is too high. diff --git a/pages/config-service-configuration/add-or-edit-group.mdx b/pages/config-service-configuration/add-or-edit-group.mdx new file mode 100644 index 00000000..c9272b5d --- /dev/null +++ b/pages/config-service-configuration/add-or-edit-group.mdx @@ -0,0 +1,17 @@ +# Add or edit group + +Add (or edit) a new group of permissions to the configuration, so they can be attributed to users. + +## Usage + +You can add a new group by visiting this address: `http://localhost:8000/cfg/admin/auth/group/add/` + +## Parameters + +### `Name` + +The name of the permission group. + +### `Permissions` + +Individual permissions to be added to the group. You can select as many as you want from the left column `Available permissions` and move them to the right column `Selected permissions`. diff --git a/pages/config-service-configuration/add-or-edit-provider.mdx b/pages/config-service-configuration/add-or-edit-provider.mdx new file mode 100644 index 00000000..d038d19f --- /dev/null +++ b/pages/config-service-configuration/add-or-edit-provider.mdx @@ -0,0 +1,19 @@ +# Add or edit providers + +Add (or edit) a new provider to the configuration, so they can be attributed to Safe Apps. + +## Usage + +You can add a new provider by visiting this address: `http://localhost:8000/cfg/admin/safe_apps/provider/add/` + +You can edit an existing provider by visiting this address: `http://localhost:8000/cfg/admin/safe_apps/provider/{provider index}/change/` where `{provider index}` is the index of the provider you want to edit. + +## Parameters + +### `Url` + +The URL the provider is hosted at. + +### `Name` + +The name of the provider. diff --git a/pages/config-service-configuration/add-or-edit-safe-app-feature.mdx b/pages/config-service-configuration/add-or-edit-safe-app-feature.mdx new file mode 100644 index 00000000..d360a59e --- /dev/null +++ b/pages/config-service-configuration/add-or-edit-safe-app-feature.mdx @@ -0,0 +1,24 @@ +# Add or edit Safe App features + +Add (or edit) a new Safe App feature to the configuration, so they can be attributed to chains. + +## Usage + +You can add a new Safe App feature by visiting this address: `http://localhost:8000/cfg/admin/safe_apps/feature/add/` + +You can edit an existing Safe App feature by visiting this address: `http://localhost:8000/cfg/admin/safe_apps/feature/{feature index}/change/` where `{feature index}` is the index of the Safe App feature you want to edit. + +## Parameters + +### `Chains` + +Select the chains that will have this feature enabled. + +### `Key` + +The key of the feature. This is the unique identifier for the feature. + +### `Description` + +A brief description of the feature. + diff --git a/pages/config-service-configuration/add-or-edit-safe-app.mdx b/pages/config-service-configuration/add-or-edit-safe-app.mdx new file mode 100644 index 00000000..4e8c4220 --- /dev/null +++ b/pages/config-service-configuration/add-or-edit-safe-app.mdx @@ -0,0 +1,63 @@ +# Add or edit Safe Apps + +Add (or edit) a new Safe App to the configuration. + +## Usage + +You can add a new Safe App by visiting this address: `http://localhost:8000/cfg/admin/safe_apps/safeapp/add/` + +You can edit an existing Safe App by visiting this address: `http://localhost:8000/cfg/admin/safe_apps/safeapp/{safe app index}/change/` where `{safe app index}` is the index of the Safe App you want to edit. + +## Parameters + +### `Listed` + +Whether the Safe App is listed in the Safe App list. + +### `Url` + +The URL the Safe App is hosted at. + +### `Name` + +The name of the Safe App. + +### `Icon url` + +The URL of the icon of the Safe App. + +### `Description` + +The description of the Safe App. + +### `ChainIds` + +The [chain](./add-or-edit-chain.mdx) IDs the Safe App is available on. + +### `Provider` + +The [provider](./add-or-edit-provider.mdx) of the Safe App. + +### `Exclusive clients` + +The [clients](./add-or-edit-client.mdx) that are exclusive to the Safe App. They cannot be used to access other Safe Apps. + +### `Developer website` + +The URL of the developer website of the Safe App. + +### `Featured` + +Whether the Safe App is featured in the Safe App list. + +### Tags for this Safe App + +The [tags](./add-or-edit-tag.mdx) that are associated with the Safe App. + +### Features set for this Safe Apps + +The [features](./add-or-edit-safe-app-feature.mdx) that are set for the Safe App. + +### Social profiles for this Safe App + +The [social profiles](./add-or-edit-social-profile.mdx) that are associated with the Safe App. diff --git a/pages/config-service-configuration/add-or-edit-social-profile.mdx b/pages/config-service-configuration/add-or-edit-social-profile.mdx new file mode 100644 index 00000000..e9c9907a --- /dev/null +++ b/pages/config-service-configuration/add-or-edit-social-profile.mdx @@ -0,0 +1,23 @@ +# Add or edit social profiles + +Add (or edit) a new social profile to the configuration, so they can be attributed to Safe Apps. + +## Usage + +You can add a new social profile by visiting this address: `http://localhost:8000/cfg/admin/safe_apps/socialprofile/add/` + +You can edit an existing social profile by visiting this address: `http://localhost:8000/cfg/admin/safe_apps/socialprofile/{social profile index}/change/` where `{social profile index}` is the index of the social profile you want to edit. + +## Parameters + +### `Safe app` + +The Safe App the social profile is attributed to. + +### `Platform` + +The platform the social profile is hosted on (Twitter, Discord, Telegram or GitHub). + +### `Uri` + +The URI of the social profile. diff --git a/pages/config-service-configuration/add-or-edit-tag.mdx b/pages/config-service-configuration/add-or-edit-tag.mdx new file mode 100644 index 00000000..66cee3d9 --- /dev/null +++ b/pages/config-service-configuration/add-or-edit-tag.mdx @@ -0,0 +1,24 @@ +# Add or edit tags + +Add (or edit) a new tag to the configuration, so they can be attributed to chains. + +## Usage + +You can add a new tag by visiting this address: `http://localhost:8000/cfg/admin/safe_apps/tag/add/` + +You can edit an existing tag by visiting this address: `http://localhost:8000/cfg/admin/safe_apps/tag/{tag index}/change/` where `{tag index}` is the index of the tag you want to edit. + +## Parameters + +### `Chains` + +Select the chains that will have this tag enabled. + +### `Key` + +The key of the tag. This is the unique identifier for the tag. + +### `Description` + +A brief description of the tag. + diff --git a/pages/config-service-configuration/add-or-edit-wallet.mdx b/pages/config-service-configuration/add-or-edit-wallet.mdx new file mode 100644 index 00000000..d6abb6b8 --- /dev/null +++ b/pages/config-service-configuration/add-or-edit-wallet.mdx @@ -0,0 +1,24 @@ +# Add or edit wallets + +Add (or edit) a new wallet to the configuration, so they can be attributed to chains. + +## Usage + +You can add a new wallet by visiting this address: `http://localhost:8000/cfg/admin/chains/wallet/add/` + +You can edit an existing wallet by visiting this address: `http://localhost:8000/cfg/admin/chains/wallet/{wallet index}/change/` where `{wallet index}` is the index of the wallet you want to edit. + +## Parameters + +### `Chains` + +Select the chains that will have this wallet enabled. + +### `Key` + +The key of the wallet. This is the unique identifier for the wallet. + +### `Description` + +A brief description of the wallet. + diff --git a/pages/config-service-configuration/add-user.mdx b/pages/config-service-configuration/add-user.mdx new file mode 100644 index 00000000..87012513 --- /dev/null +++ b/pages/config-service-configuration/add-user.mdx @@ -0,0 +1,27 @@ +# Add user + +Add a new Django user. Users are generally admins from your organization that will have partial or total access to the Config Service. + +After creation, you can access more options to [edit this user](./edit-user.mdx). + +## Usage + +You can edit an existing user by visiting this address: `http://localhost:8000/cfg/admin/auth/user/{user index}/change/`, where `{user index}` is the index of the user you want to edit. + +## Parameters + +### `Username` + +A user name for identifying this user. Must be unique. + +### `Password-based authentication` + +This section is used to set whether the user will use Django's [built-in authentication system](https://docs.djangoproject.com/en/5.1/topics/auth/) (`Enabled`), or will use an external authentication system (`Disabled`). If you enable this option, you will need to set a password for the user. If you disable this option, you will have to implement [your own authentication method](https://docs.djangoproject.com/en/5.1/topics/auth/customizing/). + +### `Password` + +Opens a section to set a password for the user. + +### `Confirm password` + +A confirmation field for the password. diff --git a/pages/config-service-configuration/edit-user.mdx b/pages/config-service-configuration/edit-user.mdx new file mode 100644 index 00000000..e01a99e9 --- /dev/null +++ b/pages/config-service-configuration/edit-user.mdx @@ -0,0 +1,31 @@ +# Edit user + +Edit an existing Django user. + +## Usage + +You can add a new user by visiting this address: `http://localhost:8000/cfg/admin/auth/user/add/` + +## Parameters + +### `Username` + +A user name for identifying this user. Must be unique. + +### `Password` + +Opens a section to set a password for the user. You can set a new password or leave it blank to keep the current one. + +### Personal info + +You can set the user's first name, last name, and email. + +### Permissions + +You can use the checkboxes to activate/deactivate the user; allow this user to access this Django website (`Staff`); give this user all permissions (`Superuser`). + +Permissions to be added to the user. You can either add the user to a group, or assign permissions directly. + +### Important dates + +You can edit important information about logging times and creation date. diff --git a/pages/config-service-configuration/overview.mdx b/pages/config-service-configuration/overview.mdx new file mode 100644 index 00000000..ab6d340d --- /dev/null +++ b/pages/config-service-configuration/overview.mdx @@ -0,0 +1,11 @@ +# Safe Config Service Django configuration + +This document describes how to configure the Config Service through the Django admin panel in a safe way. + +## Overview + +The Config Service is a Django application that allows you to manage configurations for your services. It provides a web interface where you can create, update, and delete configurations, as well as manage groups of permissions to control who can access the configurations. + +It assumes you have already set up your [Safe instance](https://github.com/safe-global/safe-infrastructure). If you haven't, please refer to the [Safe Infrastructure Deployment](/core-api/safe-infrastructure-deployment) guide. + +The following document concerns only the Safe Config Service. For other services of Safe infrastructure, please refer to the [Safe API documentation](/core-api). \ No newline at end of file diff --git a/pages/core-api/_meta.json b/pages/core-api/_meta.json index f94bf715..c67b5b56 100644 --- a/pages/core-api/_meta.json +++ b/pages/core-api/_meta.json @@ -34,5 +34,18 @@ }, "safe-installation-overview": "Overview", "safe-contracts-deployment": "Contracts Deployment", - "safe-infrastructure-deployment": "Infrastructure Deployment" + "safe-infrastructure-deployment": "Infrastructure Deployment", + "-- Safe Config Service": { + "type": "separator", + "title": "Safe Config Service" + }, + "config-service-reference": { + "title": "Configuration", + "href": "/config-service-configuration/overview", + "theme": { + "layout": "full", + "toc": false, + "sidebar": false + } + } } From ffe9e250a00c637183cb522576bf6f7fcce6069e Mon Sep 17 00:00:00 2001 From: louis-md Date: Wed, 29 Jan 2025 17:56:45 +0100 Subject: [PATCH 03/43] Add correct words to Vale allow list --- .github/styles/config/vocabularies/default/accept.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/styles/config/vocabularies/default/accept.txt b/.github/styles/config/vocabularies/default/accept.txt index a9bc51ee..0985cb94 100644 --- a/.github/styles/config/vocabularies/default/accept.txt +++ b/.github/styles/config/vocabularies/default/accept.txt @@ -9,6 +9,7 @@ [Aa][Pp][Ii] [Aa]urora [Aa]rbitrum +[Aa]ccessor [Bb]ackend [Bb]inance [Bb]lockchain @@ -52,6 +53,7 @@ [Pp]olygon [Pp]ostgres [Pp]luggable +[Pp]repended [Qq]uicknode [Qq]uickstarts [Rr]eact From 9a0f3447e2bb5953b85934bb6bd1b44132f5444c Mon Sep 17 00:00:00 2001 From: louis-md Date: Wed, 29 Jan 2025 18:17:28 +0100 Subject: [PATCH 04/43] Add reference to Config service documentation in Infrastructure deployment --- pages/core-api/safe-infrastructure-deployment.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pages/core-api/safe-infrastructure-deployment.mdx b/pages/core-api/safe-infrastructure-deployment.mdx index cf8cda6a..1ce16aa0 100644 --- a/pages/core-api/safe-infrastructure-deployment.mdx +++ b/pages/core-api/safe-infrastructure-deployment.mdx @@ -133,4 +133,6 @@ Open `http://YOUR_CONFIG_SERVICE_DOMAIN/admin` to configure your chain: ![safe-infrastructure-installation-config-service.png](../../assets/safe-infrastructure-installation-config-service.png) +You can find more information on all parameters available in the [Safe Config Service documentation](./config-service-configuration/overview.mdx). + Well done! You now have the Safe Contracts deployed on your chain and the Safe infrastructure up and running. From a5ccca02bbee2d28808b41e9dcf817873e019b6c Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:46:57 +0100 Subject: [PATCH 05/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index 70974fcf..62ae9485 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -10,7 +10,7 @@ You can edit an existing chain by visiting this address: `http://localhost:8000/ ## Parameters -### `ChainId` +### `Chain Id` The unique identifier for the chain. From 8d024bf35d5a5fc90281501e3b5c670b23602a6e Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:47:07 +0100 Subject: [PATCH 06/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index 62ae9485..6e7e898c 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -18,7 +18,7 @@ The unique identifier for the chain. The relative importance of this chain for your project. You can use this value between 0 and 100 to sort chains in the UI. -### `Chain Name` +### `Chain name` The name of the chain, in plain letters. From 80b83e11cf82eee38aa60c3e1cae4911e7c24f9c Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:47:21 +0100 Subject: [PATCH 07/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 4 ---- 1 file changed, 4 deletions(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index 6e7e898c..d53a4057 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -26,10 +26,6 @@ The name of the chain, in plain letters. The short name of the chain, as defined in [EIP-3770](https://eips.ethereum.org/EIPS/eip-3770). This corresponds to the three letters that will be prepended to all addresses on this chain. -### `Password` - -Opens a section to set a password for the user. You can set a new password or leave it blank to keep the current one. - ### `Description` A brief description of the chain. From 55d908024825b8f3071907f6820db901cff74811 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:47:28 +0100 Subject: [PATCH 08/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index d53a4057..441d55c6 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -30,7 +30,7 @@ The short name of the chain, as defined in [EIP-3770](https://eips.ethereum.org/ A brief description of the chain. -### `Chain logo URI` +### `Chain logo uri` The URI of the chain's logo. This will be displayed in the UI. From 36b3761ed265a7636f53d9fcad80ae04e6ad1a40 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:47:41 +0100 Subject: [PATCH 09/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index 441d55c6..a9ce6132 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -32,7 +32,7 @@ A brief description of the chain. ### `Chain logo uri` -The URI of the chain's logo. This will be displayed in the UI. +The chain's logo to upload. This will be displayed in the UI. ### `L2` From bbaf4be99cc5289664574411bbb2962d110df895 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:47:57 +0100 Subject: [PATCH 10/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index a9ce6132..636b426c 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -42,7 +42,7 @@ Whether this chain is a Layer 2 chain. This has important consequences on the in Whether this chain is a testnet. This will be indicated in the UI. -### `RPC authentication` +### `Rpc authentication` Whether the RPC endpoint requires authentication to access its data. If `API key path` is set, the API key will be read from the RPC URI. From ff80a0531d868eff6e5c78933b055a2490ccccae Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:48:21 +0100 Subject: [PATCH 11/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index 636b426c..ba4c47b0 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -44,7 +44,7 @@ Whether this chain is a testnet. This will be indicated in the UI. ### `Rpc authentication` -Whether the RPC endpoint requires authentication to access its data. If `API key path` is set, the API key will be read from the RPC URI. +Whether the RPC endpoint requires authentication to access its data. ### `Rpc uri` From 850cb83778b6a2718bf4ecdc9314c45a2c78960f Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:48:51 +0100 Subject: [PATCH 12/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index ba4c47b0..b2b2f44e 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -50,7 +50,7 @@ Whether the RPC endpoint requires authentication to access its data. The URI of the chain's RPC endpoint. This is the endpoint where the Config Service will fetch the chain's data. -### `Safe Apps RPC authentication` +### `Safe apps rpc authentication` Whether the RPC endpoint dedicated to Safe Apps will require authentication. If `API key path` is set, the API key will be read from the Safe Apps RPC URI. From 47d0ac9b8c5224af0e0c893aea7ab8798220e0d9 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:49:10 +0100 Subject: [PATCH 13/43] Update pages/config-service-configuration/overview.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/overview.mdx b/pages/config-service-configuration/overview.mdx index ab6d340d..d4baf240 100644 --- a/pages/config-service-configuration/overview.mdx +++ b/pages/config-service-configuration/overview.mdx @@ -1,6 +1,6 @@ # Safe Config Service Django configuration -This document describes how to configure the Config Service through the Django admin panel in a safe way. +This document describes how to configure the Config Service through the Django admin panel correctly. ## Overview From f11677b6be3bce99b93364c558e2c37df9016988 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:49:28 +0100 Subject: [PATCH 14/43] Update pages/config-service-configuration/overview.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/overview.mdx b/pages/config-service-configuration/overview.mdx index d4baf240..191b1409 100644 --- a/pages/config-service-configuration/overview.mdx +++ b/pages/config-service-configuration/overview.mdx @@ -4,7 +4,7 @@ This document describes how to configure the Config Service through the Django a ## Overview -The Config Service is a Django application that allows you to manage configurations for your services. It provides a web interface where you can create, update, and delete configurations, as well as manage groups of permissions to control who can access the configurations. +The Config Service is a Django application that allows you to manage configurations for your clients. It provides a web interface where you can create, update, and delete configurations, as well as manage groups of permissions to control who can access the configurations. It assumes you have already set up your [Safe instance](https://github.com/safe-global/safe-infrastructure). If you haven't, please refer to the [Safe Infrastructure Deployment](/core-api/safe-infrastructure-deployment) guide. From b8ca38930c8618e29f83c5ccf945a5494dddbf13 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:50:23 +0100 Subject: [PATCH 15/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index b2b2f44e..7833029c 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -52,7 +52,7 @@ The URI of the chain's RPC endpoint. This is the endpoint where the Config Servi ### `Safe apps rpc authentication` -Whether the RPC endpoint dedicated to Safe Apps will require authentication. If `API key path` is set, the API key will be read from the Safe Apps RPC URI. +Whether the RPC endpoint dedicated to Safe Apps will require authentication. ### `Safe Apps rpc uri` From 2fae26dead81b4acd1af34d512ad5b7148f49fb7 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:50:50 +0100 Subject: [PATCH 16/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index 7833029c..a65f2165 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -58,7 +58,7 @@ Whether the RPC endpoint dedicated to Safe Apps will require authentication. The URI of the chain's RPC endpoint dedicated to Safe Apps. -### `Public RPC authentication` +### `Public rpc authentication` Whether the fallback public RPC endpoint will require authentication. If `API key path` is set, the API key will be read from the Public RPC URI. From 6e1be238141920d72b9ddaa137535966914fce25 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:51:07 +0100 Subject: [PATCH 17/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index a65f2165..e13138db 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -60,7 +60,7 @@ The URI of the chain's RPC endpoint dedicated to Safe Apps. ### `Public rpc authentication` -Whether the fallback public RPC endpoint will require authentication. If `API key path` is set, the API key will be read from the Public RPC URI. +Whether the fallback public RPC endpoint will require authentication. ### `Public rpc uri` From 45f7964f01195fed2816da940bdde201deb4f154 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:51:22 +0100 Subject: [PATCH 18/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index e13138db..68b69f4a 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -96,7 +96,7 @@ The number of decimals of the chain's native currency. ### `Currency logo uri` -The URI of the chain's native currency logo. This will be displayed in the UI. +The chain's native currency logo to upload. This will be displayed in the UI. ### `Transaction service uri` From f659a1a2d4134bff9a0e88cc365116d37efa03b8 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:51:44 +0100 Subject: [PATCH 19/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index 68b69f4a..3af0646c 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -100,7 +100,7 @@ The chain's native currency logo to upload. This will be displayed in the UI. ### `Transaction service uri` -The URI of the chain's [Transaction Service](/core-api/api-safe-transaction-service). This will be used to fetch transaction data from the chain. You will need to deploy one Transaction Service per chain, as well as one `txs-db`, `amqp` and `celery` instances. +The URI of the chain's [Transaction Service](/core-api/api-safe-transaction-service). This will be used to fetch transaction data from the chain. You will need to deploy one Transaction Service per chain, as well as `txs-db`, `amqp` and `celery` instances. ### `Vpc transaction service uri` From bc32161fd4cb98042393a15d5984c87a6d11bcf0 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:52:13 +0100 Subject: [PATCH 20/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index 3af0646c..6209a60b 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -112,7 +112,7 @@ The chain color to display the text in the UI. ### `Theme background color` -The chain color to display the background in the UI. +The hexadecimal chain color to display the background in the UI. ### `Ens registry address` From 5d903285bd7e2ffa17736c2f4562d0202ca30235 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:52:50 +0100 Subject: [PATCH 21/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index 6209a60b..478a7743 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -108,7 +108,7 @@ The URI of the chain's VPC Transaction Service. If you are using a Virtual Priva ### `Theme text color` -The chain color to display the text in the UI. +The hexadecimal chain color to display the text in the UI. ### `Theme background color` From 464eb0148f96d2cbf741c902afe2e4c1a35b6d14 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:53:19 +0100 Subject: [PATCH 22/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index 478a7743..dc20892a 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -152,7 +152,7 @@ The address of the chain's Safe Proxy ### `Multisend address` -The address of the chain's multisend contract. +The address of the chain's MultiSend contract. ### `Multisand call only address` From 8face09edd90f27fc329da7beb2821ed97ddf2db Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:55:21 +0100 Subject: [PATCH 23/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index dc20892a..201cdaba 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -156,7 +156,7 @@ The address of the chain's MultiSend contract. ### `Multisand call only address` -The address of the chain's multisend call only contract. +The address of the chain's MultiSendCallOnly contract. ### `Fallback handler address` From 8516553273893c5ac5134d4342fe071cd852d1c0 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:55:52 +0100 Subject: [PATCH 24/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index 201cdaba..0af19688 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -160,7 +160,7 @@ The address of the chain's MultiSendCallOnly contract. ### `Fallback handler address` -The address of the chain's fallback handler contract. +The address of the chain's FallbackHandler contract. ### `Sign message lib address` From a6ae8b91f23cac5ed163c761e0c6574cd2b17d57 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:56:19 +0100 Subject: [PATCH 25/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index 0af19688..52b6e5c2 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -164,7 +164,7 @@ The address of the chain's FallbackHandler contract. ### `Sign message lib address` -The address of the chain's sign message library contract. +The address of the chain's SignMessageLib contract. ### `Create call address` From 68e8c73cead13f3ab14b2ee90b64b06ee7c3fbf0 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:56:43 +0100 Subject: [PATCH 26/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index 52b6e5c2..faf9dbb9 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -144,7 +144,7 @@ Whether the chain is hidden in the UI. ### `Safe singleton address` -The address of the chain's Safe Singleton. +The address of the chain's Safe singleton. ### `Safe proxy factory address` From 373ce49396c0ab67deb788da53a79fad0093bcbe Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:57:07 +0100 Subject: [PATCH 27/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index faf9dbb9..f1172e68 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -148,7 +148,7 @@ The address of the chain's Safe singleton. ### `Safe proxy factory address` -The address of the chain's Safe Proxy +The address of the chain's Safe ProxyFactory. ### `Multisend address` From 1af8219a06e3796ccba3fb2d06f9b1a337710e96 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:57:46 +0100 Subject: [PATCH 28/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index f1172e68..5067298d 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -168,7 +168,7 @@ The address of the chain's SignMessageLib contract. ### `Create call address` -The address of the chain's create call contract. +The address of the chain's CreateCall contract. ### `Simulate tx accessor address` From 3b7030461b1b20e1601d370d4ebe8dfeb5d1b008 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:58:13 +0100 Subject: [PATCH 29/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index 5067298d..ee815123 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -172,7 +172,7 @@ The address of the chain's CreateCall contract. ### `Simulate tx accessor address` -The address of the chain's simulate transaction accessor contract. +The address of the chain's SimulateTxAccessor contract. ### `Safe web authn signer factory address` From d6941bbb0c9afb2273289fb2f5a0a7835849173d Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 15:58:50 +0100 Subject: [PATCH 30/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index ee815123..666564bd 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -176,7 +176,7 @@ The address of the chain's SimulateTxAccessor contract. ### `Safe web authn signer factory address` -The address of the chain's Safe WebAuthn Signer Factory contract. +The address of the chain's SafeWebAuthnSignerFactory contract. ### Features enabled on this chain From ed71993a840f295b095c7c0d7f37dceab853d595 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 16:00:11 +0100 Subject: [PATCH 31/43] Update pages/config-service-configuration/add-or-edit-gas-price.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-gas-price.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-gas-price.mdx b/pages/config-service-configuration/add-or-edit-gas-price.mdx index af2ed1ea..9761d3ca 100644 --- a/pages/config-service-configuration/add-or-edit-gas-price.mdx +++ b/pages/config-service-configuration/add-or-edit-gas-price.mdx @@ -36,7 +36,7 @@ The relative importance of this gas price to your project. You can use this valu ### `Max fee per gas (wei)` -The maximum fee per gas that will be used to calculate the gas price. This is useful when the oracle returns a gas price that is too high. +The `maxFeePerGas` that will be used to calculate the gas price. This is useful when the oracle returns a gas price that is too high. ### `Max priority fee per gas (wei)` From ba7a3e0657e70e6dbca0be3ec9c2936e29a93ffb Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 16:00:36 +0100 Subject: [PATCH 32/43] Update pages/config-service-configuration/add-or-edit-gas-price.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-gas-price.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-gas-price.mdx b/pages/config-service-configuration/add-or-edit-gas-price.mdx index 9761d3ca..988cc2c7 100644 --- a/pages/config-service-configuration/add-or-edit-gas-price.mdx +++ b/pages/config-service-configuration/add-or-edit-gas-price.mdx @@ -40,4 +40,4 @@ The `maxFeePerGas` that will be used to calculate the gas price. This is useful ### `Max priority fee per gas (wei)` -The maximum priority fee per gas that will be used to calculate the gas price. This is useful when the oracle returns a gas price that is too high. +The `maxPriorityFeePerGas` that will be used to calculate the gas price. This is useful when the oracle returns a gas price that is too high. From f5bac333502b34ad234d0d377034cc00598ec892 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 16:01:16 +0100 Subject: [PATCH 33/43] Update pages/config-service-configuration/add-or-edit-chain.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-chain.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index 666564bd..2e047fc4 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -1,4 +1,4 @@ -# Add or edit chain +# Add or edit chains Add (or edit) a blockchain network. From 8579aa806cff0965cd9aefcc9b5540336c59b949 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 16:01:39 +0100 Subject: [PATCH 34/43] Update pages/config-service-configuration/add-or-edit-client.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-client.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-client.mdx b/pages/config-service-configuration/add-or-edit-client.mdx index 798370ab..84484a6e 100644 --- a/pages/config-service-configuration/add-or-edit-client.mdx +++ b/pages/config-service-configuration/add-or-edit-client.mdx @@ -1,4 +1,4 @@ -# Add or edit clients +# Add or edit Safe App clients Add (or edit) a new client to the configuration, so they can be attributed to Safe Apps. From f0471812bd5a98a418c29f86ab1e04e3cfb21067 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 16:02:12 +0100 Subject: [PATCH 35/43] Update pages/config-service-configuration/add-or-edit-tag.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-tag.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-tag.mdx b/pages/config-service-configuration/add-or-edit-tag.mdx index 66cee3d9..e9b346b8 100644 --- a/pages/config-service-configuration/add-or-edit-tag.mdx +++ b/pages/config-service-configuration/add-or-edit-tag.mdx @@ -1,4 +1,4 @@ -# Add or edit tags +# Add or edit Safe App tags Add (or edit) a new tag to the configuration, so they can be attributed to chains. From d4329ea670f8223dd932744279e5a706f1f09630 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 16:02:26 +0100 Subject: [PATCH 36/43] Update pages/config-service-configuration/add-or-edit-social-profile.mdx Co-authored-by: Aaron Cook --- .../config-service-configuration/add-or-edit-social-profile.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-social-profile.mdx b/pages/config-service-configuration/add-or-edit-social-profile.mdx index e9c9907a..6efbce57 100644 --- a/pages/config-service-configuration/add-or-edit-social-profile.mdx +++ b/pages/config-service-configuration/add-or-edit-social-profile.mdx @@ -1,4 +1,4 @@ -# Add or edit social profiles +# Add or edit Safe App social profiles Add (or edit) a new social profile to the configuration, so they can be attributed to Safe Apps. From ea8bb88928d99bf7a68d805f37f20b7fc93319a3 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 16:02:49 +0100 Subject: [PATCH 37/43] Update pages/config-service-configuration/add-or-edit-feature.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-feature.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-feature.mdx b/pages/config-service-configuration/add-or-edit-feature.mdx index dbd53490..26b683e0 100644 --- a/pages/config-service-configuration/add-or-edit-feature.mdx +++ b/pages/config-service-configuration/add-or-edit-feature.mdx @@ -1,4 +1,4 @@ -# Add or edit features +# Add or edit chain features Add (or edit) a new feature to the configuration, so they can be attributed to chains. From 5c5fe9d9353ab64b34ea736a8f7158a23b1f25e1 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 16:03:10 +0100 Subject: [PATCH 38/43] Update pages/config-service-configuration/add-or-edit-gas-price.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-gas-price.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-gas-price.mdx b/pages/config-service-configuration/add-or-edit-gas-price.mdx index 988cc2c7..98237cd2 100644 --- a/pages/config-service-configuration/add-or-edit-gas-price.mdx +++ b/pages/config-service-configuration/add-or-edit-gas-price.mdx @@ -1,4 +1,4 @@ -# Add or edit gas prices +# Add or edit chain gas prices Add (or edit) a new gas price to the configuration, so they can be attributed to chains. From 364082506bec068189419c430205ba8148981e57 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 16:03:31 +0100 Subject: [PATCH 39/43] Update pages/config-service-configuration/add-or-edit-group.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-group.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-group.mdx b/pages/config-service-configuration/add-or-edit-group.mdx index c9272b5d..87e0b061 100644 --- a/pages/config-service-configuration/add-or-edit-group.mdx +++ b/pages/config-service-configuration/add-or-edit-group.mdx @@ -1,4 +1,4 @@ -# Add or edit group +# Add or edit user groups Add (or edit) a new group of permissions to the configuration, so they can be attributed to users. From 1818497554f413130cf9f71cba39cee64968ba87 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 16:03:56 +0100 Subject: [PATCH 40/43] Update pages/config-service-configuration/add-or-edit-provider.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-provider.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-provider.mdx b/pages/config-service-configuration/add-or-edit-provider.mdx index d038d19f..8a202524 100644 --- a/pages/config-service-configuration/add-or-edit-provider.mdx +++ b/pages/config-service-configuration/add-or-edit-provider.mdx @@ -1,4 +1,4 @@ -# Add or edit providers +# Add or edit Safe App providers Add (or edit) a new provider to the configuration, so they can be attributed to Safe Apps. From 9b1265e362d4bff8d8c82fe8d9b856fbe099db96 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 16:04:37 +0100 Subject: [PATCH 41/43] Update pages/config-service-configuration/add-or-edit-provider.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-provider.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-provider.mdx b/pages/config-service-configuration/add-or-edit-provider.mdx index 8a202524..5bd6a8bd 100644 --- a/pages/config-service-configuration/add-or-edit-provider.mdx +++ b/pages/config-service-configuration/add-or-edit-provider.mdx @@ -12,7 +12,7 @@ You can edit an existing provider by visiting this address: `http://localhost:80 ### `Url` -The URL the provider is hosted at. +The URL the provider. ### `Name` From 5d189ec78470b07cf8d1d654a803b6a1e3bf2005 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 16:04:56 +0100 Subject: [PATCH 42/43] Update pages/config-service-configuration/add-or-edit-safe-app.mdx Co-authored-by: Aaron Cook --- pages/config-service-configuration/add-or-edit-safe-app.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/config-service-configuration/add-or-edit-safe-app.mdx b/pages/config-service-configuration/add-or-edit-safe-app.mdx index 4e8c4220..76da4608 100644 --- a/pages/config-service-configuration/add-or-edit-safe-app.mdx +++ b/pages/config-service-configuration/add-or-edit-safe-app.mdx @@ -24,7 +24,7 @@ The name of the Safe App. ### `Icon url` -The URL of the icon of the Safe App. +The icon of the Safe App to upload. ### `Description` From 6585defc3626a8c1bc8b08c66fc7ab01b2204250 Mon Sep 17 00:00:00 2001 From: louis-md Date: Fri, 31 Jan 2025 16:59:05 +0100 Subject: [PATCH 43/43] Implement requested changes --- .github/styles/config/vocabularies/default/accept.txt | 1 + .../config-service-configuration/add-or-edit-chain.mdx | 10 +++++----- .../add-or-edit-wallet.mdx | 2 +- 3 files changed, 7 insertions(+), 6 deletions(-) diff --git a/.github/styles/config/vocabularies/default/accept.txt b/.github/styles/config/vocabularies/default/accept.txt index 0985cb94..4d3f106d 100644 --- a/.github/styles/config/vocabularies/default/accept.txt +++ b/.github/styles/config/vocabularies/default/accept.txt @@ -258,6 +258,7 @@ Xai XDC YouTube Zengo +Zerion ZetaChain Zilliqa Zircuit diff --git a/pages/config-service-configuration/add-or-edit-chain.mdx b/pages/config-service-configuration/add-or-edit-chain.mdx index 2e047fc4..dd27b57e 100644 --- a/pages/config-service-configuration/add-or-edit-chain.mdx +++ b/pages/config-service-configuration/add-or-edit-chain.mdx @@ -24,7 +24,7 @@ The name of the chain, in plain letters. ### `EIP-3770 short name` -The short name of the chain, as defined in [EIP-3770](https://eips.ethereum.org/EIPS/eip-3770). This corresponds to the three letters that will be prepended to all addresses on this chain. +The short name of the chain, as defined in [EIP-3770](https://eips.ethereum.org/EIPS/eip-3770). This corresponds to the letters that will be prepended to all addresses on this chain. ### `Description` @@ -36,7 +36,7 @@ The chain's logo to upload. This will be displayed in the UI. ### `L2` -Whether this chain is a Layer 2 chain. This has important consequences on the indexing ability of the chain. If this chain is an Ethereum Layer 2, not checking this box will increase the indexing time, hence possibly missing the correct indexing of some transactions. +Whether this chain is a Layer 2 chain. ### `Is testnet` @@ -48,7 +48,7 @@ Whether the RPC endpoint requires authentication to access its data. ### `Rpc uri` -The URI of the chain's RPC endpoint. This is the endpoint where the Config Service will fetch the chain's data. +The URI of the chain's RPC endpoint. ### `Safe apps rpc authentication` @@ -128,11 +128,11 @@ The native coin used by the chain's price provider. ### `Prices provider chain name` -The name of the chain's price provider. +The name of the chain on CoinGecko. ### `Balances provider chain name` -The name of the chain's balances provider. +The name of the chain on Zerion. (Not implemented.) ### `Balances provider enabled` diff --git a/pages/config-service-configuration/add-or-edit-wallet.mdx b/pages/config-service-configuration/add-or-edit-wallet.mdx index d6abb6b8..b0327245 100644 --- a/pages/config-service-configuration/add-or-edit-wallet.mdx +++ b/pages/config-service-configuration/add-or-edit-wallet.mdx @@ -1,6 +1,6 @@ # Add or edit wallets -Add (or edit) a new wallet to the configuration, so they can be attributed to chains. +Add (or edit) a new wallet to the configuration, so they can be attributed to chains. This will enable the use of these wallets for these chains on (Web3 Onboard)(https://onboard.blocknative.com/docs/overview/introduction). ## Usage