-
Notifications
You must be signed in to change notification settings - Fork 39
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Aurora Chain documentation #95
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
e6b3c1a
Add Aurora Chain documentation
Karkunow 82da799
Fix linter errors
Karkunow 0232860
Add sidebar category
Karkunow 10cfa02
Fix linter errors
Karkunow ddd7a5f
Spellcheck errors fixed
Karkunow 0e5e4ab
Grammar fixes
Karkunow 66761d7
Edits from Armand applied + PoW fix
Karkunow File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
--- | ||
title: "Dedicated Blockchains" | ||
sidebar_position: 1 | ||
--- | ||
|
||
|
||
# Aurora Chains | ||
|
||
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, | ||
also called [Aurora Engine](/getting-started/aurora-engine). It provides you with a customized and dedicated blockchain environment. | ||
|
||
Benefits include: | ||
|
||
1. *No need for additional validators:* when your Aurora Chain is deployed, it automatically gets all the Near Blockchain validators, which are above 300. | ||
2. *Configuration*: create whitelists, choose your own custom token, gas mechanics, integrate KYC, and much more. | ||
3. *Complete ecosystem*: the Rainbow Bridge, on-ramps, indexers, oracles, DEXes, etc., Aurora Cloud provides a selection of integrations that can be deployed to your chain in order to speed up development | ||
4. *Focus on your business*: the tech side of the integration and support are entirely on the [Aurora Labs](https://auroralabs.dev/) team's shoulders. | ||
5. *Seamless interoperability* with Aurora, Near, and any other Aurora Chains: you can freely move your assets using the Rainbow Bridge and call contracts via cross-contract calls (XCC). | ||
There is no disjointness in between. You can call any smart contract in any other Aurora Chain or NEAR and interact with them freely. | ||
6. *Top-notch TPS*: we can provide you dozens of millions of transactions daily for your ecosystem – 1k+ transactions per second. | ||
|
||
## What can be configured? | ||
To make Aurora Chain work in the best possible way for your business, we will help you to configure your setup. Among the features to configure are: | ||
|
||
1. *Base token* of your Aurora Chain. | ||
2. *Gas mechanics* within your chain, such as fixed fee or percentage-based fees, gasless transactions, paying for gas with a custom token, etc. | ||
3. *Permission levels*: whitelist usage - who can transact or deploy contracts? | ||
You can learn about how to operate Aurora Chain Whitelists from your dApp [here](/aurora-cloud/chain#whitelist-management). | ||
4. *Private chain*: can be built using a private NEAR shard [Calimero](https://www.calimero.network/). | ||
|
||
## How do I create my Aurora Chain? | ||
|
||
To get an Aurora Chain for your business, please get in touch with the Aurora Labs team via the 'Contact Us' form on the [Aurora Cloud website](https://auroracloud.dev/). | ||
We will schedule a call with you to determine the initial scope of your project in order to define the configuration of your Aurora Chain | ||
(e.g., public access, gas mechanics, token, services, whitelist usage). | ||
You will then get access to your chain and to the Aurora Cloud Console within a couple of days. | ||
|
||
Once deployed, you can choose to enrich it with a selection of services you require (e.g., bridge configuration, oracles, on-ramps, block explorer, etc.) and start your development. | ||
|
||
We will provide you with access to the Aurora Cloud Console to manage and monitor your chain. On the Aurora Chain Summary Page, you will be able to monitor chain statistics and performance: | ||
|
||
![silo_monitoring](/img/silo_monitoring.png) | ||
|
||
You can manage and track the information about the configured Aurora Chain with Aurora Cloud Console. The configuration page will provide you with all of the necessary details about your chain: | ||
|
||
![silo_config](/img/silo_config.png) | ||
|
||
Note the `RPC URL` field above. As you can see, the RPC endpoint looks similar to [the one Aurora Mainnet is using](/getting-started/network-endpoints), and has a format like [https://your-chain.aurora.dev](https://your-chain.aurora.dev). | ||
|
||
Talking about the RPC nodes, we will provide a scalable cluster of those for you, accessible by that link. But if you want to manage RPCs by yourself, there are two options for you: | ||
|
||
1. Either use our docker images on your instances. And run our optimized infrastructure on your hardware, with us supporting it. | ||
|
||
2. Or create a [Standalone RPC nodes](https://github.com/aurora-is-near/standalone-rpc) by yourself and allow the community to scale the network. | ||
You can read more about spinning your own Aurora node in [this DevPortal article](https://dev.aurora.dev/posts/spinning-up-your-own-aurora-node). | ||
|
||
## Whitelist Management | ||
|
||
Every Aurora Chain has two types of whitelists defining the level of permissions for your users: | ||
|
||
1. *Transaction Access Whitelist:* to enable user accounts (EOAs) to execute transactions in your chain. | ||
2. *Deployment Access Whitelist:* to enable EOAs to deploy contracts to your chain. | ||
|
||
Both of them are optional. So, if you want to allow the usage and development for everyone, both of them will be disabled. If not, you will need to manage them. | ||
The easiest way will be to do this in the Aurora Cloud Console on the Aurora Chain Permissions Page: | ||
|
||
![silo_permissions](/img/silo_permissions.png) | ||
|
||
You can also manage them by using Cloud Console API, which is described in detail in the table below. | ||
|
||
>*Note:* you will still be able to do this via the direct contract calls on Near blockchain, if needed. But we discourage you from using those, | ||
because it is not as convenient as Cloud Console UI or Cloud Console API. | ||
|
||
### Aurora Cloud Console: Aurora Chain API | ||
|
||
| | | | ||
|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| **API path** | `/chain/whitelists/`| | ||
| **method** | `POST`| | ||
| **required request headers** | Content-Type: application/json <br/>Authorization: Bearer [**ACC API Token**]| | ||
| **required request params** | *op_type*: `add_entry` and `remove_entry` are supported <br/>*kind*: Type of whitelist. `developer` or `user` are supported. <br/> *entry*: EOA address to add or remove.| | ||
| **response code** | On success: `200 OK`<br/>On Error:<br/> - `400 BadRequest`: if a request body is empty or could not be parsed or a number of operations is greater than RequestConfig.MaxBatchLen<br/> - `401 Unauthorized`: if authorization header does not satisfy the [conditions](401 Conditions)<br/> - `403 Forbidden`: if a caller is [not authorized](403 Conditions) to perform all updates in request array (i.e., partial updates are not allowed)<br/> - `408 RequestTimeout`: with partial response, if not all responses from storage node are received before RequestConfig.TimeoutMs or `Timeout` header in request<br/> - `500 InternalServerError`: if fails to send an update request to the storage node, or fails to parse a response from the storage node | | ||
| **request example** | <pre lang="shell">curl --location --request POST '[API ENDPOINT]/chain/whitelists/' --header 'Authorization: Bearer [YOUR_ACC_API_KEY]' --header 'Content-Type: application/json' --data-raw '<br/>[<br/> {<br/> "op_type":"add_entry",<br/> "kind":"developer", <br/> "entry":"0xe93685f3bBA03016F02bD1828BaDD6195988D951"<br/> }<br/>]'</pre>| | ||
| **response example - success** | <pre lang="json">[<br/> "The entry: 0xe93685f3bBA03016F02bD1828BaDD6195988D951 has been added to the Developers whitelist successfully"<br/>]</pre>| | ||
| **response examples - error** | Response Code: 400 Bad Request <pre lang="json">{<br/> "errorMessage":"engine request at index [1] is not authorized",<br/> "error":""<br/>}</pre>Note: not all error responses contain response body, but if response body exists it has the above format.<br/>| | ||
|
||
## Learn more | ||
Here are some in-depth articles to discover details about how Aurora Chain works and how it has been developed: | ||
|
||
- [Aurora Cloud Website](https://auroracloud.dev/) | ||
- [Aurora Chain: Demo Walkthrough](https://dev.aurora.dev/posts/aurora-chain-demo) | ||
- [Aurora Chain: Code Overview](https://dev.aurora.dev/posts/aurora-chain-tech-overview) | ||
|
||
## Contact Us | ||
If you feel your business could benefit from Aurora Cloud, please do not hesitate to contact us at hello@auroracloud.dev. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's not write this like this. You can say that Aurora Labs team is available to support them in each step of the integration
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@armanddid
Like this will be better? Do we need to rename the title?
Maybe to Reliable Support or smth alike?
Or maybe we can just remove this one? I mean, the point wasn't about the support, but more about the fact the most work needed to be done - will be done by us or Aurora Cloud automations :)