diff --git a/docs/faq/onboarding/tools-and-services.md b/docs/faq/onboarding/tools-and-services.md index 6c48a20291..047d5ba060 100644 --- a/docs/faq/onboarding/tools-and-services.md +++ b/docs/faq/onboarding/tools-and-services.md @@ -12,7 +12,7 @@ If you want to experiment with simple code snippets for LSPs, please look at the ## Which tools can be used to develop dApps on LUKSO? -We have a [full set of tools](../../tools/getting-started/) and libraries that you can use to build on LSPs and interact with Universal Profiles. You can also [install the latest Universal Profile Extension](/install-up-browser-extension) to connect Universal Profiles with dApps. +We have a [full set of tools](../../tools/libraries/getting-started/) and libraries that you can use to build on LSPs and interact with Universal Profiles. You can also [install the latest Universal Profile Extension](/install-up-browser-extension) to connect Universal Profiles with dApps. ## Where can I get LYXt for test deployments? diff --git a/docs/learn/digital-assets/.assets.md b/docs/learn/digital-assets/.assets.md index bf3de926cf..aff145b866 100644 --- a/docs/learn/digital-assets/.assets.md +++ b/docs/learn/digital-assets/.assets.md @@ -241,7 +241,7 @@ The `generateLSP4JSONVerifiableURI` will return you directly what needs to be se ## Encode the LSP4 Metadata -To encode the LSP4 Metadata with ease, you can use the πŸ› οΈ [`erc725.js`](../../tools/erc725js/getting-started.md) library. The tool provides all necessary LSP Schemas and the `encodeData()` function. +To encode the LSP4 Metadata with ease, you can use the πŸ› οΈ [`erc725.js`](../../tools/libraries/erc725js/getting-started.md) library. The tool provides all necessary LSP Schemas and the `encodeData()` function. ```js import { ERC725 } from '@erc725/erc725.js'; diff --git a/docs/learn/digital-assets/getting-started.md b/docs/learn/digital-assets/getting-started.md index 6d034cc54b..b793550349 100644 --- a/docs/learn/digital-assets/getting-started.md +++ b/docs/learn/digital-assets/getting-started.md @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem'; # Getting started building Tokens & NFTs -The LUKSO ecosystem offers smart contract developers a lot of [new standards](../../standards/introduction.md) and [tools](../../tools/getting-started.md) to build **powerful, modular, and standardized** blockchain applications. +The LUKSO ecosystem offers smart contract developers a lot of [new standards](../../standards/introduction.md) and [tools](../../tools/libraries/getting-started.md) to build **powerful, modular, and standardized** blockchain applications. This page will guide you in setting up your development environment to build and deploy tokens and NFTs on LUKSO. diff --git a/docs/learn/digital-assets/metadata-management/metadata-preparation.md b/docs/learn/digital-assets/metadata-management/metadata-preparation.md index 7238cea1b7..4c17ae96c8 100644 --- a/docs/learn/digital-assets/metadata-management/metadata-preparation.md +++ b/docs/learn/digital-assets/metadata-management/metadata-preparation.md @@ -121,7 +121,7 @@ To implement Cascade and Sense support, you can reference [this](./cascade-and-s :::tip Convenience Tool -You can use the πŸ› οΈ [`erc725.js`](../../../tools/erc725js/getting-started.md) library +You can use the πŸ› οΈ [`erc725.js`](../../../tools/libraries/erc725js/getting-started.md) library to encode the LSP4 Metadata. The tool provides all necessary LSP schemas as well as the `encodeData()` function. ::: diff --git a/docs/learn/digital-assets/metadata-management/read-asset-data.md b/docs/learn/digital-assets/metadata-management/read-asset-data.md index 383d0710b2..7d864a9488 100644 --- a/docs/learn/digital-assets/metadata-management/read-asset-data.md +++ b/docs/learn/digital-assets/metadata-management/read-asset-data.md @@ -61,7 +61,7 @@ npm i @lukso/lsp-smart-contracts @erc725/erc725.js :::info -If you are using the πŸ“ƒ [lsp-smart-contracts](../../../tools/lsp-smart-contracts/getting-started) library, you can fetch the list of `interfaceId` directly from the package's [constants](../../../tools/lsp-smart-contracts/constants) called `INTERFACE_IDS`. +If you are using the πŸ“ƒ [lsp-smart-contracts](../../../tools/libraries/lsp-smart-contracts/getting-started) library, you can fetch the list of `interfaceId` directly from the package's [constants](../../../tools/libraries/lsp-smart-contracts/constants) called `INTERFACE_IDS`. Optionally, you can also find a full list of interface IDs on the [Contracts > Interface ID](https://docs.lukso.tech/contracts/interface-ids/) page and input them manually. @@ -176,7 +176,7 @@ The following data keys can be fetched πŸ‘‡ | `LSP4TokenSymbol` | The utf8 hex characters of the string representing the asset's symbol. | | `LSP4TokenName` | The utf8 hex characters of the string representing the asset's name. | -To retrieve and decode the value stored under this data keys, we will use [erc725.js](../../../tools/erc725js/getting-started.md) and instantiate the class with: +To retrieve and decode the value stored under this data keys, we will use [erc725.js](../../../tools/libraries/erc725js/getting-started.md) and instantiate the class with: 1. the LSP4 Schema that defines the data keys above and how to decode them 2. the address of your digital asset @@ -200,9 +200,9 @@ const erc725js = new ERC725( We can fetch the digital asset data in three ways: -1. using [`getData()`](../../../tools/erc725js/methods#getdata) without parameters. This will fetch the value of all data keys at once. +1. using [`getData()`](../../../tools/libraries/erc725js/methods#getdata) without parameters. This will fetch the value of all data keys at once. 2. using `getData("DataKeyName")` to fetch the value of a specific data key. For instance `getData("LSP4Metadata")`. -3. using [`fetchData('LSP4Metadata')`](../../../tools/erc725js/methods.md#fetchdata) which decodes the `VerifiableURI` to extract the JSON metadata file link and fetch its content from IPFS (or another storage service). +3. using [`fetchData('LSP4Metadata')`](../../../tools/libraries/erc725js/methods.md#fetchdata) which decodes the `VerifiableURI` to extract the JSON metadata file link and fetch its content from IPFS (or another storage service). ### Asset Name and Symbol @@ -232,10 +232,10 @@ console.log(tokenSymbol); ### Global Token Information -To fetch the whole JSON file of the asset's metadata, you can use the following 2 functions of the [`erc725js`](../../../tools/erc725js/getting-started.md) library: +To fetch the whole JSON file of the asset's metadata, you can use the following 2 functions of the [`erc725js`](../../../tools/libraries/erc725js/getting-started.md) library: -- [`fetchData('LSP4Metadata')`](../../../tools/erc725js/methods.md#fetchdata): This will download and decode the content of `VerifiableURI` as JSON. -- [`getData(LSP4Metadata)`](../../../tools/erc725js/methods#getdata): This will retrieve the raw data value from the smart contract. You will then need to decode the `VerifiableURI` maunually using [`decodeData(...)`](../../../tools/erc725js/methods.md#decodedata). +- [`fetchData('LSP4Metadata')`](../../../tools/libraries/erc725js/methods.md#fetchdata): This will download and decode the content of `VerifiableURI` as JSON. +- [`getData(LSP4Metadata)`](../../../tools/libraries/erc725js/methods#getdata): This will retrieve the raw data value from the smart contract. You will then need to decode the `VerifiableURI` maunually using [`decodeData(...)`](../../../tools/libraries/erc725js/methods.md#decodedata). ```ts // Download and verify the asset metadata JSON file diff --git a/docs/learn/digital-assets/nft/read-nft-metadata.md b/docs/learn/digital-assets/nft/read-nft-metadata.md index b744838083..9ad6738b08 100644 --- a/docs/learn/digital-assets/nft/read-nft-metadata.md +++ b/docs/learn/digital-assets/nft/read-nft-metadata.md @@ -29,8 +29,8 @@ If neither _Token ID Metadata_ nor _Base URI_ are set, you should fall back and We will need the following dependencies to follow this guide: -- [`lsp-smart-contracts`](../../../tools/lsp-smart-contracts/getting-started.md) to import the LSP8 contract ABI. -- [`erc725.js`](../../../tools/erc725js/getting-started.md) to easily get [ERC725Y](../../../standards/lsp-background/erc725.md) data keys and decode their values. +- [`lsp-smart-contracts`](../../../tools/libraries/lsp-smart-contracts/getting-started.md) to import the LSP8 contract ABI. +- [`erc725.js`](../../../tools/libraries/erc725js/getting-started.md) to easily get [ERC725Y](../../../standards/lsp-background/erc725.md) data keys and decode their values. @@ -385,7 +385,7 @@ After retrieving the metadata from the contract, you can continue to [retrieve t :::caution Version Support -Assets created with LSP versions below πŸ› οΈ [`@lukso/lsp-smart-contracts`](../../../tools/lsp-smart-contracts/getting-started.md) of `v0.14.0` lack support for retrieving token ID metadata from a Base URI. For previous LSP8 assets, the Base URI may be retrievable by calling the [`fetchData`](../../../tools/erc725js/methods.md#fetchdata) function as described in the [Global Token Information](#global-token-information) section. +Assets created with LSP versions below πŸ› οΈ [`@lukso/lsp-smart-contracts`](../../../tools/libraries/lsp-smart-contracts/getting-started.md) of `v0.14.0` lack support for retrieving token ID metadata from a Base URI. For previous LSP8 assets, the Base URI may be retrievable by calling the [`fetchData`](../../../tools/libraries/erc725js/methods.md#fetchdata) function as described in the [Global Token Information](#global-token-information) section. ::: diff --git a/docs/learn/digital-assets/nft/set-nft-metadata.md b/docs/learn/digital-assets/nft/set-nft-metadata.md index 8b0e095a34..17ca96883a 100644 --- a/docs/learn/digital-assets/nft/set-nft-metadata.md +++ b/docs/learn/digital-assets/nft/set-nft-metadata.md @@ -115,7 +115,7 @@ The next step is to encode the metadata. To do so, we need: - a JSON file that contains all the metadata of the specific NFT. This metadata has the same format as the `LSP4Metadata`. - the IPFS url where this JSON file has been uploaded -The value will be encoded as a `VerifiableURI`. We will use the `encodeData` function from the [_erc725.js_](../../../tools/erc725js/methods.md#encodedata) library to encode a `VerifiableURI` easily. +The value will be encoded as a `VerifiableURI`. We will use the `encodeData` function from the [_erc725.js_](../../../tools/libraries/erc725js/methods.md#encodedata) library to encode a `VerifiableURI` easily. ```js title="encodeVerifiableURI.ts" import { ERC725 } from '@erc725/erc725.js'; diff --git a/docs/learn/digital-assets/retrieve-token-type.md b/docs/learn/digital-assets/retrieve-token-type.md index 231bd33b89..552820e0d1 100644 --- a/docs/learn/digital-assets/retrieve-token-type.md +++ b/docs/learn/digital-assets/retrieve-token-type.md @@ -24,9 +24,9 @@ Token Types are beneficial because of the wide range of asset use cases. The [LS :::tip Convenience Tools -You can use the βš’οΈ [`erc725.js`](../../tools/erc725js/getting-started.md) library, which automatically decodes [ERC725Y](../../standards/lsp-background/erc725.md#erc725y-generic-data-keyvalue-store) storage keys for you. +You can use the βš’οΈ [`erc725.js`](../../tools/libraries/erc725js/getting-started.md) library, which automatically decodes [ERC725Y](../../standards/lsp-background/erc725.md#erc725y-generic-data-keyvalue-store) storage keys for you. -If you are using a regular contract instance from Ethers or Web3, you can use the data keys from the [`lsp-smart-contracts`](../../tools/lsp-smart-contracts/getting-started.md) library by importing the `ERC725YDataKeys` constant. +If you are using a regular contract instance from Ethers or Web3, you can use the data keys from the [`lsp-smart-contracts`](../../tools/libraries/lsp-smart-contracts/getting-started.md) library by importing the `ERC725YDataKeys` constant. ::: diff --git a/docs/learn/digital-assets/token/create-lsp7-token.md b/docs/learn/digital-assets/token/create-lsp7-token.md index 3c39ee8dd8..68fb38c91c 100644 --- a/docs/learn/digital-assets/token/create-lsp7-token.md +++ b/docs/learn/digital-assets/token/create-lsp7-token.md @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem'; # πŸͺ™ Create a LSP7 Token -This guide will walk you through the process of creating and deploying a custom [LSP7 Digital Asset](../../../standards/tokens/LSP7-Digital-Asset.md) and pre-mint a certain amount of tokens to the token owner. To build a smart contract using LSPs, you can **inherit functionality** from modular and standardized presets in the [`@lukso/lsp-smart-contracts`](../../../tools/lsp-smart-contracts/getting-started.md) library. To learn more about the contract standards itself, please refer to the [Contracts section](../../../contracts/introduction.md) of our documentation. +This guide will walk you through the process of creating and deploying a custom [LSP7 Digital Asset](../../../standards/tokens/LSP7-Digital-Asset.md) and pre-mint a certain amount of tokens to the token owner. To build a smart contract using LSPs, you can **inherit functionality** from modular and standardized presets in the [`@lukso/lsp-smart-contracts`](../../../tools/libraries/lsp-smart-contracts/getting-started.md) library. To learn more about the contract standards itself, please refer to the [Contracts section](../../../contracts/introduction.md) of our documentation. :::tip diff --git a/docs/learn/migrate/migrate-erc20-to-lsp7.md b/docs/learn/migrate/migrate-erc20-to-lsp7.md index 85e1b38b07..1274d9866a 100644 --- a/docs/learn/migrate/migrate-erc20-to-lsp7.md +++ b/docs/learn/migrate/migrate-erc20-to-lsp7.md @@ -245,9 +245,9 @@ const symbol = ethers.toUtf8String(symbolValue); // UP725 -You can also obtain the full schema with all the definitions from our [`@erc725/erc725.js`](../../tools/erc725js/getting-started.md) library. **This library will also help you to [encode easily](../../tools/erc725js/methods.md#encodedata) data key value pairs.** +You can also obtain the full schema with all the definitions from our [`@erc725/erc725.js`](../../tools/libraries/erc725js/getting-started.md) library. **This library will also help you to [encode easily](../../tools/libraries/erc725js/methods.md#encodedata) data key value pairs.** -You can also import the [full schema definition](../../tools/erc725js/schemas.md) of the LSP4 Metadata from `@erc725/erc725.js`. The library can also provide convenience for fetching, encoding and decoding. +You can also import the [full schema definition](../../tools/libraries/erc725js/schemas.md) of the LSP4 Metadata from `@erc725/erc725.js`. The library can also provide convenience for fetching, encoding and decoding. diff --git a/docs/learn/migrate/migrate-erc721-to-lsp8.md b/docs/learn/migrate/migrate-erc721-to-lsp8.md index 1fff31f5f2..5da8bf1336 100644 --- a/docs/learn/migrate/migrate-erc721-to-lsp8.md +++ b/docs/learn/migrate/migrate-erc721-to-lsp8.md @@ -247,7 +247,7 @@ const symbol = ethers.toUtf8String(symbolValue); // COOL -You can also obtain the [full schema definition](../../tools/erc725js/schemas.md) of the LSP4 Metadata from [`@erc725/erc725.js`](../../tools/erc725js/getting-started.md) library. **This library will also help you to [encode easily](../../tools/erc725js/methods.md#encodedata) data key value pairs.** +You can also obtain the [full schema definition](../../tools/libraries/erc725js/schemas.md) of the LSP4 Metadata from [`@erc725/erc725.js`](../../tools/libraries/erc725js/getting-started.md) library. **This library will also help you to [encode easily](../../tools/libraries/erc725js/methods.md#encodedata) data key value pairs.** ```javascript import { ERC725 } from '@erc725/erc725.js'; diff --git a/docs/learn/standard-detection.md b/docs/learn/standard-detection.md index 869f8b070d..932358275c 100644 --- a/docs/learn/standard-detection.md +++ b/docs/learn/standard-detection.md @@ -32,7 +32,7 @@ npm install web3 @erc725/erc725.js @lukso/lsp-smart-contracts ## Metadata Detection -You can verify if a contract contains a specific set of [ERC725Y](../standards/lsp-background/erc725#erc725y-generic-data-keyvalue-store) keys by checking the value stored under the ERC725Y storage key `SupportedStandards:{StandardName}` using the [erc725.js](../tools/erc725js/getting-started.md) library. +You can verify if a contract contains a specific set of [ERC725Y](../standards/lsp-background/erc725#erc725y-generic-data-keyvalue-store) keys by checking the value stored under the ERC725Y storage key `SupportedStandards:{StandardName}` using the [erc725.js](../tools/libraries/erc725js/getting-started.md) library. :::note Example @@ -40,7 +40,7 @@ You can verify if a contract contains a specific set of [ERC725Y](../standards/l ::: -Similar to the [Read Profile Data Guide](./universal-profile/metadata/read-profile-data.md), you can use the [`getData()`](../tools/erc725js/methods.md#getdata) function to check if the contract has a specific metadata standard like [LSP3 Profile](../standards/universal-profile/lsp3-profile-metadata), [LSP4 Digital Asset](../standards/tokens/LSP4-Digital-Asset-Metadata) or a [LSP9 Vault](../standards/universal-profile/lsp9-vault). +Similar to the [Read Profile Data Guide](./universal-profile/metadata/read-profile-data.md), you can use the [`getData()`](../tools/libraries/erc725js/methods.md#getdata) function to check if the contract has a specific metadata standard like [LSP3 Profile](../standards/universal-profile/lsp3-profile-metadata), [LSP4 Digital Asset](../standards/tokens/LSP4-Digital-Asset-Metadata) or a [LSP9 Vault](../standards/universal-profile/lsp9-vault). ### Example 1 - Detect LSP3 Profile data keys diff --git a/docs/learn/universal-profile/advanced-guides/deploy-up-with-lsp23.md b/docs/learn/universal-profile/advanced-guides/deploy-up-with-lsp23.md index d6f47f64a3..d8e8c75fce 100644 --- a/docs/learn/universal-profile/advanced-guides/deploy-up-with-lsp23.md +++ b/docs/learn/universal-profile/advanced-guides/deploy-up-with-lsp23.md @@ -175,7 +175,7 @@ async function main() { #### Create the permissions data keys and data values -In order to create all the permissions data keys and data values, we will use the [`@erc725/erc725.js`](../../../tools/erc725js/getting-started.md) library. This library is a JavaScript implementation to encode and decode data key and values easily from any ERC725Y contract storage. +In order to create all the permissions data keys and data values, we will use the [`@erc725/erc725.js`](../../../tools/libraries/erc725js/getting-started.md) library. This library is a JavaScript implementation to encode and decode data key and values easily from any ERC725Y contract storage. ```typescript async function main() { diff --git a/docs/learn/universal-profile/getting-started.md b/docs/learn/universal-profile/getting-started.md index db533c4900..4ef3a5d114 100644 --- a/docs/learn/universal-profile/getting-started.md +++ b/docs/learn/universal-profile/getting-started.md @@ -58,7 +58,7 @@ You can also create new [Universal Profiles](../../standards/universal-profile/i :::tip Relayer API -If you want to deploy Universal Profiles for your users, please check out our [Relayer API](../../tools/relayer-developer.md). +If you want to deploy Universal Profiles for your users, please check out our [Relayer API](../../tools/services/relayer-developer.md). ::: diff --git a/docs/learn/universal-profile/interactions/batch-transactions.md b/docs/learn/universal-profile/interactions/batch-transactions.md index b102e7cac6..fa7e349425 100644 --- a/docs/learn/universal-profile/interactions/batch-transactions.md +++ b/docs/learn/universal-profile/interactions/batch-transactions.md @@ -681,7 +681,7 @@ For this, we will encode the constructor parameters used when deploying the toke 2. set the metadata on the token contract. -For this we will first encode the `LSP4Metadata` using the [`erc725.js`](../../../tools/erc725js/getting-started.md) library. We will then generate the payload to call `setData` on the token contract using this encoded parameter. +For this we will first encode the `LSP4Metadata` using the [`erc725.js`](../../../tools/libraries/erc725js/getting-started.md) library. We will then generate the payload to call `setData` on the token contract using this encoded parameter. > _"How can we set the token metadata if we don't know the deployed token address yet?"_ > diff --git a/docs/learn/universal-profile/key-manager/execute-relay-transactions.md b/docs/learn/universal-profile/key-manager/execute-relay-transactions.md index 36cfa650f2..b0929eff3c 100644 --- a/docs/learn/universal-profile/key-manager/execute-relay-transactions.md +++ b/docs/learn/universal-profile/key-manager/execute-relay-transactions.md @@ -267,7 +267,7 @@ For more information regarding the construction of an LSP25 signature, see [**"S The next step for the client side is to sign the transaction message. This is done using the private key of a controller that has some permission on the Universal Profile to execute the transaction on, without needing us to pay for the gas. -To do that, we will use our convenience library [_eip191-signer_](../../../tools/eip191-signerjs/getting-started.md) which make the signing for us. +To do that, we will use our convenience library [_eip191-signer_](../../../tools/libraries/eip191-signerjs/getting-started.md) which make the signing for us. The transaction message is constructed by encoding and signing the following: diff --git a/docs/learn/universal-profile/key-manager/get-controller-permissions.md b/docs/learn/universal-profile/key-manager/get-controller-permissions.md index ee5fc3c8a0..e5ff8804e7 100644 --- a/docs/learn/universal-profile/key-manager/get-controller-permissions.md +++ b/docs/learn/universal-profile/key-manager/get-controller-permissions.md @@ -24,7 +24,7 @@ Alongside each controller, we will also retrieve their associated permissions. A ## Setup -We will use the [`erc725.js`](../../../tools/erc725js/getting-started.md) library to easily query and decode the [`AddressPermissions[]`](../../../standards/universal-profile/lsp6-key-manager.md#retrieving-list-of-controllers) and [`AddressPermissions:Permissions:`](../../../standards/universal-profile/lsp6-key-manager.md#address-permissions) data keys on the Universal Profile. +We will use the [`erc725.js`](../../../tools/libraries/erc725js/getting-started.md) library to easily query and decode the [`AddressPermissions[]`](../../../standards/universal-profile/lsp6-key-manager.md#retrieving-list-of-controllers) and [`AddressPermissions:Permissions:`](../../../standards/universal-profile/lsp6-key-manager.md#address-permissions) data keys on the Universal Profile. ```bash npm install @erc725/erc725.js @@ -55,7 +55,7 @@ const erc725 = new ERC725( ## Step 2 - Get the list of controllers -You can now simply query the [`AddressPermissions[]`](../../../standards/universal-profile/lsp6-key-manager.md#retrieving-addresses-with-permissions) data key with the [`getData('AddressPermissions[]')`](../../../tools/erc725js/methods.md#getdata) function from _erc725.js_. This will return you an array of addresses. +You can now simply query the [`AddressPermissions[]`](../../../standards/universal-profile/lsp6-key-manager.md#retrieving-addresses-with-permissions) data key with the [`getData('AddressPermissions[]')`](../../../tools/libraries/erc725js/methods.md#getdata) function from _erc725.js_. This will return you an array of addresses. ```js title="Retrieve the list of addresses that have some permissions on the πŸ†™." async function getPermissionedAddresses() { @@ -81,7 +81,7 @@ async function getPermissionedAddresses() { @@ -145,7 +145,7 @@ async function getPermissionedAddresses() { The `value` above `0x0000...0008` in the object does not give us a lot of information. This is because **permissions are encoded as a [`BitArray`](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-2-ERC725YJSONSchema.md#BitArray)**. -Luckily, we don't need to understand the complexity behind the scene to understand the permissions that are set. After retrieving these encoded permission values, we can use again the [`decodePermissions(...)`](../../../tools/erc725js/methods#decodepermissions) function from the [_erc725.js_](../../../tools/erc725js/getting-started.md) library to decode them easily. +Luckily, we don't need to understand the complexity behind the scene to understand the permissions that are set. After retrieving these encoded permission values, we can use again the [`decodePermissions(...)`](../../../tools/libraries/erc725js/methods#decodepermissions) function from the [_erc725.js_](../../../tools/libraries/erc725js/getting-started.md) library to decode them easily. The function returns an object showing which permissions the controller has with `true` or `false`. diff --git a/docs/learn/universal-profile/key-manager/grant-permissions.md b/docs/learn/universal-profile/key-manager/grant-permissions.md index 35b758bded..304e787b18 100644 --- a/docs/learn/universal-profile/key-manager/grant-permissions.md +++ b/docs/learn/universal-profile/key-manager/grant-permissions.md @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem'; This guide will teach you how to grant [permissions](../../../standards/universal-profile/lsp6-key-manager.md#address-permissions) to any address so they can interact with your πŸ†™. You will learn: -- How permissions in the LSP6 Key Manager work + how to create them using [_erc725.js_](../../../tools/erc725js/getting-started.md). +- How permissions in the LSP6 Key Manager work + how to create them using [_erc725.js_](../../../tools/libraries/erc725js/getting-started.md). - How to set permissions for a third party `address` on your Universal Profile ![Give permissions to 3rd parties overview](/img/guides/lsp6/grant-permissions-to-3rd-parties-overview.jpeg) @@ -40,8 +40,8 @@ These permissions are stored in theΒ Universal Profile. **We need to update thre To follow this guide, we will need the following libraries and packages: -- [`erc725.js`](../../../tools/erc725js/getting-started.md) to encode the permissions -- The [`lsp-smart-contracts`](../../../tools/lsp-smart-contracts/getting-started.md) package to get the [Universal Profile's ABI](../../../standards/universal-profile/introduction.md) +- [`erc725.js`](../../../tools/libraries/erc725js/getting-started.md) to encode the permissions +- The [`lsp-smart-contracts`](../../../tools/libraries/lsp-smart-contracts/getting-started.md) package to get the [Universal Profile's ABI](../../../standards/universal-profile/introduction.md) - `web3.js` or `ethers.js` to interact with our `UniversalProfile` smart contract. @@ -84,7 +84,7 @@ const erc725 = new ERC725( :::success Permissions List -More permissions are available in _erc725.js_. See the [`encodePermissions(...)`](../../../tools/erc725js/methods.md#encodepermissions) function for a complete list. +More permissions are available in _erc725.js_. See the [`encodePermissions(...)`](../../../tools/libraries/erc725js/methods.md#encodepermissions) function for a complete list. To learn about what each permission enables, see the [**Standards > LSP6 Key Manager > Permissions**](../../../standards/universal-profile/lsp6-key-manager.md#permissions) section. @@ -92,7 +92,7 @@ To learn about what each permission enables, see the [**Standards > LSP6 Key Man Let's consider in our example that we want to grant the permission `SUPER_SETDATA` to a `beneficiaryAddress`, so that it can edit any of the Universal Profile metadata. -To do so, we will use the [`encodePermissions(..)`](../../../tools/erc725js/methods#encodepermissions) function, a convenience function from the _erc725.js_ library to encode permissions as their raw `bytes32` value. The function takes as an input will an object of all permissions that will be set. +To do so, we will use the [`encodePermissions(..)`](../../../tools/libraries/erc725js/methods#encodepermissions) function, a convenience function from the _erc725.js_ library to encode permissions as their raw `bytes32` value. The function takes as an input will an object of all permissions that will be set. ```ts // Create the permissions for our future controller diff --git a/docs/learn/universal-profile/metadata/edit-profile.md b/docs/learn/universal-profile/metadata/edit-profile.md index b5f6034ae6..c45d6f1594 100644 --- a/docs/learn/universal-profile/metadata/edit-profile.md +++ b/docs/learn/universal-profile/metadata/edit-profile.md @@ -16,7 +16,7 @@ To achieve this goal, we will perform the following steps: 1. Create a JSON file that contains your profile details (`LSP3Profile` metadata). 2. Upload this JSON file to [IPFS] using our [tools-data-providers](https://github.com/lukso-network/tools-data-providers) library. -3. Set your new [profile metadata](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-3-Profile-Metadata.md#lsp3profile) key to your Universal Profile with our [erc725.js](../../../tools/erc725js/getting-started.md) library and `web3.js`. +3. Set your new [profile metadata](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-3-Profile-Metadata.md#lsp3profile) key to your Universal Profile with our [erc725.js](../../../tools/libraries/erc725js/getting-started.md) library and `web3.js`. ![Universal Profile with pictures and infos on wallet.universalprofile.cloud](../img/edit-profile.png) @@ -198,7 +198,7 @@ To do so, we will use our [erc725.js] library, which helps us encode the data ea Once our erc725.js is initialized, we can encode the `LSP3Profile` data to generate a key and a value. -To do so, we use the [`encodeData()`](../../../tools/erc725js/methods.md#encodeData) function. We call it with an object containing the `keyName` and the `value`: +To do so, we use the [`encodeData()`](../../../tools/libraries/erc725js/methods.md#encodeData) function. We call it with an object containing the `keyName` and the `value`: - `keyName`: `LSP3Profile`, the name of the key we want to encode. - `value`: an object with: @@ -301,7 +301,7 @@ You can now check your UP on the [profile explorer](https://universalprofile.clo `https://wallet.universalprofile.cloud/[UP ADDRESS]?network=testnet` -[erc725.js]: ../../../tools/erc725js/getting-started +[erc725.js]: ../../../tools/libraries/erc725js/getting-started [ipfs]: https://ipfs.io/ -[lsp-smart-contracts]: ../../../tools/lsp-smart-contracts/getting-started.md +[lsp-smart-contracts]: ../../../tools/libraries/lsp-smart-contracts/getting-started.md [tools-data-providers]: https://github.com/lukso-network/tools-data-providers diff --git a/docs/learn/universal-profile/metadata/register-lsp12-issued-assets.md b/docs/learn/universal-profile/metadata/register-lsp12-issued-assets.md index 2690f045be..6c6c12988b 100644 --- a/docs/learn/universal-profile/metadata/register-lsp12-issued-assets.md +++ b/docs/learn/universal-profile/metadata/register-lsp12-issued-assets.md @@ -135,7 +135,7 @@ const accounts = await web3.eth.getAccounts(); ## Encode the data keys -After setting up the array of assets, you can use the [`erc725.js`](../../../tools/erc725js/getting-started.md) library to encode the [`LSP12IssuedAssets[]`](../../../standards/universal-profile/lsp12-issued-assets/) data keys. There are two ways to encode data: +After setting up the array of assets, you can use the [`erc725.js`](../../../tools/libraries/erc725js/getting-started.md) library to encode the [`LSP12IssuedAssets[]`](../../../standards/universal-profile/lsp12-issued-assets/) data keys. There are two ways to encode data: - **Set the full issued assets list**: If you want to initially set issued assets on a Universal Profile or re-set all elements, you can encode the data without defining optional length or index parameters. Therefore, the issued assets will only consist of the asset addresses you provide in your array of assets. - **add, update, or remove existing issued assets**: If the Universal Profile already has issued assets, and you want to add, update, or remove certain assets, you can provide the `startingIndex` and `totalArrayLength` parameters. Therefore, your prepared array only represents a subset of all the issued assets listed in your Universal Profile. @@ -148,7 +148,7 @@ Please be careful when updating existing issued assets. Incorrect usage of `star :::info -You can read more about the `encodeData` function of [`erc725.js`](../../../tools/erc725js/getting-started.md) within the related [ERC725 Documentation](../../../tools/erc725js/methods#encodedata). +You can read more about the `encodeData` function of [`erc725.js`](../../../tools/libraries/erc725js/getting-started.md) within the related [ERC725 Documentation](../../../tools/libraries/erc725js/methods#encodedata). ::: diff --git a/docs/learn/universal-profile/metadata/retrieve-owned-assets.md b/docs/learn/universal-profile/metadata/retrieve-owned-assets.md index aba0c2ed91..e1db558506 100644 --- a/docs/learn/universal-profile/metadata/retrieve-owned-assets.md +++ b/docs/learn/universal-profile/metadata/retrieve-owned-assets.md @@ -22,7 +22,7 @@ This guide shows you how to easily retrieve the list of owned asset, by fetching ## Using erc725.js -The [erc725.js](../../../tools/erc725js/getting-started.md) enable us to do that easily. +The [erc725.js](../../../tools/libraries/erc725js/getting-started.md) enable us to do that easily. ```bash npm i @erc725/erc725.js diff --git a/docs/learn/universal-profile/universal-receiver/create-receiver-forwarder.md b/docs/learn/universal-profile/universal-receiver/create-receiver-forwarder.md index 7ef594e6cd..7501419b2f 100644 --- a/docs/learn/universal-profile/universal-receiver/create-receiver-forwarder.md +++ b/docs/learn/universal-profile/universal-receiver/create-receiver-forwarder.md @@ -37,7 +37,7 @@ In order to follow this guide, you will need the followings: 2. Fund the main EOA controller of your πŸ†™ (See **[Step 1](#step-1---enable-your-controller-to-add-a-universal-receiver) bullet point 3** to retrieve its address) using the [Testnet Faucet](https://faucet.testnet.lukso.network/). 3. The address of the LSP7 token that you want to use to forward of portion of the amount received. 4. The v0.14.0 [`@lukso/lsp-smart-contracts`](../../../contracts/introduction.md) library installed. -5. The [_erc725.js_](../../../tools/erc725js/getting-started.md) library installed to encode the data key / value to register our LSP1 Forwarder. +5. The [_erc725.js_](../../../tools/libraries/erc725js/getting-started.md) library installed to encode the data key / value to register our LSP1 Forwarder. 6. The [`dotenv`](https://www.npmjs.com/package/dotenv) package to load our main EOA controller private key into our script. ```bash diff --git a/docs/learn/vault/edit-vault-data.md b/docs/learn/vault/edit-vault-data.md index 98e2e32034..84248e1050 100644 --- a/docs/learn/vault/edit-vault-data.md +++ b/docs/learn/vault/edit-vault-data.md @@ -552,6 +552,6 @@ await updateVaultURD(vaultURDAddress); ## Reading Data -The **LSP9Vault** contract is an **ERC725** contract, so it shares the same way to read data as Universal Profiles and other ERC725 contracts by using **[erc725.js](../../tools/erc725js/getting-started.md)**. +The **LSP9Vault** contract is an **ERC725** contract, so it shares the same way to read data as Universal Profiles and other ERC725 contracts by using **[erc725.js](../../tools/libraries/erc725js/getting-started.md)**. You can refer to the **[Read Profile Data Guide](../universal-profile/metadata/read-profile-data)** to learn how to **fetch data** like received or issued assets from [ERC725Y Storage](../../standards/lsp-background/erc725#erc725y-generic-data-keyvalue-store). However, please note that the **Universal Profile** address has to be exchanged with the **Vault's** address. diff --git a/docs/standards/generic-standards/lsp2-json-schema.md b/docs/standards/generic-standards/lsp2-json-schema.md index 190ed6a88d..900c4a84c9 100644 --- a/docs/standards/generic-standards/lsp2-json-schema.md +++ b/docs/standards/generic-standards/lsp2-json-schema.md @@ -14,7 +14,7 @@ description: LUKSO's LSP2 - ERC725Y JSON Schema for better abstraction on top of :::success Recommendation -Our [JavaScript library **erc725.js**](../../tools/erc725js/getting-started.md) makes it easy to read + write data encoded according to the LSP2 Schema without manually going through all the encoding complexity. +Our [JavaScript library **erc725.js**](../../tools/libraries/erc725js/getting-started.md) makes it easy to read + write data encoded according to the LSP2 Schema without manually going through all the encoding complexity. ::: diff --git a/docs/standards/relayer-api.md b/docs/standards/relayer-api.md index 28d5290411..f4c57a8c94 100644 --- a/docs/standards/relayer-api.md +++ b/docs/standards/relayer-api.md @@ -15,7 +15,7 @@ import TabItem from '@theme/TabItem'; :::success Relayer API -To access our Relayer API, see our [**Relayer Developer Access**](../tools/relayer-developer.md) page. +To access our Relayer API, see our [**Relayer Developer Access**](../tools/services/relayer-developer.md) page. ::: diff --git a/docs/standards/universal-profile/lsp6-key-manager.md b/docs/standards/universal-profile/lsp6-key-manager.md index 1b8568c91d..00cf48ef61 100644 --- a/docs/standards/universal-profile/lsp6-key-manager.md +++ b/docs/standards/universal-profile/lsp6-key-manager.md @@ -56,7 +56,7 @@ Permissions for addresses are not stored on the Key Manager. Instead, they are * :::tip -You can use the [`encodePermissions(...)`](../../../../tools/erc725js/methods#encodepermissions) and [`decodePermissions(...)`](../../../../tools/erc725js/methods#decodepermissions) functions from the [_erc725.js_](../../../../tools/erc725js/getting-started) tool to easily **encode and decode permissions values** or **combine multiple permissions together**. +You can use the [`encodePermissions(...)`](../../../../tools/libraries/erc725js/methods#encodepermissions) and [`decodePermissions(...)`](../../../../tools/libraries/erc725js/methods#decodepermissions) functions from the [_erc725.js_](../../../../tools/libraries/erc725js/getting-started) tool to easily **encode and decode permissions values** or **combine multiple permissions together**. ::: @@ -458,7 +458,7 @@ permissions: EDITPERMISSIONS + SETDATA :::tip -The convenience function [`getData(...)`](../../tools/erc725js/methods.md#getdata) from [_erc725.js_](../../../../tools/erc725js/getting-started) will return you the whole list of controllers when providing the `AddressPermission[]` array data key as a parameter. +The convenience function [`getData(...)`](../../tools/libraries/erc725js/methods.md#getdata) from [_erc725.js_](../../../../tools/libraries/erc725js/getting-started) will return you the whole list of controllers when providing the `AddressPermission[]` array data key as a parameter. ::: diff --git a/docs/tools/eip191-signerjs/_category_.yml b/docs/tools/eip191-signerjs/_category_.yml deleted file mode 100644 index a8d9d69588..0000000000 --- a/docs/tools/eip191-signerjs/_category_.yml +++ /dev/null @@ -1,3 +0,0 @@ -label: 'eip191-signer.js' -collapsed: true -position: 5 diff --git a/docs/tools/erc725-tools.md b/docs/tools/erc725-tools.md index 61a67cb63d..9af38de8be 100644 --- a/docs/tools/erc725-tools.md +++ b/docs/tools/erc725-tools.md @@ -1,9 +1,23 @@ --- -title: πŸ” Inspector Tools -sidebar_position: 8 +title: πŸ” Explorers & Debug Tools +sidebar_position: 4 --- -# ERC725 Tools +# πŸ” Explorers & Debug Tools + +## Block Explorers + +LUKSO uses the open-source [Blockscout Explorer](https://github.com/blockscout/blockscout) fork to inspect blockchain and transaction data. + +LUKSO Mainnet + +- [LUKSO Mainnet Execution Explorer](https://explorer.lukso.network/) +- [LUKSO Mainnet Consensus Explorer](https://explorer.consensus.mainnet.lukso.network/) + +LUKSO Testnet + +- [LUKSO Testnet Execution Explorer](https://explorer.execution.testnet.lukso.network) +- [LUKSO Testnet Consensus Explorer](https://explorer.consensus.testnet.lukso.network) ## ERC725 Inspect diff --git a/docs/tools/integrations.md b/docs/tools/integrations.md index 2cab03e0f2..978d94c599 100644 --- a/docs/tools/integrations.md +++ b/docs/tools/integrations.md @@ -1,7 +1,7 @@ --- id: integrations title: πŸͺ’ Integrations -sidebar_position: 2 +sidebar_position: 3 --- # πŸͺ’ Integrations diff --git a/docs/tools/libraries/_category_.yml b/docs/tools/libraries/_category_.yml new file mode 100644 index 0000000000..3abacc74cb --- /dev/null +++ b/docs/tools/libraries/_category_.yml @@ -0,0 +1,3 @@ +label: 'πŸ“š Libraries' +collapsed: true +position: 1 diff --git a/docs/tools/eip191-signerjs/Classes/EIP191Signer.md b/docs/tools/libraries/eip191-signerjs/Classes/EIP191Signer.md similarity index 100% rename from docs/tools/eip191-signerjs/Classes/EIP191Signer.md rename to docs/tools/libraries/eip191-signerjs/Classes/EIP191Signer.md diff --git a/docs/tools/eip191-signerjs/Classes/_category_.yml b/docs/tools/libraries/eip191-signerjs/Classes/_category_.yml similarity index 100% rename from docs/tools/eip191-signerjs/Classes/_category_.yml rename to docs/tools/libraries/eip191-signerjs/Classes/_category_.yml diff --git a/docs/tools/libraries/eip191-signerjs/_category_.yml b/docs/tools/libraries/eip191-signerjs/_category_.yml new file mode 100644 index 0000000000..c122ddc408 --- /dev/null +++ b/docs/tools/libraries/eip191-signerjs/_category_.yml @@ -0,0 +1,3 @@ +label: 'πŸ–‹οΈ eip191-signer.js' +collapsed: true +position: 4 diff --git a/docs/tools/eip191-signerjs/getting-started.md b/docs/tools/libraries/eip191-signerjs/getting-started.md similarity index 100% rename from docs/tools/eip191-signerjs/getting-started.md rename to docs/tools/libraries/eip191-signerjs/getting-started.md diff --git a/docs/tools/libraries/erc725js/_category_.yml b/docs/tools/libraries/erc725js/_category_.yml new file mode 100644 index 0000000000..f94a61686d --- /dev/null +++ b/docs/tools/libraries/erc725js/_category_.yml @@ -0,0 +1,3 @@ +label: 'πŸ“œ erc725.js' +collapsed: true +position: 1 diff --git a/docs/tools/erc725js/getting-started.md b/docs/tools/libraries/erc725js/getting-started.md similarity index 98% rename from docs/tools/erc725js/getting-started.md rename to docs/tools/libraries/erc725js/getting-started.md index 28e52c46a4..809f74721a 100644 --- a/docs/tools/erc725js/getting-started.md +++ b/docs/tools/libraries/erc725js/getting-started.md @@ -35,7 +35,7 @@ There are 3 main ways to use _erc725.js_. ### Option 1: use a schema for encoding / decoding data -Create an instance of `ERC725` with just a [schema](https://docs.lukso.tech/tools/erc725js/schemas). **Useful for just encoding / decoding data.** +Create an instance of `ERC725` with just a [schema](https://docs.lukso.tech/tools/libraries/erc725js/schemas). **Useful for just encoding / decoding data.** ```js import ERC725, { ERC725JSONSchema } from '@erc725/erc725.js'; diff --git a/docs/tools/erc725js/methods.md b/docs/tools/libraries/erc725js/methods.md similarity index 100% rename from docs/tools/erc725js/methods.md rename to docs/tools/libraries/erc725js/methods.md diff --git a/docs/tools/erc725js/providers.md b/docs/tools/libraries/erc725js/providers.md similarity index 100% rename from docs/tools/erc725js/providers.md rename to docs/tools/libraries/erc725js/providers.md diff --git a/docs/tools/erc725js/schemas.md b/docs/tools/libraries/erc725js/schemas.md similarity index 74% rename from docs/tools/erc725js/schemas.md rename to docs/tools/libraries/erc725js/schemas.md index 143f2f98d4..d24279e3ba 100644 --- a/docs/tools/erc725js/schemas.md +++ b/docs/tools/libraries/erc725js/schemas.md @@ -10,9 +10,9 @@ For more details on schemas, see the [**official specification** of the LSP2 ERC ::: -The βš’οΈ [erc725.js](https://npmjs.com/package/@erc725/erc725.js) library works with [ERC725Y JSON schemas](../../standards/generic-standards/lsp2-json-schema). These schemas are JSON structures that tell developers and programs how to decode and encode πŸ—‚οΈ [ERC725Y data keys](../../standards/lsp-background/erc725#erc725y-generic-data-keyvalue-store) from any [ERC725Y](https://eips.ethereum.org/EIPS/eip-725) smart contract.. You need to load the required schemas of the data keys you want to fetch when initializing the `ERC725` class. +The βš’οΈ [erc725.js](https://npmjs.com/package/@erc725/erc725.js) library works with [ERC725Y JSON schemas](../../../standards/generic-standards/lsp2-json-schema). These schemas are JSON structures that tell developers and programs how to decode and encode πŸ—‚οΈ [ERC725Y data keys](../../../standards/lsp-background/erc725#erc725y-generic-data-keyvalue-store) from any [ERC725Y](https://eips.ethereum.org/EIPS/eip-725) smart contract.. You need to load the required schemas of the data keys you want to fetch when initializing the `ERC725` class. -The most common and standard schemas are [available](../../tools/erc725js/schemas.md) directly within the _erc725.js_ library. But you can also create and load your own ERC725Y JSON schemas if you want to use custom data keys. +The most common and standard schemas are available directly within the _erc725.js_ library. But you can also create and load your own ERC725Y JSON schemas if you want to use custom data keys. _A quick reference for keys used in schema definitions can be seen below_ diff --git a/docs/tools/getting-started.md b/docs/tools/libraries/getting-started.md similarity index 93% rename from docs/tools/getting-started.md rename to docs/tools/libraries/getting-started.md index 5853c5b86f..a9d321e6f1 100644 --- a/docs/tools/getting-started.md +++ b/docs/tools/libraries/getting-started.md @@ -1,10 +1,10 @@ --- id: getting-started -title: Getting Started -sidebar_position: 1 +title: πŸ“– Introduction +sidebar_position: 0 --- -# Getting Started +# Libraries Libraries that are actively maintained by the LUKSO team. @@ -15,7 +15,7 @@ Libraries that are actively maintained by the LUKSO team. Repository - lsp-smart-contracts + lsp-smart-contracts npm badge lukso-network/lsp-smart-contracts @@ -25,7 +25,7 @@ Libraries that are actively maintained by the LUKSO team. lukso-network/lsp-utils - erc725.js + erc725.js npm badge ERC725Alliance/erc725.js diff --git a/docs/tools/libraries/lsp-factoryjs/_category_.yml b/docs/tools/libraries/lsp-factoryjs/_category_.yml new file mode 100644 index 0000000000..b039ca716b --- /dev/null +++ b/docs/tools/libraries/lsp-factoryjs/_category_.yml @@ -0,0 +1,3 @@ +label: '🏭 lsp-factory.js' +collapsed: true +position: 5 diff --git a/docs/tools/lsp-factoryjs/getting-started.md b/docs/tools/libraries/lsp-factoryjs/getting-started.md similarity index 56% rename from docs/tools/lsp-factoryjs/getting-started.md rename to docs/tools/libraries/lsp-factoryjs/getting-started.md index dc50e7e9b7..9a2cb35dd6 100644 --- a/docs/tools/lsp-factoryjs/getting-started.md +++ b/docs/tools/libraries/lsp-factoryjs/getting-started.md @@ -8,8 +8,8 @@ sidebar_position: 1.1 This package is deprecated. Please check the following guides and library: -- [Deploying Universal Profiles with LSP23 Factory](../../learn/universal-profile/advanced-guides/deploy-up-with-lsp23/) -- [Deploying tokens and NFTs](../../learn/digital-assets/getting-started) +- [Deploying Universal Profiles with LSP23 Factory](../../../learn/universal-profile/advanced-guides/deploy-up-with-lsp23/) +- [Deploying tokens and NFTs](../../../learn/digital-assets/getting-started) - [`lsp-utils`](../lsp-utils/getting-started.md) library to easily set profile and asset metadata ::: diff --git a/docs/tools/libraries/lsp-smart-contracts/_category_.yml b/docs/tools/libraries/lsp-smart-contracts/_category_.yml new file mode 100644 index 0000000000..8454fbef5c --- /dev/null +++ b/docs/tools/libraries/lsp-smart-contracts/_category_.yml @@ -0,0 +1,3 @@ +label: 'πŸ“‘ lsp-smart-contracts' +collapsed: true +position: 2 diff --git a/docs/tools/lsp-smart-contracts/constants.md b/docs/tools/libraries/lsp-smart-contracts/constants.md similarity index 81% rename from docs/tools/lsp-smart-contracts/constants.md rename to docs/tools/libraries/lsp-smart-contracts/constants.md index 4e8e749448..4593fc96e1 100644 --- a/docs/tools/lsp-smart-contracts/constants.md +++ b/docs/tools/libraries/lsp-smart-contracts/constants.md @@ -42,4 +42,4 @@ import { } from '@lukso/lsp-smart-contracts'; ``` -You can find the [interface IDs](../../contracts/interface-ids) of the smart contracts in or more information in the [`README.md`](https://github.com/lukso-network/lsp-smart-contracts/blob/develop/README.md). +You can find the [interface IDs](../../../contracts/interface-ids) of the smart contracts in or more information in the [`README.md`](https://github.com/lukso-network/lsp-smart-contracts/blob/develop/README.md). diff --git a/docs/tools/lsp-smart-contracts/contracts-abi.md b/docs/tools/libraries/lsp-smart-contracts/contracts-abi.md similarity index 80% rename from docs/tools/lsp-smart-contracts/contracts-abi.md rename to docs/tools/libraries/lsp-smart-contracts/contracts-abi.md index 86a043fc72..f9e9526755 100644 --- a/docs/tools/lsp-smart-contracts/contracts-abi.md +++ b/docs/tools/libraries/lsp-smart-contracts/contracts-abi.md @@ -4,7 +4,7 @@ sidebar_position: 2 # Contracts ABI -You can import the [LUKSO smart contracts](../../contracts/introduction.md) ABIs from the `/artifacts` folder: +You can import the [LUKSO smart contracts](../../../contracts/introduction.md) ABIs from the `/artifacts` folder: diff --git a/docs/tools/lsp-smart-contracts/getting-started.md b/docs/tools/libraries/lsp-smart-contracts/getting-started.md similarity index 89% rename from docs/tools/lsp-smart-contracts/getting-started.md rename to docs/tools/libraries/lsp-smart-contracts/getting-started.md index 128d0aaf1d..1c68898f13 100644 --- a/docs/tools/lsp-smart-contracts/getting-started.md +++ b/docs/tools/libraries/lsp-smart-contracts/getting-started.md @@ -17,6 +17,6 @@ npm install @lukso/lsp-smart-contracts :::tip -You can find more information and examples on our [smart contract implementation page](../../contracts/introduction.md). +You can find more information and examples on our [smart contract implementation page](../../../contracts/introduction.md). ::: diff --git a/docs/tools/lsp-smart-contracts/solidity-contracts.md b/docs/tools/libraries/lsp-smart-contracts/solidity-contracts.md similarity index 67% rename from docs/tools/lsp-smart-contracts/solidity-contracts.md rename to docs/tools/libraries/lsp-smart-contracts/solidity-contracts.md index 1513bfd229..bae29f031b 100644 --- a/docs/tools/lsp-smart-contracts/solidity-contracts.md +++ b/docs/tools/libraries/lsp-smart-contracts/solidity-contracts.md @@ -4,7 +4,7 @@ sidebar_position: 3 # Solidity Contracts -The solidity sources of the [LUKSO smart contracts](../../contracts/introduction.md) are available in the `/contracts` folder. +The solidity sources of the [LUKSO smart contracts](../../../contracts/introduction.md) are available in the `/contracts` folder. ```solidity import "@lukso/lsp-smart-contracts/contracts/LSP0ERC725Account/LSP0ERC725Account.sol"; diff --git a/docs/tools/lsp-utils/IPFS.md b/docs/tools/libraries/lsp-utils/IPFS.md similarity index 100% rename from docs/tools/lsp-utils/IPFS.md rename to docs/tools/libraries/lsp-utils/IPFS.md diff --git a/docs/tools/lsp-utils/LSP12IssuedAssets.md b/docs/tools/libraries/lsp-utils/LSP12IssuedAssets.md similarity index 100% rename from docs/tools/lsp-utils/LSP12IssuedAssets.md rename to docs/tools/libraries/lsp-utils/LSP12IssuedAssets.md diff --git a/docs/tools/lsp-utils/LSP23LinkedContractsFactory.md b/docs/tools/libraries/lsp-utils/LSP23LinkedContractsFactory.md similarity index 100% rename from docs/tools/lsp-utils/LSP23LinkedContractsFactory.md rename to docs/tools/libraries/lsp-utils/LSP23LinkedContractsFactory.md diff --git a/docs/tools/lsp-utils/LSP2ERC725YJSONSchema.md b/docs/tools/libraries/lsp-utils/LSP2ERC725YJSONSchema.md similarity index 100% rename from docs/tools/lsp-utils/LSP2ERC725YJSONSchema.md rename to docs/tools/libraries/lsp-utils/LSP2ERC725YJSONSchema.md diff --git a/docs/tools/lsp-utils/LSP3ProfileMetadata.md b/docs/tools/libraries/lsp-utils/LSP3ProfileMetadata.md similarity index 100% rename from docs/tools/lsp-utils/LSP3ProfileMetadata.md rename to docs/tools/libraries/lsp-utils/LSP3ProfileMetadata.md diff --git a/docs/tools/lsp-utils/LSP4DigitalAssetMetadata.md b/docs/tools/libraries/lsp-utils/LSP4DigitalAssetMetadata.md similarity index 100% rename from docs/tools/lsp-utils/LSP4DigitalAssetMetadata.md rename to docs/tools/libraries/lsp-utils/LSP4DigitalAssetMetadata.md diff --git a/docs/tools/lsp-utils/LSP5ReceivedAssets.md b/docs/tools/libraries/lsp-utils/LSP5ReceivedAssets.md similarity index 100% rename from docs/tools/lsp-utils/LSP5ReceivedAssets.md rename to docs/tools/libraries/lsp-utils/LSP5ReceivedAssets.md diff --git a/docs/tools/lsp-utils/LSP6KeyManager.md b/docs/tools/libraries/lsp-utils/LSP6KeyManager.md similarity index 100% rename from docs/tools/lsp-utils/LSP6KeyManager.md rename to docs/tools/libraries/lsp-utils/LSP6KeyManager.md diff --git a/docs/tools/erc725js/_category_.yml b/docs/tools/libraries/lsp-utils/_category_.yml similarity index 53% rename from docs/tools/erc725js/_category_.yml rename to docs/tools/libraries/lsp-utils/_category_.yml index b39f8ac355..3f7b88f741 100644 --- a/docs/tools/erc725js/_category_.yml +++ b/docs/tools/libraries/lsp-utils/_category_.yml @@ -1,3 +1,3 @@ -label: 'erc725.js' +label: 'πŸ“‘ lsp-utils' collapsed: true position: 3 diff --git a/docs/tools/lsp-utils/getting-started.md b/docs/tools/libraries/lsp-utils/getting-started.md similarity index 100% rename from docs/tools/lsp-utils/getting-started.md rename to docs/tools/libraries/lsp-utils/getting-started.md diff --git a/docs/tools/lsp-factoryjs/_category_.yml b/docs/tools/lsp-factoryjs/_category_.yml deleted file mode 100644 index 58d1392583..0000000000 --- a/docs/tools/lsp-factoryjs/_category_.yml +++ /dev/null @@ -1,3 +0,0 @@ -label: 'lsp-factory.js' -collapsed: true -position: 4 diff --git a/docs/tools/lsp-smart-contracts/_category_.yml b/docs/tools/lsp-smart-contracts/_category_.yml deleted file mode 100644 index 6d652f6498..0000000000 --- a/docs/tools/lsp-smart-contracts/_category_.yml +++ /dev/null @@ -1,3 +0,0 @@ -label: 'lsp-smart-contracts' -collapsed: true -position: 6 diff --git a/docs/tools/lsp-utils/_category_.yml b/docs/tools/lsp-utils/_category_.yml deleted file mode 100644 index a4516235bd..0000000000 --- a/docs/tools/lsp-utils/_category_.yml +++ /dev/null @@ -1,3 +0,0 @@ -label: 'lsp-utils' -collapsed: true -position: 7 diff --git a/docs/tools/services/_category_.yml b/docs/tools/services/_category_.yml new file mode 100644 index 0000000000..8a5316d05f --- /dev/null +++ b/docs/tools/services/_category_.yml @@ -0,0 +1,3 @@ +label: '🧰 Services' +collapsed: true +position: 2 diff --git a/docs/tools/docker-factory.md b/docs/tools/services/docker-factory.md similarity index 95% rename from docs/tools/docker-factory.md rename to docs/tools/services/docker-factory.md index 2138b3d9fe..2e97b261b4 100644 --- a/docs/tools/docker-factory.md +++ b/docs/tools/services/docker-factory.md @@ -1,6 +1,6 @@ --- title: 🏭 Node Docker Factory -sidebar_position: 9 +sidebar_position: 3 --- # Node Docker Factory diff --git a/docs/tools/indexer.md b/docs/tools/services/indexer.md similarity index 98% rename from docs/tools/indexer.md rename to docs/tools/services/indexer.md index 944312d7f3..8b28c13520 100644 --- a/docs/tools/indexer.md +++ b/docs/tools/services/indexer.md @@ -1,6 +1,6 @@ --- title: πŸ“‘ Indexer access -sidebar_position: 10 +sidebar_position: 1 --- # Indexer developer access diff --git a/docs/tools/relayer-developer.md b/docs/tools/services/relayer-developer.md similarity index 94% rename from docs/tools/relayer-developer.md rename to docs/tools/services/relayer-developer.md index d6fd8e552d..0bc559437f 100644 --- a/docs/tools/relayer-developer.md +++ b/docs/tools/services/relayer-developer.md @@ -1,6 +1,6 @@ --- title: ⛽️ Relayer access -sidebar_position: 10 +sidebar_position: 2 --- # Relayer developer access @@ -29,9 +29,9 @@ Please fill out [this form](https://forms.gle/rhWA25m3jjuPNPva9) to request acce You can deploy Universal Profiles for users by providing either: - OPTION 1: a list of controller addresses (`lsp6ControllerAddress`) and metadata (`lsp3Profile`) -- OPTION 2: a `salt` and [`postDeploymentCallData`](../learn/universal-profile/advanced-guides/deploy-up-with-lsp23#create-the-universal-profile-initialization-calldata) +- OPTION 2: a `salt` and [`postDeploymentCallData`](../../learn/universal-profile/advanced-guides/deploy-up-with-lsp23#create-the-universal-profile-initialization-calldata) -In this process, you might need to use the [`up_import`](../standards/rpc-api#up_import) RPC call from the [Universal Profile Extension](/install-up-browser-extension) in order to add the deployed UP to the browser extension. +In this process, you might need to use the [`up_import`](../../standards/rpc-api#up_import) RPC call from the [Universal Profile Extension](/install-up-browser-extension) in order to add the deployed UP to the browser extension.
OPTION 1: lsp6ControllerAddress & lsp3Profile diff --git a/docusaurus.config.js b/docusaurus.config.js index 3ee5cf0301..6f3bcb9180 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -169,6 +169,91 @@ export default { from: '/tools/partners', to: '/tools/integrations', }, + { + from: '/tools/eip191-signerjs/getting-started', + to: '/tools/libraries/eip191-signerjs/getting-started', + }, + { + from: '/tools/erc725js/getting-started', + to: '/tools/libraries/erc725js/getting-started', + }, + { + from: '/tools/erc725js/methods', + to: '/tools/libraries/erc725js/methods', + }, + { + from: '/tools/erc725js/providers', + to: '/tools/libraries/erc725js/providers', + }, + { + from: '/tools/erc725js/schemas', + to: '/tools/libraries/erc725js/schemas', + }, + { + from: '/tools/lsp-smart-contracts/constants', + to: '/tools/libraries/lsp-smart-contracts/constants', + }, + { + from: '/tools/lsp-smart-contracts/contracts-abi', + to: '/tools/libraries/lsp-smart-contracts/contracts-abi', + }, + { + from: '/tools/lsp-smart-contracts/getting-started', + to: '/tools/libraries/lsp-smart-contracts/getting-started', + }, + { + from: '/tools/lsp-smart-contracts/solidity-contracts', + to: '/tools/libraries/lsp-smart-contracts/solidity-contracts', + }, + { + from: '/tools/lsp-utils/getting-started', + to: '/tools/libraries/lsp-utils/getting-started', + }, + { + from: '/tools/lsp-utils/IPFS', + to: '/tools/libraries/lsp-utils/IPFS', + }, + { + from: '/tools/lsp-utils/LSP3ProfileMetadata', + to: '/tools/libraries/lsp-utils/LSP3ProfileMetadata', + }, + { + from: '/tools/lsp-utils/LSP4DigitalAssetMetadata', + to: '/tools/libraries/lsp-utils/LSP4DigitalAssetMetadata', + }, + { + from: '/tools/lsp-utils/LSP5ReceivedAssets', + to: '/tools/libraries/lsp-utils/LSP5ReceivedAssets', + }, + { + from: '/tools/lsp-utils/LSP6KeyManager', + to: '/tools/libraries/lsp-utils/LSP6KeyManager', + }, + { + from: '/tools/lsp-utils/LSP12IssuedAssets', + to: '/tools/libraries/lsp-utils/LSP12IssuedAssets', + }, + { + from: '/tools/lsp-utils/LSP23LinkedContractsFactory', + to: '/tools/libraries/lsp-utils/LSP23LinkedContractsFactory', + }, + { + from: '/tools/docker-factory', + to: '/tools/services/docker-factory', + }, + { + from: '/tools/getting-started', + to: '/tools/libraries/getting-started', + }, + { + from: '/tools/indexer', + to: '/tools/services/indexer', + }, + { + from: '/tools/relayer-developer', + to: '/tools/services/relayer-developer', + }, + // lsp-factory deprecation { from: '/tools/lsp-factoryjs/deployment/universal-profile', @@ -178,21 +263,25 @@ export default { from: '/tools/lsp-factoryjs/deployment/digital-asset', to: '/learn/digital-assets/getting-started', }, + { + from: '/tools/lsp-factoryjs/getting-started', + to: '/tools/libraries/lsp-factoryjs/getting-started', + }, { from: '/tools/lsp-factoryjs/classes/universal-profile', - to: '/tools/lsp-factoryjs/getting-started', + to: '/tools/libraries/lsp-factoryjs/getting-started', }, { from: '/tools/lsp-factoryjs/classes/lsp4-digital-asset-metadata', - to: '/tools/lsp-factoryjs/getting-started', + to: '/tools/libraries/lsp-factoryjs/getting-started', }, { from: '/tools/lsp-factoryjs/classes/lsp7-digital-asset', - to: '/tools/lsp-factoryjs/getting-started', + to: '/tools/libraries/lsp-factoryjs/getting-started', }, { from: '/tools/lsp-factoryjs/classes/lsp8-identifiable-digital-asset', - to: '/tools/lsp-factoryjs/getting-started', + to: '/tools/libraries/lsp-factoryjs/getting-started', }, { from: '/learn/expert-guides/universal-profile/deploy-universal-profile', @@ -240,7 +329,7 @@ export default { }, { type: 'doc', - docId: 'tools/getting-started', + docId: 'tools/libraries/getting-started', position: 'left', label: 'Tools', }, diff --git a/sidebars.js b/sidebars.js index bf8a3ef7ce..6c82f374cf 100644 --- a/sidebars.js +++ b/sidebars.js @@ -126,68 +126,6 @@ module.exports = { href: 'https://github.com/lukso-network/lsp-smart-contracts/tree/develop/audits', }, ], - toolsSidebar: [ - 'tools/getting-started', - 'tools/integrations', - { - type: 'category', - label: 'πŸ“œ erc725.js', - collapsed: true, - items: [ - { - type: 'autogenerated', - dirName: 'tools/erc725js', - }, - ], - }, - { - type: 'category', - label: 'πŸ–‹οΈ eip191-signer.js', - collapsed: true, - items: [ - { - type: 'autogenerated', - dirName: 'tools/eip191-signerjs', - }, - ], - }, - { - type: 'category', - label: 'πŸ“‘ lsp-smart-contracts', - collapsed: true, - items: [ - { - type: 'autogenerated', - dirName: 'tools/lsp-smart-contracts', - }, - ], - }, - { - type: 'category', - label: 'πŸ“‘ lsp-utils', - collapsed: true, - items: [ - { - type: 'autogenerated', - dirName: 'tools/lsp-utils', - }, - ], - }, - { - type: 'category', - label: '🏭 lsp-factory.js (deprecated)', - collapsed: true, - items: [ - { - type: 'autogenerated', - dirName: 'tools/lsp-factoryjs', - }, - ], - }, - 'tools/erc725-tools', - 'tools/relayer-developer', - 'tools/indexer', - 'tools/docker-factory', - ], + toolsSidebar: [{ type: 'autogenerated', dirName: 'tools' }], faqSidebar: [{ type: 'autogenerated', dirName: 'faq' }], }; diff --git a/src/pages/index.js b/src/pages/index.js index 14d5ceb145..dc283485cc 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -55,7 +55,7 @@ function Index() { />