Skip to content

Commit

Permalink
Fix dev-tools linting
Browse files Browse the repository at this point in the history
  • Loading branch information
Karkunow committed Dec 20, 2024
1 parent 1e63a6c commit 31417db
Show file tree
Hide file tree
Showing 10 changed files with 59 additions and 53 deletions.
2 changes: 1 addition & 1 deletion docs/dev-tools/basics/block-explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Blockscout is one of the most well-known block explorers for Ethereum, capable o

Users are able to view transactions, addresses, and blocks. Developers can get a wide range of charts and statistics related to smart contract execution, collator data, specific transfers between tokens, and a list of [ERC-20 tokens on Aurora](https://explorer.mainnet.aurora.dev/tokens).\
\
You can also see all of the verified contracts[ here](https://explorer.mainnet.aurora.dev/verified-contracts), work with [API](https://explorer.mainnet.aurora.dev/api-docs) or [use GraphQL](https://explorer.mainnet.aurora.dev/graphiql) to query information about blocks or transactions.\
You can also see all of the verified contracts[here](https://explorer.mainnet.aurora.dev/verified-contracts), work with [API](https://explorer.mainnet.aurora.dev/api-docs) or [use GraphQL](https://explorer.mainnet.aurora.dev/graphiql) to query information about blocks or transactions.\
\
As an example of the API usage, you can get your ERC-20 token balance by using this method:

Expand Down
2 changes: 1 addition & 1 deletion docs/dev-tools/basics/metamask.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: MetaMask
---
MetaMask is a browser extension and mobile app that serves as a secure and user-friendly gateway to interact with the Ethereum blockchain. As a cryptocurrency wallet, it allows users to store, manage, and transact Ether (ETH) and various Ethereum-based tokens (ERC-20 and ERC-721).
MetaMask is a browser extension and mobile app that serves as a secure and user-friendly gateway to interact with the Ethereum blockchain. As a cryptocurrency wallet, it allows users to store, manage, and transact Ether (ETH) and various Ethereum-based tokens (ERC-20 and ERC-721).

In addition, MetaMask simplifies access to decentralized applications (dApps) by enabling users to authenticate and execute transactions without the need for a separate blockchain client. By providing a seamless bridge between web browsers and the Ethereum network, MetaMask plays a vital role in the widespread adoption and use of blockchain-based applications.

Expand Down
31 changes: 17 additions & 14 deletions docs/dev-tools/cloud/borealis-business.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,26 @@
---
title: Borealis Business
title: Gas Abstraction
---
Since its inception, the Aurora Protocol has continued to break boundaries in the blockchain world. Its latest innovation is a service known as Borealis Business, aimed at solving one of the most significant challenges for users of Web3 products – the concept of transaction fees.\

Since its inception, the Aurora Protocol has continued to break boundaries in the blockchain world. Its latest innovation is a service providing you the Gas Abstraction, aimed at solving one of the most significant challenges for users of Web3 products – the concept of transaction fees.\
\
Borealis Business is a transaction processing and accounting service that allows Aurora Cloud customers to hide the fees complexities from their users while implementing nearly any conceivable business model to manage costs. This article aims to shed light on Borealis Business, its operations, benefits, and integration details with the comprehensive suite of [*Aurora Cloud*](https://auroracloud.dev/) offerings.
Gas Abstraction is a transaction processing and accounting service that allows Aurora Cloud customers to hide the fees complexities from their users while implementing nearly any conceivable business model to manage costs. This article aims to shed light on Gas Abstraction, its operations, benefits, and integration details with the comprehensive suite of [*Aurora Cloud*](https://auroracloud.dev/) offerings.

## How does it work?

Aurora has a relaying architecture mapping Aurora to NEAR transactions, separating the origination and payment. At the core of the Borealis Business is the Rule Engine (BBRE), which oversees this transaction relaying to fulfill its cost management goals. It allows the transfer of transaction costs to a third party–typically a decentralized app (dApp)–that seeks to cover its users' fees. This way, businesses can make their users' experience friction-free by shouldering transaction fees.
Aurora has a relaying architecture mapping Aurora to NEAR transactions, separating the origination and payment. At the core of the Gas Abstraction is the Rule Engine (RE), which oversees this transaction relaying to fulfill its cost management goals. It allows the transfer of transaction costs to a third party–typically a decentralized app (dApp)–that seeks to cover its users' fees. This way, businesses can make their users' experience friction-free by shouldering transaction fees.

Companies can establish Customer Deals through the Rule Engine by setting specific rules determining who should pay for a transaction and under what conditions. E.g., incoming transactions to the Aurora+ staking contract are now made free in this way. The strategies which Rule Engine allows are particularly advantageous for companies seeking to offer region-specific or time-bound promotions.

Companies can establish Customer Deals through the Rule Engine by setting specific rules determining who should pay for a transaction and under what conditions. E.g., incoming transactions to the Aurora+ staking contract are now made free in this way. The strategies which Rule Engine allows are particularly advantageous for companies seeking to offer region-specific or time-bound promotions. For instance, businesses can provide free transactions exclusively to their European customers around the clock while extending this offer to customers from other regions only on weekends. This level of customization empowers companies to accommodate diverse business models and opens up possibilities for novel concepts, including cross-business interactions.
For instance, businesses can provide free transactions exclusively to their European customers around the clock while extending this offer to customers from other regions only on weekends. This level of customization empowers companies to accommodate diverse business models and opens up possibilities for novel concepts, including cross-business interactions.

## Setting Up a Deal

The setup process for a Customer Deal begins with the company formulating specific terms and conditions and the AuroraLabs team translating those into rules for use within the Rule Engine.\
\
For instance, a rule might be as follows: "All users interacting with contract A will receive 50 free transactions per month." If a transaction meets the specified criteria outlined in these rules, the associated cost is billed directly to the business that owns the deal. The rule engine diligently executes this checking and matching process, ensuring accurate transaction cost allocation.

While Borealis Business does not have a user interface, efforts are underway to incorporate this shortly. Storing all matched transactions within a Borealis Business database can offer immense value by providing comprehensive analytics about the deals. We plan to support an analytics dashboard using a [*Metabase*](https://www.metabase.com/), providing the companies with critical insights into that data.
While Gas Abstraction does not have a user interface, efforts are underway to incorporate this shortly. Storing all matched transactions within a Gas Abstraction database can offer immense value by providing comprehensive analytics about the deals. We plan to support an analytics dashboard using a [*Metabase*](https://www.metabase.com/), providing the companies with critical insights into that data.

Let’s see this setup process in more detail.

Expand All @@ -34,13 +37,13 @@ Typically, setting up a deal would initiate with specific parameters. These, how
* **TO:** This parameter specifies the transaction's target, and it can take values such as an ***address*** so that the rule engine will pick up transactions directed to this specific contract address. If a transaction goes to another contract, it cannot be associated with this deal.
* **DEAL**: This parameter specifies the number of transactions that the beneficiaries of this deal can get. It can be set to UNLIMITED or a specific number.

Here are a few simple examples of Borealis Business deals:
Here are a few simple examples of Gas Abstraction deals:

![](https://www.datocms-assets.com/95026/1687255307-untitled-2023-06-12-1504.png)

### Aurora Pass as a Deal

A notable example of a deal within Borealis Business is Aurora Pass (AP), which stands out due to its unique approach. Unlike other deals, Aurora Pass does not utilize the address as the FROM parameter. Instead, it employs an authorization (AUTH) token system that is automatically generated when a new user sets up an account on Aurora Pass.
A notable example of a deal within Gas Abstraction is Aurora Pass (AP), which stands out due to its unique approach. Unlike other deals, Aurora Pass does not utilize the address as the FROM parameter. Instead, it employs an authorization (AUTH) token system that is automatically generated when a new user sets up an account on Aurora Pass.

The Rule Engine plays a crucial role when transactions occur by validating each associated AUTH token. Upon identifying a token that corresponds to an Aurora Pass account, the engine applies the specified deal, ensuring that transaction costs are allocated according to the conditions outlined in the Aurora Pass deal. Moreover, AUTH tokens allow future support of multiple addresses within Aurora Pass while keeping the possibility of applying the benefits of free transactions to a whole account and not to a specific address.\
\
Expand All @@ -62,7 +65,7 @@ However, it's important to note that the scope of this API will extend far beyon

## User Experience and User Journey

Borealis Business’ user journey is seamless. Once a user signs into a dApp with a Borealis deal, the dApp checks the whitelist status of the user's address. If approved, the user can make transactions within the app without bearing the transaction cost. This process is managed by the Borealis rule engine, which matches the transaction with the relevant deal.
Gas Abstraction’ user journey is seamless. Once a user signs into a dApp with a Borealis deal, the dApp checks the whitelist status of the user's address. If approved, the user can make transactions within the app without bearing the transaction cost. This process is managed by the Borealis rule engine, which matches the transaction with the relevant deal.

### User Journey

Expand All @@ -87,18 +90,18 @@ In addition, Aurora has established anti-abuse rules to prevent potential abuse

A transaction can be part of multiple deals. Aurora has created a hierarchy of deals and a randomization process to manage this. If a user connects with Aurora Pass on a dApp, the transaction is attributed to the dApp deal, not the Aurora Pass deal. This hierarchy ensures that dApps take precedence over Aurora's own deals.

The randomization process comes into play when some transaction matches multiple deals. In such cases, the transaction will be randomly added to one of the deals. This balanced system ensures fair distribution and usage of the Borealis Business service across various deals.
The randomization process comes into play when some transaction matches multiple deals. In such cases, the transaction will be randomly added to one of the deals. This balanced system ensures fair distribution and usage of the Gas Abstraction service across various deals.

## Developers Considerations

While the Aurora engineering team is responsible for crafting Customer Deals and the rules that regulate them, there are a few essential aspects that developers need to keep in mind, particularly when these deals are directed at smart contracts. For instance, a modular architecture might be required if the aim is to set up multiple contracts based on the varying benefits allocated to different users. Moreover, if the business model requires the dynamic deployment of contracts through contract factories, it might be necessary to whitelist users for all the contracts that require it.

In conclusion, the Borealis Business provides an innovative solution to a significant issue within the blockchain ecosystem: the cost of transactions. As a result, Aurora is paving the way for more user-friendly blockchain applications and potentially transformative business models, which developers should consider while creating new applications and products.
In conclusion, the Gas Abstraction provides an innovative solution to a significant issue within the blockchain ecosystem: the cost of transactions. As a result, Aurora is paving the way for more user-friendly blockchain applications and potentially transformative business models, which developers should consider while creating new applications and products.

## What’s next?

Borealis Business represents a transformative approach to managing transaction costs in the realm of blockchain. Its strategic alignment with the needs of businesses and users sets it apart, reflecting the evolving demands of the digital landscape. Its innovative mechanisms allow businesses to absorb transaction costs, providing a seamless user experience. Its ability to distinguish between the initiator of a transaction and the payer of transaction costs has proven to be a game-changer.
Gas Abstraction represents a transformative approach to managing transaction costs in the realm of blockchain. Its strategic alignment with the needs of businesses and users sets it apart, reflecting the evolving demands of the digital landscape. Its innovative mechanisms allow businesses to absorb transaction costs, providing a seamless user experience. Its ability to distinguish between the initiator of a transaction and the payer of transaction costs has proven to be a game-changer.

A significant advantage of Borealis Business is its inherent ability to adapt and expand based on market demands and technological advancements. The planned release of public APIs will add another dimension to the offering. It will give businesses more control over the customization and management of their deals and whitelist. The autonomy our APIs will provide is a significant leap forward, allowing businesses to adapt swiftly and efficiently to changing market conditions and user demands.
A significant advantage of Gas Abstraction is its inherent ability to adapt and expand based on market demands and technological advancements. The planned release of public APIs will add another dimension to the offering. It will give businesses more control over the customization and management of their deals and whitelist. The autonomy our APIs will provide is a significant leap forward, allowing businesses to adapt swiftly and efficiently to changing market conditions and user demands.

Future advancements will reinforce Borealis Business' role as a cutting-edge solution and strengthen Aurora's standing as an innovative leader in the blockchain industry. As we enter an increasingly digital future, the agility and adaptability of systems like this will undoubtedly become more crucial. Aurora is already paving the way, redefining the status quo, and pushing the boundaries of what's possible in transaction cost management.
Future advancements will reinforce Gas Abstraction' role as a cutting-edge solution and strengthen Aurora's standing as an innovative leader in the blockchain industry. As we enter an increasingly digital future, the agility and adaptability of systems like this will undoubtedly become more crucial. Aurora is already paving the way, redefining the status quo, and pushing the boundaries of what's possible in transaction cost management.
16 changes: 8 additions & 8 deletions docs/dev-tools/indexers/flair.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,18 @@ Compared to other alternatives the main reasons are:

* ✅ Listen to **any EVM chain** with just an RPC URL.

* Free managed RPC URLs for +8 popular chains already included.
* Works with both websocket and https-only RPCs.
* Free managed RPC URLs for +8 popular chains already included.
* Works with both websocket and https-only RPCs.

* ✅ Track and ingest **any contract** for **any event topic.**

* Auto-track new contracts deployed from factory contracts.
* Auto-track new contracts deployed from factory contracts.

***Custom processor scripts** with JavaScript runtime (with **Typescript** support)

* Make external API or Webhook calls to third-party or your backend.
* Get current or historical USD value of any ERC20 token amount of any contract address on any chain.
* Use any external NPM library.
* Make external API or Webhook calls to third-party or your backend.
* Get current or historical USD value of any ERC20 token amount of any contract address on any chain.
* Use any external NPM library.

***Stream** any stored data to your destination database (Postgres, MongoDB, MySQL, Kafka, Elasticsearch, Timescale, etc).

Expand All @@ -45,9 +45,9 @@ git clone https://github.com/flair-sdk/starter-boilerplate.git
# ... follow instructions in README.md
```

*Boilerplate instructions will create a ****new cluster****, generate ****an API Key****, and set up a manifest.yml to index your ****first contract**** with ****sample custom processor**** scripts.*
Boilerplate instructions will create `a new cluster`, generate `an API Key`, and set up a `manifest.yml` to index your first contract with sample custom processor scripts.

*Learn more about the *[*structure of manifest.yml*](https://docs.flair.dev/reference/manifest.yml)*.*
Learn more about the [*structure of manifest.yml*](https://docs.flair.dev/reference/manifest.yml).

2️⃣ Configure Aurora RPC nodes

Expand Down
2 changes: 1 addition & 1 deletion docs/dev-tools/oracles/dia.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DIA
---
DIA is an ecosystem for open financial data in a financial smart contract ecosystem.
DIA is an ecosystem for open financial data in a financial smart contract ecosystem.

The target of DIA is to bring together data analysts, data providers and data users. In general, DIA provides a reliable and verifiable bridge between off-chain data from various sources and on-chain smart contracts that can be used to build a variety of financial Dapps.

Expand Down
4 changes: 3 additions & 1 deletion docs/dev-tools/oracles/pyth.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Pyth
---
Pyth Network is an oracle that publishes financial market data to multiple blockchains. Our market data is contributed by over 80 [first-party publishers(opens in a new tab)](https://pyth.network/publishers/), including some of the biggest exchanges and market-making firms in the world. We offer price feeds for a number of different asset classes, including [US equities, commodities, and cryptocurrencies(opens in a new tab)](https://pyth.network/price-feeds/). Each price feed publishes a [robust aggregate](https://docs.pyth.network/documentation/how-pyth-works/price-aggregation) of publisher prices that updates multiple times per second.
Pyth Network is an oracle that publishes financial market data to multiple blockchains. Our market data is contributed by over 80 [first-party publishers(opens in a new tab)](https://pyth.network/publishers/), including some of the biggest exchanges and market-making firms in the world.

We offer price feeds for a number of different asset classes, including [US equities, commodities, and cryptocurrencies(opens in a new tab)](https://pyth.network/price-feeds/). Each price feed publishes a [robust aggregate](https://docs.pyth.network/documentation/how-pyth-works/price-aggregation) of publisher prices that updates multiple times per second.

### Price Feeds

Expand Down
Loading

0 comments on commit 31417db

Please sign in to comment.