From 3066150c2ad686af49457a867315b21633aa6c9f Mon Sep 17 00:00:00 2001 From: Owanate Amachree Date: Fri, 1 Nov 2024 13:58:30 +0200 Subject: [PATCH] Update dev-tools left nav categories --- .../rif-suite/rns/specs/resolver.md | 4 +- .../02-overview/index.md | 2 +- .../05-smart-contracts/06-eas/_category_.yml | 5 -- docs/02-developers/07-rpc-api/_category_.yml | 2 +- .../account-abstraction/etherspot.md | 25 ++++++ .../05-dev-tools/account-abstraction/index.md | 53 ++++++------- docs/05-dev-tools/additional-tools/index.md | 44 +++++++++-- .../attestations/eas.md} | 8 +- docs/05-dev-tools/attestations/index.md | 40 ++++++++++ docs/05-dev-tools/code-quality/index.md | 21 ----- .../05-dev-tools/cross-chain-bridges/index.md | 77 ++++++++++++------- docs/05-dev-tools/data/covalent.md | 24 ++++++ docs/05-dev-tools/data/envio.md | 10 +-- docs/05-dev-tools/data/index.md | 66 ++++++++-------- docs/05-dev-tools/data/thegraph.md | 2 + .../foundry.md | 0 .../hardhat.md | 0 docs/05-dev-tools/dev-environments/index.md | 42 ++++++++++ docs/05-dev-tools/dev-environments/remix.md | 26 +++++++ docs/05-dev-tools/environments/index.md | 36 --------- docs/05-dev-tools/explorers/blockscout.md | 2 + docs/05-dev-tools/explorers/index.md | 45 +++++++---- docs/05-dev-tools/explorers/rootstock.md | 6 +- docs/05-dev-tools/index.md | 4 +- docs/05-dev-tools/interoperability/index.md | 15 ---- docs/05-dev-tools/mining/index.md | 19 ----- docs/05-dev-tools/no-code/index.md | 45 +++++++++++ docs/05-dev-tools/node-rpc/index.md | 62 ++++++++++++--- docs/05-dev-tools/oracles/index.md | 34 ++++++++ docs/05-dev-tools/sdks/index.md | 11 --- src/pages/components.md | 2 +- vercel.json | 4 +- 32 files changed, 494 insertions(+), 242 deletions(-) delete mode 100644 docs/02-developers/05-smart-contracts/06-eas/_category_.yml create mode 100644 docs/05-dev-tools/account-abstraction/etherspot.md rename docs/{02-developers/05-smart-contracts/06-eas/overview.md => 05-dev-tools/attestations/eas.md} (95%) create mode 100644 docs/05-dev-tools/attestations/index.md delete mode 100644 docs/05-dev-tools/code-quality/index.md create mode 100644 docs/05-dev-tools/data/covalent.md rename docs/05-dev-tools/{environments => dev-environments}/foundry.md (100%) rename docs/05-dev-tools/{environments => dev-environments}/hardhat.md (100%) create mode 100644 docs/05-dev-tools/dev-environments/index.md create mode 100644 docs/05-dev-tools/dev-environments/remix.md delete mode 100644 docs/05-dev-tools/environments/index.md delete mode 100644 docs/05-dev-tools/interoperability/index.md delete mode 100644 docs/05-dev-tools/mining/index.md create mode 100644 docs/05-dev-tools/no-code/index.md create mode 100644 docs/05-dev-tools/oracles/index.md delete mode 100644 docs/05-dev-tools/sdks/index.md diff --git a/docs/01-concepts/rif-suite/rns/specs/resolver.md b/docs/01-concepts/rif-suite/rns/specs/resolver.md index ad0a9514..112585d6 100644 --- a/docs/01-concepts/rif-suite/rns/specs/resolver.md +++ b/docs/01-concepts/rif-suite/rns/specs/resolver.md @@ -12,9 +12,9 @@ Resolvers MUST specify a fallback function that throws. Resolvers must implement ERC-165 interface detection standard. supportsInterface method must return if the interfaceID queried is simply equal to the signature hash of the function that resolves the desired resource record. -Currently standardized resolver interfaces are specified below. + ### Contract address diff --git a/docs/02-developers/03-blockchain-essentials/02-overview/index.md b/docs/02-developers/03-blockchain-essentials/02-overview/index.md index 29b70943..f4ca8595 100644 --- a/docs/02-developers/03-blockchain-essentials/02-overview/index.md +++ b/docs/02-developers/03-blockchain-essentials/02-overview/index.md @@ -146,7 +146,7 @@ Thus, the smart contract/dApp development skills that you’re used to will tran ### Tools - [Hardhat](https://hardhat.org/docs) is an Ethereum development environment designed for professionals. It's primarily used in the development of smart contracts for the Ethereum blockchain. - Refer to the [Hardhat Overview](/dev-tools/environments/hardhat/) for an overview of how it's used on Rootstock. + Refer to the [Hardhat Guides](/dev-tools/dev-environments/hardhat/) for guides on how to use Hardhat on Rootstock. - [Metamask](https://metamask.io/) is a browser extension cryptocurrency wallet or mobile app, enabling users to interact with the Rootstock blockchain, diff --git a/docs/02-developers/05-smart-contracts/06-eas/_category_.yml b/docs/02-developers/05-smart-contracts/06-eas/_category_.yml deleted file mode 100644 index 643f9338..00000000 --- a/docs/02-developers/05-smart-contracts/06-eas/_category_.yml +++ /dev/null @@ -1,5 +0,0 @@ -label: Getting Started with EAS -position: 300 -link: - type: generated-index - slug: /developers/smart-contracts/eas/ \ No newline at end of file diff --git a/docs/02-developers/07-rpc-api/_category_.yml b/docs/02-developers/07-rpc-api/_category_.yml index f43799ed..1acf63aa 100644 --- a/docs/02-developers/07-rpc-api/_category_.yml +++ b/docs/02-developers/07-rpc-api/_category_.yml @@ -4,4 +4,4 @@ position: 5 link: type: generated-index slug: /developers/rpc-api/ - description: "RPC API services for interacting with Rootstock network." \ No newline at end of file + description: RPC API services for interacting with Rootstock network. \ No newline at end of file diff --git a/docs/05-dev-tools/account-abstraction/etherspot.md b/docs/05-dev-tools/account-abstraction/etherspot.md new file mode 100644 index 00000000..e0b2c3a1 --- /dev/null +++ b/docs/05-dev-tools/account-abstraction/etherspot.md @@ -0,0 +1,25 @@ +--- +sidebar_position: 100 +sidebar_label: Etherspot Prime SDK +title: Account Abstraction using Etherspot Prime SDK +description: "Create a seamless user experience for your dApps on Rootstock and EVM-compatible chains." +tags: [etherspot, account abstraction, developer tools, rsk, rootstock, ethereum, dApps, smart contracts] +--- + +Etherspot is an Account Abstraction infrastructure designed to help developers create a seamless web3 user experience for users interacting with their dApps. + +Available on: + +## Features + +Etherspot offers the following AA services: + +* [Account abstraction Prime SDK](https://etherspot.fyi/prime-sdk/intro) — From social logins, sponsored transactions to transaction batching, using an Etherspot smart wallet can give your dApps a web2-like interface to improve the experience for users. +* [TransactionKit](https://etherspot.io/transactionkit) - A smart account React library for fast and simple web3 development. +* [Skandha Bundler](https://github.com/etherspot/skandha) - A modular, developer-friendly Typescript Bundler for Ethereum EIP-4337 Account Abstraction +* [Arka Paymaster](https://etherspot.fyi/arka/intro) - An open-source Paymaster service for gasless and sponsored transactions. + +If you have any questions, do not hesitate to reach out to the team on [Discord](http://discord.gg/rootstock). + +## Related Guides +* [Account Abstraction using Etherspot Prime SDK](/developers/quickstart/rootstock-etherspot/) \ No newline at end of file diff --git a/docs/05-dev-tools/account-abstraction/index.md b/docs/05-dev-tools/account-abstraction/index.md index 93e75f27..e93d8f83 100644 --- a/docs/05-dev-tools/account-abstraction/index.md +++ b/docs/05-dev-tools/account-abstraction/index.md @@ -1,44 +1,45 @@ --- sidebar_position: 3 sidebar_label: Account Abstraction -title: Account Abstraction -description: "How to get started with writing, deploying and testing smart contracts on Rootstock using Hardhat." +title: Account Abstraction on Rootstock +description: "Create smarter accounts that give users a seamless web3 experience" tags: [hardhat, quick start, developer tools, rsk, rootstock, ethereum, dApps, smart contracts] --- +Account abstraction refers to the different ways to create and manage accounts, other than using a Secret Recovery Phrase and a wallet. -Account abstraction enables the creation of new types of accounts called “contract-type accounts” or simply “accounts”. These accounts can hold both code and ether, and they can execute transactions and smart contract functions. This means that contracts can directly control and manipulate funds, eliminating the need for a separate EOA to initiate transactions. +It enables the creation of new types of accounts called “contract-type accounts” or simply “accounts”. These accounts can hold both code and ether, and they can execute transactions and smart contract functions. This means that contracts can directly control and manipulate funds, eliminating the need for a separate EOA to initiate transactions. Simply put; Regular accounts hold your crypto and need your private key for transactions. Account abstraction lets you create smarter accounts like mini-apps that hold your crypto and can send transactions without needing your key every time. -## Benefits - -Account abstraction brings several benefits to the Rootstock ecosystem: - +Some benefits include: - Enhanced efficiency: By allowing contracts to directly control funds, account abstraction reduces the number of transactions and storage operations required. This leads to improved efficiency and reduces gas costs. - Improved privacy: Account abstraction enables the creation of more sophisticated smart contracts that can handle transactions privately within the contract itself. It eliminates the need for external transactions, enhancing privacy for users. - Flexible fee payment models: With account abstraction, contracts can pay transaction fees on behalf of users. This allows for more flexible fee payment models, such as subscriptions or microtransactions, where users don’t need to have ether to execute transactions. - Customized transaction semantics: Account abstraction opens up possibilities for customizing transaction semantics. Contracts can define their own rules and conditions for executing transactions, enabling more complex and dynamic interactions. -## Account Abstraction Solutions on Rootstock - -## Etherspot - -Etherspot is a top-notch Account Abstraction infrastructure designed to help developers create an unparalleled user experience for their blockchain protocols on Ethereum and EVM-compatible chains. Get started with [Account Abstraction on Rootstock using Etherspot Prime SDK](https://etherspot.fyi/prime-sdk/intro). - -Currently available on: - - - - YES - - - NO - - - -## Gelato - +The Rootstock network is innovating in the account abstraction space, here are solutions that can be used for building your dApps with account abstraction capabilities on Rootstock. + +

+ + + + + diff --git a/docs/05-dev-tools/additional-tools/index.md b/docs/05-dev-tools/additional-tools/index.md index 16a13b39..487f3911 100644 --- a/docs/05-dev-tools/additional-tools/index.md +++ b/docs/05-dev-tools/additional-tools/index.md @@ -1,5 +1,5 @@ --- -sidebar_position: 12 +sidebar_position: 13 sidebar_label: General Tools title: General Tools description: "How to get started with writing, deploying and testing smart contracts on Rootstock using Hardhat." @@ -8,16 +8,46 @@ tags: [hardhat, quick start, developer tools, rsk, rootstock, ethereum, dApps, s ## Faucets -* [Rootstock Faucet](https://faucet.rootstock.io/) +* [Rootstock Faucet](https://faucet.rootstock.io/): Get free RBTC testnet tokens for development and testing. +* [RIF Testnet Faucet](https://faucet.rifos.org/): Obtain free RIF testnet tokens to explore the RIF ecosystem. -* [RIF Testnet Faucet](https://faucet.rifos.org/) +## Gas Fees +* [Rootstock Gas Station](https://rskgasstation.info/?AspxAutoDetectCookieSupport=1): Estimate gas fees for your transactions on the Rootstock network. -## Gas +## Exchanges - Getting RBTC -* [Rootstock Gas Station](https://rskgasstation.info/?AspxAutoDetectCookieSupport=1) +To acquire RBTC or RIF, you can use various methods: -## Exchanges +* Exchanges: Purchase RBTC or RIF on cryptocurrency exchanges that support them. See the [RBTC](https://rootstock.io/rbtc/) section to get started. To get RIF, see the [RIF Token](https://rif.technology/rif-token/) section. +* Bridges: Transfer your tokens from other blockchains to the Rootstock network using bridges. -You can get RBTC via exchanges and bridges. See the [RBTC](https://rootstock.io/rbtc/) section to get started. To get RIF, see the [RIF Token](https://rif.technology/rif-token/) section. +## Code Quality +To ensure the quality and security of your smart contracts, consider using these tools: +* Sourcify: Verify and document your Solidity contracts to enhance transparency and readability. +* Slither: Identify potential vulnerabilities and optimize your codebase for efficiency and security. + +## dApp Testing + +Effectively test your dApps with these tools: + +* Cucumber: Write clear and concise test scenarios using Gherkin syntax. Get started using the [dApp automation with Cucumber and Playwright](/resources/tutorials/dapp-automation-cucumber) +* Playwright: Automate browser interactions to simulate real-world user behavior. +* Synpress: Specifically designed for dApp testing, seamlessly integrates with MetaMask and other wallets. + +## Mining Tools + +Interested in mining on the Rootstock network? Consider using these mining pools: + +* [BraiinsPool](https://braiins.com/pool) +* [Luxor](https://luxor.tech/mining) +* [F2Pool](https://www.f2pool.com/) +* [ViaBTC](https://www.viabtc.com/) +* [Antpool](https://www.antpool.com/home) + +:::info[Info] + +If you're looking to set up your node for merged mining. See the [Node Operator](/node-operators/merged-mining/) section for more information. + +::: \ No newline at end of file diff --git a/docs/02-developers/05-smart-contracts/06-eas/overview.md b/docs/05-dev-tools/attestations/eas.md similarity index 95% rename from docs/02-developers/05-smart-contracts/06-eas/overview.md rename to docs/05-dev-tools/attestations/eas.md index c6a6c599..df400efa 100644 --- a/docs/02-developers/05-smart-contracts/06-eas/overview.md +++ b/docs/05-dev-tools/attestations/eas.md @@ -1,7 +1,7 @@ --- -sidebar_position: 310 +sidebar_position: 100 title: Ethereum Attestation Service -sidebar_label: Overview +sidebar_label: Ethereum Attestation Service description: "Ethereum Attestation Service (EAS) is an open-source infrastructure public good for making attestations onchain or offchain. Learn how to use it on Rootstock." tags: [rsk, rootstock, guides, EAS, Attestation, Ethereum] --- @@ -10,6 +10,8 @@ tags: [rsk, rootstock, guides, EAS, Attestation, Ethereum] EAS is a foundational layer that empowers anyone to make attestations about anything. By creating a decentralized ledger of verifiable claims, we can revolutionize traditional finance, build decentralized reputation systems, voting mechanisms, governance frameworks, social media platforms, supply chain tracking systems, knowledge graphs, and lots more. +Available on: + ## How EAS is integrated with Rootstock The EAS essential contracts has been successfully deployed to Rootstock, this includes a robust indexer, and a user-friendly alternative explorer. The following sections will delve into the technical details of these implementations. @@ -67,6 +69,6 @@ Find the deployed EAS contracts on Rootstock Mainnet and Tesnet: - [EAS](https://attest.org/) - [Core Concepts](https://docs.attest.org/docs/category/core-concepts) - [How EAS Works](https://docs.attest.org/docs/core--concepts/how-eas-works) -- [Use Cases](https://docs.attest.org/docs/quick--start/use-cases-overview)] +- [Use Cases](https://docs.attest.org/docs/quick--start/use-cases-overview) - [EAS Docs](https://docs.attest.org/docs/welcome) - [EAS Github](https://github.com/ethereum-attestation-service) \ No newline at end of file diff --git a/docs/05-dev-tools/attestations/index.md b/docs/05-dev-tools/attestations/index.md new file mode 100644 index 00000000..8f251c7a --- /dev/null +++ b/docs/05-dev-tools/attestations/index.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 11 +sidebar_label: Attestations +title: Attestations on Rootstock +description: "An attestation is a digital certificate or proof that verifies a specific claim or fact. Learn about how to verify or attest documents, identity, asset ownership in your dApps using attestation tools on Rootstock." +tags: [attestation, eas, developer tools, rsk, rootstock, ethereum, dApps, smart contracts] +--- + +An attestation is a digital certificate or proof that verifies a specific claim or fact. It's like a digital stamp of approval, confirming something is true or has occurred. + +## Real-world Examples + +* Passport: A physical document attesting to a person's citizenship and right to travel internationally. +* University Degree: A certificate confirming academic achievement and qualifications. +* Driver's License: A legal document certifying the holder's ability to operate a motor vehicle. + +## Web3 Attestations + +In the web3 world, attestations are taking on a new dimension. They can be used to verify: + +* Digital Identity: Proving one's identity without relying on centralized authorities. +* Asset Ownership: Confirming ownership of digital assets like NFTs or cryptocurrency. +* Credential Verification: Verifying skills, certifications, and work experience. + +The Rootstock network is innovating in the attestation space, here are solutions that can be used for attesting documents or verifying identities within your dApps. + +

+ + + + + + diff --git a/docs/05-dev-tools/code-quality/index.md b/docs/05-dev-tools/code-quality/index.md deleted file mode 100644 index c38aa178..00000000 --- a/docs/05-dev-tools/code-quality/index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -sidebar_position: 9 -sidebar_label: Code Quality -title: Code Quality -description: "How to get started with writing, deploying and testing smart contracts on Rootstock using Hardhat." -tags: [hardhat, quick start, developer tools, rsk, rootstock, ethereum, dApps, smart contracts] ---- - -Here you can find tools to test and verify your smart contracts. - -## Sourcify - -Sourcify enables transparent and human-readable smart contract interactions through automated Solidity contract verification, contract metadata, and NatSpec comments. - -## Slither - -The Slither framework provides automated vulnerability and optimization detection, as well as assistive codebase summaries to further developer comprehension. - -## Cucumber - -Cucumber's user-friendly behavior-driven development, Playwright's precise browser automation, and the tailored dApp testing capabilities of Synpress. With Cucumber's Gherkin syntax, teams collaboratively define DApp behaviors. Playwright, customized for Chrome, adds finesse to browser automation. Synpress, in its Playwright version, effortlessly integrates with MetaMask (more software wallets to come) for thorough dApp testing. Get started using the [dApp automation with Cucumber and Playwright](/resources/tutorials/dapp-automation-cucumber) \ No newline at end of file diff --git a/docs/05-dev-tools/cross-chain-bridges/index.md b/docs/05-dev-tools/cross-chain-bridges/index.md index 989965cc..cd37176f 100644 --- a/docs/05-dev-tools/cross-chain-bridges/index.md +++ b/docs/05-dev-tools/cross-chain-bridges/index.md @@ -1,31 +1,56 @@ --- sidebar_position: 5 -sidebar_label: Cross Chain Bridges -title: Cross Chain Bridges +sidebar_label: Cross Chain +title: Cross Chain - Bridging between Blockchains description: "How to get started with writing, deploying and testing smart contracts on Rootstock using Hardhat." -tags: [hardhat, quick start, developer tools, rsk, rootstock, ethereum, dApps, smart contracts] +tags: [cross chain, bridges, developer tools, rsk, rootstock, ethereum, dApps, smart contracts] --- -## Router Protocol - -Router Protocol is a layer-1 blockchain enabling chain abstraction. - -## Chainport - -Chainport is a cross-chain bridge integrated with Rootstock. - -## Wormhole - -Wormhole provides access to all the information you need to develop secure multichain applications powered by Wormhole on Rootstock. - -## Tokenbridge - -Safely move your ERC20 tokens between Rootstock and Ethereum with the Tokenbridge dApp. This user-friendly interface lets you interact with the Token Bridge contracts directly. It is available on [Mainnet](https://dapp.tokenbridge.rootstock.io/) or [Testnet](https://dapp.testnet.bridges.rootstock.io/). - -## PowPeg App - -The [PowPeg App](https://powpeg.rootstock.io/) converts BTC to RBTC and vice versa. It is secured by the [PowPeg protocol](/concepts/powpeg/), which is a unique protocol that secures the locked bitcoins with the same Bitcoin hashrate that establishes consensus. - -It is a web application that fosters the interaction between the bitcoin blockchain and the Rootstock network for easier exchange of BTC and RBTC. It also provides a way to visualize the status of transactions, communicate with a user wallet (both hardware wallets and software wallets), while also providing the highest possible level of security for transactions. - -Get started with the [PowPeg App](/resources/guides/powpeg-app/) \ No newline at end of file +Imagine different islands, each with its own unique economy and currency. To trade with each other, these islands need bridges to connect them. In the world of blockchain, these islands are different blockchains, and the bridges are cross-chain bridges. + +## Why do we need cross-chain bridges? + +* Seamless Asset Movement: Just like you can move money between different bank accounts, cross-chain bridges allow you to move your digital assets (like cryptocurrencies or NFTs) between different blockchains. +* Expanded Opportunities: By connecting different blockchains, you can access a wider range of financial services, decentralized applications (dApps), and investment opportunities. + +## How do cross-chain bridges work? + +* Lock and Mint: When you want to move assets from one blockchain (let's call it Chain A) to another (Chain B), the bridge locks your assets on Chain A and mints a corresponding amount of wrapped assets on Chain B. +* Transfer and Burn: You can then transfer these wrapped assets on Chain B. Once you're ready to move them back to Chain A, the bridge burns the wrapped assets on Chain B and releases your original assets on Chain A. + +## Bridging Solutions on Rootstock + + + + + + + \ No newline at end of file diff --git a/docs/05-dev-tools/data/covalent.md b/docs/05-dev-tools/data/covalent.md new file mode 100644 index 00000000..b5af701f --- /dev/null +++ b/docs/05-dev-tools/data/covalent.md @@ -0,0 +1,24 @@ +--- +sidebar_label: Covalent +sidebar_position: 4 +title: Get Started with Covalent +description: "Covalent provides the industry-leading Unified API bringing visibility to billions of Web3 data points. Developers use Covalent to build exciting multi-chain applications like crypto wallets, NFT galleries, and investor dashboard tools utilizing data from 100+ blockchains including Rootstock." +tags: [Covalent, indexers, data, dApps, smart contracts, developers, developer tools, get-started] +--- + +Covalent provides the industry-leading Unified API bringing visibility to billions of Web3 data points. Developers use Covalent to build exciting multi-chain applications like crypto wallets, NFT galleries, and investor dashboard tools utilizing data from 100+ blockchains including Rootstock. + +The Covalent API maintains a full archival copy of every supported blockchain, meaning every balance, transaction, log event, and NFT asset data is available from the genesis block. This data is available via: + +1. [Unified API](#unified-api) - Incorporate blockchain data into your app with a familiar REST API +2. [Increment](#increment) - Create and embed custom charts with no-code analytics + +### Why use Covalent? + +Use Covalent if you need: +* Structured and enhanced on-chain data well beyond what you get from RPC providers +* Broad and deep multi-chain data at scale +* Enterprise-grade performance + + + diff --git a/docs/05-dev-tools/data/envio.md b/docs/05-dev-tools/data/envio.md index de8d9c75..55f46033 100644 --- a/docs/05-dev-tools/data/envio.md +++ b/docs/05-dev-tools/data/envio.md @@ -6,7 +6,9 @@ description: "Easily query on-chain data through a decentralized network of inde tags: [Envio, indexers, data, subgraphs, dApps, smart contracts, developers, developer tools, get-started, how-to] --- -[Envio](https://envio.dev/) is a feature-rich indexing solution that provides developers with a seamless and efficient way to index and aggregate real-time or historical blockchain data for Rootstock, and **other EVM chains**. The indexed data is easily accessible through custom [GraphQL](https://graphql.org/) queries, giving developers the flexibility and power to retrieve specific information. See [Getting started with Envio](/dev-tools/data/envio/) +[Envio](https://envio.dev/) is a feature-rich indexing solution that provides developers with a seamless and efficient way to index and aggregate real-time or historical blockchain data for Rootstock, and **other EVM chains**. The indexed data is easily accessible through custom [GraphQL](https://graphql.org/) queries, giving developers the flexibility and power to retrieve specific information. See [Getting started with Envio](/dev-tools/data/envio/). + +Available on: Developers can choose whether they want to start from a template (e.g. Blank, ERC-20, etc.), or use the Contract Import feature: @@ -14,18 +16,16 @@ Developers can choose whether they want to start from a template (e.g. Blank, ER The following are the prerequisite packages required for Envio: -* [Node.js](http://node.js) (use[ v18](https://nodejs.org/download/release/v18.18.0/) or newer) -* [pnpm](https://pnpm.io/installation) (use v8 or newer) +* [Node.js](http://node.js) or newer +* [pnpm](https://pnpm.io/installation) or newer * [Docker Desktop](https://www.docker.com/products/docker-desktop/) Docker is required specifically for running the Envio indexer locally. - ## Installation You can install Envio by running the command below: - ```bash npm i -g envio ``` diff --git a/docs/05-dev-tools/data/index.md b/docs/05-dev-tools/data/index.md index cf1f7226..6119d625 100644 --- a/docs/05-dev-tools/data/index.md +++ b/docs/05-dev-tools/data/index.md @@ -1,39 +1,43 @@ --- sidebar_position: 5 -sidebar_label: On chain data & Indexing +sidebar_label: Data Indexers title: Data Indexing description: "How to get started with writing, deploying and testing smart contracts on Rootstock using Hardhat." tags: [hardhat, quick start, developer tools, rsk, rootstock, ethereum, dApps, smart contracts] --- -## TheGraph +Data indexers act like librarians for blockchain data, organizing and storing information in a way that's easy to access. This makes it easier for dApps to get the data they need, which in turn makes dApps faster and more efficient. + +## Why are data indexers important? + +* Speed: Indexers provide pre-organized data, saving time and resources. +* Performance: They help dApps work smoothly, especially when dealing with a lot of data. +* Scalability: Indexers allow dApps to handle more users and data without slowing down. + + + + + + -Getting historical data on smart contracts can be challenging when building dApps. [The Graph](https://thegraph.com/) provides an easy way to query smart contracts data through APIs known as [subgraphs](https://thegraph.com/docs/en/developing/developer-faqs/#1-what-is-a-subgraph). Its infrastructure relies on a decentralized network of indexers, enabling dApps to achieve true decentralization. See [Getting started with TheGraph](./thegraph.md). - -## Envio - -[Envio](https://envio.dev/) is a feature-rich indexing solution that provides developers with a seamless and efficient way to index and aggregate real-time or historical blockchain data for Rootstock, and **other EVM chains**. The indexed data is easily accessible through custom [GraphQL](https://graphql.org/) queries, giving developers the flexibility and power to retrieve specific information. - -Envio offers native support for Rootstock and has been designed to support high-throughput blockchain applications that rely on real-time data for their business requirements. - -Designed to optimize the developer experience, Envio offers automatic code generation, flexible language support, quickstart templates, and a reliable, cost-effective hosted service. - -Indexers on Envio can be written in [JavaScript](https://www.javascript.com/), [TypeScript](https://www.typescriptlang.org/), or [ReScript](https://rescript-lang.org/). - -## Covalent - -Covalent provides the industry-leading Unified API bringing visibility to billions of Web3 data points. Developers use Covalent to build exciting multi-chain applications like crypto wallets, NFT galleries, and investor dashboard tools utilizing data from 100+ blockchains including Rootstock. - -The Covalent API maintains a full archival copy of every supported blockchain, meaning every balance, transaction, log event, and NFT asset data is available from the genesis block. This data is available via: - -1. [Unified API](#unified-api) - Incorporate blockchain data into your app with a familiar REST API -2. [Increment](#increment) - Create and embed custom charts with no-code analytics - -### Why use Covalent? - -Use Covalent if you need: -* Structured and enhanced on-chain data well beyond what you get from RPC providers -* Broad and deep multi-chain data at scale -* Enterprise-grade performance - -> **[Sign up to start building on Rootstock](https://www.covalenthq.com/platform/?utm_source=rootstock&utm_medium=partner-docs)** diff --git a/docs/05-dev-tools/data/thegraph.md b/docs/05-dev-tools/data/thegraph.md index 5229fbe0..df9a34c5 100644 --- a/docs/05-dev-tools/data/thegraph.md +++ b/docs/05-dev-tools/data/thegraph.md @@ -8,6 +8,8 @@ tags: [TheGraph, indexers, data, subgraphs, dApps, smart contracts, developers, Getting historical data on smart contracts can be challenging when building dApps. [The Graph](https://thegraph.com/) provides an easy way to query smart contracts data through APIs known as [subgraphs](https://thegraph.com/docs/en/developing/developer-faqs/#1-what-is-a-subgraph). Its infrastructure relies on a decentralized network of indexers, enabling dApps to achieve true decentralization. +Available on: + These subgraphs only take a few minutes to set up and get running. To get started, follow these steps below: diff --git a/docs/05-dev-tools/environments/foundry.md b/docs/05-dev-tools/dev-environments/foundry.md similarity index 100% rename from docs/05-dev-tools/environments/foundry.md rename to docs/05-dev-tools/dev-environments/foundry.md diff --git a/docs/05-dev-tools/environments/hardhat.md b/docs/05-dev-tools/dev-environments/hardhat.md similarity index 100% rename from docs/05-dev-tools/environments/hardhat.md rename to docs/05-dev-tools/dev-environments/hardhat.md diff --git a/docs/05-dev-tools/dev-environments/index.md b/docs/05-dev-tools/dev-environments/index.md new file mode 100644 index 00000000..2b1e1456 --- /dev/null +++ b/docs/05-dev-tools/dev-environments/index.md @@ -0,0 +1,42 @@ +--- +sidebar_position: 2 +sidebar_label: Dev Environments +title: Dev Environments +description: "How to get started with writing, deploying and testing smart contracts on Rootstock using Hardhat." +tags: [hardhat, quick start, developer tools, rsk, rootstock, ethereum, dApps, smart contracts] +--- + +Dev Environments provide a complete set of tools for writing, testing, and deploying your smart contracts on Rootstock. + +Some benefits of using a dev environment: + +* Streamlined Workflow: No need to cobble together tools from different sources – everything you need is in one place. +* Efficiency: Dev environments automate repetitive tasks, saving you time and effort. +* Error Reduction: Built-in features can help you catch bugs in your code before deployment. + + + + + + diff --git a/docs/05-dev-tools/dev-environments/remix.md b/docs/05-dev-tools/dev-environments/remix.md new file mode 100644 index 00000000..44c5625c --- /dev/null +++ b/docs/05-dev-tools/dev-environments/remix.md @@ -0,0 +1,26 @@ +--- +sidebar_position: 4 +sidebar_label: Remix +title: Remix on Rootstock +description: "How to get started with writing, deploying and testing smart contracts on Rootstock using Remix." +tags: [remix, quick start, developer tools, rsk, rootstock, ethereum, dApps, smart contracts] +--- + +The process of writing, compiling and deploying Solidity contracts can be tedious or a bit obscure at the beginning, if you try to do it programmatically or using terminals. Get started writing, compiling, and deploying Solidity contracts quickly with Remix. + +[Remix](https://remix.ethereum.org/) is an online web tool used to write, compile, deploy and debug Solidity code. It can be connected with Metamask and used to deploy smart contracts to both the Rootstock Testnet and Mainnet. + +Some benefits of using Remix include: + +* Ideal for beginners: Get started with smart contract development without any upfront investment. +* No Cost: It's a free tool, making it accessible to anyone +* Remix offers a clean and intuitive interface that is easy to navigate, even for beginners. +* No Setup Required: It's a web-based tool, so no local setup is needed, making it accessible from any device with an internet connection. +* Solidity Compiler: Built-in compiler for writing and compiling Solidity smart contracts.   +* Debugger: Powerful debugger to step through code execution, inspect variables, and identify errors.   +* Simulator: Simulate blockchain environments to test smart contracts without deploying them to a live network. +* Deployment: Easily deploy smart contracts to various networks, including Rootstock's testnet and mainnet.   +* Plugin Ecosystem: A rich ecosystem of plugins for extending functionality, such as code analysis, security audits, and more. +* Community and Support: A large and active community of developers provides support and shares knowledge + + diff --git a/docs/05-dev-tools/environments/index.md b/docs/05-dev-tools/environments/index.md deleted file mode 100644 index 9380dd5b..00000000 --- a/docs/05-dev-tools/environments/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -sidebar_position: 2 -sidebar_label: Environments -title: Dev Environments -description: "How to get started with writing, deploying and testing smart contracts on Rootstock using Hardhat." -tags: [hardhat, quick start, developer tools, rsk, rootstock, ethereum, dApps, smart contracts] ---- - -## Hardhat -[Hardhat](https://hardhat.org/docs) is an Ethereum development environment for developers. It's primarily used in the development of smart contracts for the Rootstock and EVM-compatible chains. - -### Resources -* [Hardhat Quick Start Guide](/developers/quickstart/) -* [Hardhat Guide](/developers/smart-contracts/) - - -## Remix - -[Remix](https://remix.ethereum.org/) is an online web tool. It is an IDE (Integrated Development Environment) used to write, compile, deploy and debug Solidity code. Can be connected with Metamask and used to deploy smart contracts to both the Rootstock Testnet and Mainnet. - -## Foundry - -[Foundry](https://book.getfoundry.sh) is a smart contract development toolchain, and user-friendly development environment for writing and testing smart contracts in Solidity. It manages dependencies, compiles, run tests, deploy contracts and allows for interaction with EVM-compatible chains using a command-line tool called [Forge](https://book.getfoundry.sh/forge/). - -### Resources -* [Getting started with Foundry](/developers/smart-contracts/foundry/) - -## No Code Platforms - -### CryptoDO - -CryptoDo is a multichain, no-code web3 solution builder for businesses. - -### Forward Protocol - -Build a dApp on Rootstock using Forward Protocol's no-code tools. \ No newline at end of file diff --git a/docs/05-dev-tools/explorers/blockscout.md b/docs/05-dev-tools/explorers/blockscout.md index e083d69b..fff756e5 100644 --- a/docs/05-dev-tools/explorers/blockscout.md +++ b/docs/05-dev-tools/explorers/blockscout.md @@ -7,6 +7,8 @@ tags: [rsk, explorer, rootstock, Blockscout, smart contracts, transactions, tool [Blockscout](https://rootstock.blockscout.com/) is a robust open-source tool for exploring transactions on any EVM blockchain, including Rootstock, the leading Bitcoin sidechain1. With Blockscout, you can access in-depth information, verify and interact with smart contracts, create and manage your account, view advanced statistics, and more. +Available on: +
Roostock blockscout page
To use Blockscout with Rootstock, visit the [Rootstock Block Explorer](https://rootstock.blockscout.com/), where you can see the latest blocks, transactions, and addresses on the Rootstock network. diff --git a/docs/05-dev-tools/explorers/index.md b/docs/05-dev-tools/explorers/index.md index 0ddf54f1..196d0ac5 100644 --- a/docs/05-dev-tools/explorers/index.md +++ b/docs/05-dev-tools/explorers/index.md @@ -1,23 +1,36 @@ --- sidebar_position: 4 sidebar_label: Explorers -title: Explorers +title: Explorers on Rootstock description: "How to get started with writing, deploying and testing smart contracts on Rootstock using Hardhat." tags: [hardhat, quick start, developer tools, rsk, rootstock, ethereum, dApps, smart contracts] --- -## Explorers - -Here's a list of Blockchain explorers on Rootstock. - -### Rootstock Explorer - -The [Rootstock Explorer](https://explorer.rootstock.io/) provides a UI for exploring and verifying transactions, blocks, addresses, tokens, stats, and interacting with smart contracts. - -### Blockscout Explorer - -[Blockscout](https://rootstock.blockscout.com/) is a robust open-source tool for exploring transactions on any EVM blockchain, including Rootstock, the leading Bitcoin sidechain1. With Blockscout, you can access in-depth information, verify and interact with smart contracts, create and manage your account, view advanced statistics, and more. - -### 3xpl - -[3xpl](https://3xpl.com/rootstock) 3xpl (short for 3xplor3r) is a super-fast, universal explorer for most popular public blockchains. It offers an easy-to-understand block explorer interface for ordinary crypto users, as well as lots of professional features for developers and analysts. \ No newline at end of file +Blockchain explorers are powerful tools that allow you to dive deep into the world of blockchain activity. They function like search engines for blockchains, letting you explore transactions, blocks, addresses, tokens, and even interact with smart contracts. + + + + + + diff --git a/docs/05-dev-tools/explorers/rootstock.md b/docs/05-dev-tools/explorers/rootstock.md index eee9006f..92c85a25 100644 --- a/docs/05-dev-tools/explorers/rootstock.md +++ b/docs/05-dev-tools/explorers/rootstock.md @@ -1,13 +1,15 @@ --- sidebar_position: 3 -sidebar_label: Rootstock Explorers -title: Overview of the Rootstock Explorer +sidebar_label: Rootstock Explorer +title: Get Started with the Rootstock Explorer tags: [overview, explorer, rootstock, smart contracts, transactions, developer tools] description: Explore transaction --- You can browse the overview of Rootstock on the [explorer page](https://explorer.rootstock.io/) as shown below. +Available on: +
overview of explorer
## Switch between Tabs diff --git a/docs/05-dev-tools/index.md b/docs/05-dev-tools/index.md index 3c2587b2..66718638 100644 --- a/docs/05-dev-tools/index.md +++ b/docs/05-dev-tools/index.md @@ -1,6 +1,6 @@ --- sidebar_position: 1 -title: Developer Tools +title: Developer Tooling and Infrastructure sidebar_label: All Tools tags: [rsk, rootstock, tools, developer tools] description: "Explore a curated selection of smart contract development tools and languages. From the familiar Solidity to Rust or Developer Environments like Hardhat, you'll find everything you need to interact and deploy your smart contracts on Rootstock." @@ -64,7 +64,7 @@ description: "Explore a curated selection of smart contract development tools an title="Hardhat" subtitle="Dev Environments" color="orange" - linkHref="/dev-tools/environments/hardhat/" + linkHref="/dev-tools/dev-environments/hardhat/" linkTitle="Deploy Smart Contracts" description="Hardhat is an Ethereum development environment for developers. It's primarily used in the development of smart contracts for the Rootstock and EVM-compatible chains." /> diff --git a/docs/05-dev-tools/interoperability/index.md b/docs/05-dev-tools/interoperability/index.md deleted file mode 100644 index b4e524c6..00000000 --- a/docs/05-dev-tools/interoperability/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -sidebar_position: 10 -sidebar_label: Oracles -title: Oracles -description: "How to get started with writing, deploying and testing smart contracts on Rootstock using Hardhat." -tags: [hardhat, quick start, developer tools, rsk, rootstock, ethereum, dApps, smart contracts] ---- - -## Umbrella Network - -Umbrella Network provides access to reliable and secure data verified by Umbrella's decentralized network. Utilize Umbrella's Data Layer to build customizable and composable data streams on demand on Rootstock. - -## RedStone Finance - -[RedStone](https://redstone.finance/) provides data feeds to blockchains such as Rootstock and layer 2 scaling solutions across the entire blockchain ecosystem that are both EVM and non-EVM compatible. RedStone allows data to be provided on-demand rather than on a fixed schedule, reducing the costs of putting data 'on-chain'. This is achieved by storing data off of the blockchain as cryptography signed packages and allowing smart contracts of dApps to fetch data when necessary. \ No newline at end of file diff --git a/docs/05-dev-tools/mining/index.md b/docs/05-dev-tools/mining/index.md deleted file mode 100644 index 8880c6f0..00000000 --- a/docs/05-dev-tools/mining/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -sidebar_position: 11 -sidebar_label: Mining Pools -title: Mining Pools on Rootstock -description: "How to get started with writing, deploying and testing smart contracts on Rootstock using Hardhat." -tags: [hardhat, quick start, developer tools, rsk, rootstock, ethereum, dApps, smart contracts] ---- - -## Mining - -### BraiinsPool - -### Luxor - -### F2Pool - -### ViaBTC - -### Antpool \ No newline at end of file diff --git a/docs/05-dev-tools/no-code/index.md b/docs/05-dev-tools/no-code/index.md new file mode 100644 index 00000000..352b694f --- /dev/null +++ b/docs/05-dev-tools/no-code/index.md @@ -0,0 +1,45 @@ +--- +sidebar_position: 12 +sidebar_label: No Code +title: No Code Tools on Rootstock +description: "Get started with building and deploying dApps using No Code Tools" +tags: [no code, developer tools, rsk, rootstock, ethereum, dApps, smart contracts] +--- + +No-code tools allow you to create complex applications using a visual interface, drag-and-drop components, and pre-built templates. + +## Benefits + +No-code tools offer a variety of advantages for businesses and developers: + +* Rapid Prototyping: Quickly create and test ideas without the lengthy development cycles of traditional coding. +* Accelerated Time-to-Market: Launch products and services faster to gain a competitive edge. +* Lower Labor Costs: Minimize the need for hiring and retaining skilled developers. +* Reduced Development Time: Shorter development cycles lead to lower overall costs. +* Democratization of Development: Empower non-technical users to build applications. +* Lower Barrier to Entry: Encourage innovation and experimentation. +* Easy Customization: Tailor applications to specific needs without complex coding. +* Rapid Iteration: Quickly adapt to changing requirements and market trends. +* Visual Interfaces: Facilitate collaboration between technical and non-technical teams. +* Shared Understanding: Visual representations make it easier to understand and discuss application logic. + +Rootstock, a leading Bitcoin sidechain, offers a user-friendly approach to web3 development with its no-code tools: + + + + + \ No newline at end of file diff --git a/docs/05-dev-tools/node-rpc/index.md b/docs/05-dev-tools/node-rpc/index.md index c43b6fd2..989c83a3 100644 --- a/docs/05-dev-tools/node-rpc/index.md +++ b/docs/05-dev-tools/node-rpc/index.md @@ -1,25 +1,65 @@ --- sidebar_position: 8 -sidebar_label: Node RPC -title: Node RPC +sidebar_label: Node Providers +title: Node Providers description: "How to get started with writing, deploying and testing smart contracts on Rootstock using Hardhat." tags: [hardhat, quick start, developer tools, rsk, rootstock, ethereum, dApps, smart contracts] --- -## RPC +Building dApps on Rootstock involves interacting with the blockchain network. But how do you access this network? That's where node providers come in. Think of them as gateways to the blockchain. -### RPC API +## What are Node Providers? -The [RPC API](http://rpc.rootstock.io/) provides a seamless and intuitive web interface for developers to interact with [Rootstock nodes](/node-operators/setup/) via [JSON-RPC](/node-operators/json-rpc/methods/) methods. It aims to address the challenges faced by developers when trying to access critical information like logs, transactions, and balances through RPC, which can significantly impact the timely development of dApps on the Rootstock blockchain. +Imagine a vast library filled with information about everything happening on the Rootstock network. Node providers maintain copies of this information, allowing developers to connect and retrieve essential details. These details can include transaction history, account balances, and smart contract data. -### GetBlock +## How Node Providers Work -GetBlock provides instant connection to blockchain nodes including Rootstock, Bitcoin (BTC), Ethereum (ETH), among others. +* Full Nodes: Node providers run full nodes, which download and store the entire history of the Rootstock blockchain. +* API Access: They offer an interface (API) that developers can use to communicate with these nodes and request specific data. This eliminates the need for developers to download the entire blockchain themselves, saving time and resources. -### NOWNodes +Several node provider services are available for Rootstock -NOWNodes is a blockchain-as-a-service enterprise solution that lets users get access to full Nodes and blockbook Explorers via an API. + + + + + + + -### dRPC -dRPC provides access to a distributed network of node providers. diff --git a/docs/05-dev-tools/oracles/index.md b/docs/05-dev-tools/oracles/index.md new file mode 100644 index 00000000..fa051614 --- /dev/null +++ b/docs/05-dev-tools/oracles/index.md @@ -0,0 +1,34 @@ +--- +sidebar_position: 10 +sidebar_label: Oracles +title: Oracles +description: "How to get started with writing, deploying and testing smart contracts on Rootstock using Hardhat." +tags: [hardhat, quick start, developer tools, rsk, rootstock, ethereum, dApps, smart contracts] +--- + +Oracles act as bridges, securely bringing external data onto the Rootstock blockchain for dApps to utilize. + +## How Oracles Work: +* Data Request: A dApp sends a request to an oracle network, specifying the data it needs. +* Data Collection: Oracles retrieve the data from reliable sources (weather APIs, stock exchanges). +* Verification: Multiple oracles within the network verify the data for accuracy and security. +* Delivery: The verified data is then delivered to the dApp. + + + + + \ No newline at end of file diff --git a/docs/05-dev-tools/sdks/index.md b/docs/05-dev-tools/sdks/index.md deleted file mode 100644 index f74e423d..00000000 --- a/docs/05-dev-tools/sdks/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -sidebar_position: 6 -sidebar_label: SDKs / CLIs / Libraries -title: SDKs / CLIs / Libraries -description: "How to get started with writing, deploying and testing smart contracts on Rootstock using Hardhat." -tags: [hardhat, quick start, developer tools, rsk, rootstock, ethereum, dApps, smart contracts] ---- - -### RIF Wallet - -### RIF Relay diff --git a/src/pages/components.md b/src/pages/components.md index a546fce6..f1bb8ac9 100644 --- a/src/pages/components.md +++ b/src/pages/components.md @@ -672,7 +672,7 @@ Detailed option description you can find [here](https://shields.io/badges/static - **Code** ```jsx - + diff --git a/vercel.json b/vercel.json index 15716a23..9c1fab26 100644 --- a/vercel.json +++ b/vercel.json @@ -634,6 +634,8 @@ {"source" : "/guides/stablecoin/stablecoin-vs-digital-assets", "destination" : "https://blog.rootstock.io/noticia/stablecoin-vs-digital-asset/"}, {"source" : "/guides/dex/features-of-a-dex", "destination" : "https://blog.rootstock.io/noticia/features-of-a-dex/"}, {"source" : "/developers/quickstart/alchemy/", "destination" : "/developers/rpc-api/alchemy/"}, - {"source" : "/developers/rpc-api/setup/", "destination" : "/developers/rpc-api/rootstock/setup/"} + {"source" : "/developers/rpc-api/setup/", "destination" : "/developers/rpc-api/rootstock/setup/"}, + {"source" : "/developers/smart-contracts/eas/", "destination" : "/dev-tools/attestations/eas/"}, + {"source" : "/developers/smart-contracts/eas/overview/", "destination" : "/dev-tools/attestations/eas/"} ] } \ No newline at end of file