From a05b2b8343caff21e8f1537fe7d5c8a12da19d5b Mon Sep 17 00:00:00 2001 From: frozeman Date: Wed, 1 Nov 2023 00:18:29 +0000 Subject: [PATCH 1/4] [create-pull-request] automated change --- docs/tools/erc725js/classes/ERC725.md | 7 ++++--- docs/tools/erc725js/providers.md | 4 ++-- docs/tools/erc725js/schemas.md | 5 +++++ .../lsp-factoryjs/classes/lsp4-digital-asset-metadata.md | 2 +- docs/tools/lsp-factoryjs/classes/lsp7-digital-asset.md | 2 +- .../classes/lsp8-identifiable-digital-asset.md | 2 +- docs/tools/lsp-factoryjs/classes/universal-profile.md | 6 +++--- 7 files changed, 17 insertions(+), 11 deletions(-) diff --git a/docs/tools/erc725js/classes/ERC725.md b/docs/tools/erc725js/classes/ERC725.md index bed34ec359..c6a410195b 100644 --- a/docs/tools/erc725js/classes/ERC725.md +++ b/docs/tools/erc725js/classes/ERC725.md @@ -187,8 +187,7 @@ myErc725.decodeData([ value: [ { key: '0x7c8c3416d6cda87cd42c71ea1843df28ac4850354f988d55ee2eaa47b6dc05cd', - value: - '0x0000000000000000000000000000000000000000000000000000000000000002', + value: '0x00000000000000000000000000000002', }, { key: '0x7c8c3416d6cda87cd42c71ea1843df2800000000000000000000000000000000', @@ -593,7 +592,7 @@ myErc725.encodeData([ ], values: [ '0x6f357c6a820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361696670733a2f2f516d597231564a4c776572673670456f73636468564775676f3339706136727963455a4c6a7452504466573834554178', - '0x0000000000000000000000000000000000000000000000000000000000000002', + '0x00000000000000000000000000000002', '0xd94353d9b005b3c0a9da169b768a31c57844e490', '0xdaea594e385fc724449e3118b2db7e86dfba1826', '0x1183790f29be3cdfd0a102862fea1a4a30b3adab', @@ -704,6 +703,7 @@ ERC725.decodeMappingKey( '0x35e6950bc8d21a1699e50000cafecafecafecafecafecafecafecafecafecafe', 'MyKeyName:
', ); +// Decoding will checksum addresses // [{ // type: 'address', // value: '0xCAfEcAfeCAfECaFeCaFecaFecaFECafECafeCaFe' @@ -806,6 +806,7 @@ ERC725.encodePermissions({ ENCRYPT: false, DECRYPT: false, SIGN: false, + EXECUTE_RELAY_CALL: false }), // '0x0000000000000000000000000000000000000000000000000000000000000110' diff --git a/docs/tools/erc725js/providers.md b/docs/tools/erc725js/providers.md index ec0b69e29c..4cda2f447b 100644 --- a/docs/tools/erc725js/providers.md +++ b/docs/tools/erc725js/providers.md @@ -30,9 +30,9 @@ const ethereumProvider = window.ethereum; const erc725 = new ERC725([], '0x...', ethereumProvider); ``` -## Web3 +## Web3 (deprecated) -The following code snippet will use the web3 provider available at web3.providers from the corresponding `web3` library. +The following code snippet will use the web3 provider available at `web3.providers` from the corresponding `web3` library. :::caution Warning diff --git a/docs/tools/erc725js/schemas.md b/docs/tools/erc725js/schemas.md index 915497697b..42ecde81a9 100644 --- a/docs/tools/erc725js/schemas.md +++ b/docs/tools/erc725js/schemas.md @@ -31,9 +31,11 @@ LSP4DigitalAssetLegacy.json LSP4DigitalAsset.json LSP5ReceivedAssets.json LSP6KeyManager.json +LSP8IdentifiableDigitalAsset.json LSP9Vault.json LSP10ReceivedVaults.json LSP12IssuedAssets.json +LSP17ContractExtension.json ``` You can import them from: @@ -45,4 +47,7 @@ import LSP5 from '@erc725/erc725.js/schemas/LSP5ReceivedAssets.json'; // Later use them on instantiation const myErc725Contract = new ERC725js(LSP3, address, web3.currentProvider); + +// You can retrieve the current loaded schema via +myErc725Contract.options.schemas; ``` diff --git a/docs/tools/lsp-factoryjs/classes/lsp4-digital-asset-metadata.md b/docs/tools/lsp-factoryjs/classes/lsp4-digital-asset-metadata.md index 51f3f91db3..1062a41390 100644 --- a/docs/tools/lsp-factoryjs/classes/lsp4-digital-asset-metadata.md +++ b/docs/tools/lsp-factoryjs/classes/lsp4-digital-asset-metadata.md @@ -257,7 +257,7 @@ await LSP4DigitalAssetMetadata.uploadMetadata( port: 5001, protocol: 'https', }, - }, + } ); /** { diff --git a/docs/tools/lsp-factoryjs/classes/lsp7-digital-asset.md b/docs/tools/lsp-factoryjs/classes/lsp7-digital-asset.md index 7fc0d94c55..206da7e0e7 100644 --- a/docs/tools/lsp-factoryjs/classes/lsp7-digital-asset.md +++ b/docs/tools/lsp-factoryjs/classes/lsp7-digital-asset.md @@ -115,7 +115,7 @@ await lspFactory.LSP7DigitalAsset.deploy( console.log(contracts.LSP7DigitalAsset); }, }, - }, + } ); /** diff --git a/docs/tools/lsp-factoryjs/classes/lsp8-identifiable-digital-asset.md b/docs/tools/lsp-factoryjs/classes/lsp8-identifiable-digital-asset.md index 3dbf002982..6d050b39a0 100644 --- a/docs/tools/lsp-factoryjs/classes/lsp8-identifiable-digital-asset.md +++ b/docs/tools/lsp-factoryjs/classes/lsp8-identifiable-digital-asset.md @@ -119,7 +119,7 @@ await lspFactory.LSP8IdentifiableDigitalAsset.deploy( console.log(contracts.LSP8IdentifiableDigitalAsset); }, }, - }, + } ); /** diff --git a/docs/tools/lsp-factoryjs/classes/universal-profile.md b/docs/tools/lsp-factoryjs/classes/universal-profile.md index 6e7bb540b1..8fce8a74e9 100644 --- a/docs/tools/lsp-factoryjs/classes/universal-profile.md +++ b/docs/tools/lsp-factoryjs/classes/universal-profile.md @@ -176,7 +176,7 @@ await lspFactory.UniversalProfile.deploy( console.log(contracts); }, }, - }, + } ); /** @@ -511,7 +511,7 @@ await UniversalProfile.uploadProfileData( }, { ipfsGateway: 'https://ipfs.infura.io', - }, + } ); /** @@ -543,7 +543,7 @@ await UniversalProfile.uploadProfileData( port: 5001, protocol: 'https', }, - }, + } ); /** From 367434ea6aa60dbf2318f20ed18a32a079435f21 Mon Sep 17 00:00:00 2001 From: Felix Hildebrandt Date: Wed, 1 Nov 2023 11:38:25 +0100 Subject: [PATCH 2/4] fix: wrong links in node guide --- docs/networks/advanced-guides/withdrawal-update.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/networks/advanced-guides/withdrawal-update.md b/docs/networks/advanced-guides/withdrawal-update.md index 8ffe32f732..2b35dfbe47 100644 --- a/docs/networks/advanced-guides/withdrawal-update.md +++ b/docs/networks/advanced-guides/withdrawal-update.md @@ -246,7 +246,7 @@ A maximum of 16 validator keys can update their withdrawal credentials per block ::: 1. Open the Validator Withdrawal Page of the related network: - - [LUKSO Mainnet Validator Withdrawals](https://explorer.consensus.mainnet.lukso.network/tools/broadcast) - - [LUKSO Testnet Validator Withdrawals](https://explorer.consensus.testnet.lukso.network/tools/broadcast) + - [LUKSO Mainnet Validator Withdrawals](https://explorer.consensus.mainnet.lukso.network/validators/withdrawals) + - [LUKSO Testnet Validator Withdrawals](https://explorer.consensus.testnet.lukso.network/validators/withdrawals) 2. Scroll down to the list of **Address Changes**. 3. Your Validator indices should show up as some of the latest entries. From 897991002d4e850072636c9e1694ce8078287acb Mon Sep 17 00:00:00 2001 From: Felix Hildebrandt Date: Wed, 1 Nov 2023 13:31:41 +0100 Subject: [PATCH 3/4] update or add checkpoint sync notices --- docs/networks/advanced-guides/switch-consensus-clients.md | 4 ++-- docs/networks/advanced-guides/update-clients.md | 6 ++++++ docs/networks/advanced-guides/update-the-node.md | 6 ++++++ docs/networks/mainnet/become-a-validator.md | 4 ++-- docs/networks/mainnet/running-a-node.md | 4 ++-- 5 files changed, 18 insertions(+), 6 deletions(-) diff --git a/docs/networks/advanced-guides/switch-consensus-clients.md b/docs/networks/advanced-guides/switch-consensus-clients.md index 0a5827f2db..f749f8ec73 100644 --- a/docs/networks/advanced-guides/switch-consensus-clients.md +++ b/docs/networks/advanced-guides/switch-consensus-clients.md @@ -157,9 +157,9 @@ If you are setting up a node for the testnet, add the `--testnet` flag to the st ::: -:::note +:::info -You will need the LUKSO CLI Version 0.8.0 or above in order to use the `--checkpoint-sync` command. If you are using an older version, please pass down the checkpoint flag as described in the [LUKSO CLI Documentation](https://github.com/lukso-network/tools-lukso-cli/tree/main#using-checkpoint-syncing). +You will need the LUKSO CLI Version 0.8.0 or above in order to use the `--checkpoint-sync` command. If you are using an older version or run into issues, please pass down the checkpoint flag manually, as described in the [LUKSO CLI Checkpoint Documentation](https://github.com/lukso-network/tools-lukso-cli/tree/main#using-checkpoint-syncing). ::: diff --git a/docs/networks/advanced-guides/update-clients.md b/docs/networks/advanced-guides/update-clients.md index b416b4ada0..5f8199af76 100644 --- a/docs/networks/advanced-guides/update-clients.md +++ b/docs/networks/advanced-guides/update-clients.md @@ -91,6 +91,12 @@ If you are setting up a node for the testnet, add the `--testnet` flag to the st ::: +:::info + +You will need the LUKSO CLI Version 0.8.0 or above in order to use the `--checkpoint-sync` command. If you are using an older version or run into issues, please pass down the checkpoint flag manually, as described in the [LUKSO CLI Checkpoint Documentation](https://github.com/lukso-network/tools-lukso-cli/tree/main#using-checkpoint-syncing). + +::: + ```sh # Starting the Mainnet Node lukso start --checkpoint-sync diff --git a/docs/networks/advanced-guides/update-the-node.md b/docs/networks/advanced-guides/update-the-node.md index 2787a7178f..bb6cb85a23 100644 --- a/docs/networks/advanced-guides/update-the-node.md +++ b/docs/networks/advanced-guides/update-the-node.md @@ -299,6 +299,12 @@ If you are setting up a node for the testnet, add the `--testnet` flag to the st ::: +:::info + +You will need the LUKSO CLI Version 0.8.0 or above in order to use the `--checkpoint-sync` command. If you are using an older version or run into issues, please pass down the checkpoint flag manually, as described in the [LUKSO CLI Checkpoint Documentation](https://github.com/lukso-network/tools-lukso-cli/tree/main#using-checkpoint-syncing). + +::: + ```sh # Starting the Mainnet Node lukso start --checkpoint-sync diff --git a/docs/networks/mainnet/become-a-validator.md b/docs/networks/mainnet/become-a-validator.md index 30480f1084..bb45aff483 100644 --- a/docs/networks/mainnet/become-a-validator.md +++ b/docs/networks/mainnet/become-a-validator.md @@ -107,9 +107,9 @@ If you are setting up a node for the testnet, add the `--testnet` flag to the st ::: -:::note +:::info -You will need the LUKSO CLI Version 0.8.0 or above in order to use the `--checkpoint-sync` command. If you are using an older version, please pass down the checkpoint flag as described in the [LUKSO CLI Documentation](https://github.com/lukso-network/tools-lukso-cli/tree/main#using-checkpoint-syncing). +You will need the LUKSO CLI Version 0.8.0 or above in order to use the `--checkpoint-sync` command. If you are using an older version or run into issues, please pass down the checkpoint flag manually, as described in the [LUKSO CLI Checkpoint Documentation](https://github.com/lukso-network/tools-lukso-cli/tree/main#using-checkpoint-syncing). ::: diff --git a/docs/networks/mainnet/running-a-node.md b/docs/networks/mainnet/running-a-node.md index bd22d35200..a7822c649b 100644 --- a/docs/networks/mainnet/running-a-node.md +++ b/docs/networks/mainnet/running-a-node.md @@ -126,9 +126,9 @@ The shortcut is ideal for making installation, validator migration, or recovery ::: -:::note +:::info -You will need the LUKSO CLI Version 0.8.0 or above in order to use the `--checkpoint-sync` command. If you are using an older version, please pass down the checkpoint flag as described in the [LUKSO CLI Documentation](https://github.com/lukso-network/tools-lukso-cli/tree/main#using-checkpoint-syncing). +You will need the LUKSO CLI Version 0.8.0 or above in order to use the `--checkpoint-sync` command. If you are using an older version or run into issues, please pass down the checkpoint flag manually, as described in the [LUKSO CLI Checkpoint Documentation](https://github.com/lukso-network/tools-lukso-cli/tree/main#using-checkpoint-syncing). ::: From ba7a702c5b6ebc74335461be54f50421b426f9db Mon Sep 17 00:00:00 2001 From: Felix Hildebrandt Date: Wed, 1 Nov 2023 15:38:43 +0100 Subject: [PATCH 4/4] reorder checkpoint sync menu --- docs/networks/mainnet/running-a-node.md | 26 ++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/networks/mainnet/running-a-node.md b/docs/networks/mainnet/running-a-node.md index a7822c649b..62dd85ac5c 100644 --- a/docs/networks/mainnet/running-a-node.md +++ b/docs/networks/mainnet/running-a-node.md @@ -105,19 +105,6 @@ If you want more convenience and your validator to operate quickly, you can also > After the synchronization is finalized, you will end up with the equal blockchain data. You can use the flag on every startup. However, it shows the most significant effect when synchronizing from scratch or after an extended downtime. The shortcut is ideal for fresh installations, validator migration, or recovery. - - -:::info - -The synchronization process will take multiple hours for the node to finalize. - -::: - -```sh -lukso start -``` - - :::tip @@ -137,6 +124,19 @@ lukso start --checkpoint-sync ``` + + +:::info + +The synchronization process will take multiple hours for the node to finalize. + +::: + +```sh +lukso start +``` + + :::info