From 5f201c3058eb167c0693851f0ad3e59f4dc0573a Mon Sep 17 00:00:00 2001 From: Slava Karkunov Date: Tue, 20 Feb 2024 18:08:16 +0000 Subject: [PATCH] Fix linter + rename Aurora Chains article --- docs/aurora-cloud/chain.md | 6 +++--- docs/onboard/introduction.md | 9 ++++++--- docs/onboard/promo-widget.md | 6 ++++-- docs/onboard/troubleshooting.md | 11 +++++------ docs/onboard/wallet-connect.md | 3 +-- docs/onboard/wallets/rainbowkit.md | 12 +++++------- docs/onboard/wallets/web3modal.md | 5 +++-- sidebars.js | 10 +--------- 8 files changed, 28 insertions(+), 34 deletions(-) diff --git a/docs/aurora-cloud/chain.md b/docs/aurora-cloud/chain.md index c63d8ab2..2c92008e 100644 --- a/docs/aurora-cloud/chain.md +++ b/docs/aurora-cloud/chain.md @@ -1,12 +1,12 @@ --- -title: "Dedicated Blockchains" +sidebar_label: Launch your chain (Aurora Chain) sidebar_position: 1 --- -# Aurora Chains +# Aurora Chain -Aurora Chains are dedicated EVM-compatible blockchains built on top of the NEAR Protocol. They are your own instance of Aurora – every Aurora Chain is based upon the Aurora smart contract, +Aurora Chain is a dedicated EVM-compatible blockchain built on top of the NEAR Protocol. It is your own instance of Aurora – every Aurora Chain is based upon the Aurora smart contract, also called [Aurora Engine](/getting-started/aurora-engine). It provides you with a customized and dedicated blockchain environment. Benefits include: diff --git a/docs/onboard/introduction.md b/docs/onboard/introduction.md index 3bde122c..158e8443 100644 --- a/docs/onboard/introduction.md +++ b/docs/onboard/introduction.md @@ -4,7 +4,8 @@ title: "Introduction" # Aurora Pass -Aurora Pass is a mobile cryptocurrency wallet that makes it easier than ever to manage your Aurora Mainnet and Aurora Chain assets, and use any DApps across these chains. It helps also to onboard your users, even if they are not familiar with Web3 ecosystem yet. +Aurora Pass is a mobile cryptocurrency wallet that makes it easier than ever to manage your Aurora Mainnet and Aurora Chain assets, and use any DApps across these chains. +It helps also to onboard your users, even if they are not familiar with Web3 ecosystem yet. ## Key Features @@ -24,9 +25,11 @@ You can follow the step-by-step [integration example](/onboard/integration-examp ## Promo Widget -To allow new users to install Aurora Pass quickly, you can add a [promo widget](/onboard/promo-widget) to your DApp. It will direct a user to download Aurora Pass application on a mobile phone in the most convinient way. +To allow new users to install Aurora Pass quickly, you can add a [promo widget](/onboard/promo-widget) to your DApp. +It will direct a user to download Aurora Pass application on a mobile phone in the most convinient way. -It is optional to add it to your DApp. But otherwise, you will need to implement some other way to lead user to the installation of the wallet. So, we advice everyone to use it as an onboarding entrypoint in their DApps. +It is optional to add it to your DApp. But otherwise, you will need to implement some other way to lead user to the installation of the wallet. +So, we advice everyone to use it as an onboarding entrypoint in their DApps. ## Free transactions diff --git a/docs/onboard/promo-widget.md b/docs/onboard/promo-widget.md index 261562a4..b6bc714b 100644 --- a/docs/onboard/promo-widget.md +++ b/docs/onboard/promo-widget.md @@ -4,7 +4,8 @@ title: "Promo Widget" # Promo Widget -If you develop a DApp – you will need a way to get your users to install Aurora Pass application to their phone. We have created a widget to simplify this step. This modal leads a user to download the wallet application for iOS or Android by scanning a QR code: +If you develop a DApp – you will need a way to get your users to install Aurora Pass application to their phone. We have created a widget to simplify this step. +This modal leads a user to download the wallet application for iOS or Android by scanning a QR code: ![ap_widget_qr_and_main](/img/ap_widget_qr_and_main.png) @@ -95,7 +96,8 @@ If you click on `Open Promo` link, you will be able to see the Promo Widget now: And then, if you click further on the 'Skip, I have a wallet' button, you will see the placeholder message about Web3Modal: ![ap_widget_example_1](/img/ap_widget_example_2.png) -Now, you can also take a look at the bigger [integration example here](/onboard/integration-example) to learn how to add Web3Modal to your project. Or go directly to the section of [adding the Web3Modal](/onboard/integration-example#adding-web3modal) if you came here from that page. +Now, you can also take a look at the bigger [integration example here](/onboard/integration-example) to learn how to add Web3Modal to your project. +Or go directly to the section of [adding the Web3Modal](/onboard/integration-example#adding-web3modal) if you came here from that page. ### What should be called in onComplete function? diff --git a/docs/onboard/troubleshooting.md b/docs/onboard/troubleshooting.md index d13b3be8..b03c0bf7 100644 --- a/docs/onboard/troubleshooting.md +++ b/docs/onboard/troubleshooting.md @@ -9,15 +9,15 @@ Sometimes by mistake a user can send assets to her address on those non-supporte E.g, suppose you have send your assets to some of yours Ethereum addresses. -Then, if you have a private key of that address or a seed phrase - these tokens can be easily recovered by importing one of them into a compatible wallet like MetaMask and then bridging them to Aurora or to any other address. +Then, if you have a private key of that address or a seed phrase - these tokens can be easily recovered by importing one of them into a compatible wallet like MetaMask and + then bridging them to Aurora or to any other address. In a case if you have transferred them to CEX address, you won't be able to recover these tokens, if that CEX doesn't support Aurora yet. Currently, we support Coinbase, KuCoin and Gate.io CEXes. ### I can't find the token [XYZ] in my wallet – can I add it somehow? -If you are a developer, please add a PR to [this repository](https://github.com/aurora-is-near/bridge-assets) following [this example](https://github.com/aurora-is-near/bridge-assets/pull/273/files). - -If you are a user, please contact our [Support Team](https://discord.gg/dEFJBz8HQV) via Discord and we will help you to resolve this issue. +- If you are developer, please add a PR to [this repository](https://github.com/aurora-is-near/bridge-assets) following [this example](https://github.com/aurora-is-near/bridge-assets/pull/273/files). +- If you are user, please contact our [Support Team](https://discord.gg/dEFJBz8HQV) via Discord and we will help you to resolve this issue. ### I have paid for my transaction pack, but got no transactions added @@ -35,6 +35,7 @@ This error looks like this: This error means that DApp is already using some existing pairing but the wallet doesn't know it was disconnected, so there is some non-sync state between them. To fix it, please try to follow the next steps: + 1. Try to disconnect all previously connected wallets from that DApp. 2. Re-connect with you AuroraPass wallet to a DApp. @@ -54,5 +55,3 @@ So, we advice you to verify all (or most) of your contracts, which gives your us ### I have a problem, which is not on the list Please, contact our [Support Team](https://discord.gg/dEFJBz8HQV) on Discord and open a ticket describing your problem. - - diff --git a/docs/onboard/wallet-connect.md b/docs/onboard/wallet-connect.md index 8728d61f..32588070 100644 --- a/docs/onboard/wallet-connect.md +++ b/docs/onboard/wallet-connect.md @@ -4,8 +4,7 @@ title: "Integrate Wallet Connect" # Wallet Connect Integration -Aurora Pass is meant to be used with [WalletConnect v2](https://docs.walletconnect.com/). -It is an industry standard to create an encrypted connection between a DApp and EVM wallet, +Aurora Pass is meant to be used with [WalletConnect v2](https://docs.walletconnect.com/). It is an industry standard to create an encrypted connection between a DApp and EVM wallet, initialized by scanning a QR code, or via [deeplink](https://docs.walletconnect.com/web3wallet/mobileLinking) for mobile apps and browsers. ## Integration Guide diff --git a/docs/onboard/wallets/rainbowkit.md b/docs/onboard/wallets/rainbowkit.md index eb677fa5..01a4c757 100644 --- a/docs/onboard/wallets/rainbowkit.md +++ b/docs/onboard/wallets/rainbowkit.md @@ -98,7 +98,8 @@ walletConnectWallet(options: { }); ``` -3. So now, just use the `explorerRecommendedWalletIds` option (documentated [here](https://docs.walletconnect.com/web3modal/v2/react/wagmi/options#explorerrecommendedwalletids-optional)) and paste Aurora Pass ID to it: +3. So now, just use the `explorerRecommendedWalletIds` option + (documentated [here](https://docs.walletconnect.com/web3modal/v2/react/wagmi/options#explorerrecommendedwalletids-optional)) and paste Aurora Pass ID to it: ```tsx let options = { @@ -109,12 +110,9 @@ let options = { // pass the 'options' here as the last argument const connectors = connectorsForWallets([ ... - walletConnectWallet({projectId, options}) - ... + walletConnectWallet({projectId, options}) + ... ]); ``` -That is it. Now you can use Aurora Pass from your RainbowKit popup. - - - +That is it. Now, you can use Aurora Pass from your RainbowKit popup. diff --git a/docs/onboard/wallets/web3modal.md b/docs/onboard/wallets/web3modal.md index 30c3e017..63f2eb4c 100644 --- a/docs/onboard/wallets/web3modal.md +++ b/docs/onboard/wallets/web3modal.md @@ -3,7 +3,8 @@ sidebar_label: Web3Modal title: Web3Modal --- -The [Web3Modal](https://docs.walletconnect.com/web3modal/about) allows you to easily connect your DApp with wallets. It provides a simple and intuitive interface for DApps to request actions such as signing transactions and interacting with smart contracts on the blockchain. +The [Web3Modal](https://docs.walletconnect.com/web3modal/about) allows you to easily connect your DApp with wallets. + It provides a simple and intuitive interface for DApps to request actions such as signing transactions and interacting with smart contracts on the blockchain. ![web3modal](/img/web3modal.png) @@ -25,4 +26,4 @@ You can add Aurora Pass as a recommended wallet by using the corresponding confi 76260019aec5a3c44dd2421bf78e80f71a6c090d932c413a287193ed79450694 ``` -You can find an example of how to add the Aurora Pass Wallet ID in the integration example [here](/onboard/integration-example#add-aurorapass-to-your-wallet-list). \ No newline at end of file +You can find an example of how to add the Aurora Pass Wallet ID in the integration example [here](/onboard/integration-example#add-aurorapass-to-your-wallet-list). diff --git a/sidebars.js b/sidebars.js index fd6862c4..29c7128b 100644 --- a/sidebars.js +++ b/sidebars.js @@ -77,15 +77,7 @@ const sidebars = { // }, ] }, - { - type: 'category', - label: 'Aurora Cloud', - collapsible: true, - collapsed: false, - items: [ - 'aurora-cloud/chain', - ] - }, + 'aurora-cloud/chain', { type: 'category', label: 'Bridge',