From beba1d2ccf88c866c0ce785b022d12f52a3c5428 Mon Sep 17 00:00:00 2001 From: antiyro Date: Mon, 2 Dec 2024 14:39:45 +0000 Subject: [PATCH 1/2] fixed some broken links --- pages/Installation/install.en.mdx | 2 +- pages/introduction.en.mdx | 15 +-- pages/liscense.en.mdx | 191 +----------------------------- pages/overview.en.mdx | 4 +- pages/quickstart/launch.en.mdx | 2 +- pages/tutorials-chain/evm.en.mdx | 121 +++++++++++++++++++ 6 files changed, 132 insertions(+), 203 deletions(-) create mode 100644 pages/tutorials-chain/evm.en.mdx diff --git a/pages/Installation/install.en.mdx b/pages/Installation/install.en.mdx index 1ee59ce..e8aa659 100644 --- a/pages/Installation/install.en.mdx +++ b/pages/Installation/install.en.mdx @@ -447,7 +447,7 @@ We want anyone to be able to launch a Madara full node, which is why we've divid You will need to download and run the installer script using the following command: ```bash - curl -sL https://raw.githubusercontent.com/madara-alliance/madara/refs/heads/main/scripts/launcher -o launcher && chmod +x launcher && ./launcher +curl -sL https://madara.build/launcher.sh && chmod +x launcher.sh && ./launcher.sh ``` ### Follow instructions diff --git a/pages/introduction.en.mdx b/pages/introduction.en.mdx index b35e7e3..922e651 100644 --- a/pages/introduction.en.mdx +++ b/pages/introduction.en.mdx @@ -39,12 +39,12 @@ From setting up a Full Node to configuring a Sequencer or your own Devnet, all t } /> } /> } /> } /> - } - /> diff --git a/pages/liscense.en.mdx b/pages/liscense.en.mdx index 2e4d9e2..0c9ca45 100644 --- a/pages/liscense.en.mdx +++ b/pages/liscense.en.mdx @@ -1,190 +1,3 @@ - # Liscence +# License - Madara is under the [Apache Liscence](http://www.apache.org/licenses/) Version 2.0, January 2004 - -TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - -1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - -2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - -3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - -4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - -5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - -6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - -7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - -8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - -9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - -END OF TERMS AND CONDITIONS - -Copyright 2022 - 2023 Madara - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. +Madara is under the [Apache License](http://www.apache.org/licenses/) Version 2.0, January 2004. \ No newline at end of file diff --git a/pages/overview.en.mdx b/pages/overview.en.mdx index a0a4dae..b7ae4f6 100644 --- a/pages/overview.en.mdx +++ b/pages/overview.en.mdx @@ -28,8 +28,8 @@ Welcome to the Chain Operators section of the Madara documentation, your compreh This section is intended to help you configure and customize your Chain. To - configure Madara as a client, you should head up to the [Chain - Operator](/overview) section. + configure Madara as a client, you should head up to the [Node + Operator](/introduction) section. ## Starting Points for Chain Operators diff --git a/pages/quickstart/launch.en.mdx b/pages/quickstart/launch.en.mdx index 9b5acc5..d2eee05 100644 --- a/pages/quickstart/launch.en.mdx +++ b/pages/quickstart/launch.en.mdx @@ -27,7 +27,7 @@ As an introduction to the following section, we created a video tutorial to give ### Download and launch the installer ```bash - curl -sL https://madara.build/launcher.sh && chmod +x launcher && ./launcher +curl -sL https://madara.build/launcher.sh && chmod +x launcher.sh && ./launcher.sh ``` ### Follow the tutorial diff --git a/pages/tutorials-chain/evm.en.mdx b/pages/tutorials-chain/evm.en.mdx new file mode 100644 index 0000000..b23a8cf --- /dev/null +++ b/pages/tutorials-chain/evm.en.mdx @@ -0,0 +1,121 @@ +--- +title: How to Launch Your EVM App Chain? +lang: en-US +description: How to Launch Your EVM App Chain +--- + +import { Steps } from "nextra-theme-docs"; +import { Callout } from "nextra-theme-docs"; +import { Cards, Card } from "nextra/components"; +import { FontAwesomeIcon } from "@fortawesome/react-fontawesome"; +import { + faLinux, + faApple, + faWindows, +} from "@fortawesome/free-brands-svg-icons"; +import { Tabs, Tab } from "nextra/components"; + +# How to Launch Your EVM App Chain + +This guide will walk you through the process of launching an EVM App Chain using the [Kakarot](https://github.com/kkrt-labs/kakarot) deployer. + +## Quick Start Tutorial + +As an introduction to the following section, we have created a video tutorial to give you more context on how to customize your Madara App Chain. + +-- Video goes here -- + + + We recommend continuing with the [Next Section](#step-by-step-tutorial), which + will help you better understand the different components of Madara + as an EVM Starknet client. + + +## Step-by-Step Tutorial + + + Note that this tutorial uses Madara as a devnet to retrieve + + +### Configure Your Madara Client + +Now that you have your client installed and running smoothly in sequencer mode, you may want to configure it further to match your desired setup or network. There are two types of configuration for your node: + +- **Node Configuration**: the configuration of your node itself as a sequencer engine. +- **Chain Configuration**: the configuration of the chain you are currently running your node on. + +In this tutorial, we'll focus on a simple configuration of your App Chain by manipulating only the Chain Configuration (for advanced Node configuration, please visit the [Configuration](fundamentals/configuration) section of the Node Operator guide). + +Here, we will imagine that our node wants to launch a Starknet clone App Chain with the following configuration: + +```yml +chain_name: "Starklone" +chain_id: "SN_KLONE" +native_fee_token_address: "0x012345a0fc34fa1af16a1cdee98ffb20c31f5cd61d6ab07201858f4287c938d" +parent_fee_token_address: "0x012346570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7" +latest_protocol_version: "0.13.2" +block_time: "30s" +pending_block_update_time: "2s" +execution_batch_size: 16 +bouncer_config: +block_max_capacity: + builtin_count: + add_mod: 18446744073709551615 + bitwise: 18446744073709551615 + ecdsa: 18446744073709551615 + ec_op: 18446744073709551615 + keccak: 18446744073709551615 + mul_mod: 18446744073709551615 + pedersen: 18446744073709551615 + poseidon: 18446744073709551615 + range_check: 18446744073709551615 + range_check96: 18446744073709551615 + gas: 5000000 + n_steps: 40000000 + message_segment_length: 18446744073709551615 + n_events: 18446744073709551615 + state_diff_size: 131072 +sequencer_address: "0x01234a1bd84444c89232ec27754698e5d2e7e1a7f1539f12027f28b23ec9f3d8" +eth_core_contract_address: "0xc662c410C0ECf747543f5bA90660f6ABeBD9C8c4" +eth_gps_statement_verifier: "0x47312450B3Ac8b5b8e247a6bB6d523e7605bDb60" +``` + +You simply need to save this configuration as a `.yml` file somewhere on your machine and call it via: + +- **`--chain-config-path `**: Specifies the chain configuration file path. + +In our case, the command would be: + +```bash +cargo run --release -- \ +--name Madara \ +--sequencer \ +--base-path /var/lib/madara \ +--l1-endpoint ${ETHEREUM_API_URL} \ +--chain-config-path "/path/to/your/config.yml" +``` + +Another way to run this configuration would be to override the elements that differ from the original Starknet mainnet configuration using: + +- **`--preset `**: Uses a preset as the chain configuration. + + - Possible values: `mainnet`, `sepolia`, `integration`, `devnet` + +- **`--chain-config-override `**: Overrides specific chain configuration parameters. + +This would give the following command: + +```bash +cargo run --release -- \ +--name Madara \ +--sequencer \ +--preset mainnet \ +--base-path /var/lib/madara \ +--l1-endpoint ${ETHEREUM_API_URL} \ +--rpc-port 9945 \ +--rpc-cors '*' \ +--rpc-external \ +--chain-config-override chain_name="Starklone" chain_id="SN_KLONE" native_fee_token_address="0x012345a0fc34fa1af16a1cdee98ffb20c31f5cd61d6ab07201858f4287c938d" parent_fee_token_address="0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7" sequencer_address="0x01234a1bd84444c89232ec27754698e5d2e7e1a7f1539f12027f28b23ec9f3d8" +``` + +You now know how to customize your App Chain! To learn more about customizing your client, visit the [Node Configuration](/fundamentals/configuration) and [Chain Configuration](/chain-configuration/parameters) sections. From 7e982b80b83e71624a0c4ac506c91b4f96c41473 Mon Sep 17 00:00:00 2001 From: antiyro Date: Mon, 2 Dec 2024 14:40:43 +0000 Subject: [PATCH 2/2] removed evm --- pages/tutorials-chain/evm.en.mdx | 121 ------------------------------- 1 file changed, 121 deletions(-) delete mode 100644 pages/tutorials-chain/evm.en.mdx diff --git a/pages/tutorials-chain/evm.en.mdx b/pages/tutorials-chain/evm.en.mdx deleted file mode 100644 index b23a8cf..0000000 --- a/pages/tutorials-chain/evm.en.mdx +++ /dev/null @@ -1,121 +0,0 @@ ---- -title: How to Launch Your EVM App Chain? -lang: en-US -description: How to Launch Your EVM App Chain ---- - -import { Steps } from "nextra-theme-docs"; -import { Callout } from "nextra-theme-docs"; -import { Cards, Card } from "nextra/components"; -import { FontAwesomeIcon } from "@fortawesome/react-fontawesome"; -import { - faLinux, - faApple, - faWindows, -} from "@fortawesome/free-brands-svg-icons"; -import { Tabs, Tab } from "nextra/components"; - -# How to Launch Your EVM App Chain - -This guide will walk you through the process of launching an EVM App Chain using the [Kakarot](https://github.com/kkrt-labs/kakarot) deployer. - -## Quick Start Tutorial - -As an introduction to the following section, we have created a video tutorial to give you more context on how to customize your Madara App Chain. - --- Video goes here -- - - - We recommend continuing with the [Next Section](#step-by-step-tutorial), which - will help you better understand the different components of Madara - as an EVM Starknet client. - - -## Step-by-Step Tutorial - - - Note that this tutorial uses Madara as a devnet to retrieve - - -### Configure Your Madara Client - -Now that you have your client installed and running smoothly in sequencer mode, you may want to configure it further to match your desired setup or network. There are two types of configuration for your node: - -- **Node Configuration**: the configuration of your node itself as a sequencer engine. -- **Chain Configuration**: the configuration of the chain you are currently running your node on. - -In this tutorial, we'll focus on a simple configuration of your App Chain by manipulating only the Chain Configuration (for advanced Node configuration, please visit the [Configuration](fundamentals/configuration) section of the Node Operator guide). - -Here, we will imagine that our node wants to launch a Starknet clone App Chain with the following configuration: - -```yml -chain_name: "Starklone" -chain_id: "SN_KLONE" -native_fee_token_address: "0x012345a0fc34fa1af16a1cdee98ffb20c31f5cd61d6ab07201858f4287c938d" -parent_fee_token_address: "0x012346570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7" -latest_protocol_version: "0.13.2" -block_time: "30s" -pending_block_update_time: "2s" -execution_batch_size: 16 -bouncer_config: -block_max_capacity: - builtin_count: - add_mod: 18446744073709551615 - bitwise: 18446744073709551615 - ecdsa: 18446744073709551615 - ec_op: 18446744073709551615 - keccak: 18446744073709551615 - mul_mod: 18446744073709551615 - pedersen: 18446744073709551615 - poseidon: 18446744073709551615 - range_check: 18446744073709551615 - range_check96: 18446744073709551615 - gas: 5000000 - n_steps: 40000000 - message_segment_length: 18446744073709551615 - n_events: 18446744073709551615 - state_diff_size: 131072 -sequencer_address: "0x01234a1bd84444c89232ec27754698e5d2e7e1a7f1539f12027f28b23ec9f3d8" -eth_core_contract_address: "0xc662c410C0ECf747543f5bA90660f6ABeBD9C8c4" -eth_gps_statement_verifier: "0x47312450B3Ac8b5b8e247a6bB6d523e7605bDb60" -``` - -You simply need to save this configuration as a `.yml` file somewhere on your machine and call it via: - -- **`--chain-config-path `**: Specifies the chain configuration file path. - -In our case, the command would be: - -```bash -cargo run --release -- \ ---name Madara \ ---sequencer \ ---base-path /var/lib/madara \ ---l1-endpoint ${ETHEREUM_API_URL} \ ---chain-config-path "/path/to/your/config.yml" -``` - -Another way to run this configuration would be to override the elements that differ from the original Starknet mainnet configuration using: - -- **`--preset `**: Uses a preset as the chain configuration. - - - Possible values: `mainnet`, `sepolia`, `integration`, `devnet` - -- **`--chain-config-override `**: Overrides specific chain configuration parameters. - -This would give the following command: - -```bash -cargo run --release -- \ ---name Madara \ ---sequencer \ ---preset mainnet \ ---base-path /var/lib/madara \ ---l1-endpoint ${ETHEREUM_API_URL} \ ---rpc-port 9945 \ ---rpc-cors '*' \ ---rpc-external \ ---chain-config-override chain_name="Starklone" chain_id="SN_KLONE" native_fee_token_address="0x012345a0fc34fa1af16a1cdee98ffb20c31f5cd61d6ab07201858f4287c938d" parent_fee_token_address="0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7" sequencer_address="0x01234a1bd84444c89232ec27754698e5d2e7e1a7f1539f12027f28b23ec9f3d8" -``` - -You now know how to customize your App Chain! To learn more about customizing your client, visit the [Node Configuration](/fundamentals/configuration) and [Chain Configuration](/chain-configuration/parameters) sections.