Skip to content

fix: minor typos in the docs #10

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: minor typos in the docs #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93a2843
fix typo FLUENT_INTERFACE.md
tudorpintea999 Dec 4, 2023
801056e
fix typo REDSTONE_DATA_ECOSYSTEM.md
tudorpintea999 Dec 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/FLUENT_INTERFACE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Redstone implements a fluent interface to simplify query creation thanks to a human readable syntax.

### Importing
To use the fluent interface you should import the redstone-api in a standard way and initialise a query calling `redstone.query()`;
To use the fluent interface you should import the redstone-api in a standard way and initialize a query calling `redstone.query()`;
```js
// Using Node.js `require()`
const redstone = require('redstone-api');
Expand All @@ -14,7 +14,7 @@ import redstone from 'redstone-api';
```

## Usage
All redstone queries consits of 4 parts:
All redstone queries consists of 4 parts:
- Query initialization (`redstone.query()`)
- What to fetch (`symbol` or `symbols`)
- For which date/dates (`latest`, `atDate`, `forLastHours`, `hoursAgo`, `fromDate`, `toDate`)
Expand Down
14 changes: 7 additions & 7 deletions docs/REDSTONE_DATA_ECOSYSTEM.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,23 @@
<p>
Financial data is the backbone of decentralised finance.
It enables assets valuation and collateral management.
Without access to the reliable pricing feeds, it's impossible to create instruments like derivatives, options and futures.
Without access to reliable pricing feeds, it's impossible to create instruments like derivatives, options and futures.
</p>

<p>
The awareness of the importance of data quality raised with the growth of decentralised finance.
This sector (aka DeFi) is experiencing an exponential growth surpassing 5bn valuation
This sector (aka DeFi) is experiencing exponential growth surpassing 5bn valuation
and attracting professional investors and thousands of retail users.
At the beginning, different protocols used their own, in-house price feeds.
The naive approach to getting financial data lead to many multiple security incidents
resulting in millions of dollars being lost and posing an existential threat to the further growth of the sector.
Let's just mention the few costly incidents from the last year:
Let's just mention a few costly incidents from the last year:

</p>

<p>
The hard-learned lesson about the data quality importance led to the explosive growth of data-providing services.
The Chainlink, being the market leader, experienced a massive growth reaching a valuation that exceed the whole defi space.
The Chainlink, being the market leader, experienced massive growth reaching a valuation that exceed the whole defi space.
This led many experts to the conclusion, that <b>the whole decentralised finance is as valuable as the data that powers it</b>.
</p>

Expand All @@ -38,7 +38,7 @@ when we are expecting more and more financial instruments to enter the market.
Redstone uses Arweave as a base blockchain.
Arweave with its affordable permanent storage blockchain appears to be a perfect remedy for the pains of the DeFi sector.
Moreover, the Smartweave contracts may help to maintain data integrity managing the reputation of data providers.
Arweave offers also a neat monetisation model with the Profit Sharing Token rewarding providers for high-quality data.
Arweave offers also a neat monetization model with the Profit Sharing Token rewarding providers for high-quality data.
</p>

<h3>Architecute</h3>
Expand All @@ -53,7 +53,7 @@ Data miners are agents (system deamons) that periodically upload data to the net

The orders are also stored on the Arweave chain and periodically queried by the miners.

Data miners could be started by executing the following scipt from the main directory:
Data miners could be started by executing the following script from the main directory:

`
node ./backend/provider/data-miners/mine-data.js
Expand All @@ -66,7 +66,7 @@ Data processors can transform one data set into another. It allows producing mea
<h5>Balancer rewards</h5>
An example of data processor is the code calculating rewards for providing liquidity to the Balancer protocol.

The sample processor could be started by executing the following scipt from the main directory:
The sample processor could be started by executing the following script from the main directory:

`
node ./backend/provider/data-miners/mine-balancer-rewards.js
Expand Down