Skip to content

Commit 5811af6

Browse files
committed
Update capitalization of API3 to Api3
1 parent efd19b2 commit 5811af6

15 files changed

Lines changed: 74 additions & 74 deletions

File tree

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
## Contributor's Guide
22

3-
Welcome to the API3 Documentation Repository. This guide will help you get
4-
started with contributing to the API3 documentation.
3+
Welcome to the Api3 Documentation Repository. This guide will help you get
4+
started with contributing to the Api3 documentation.
55

66
## How to get started
77

8-
The API3 Docs uses [VitePress](https://vitepress.dev/), a Vue-powered static
8+
The Api3 Docs uses [VitePress](https://vitepress.dev/), a Vue-powered static
99
site generator. Follow the steps below to get started.
1010

1111
Make sure to check out https://docs.api3.org/dev/ for more details and
12-
information about getting started and making a contribution to the API3 Docs.
12+
information about getting started and making a contribution to the Api3 Docs.
1313

1414
### Pre-requisites
1515

@@ -32,9 +32,9 @@ pnpm docs:dev
3232

3333
### Structure
3434

35-
The API3 Docs repository is structured as follows:
35+
The Api3 Docs repository is structured as follows:
3636

37-
- `/docs/dapis`: Explore section within the API3 Docs.
37+
- `/docs/dapis`: Explore section within the Api3 Docs.
3838
- `/docs/oev`: All the guides that demonstrate the use of Airnode, QRNG and
3939
dAPIs.
4040
- `/docs/reference`: Contains the core documentation for Airnode, QRNG and
@@ -43,7 +43,7 @@ The API3 Docs repository is structured as follows:
4343
Each section will have a `sidebar.js` file that contains the sidebar structure
4444
for that section.
4545

46-
`/_components`: Contains the custom vue components used in the API3 Docs.
46+
`/_components`: Contains the custom vue components used in the Api3 Docs.
4747

4848
[Check this out](https://docs.api3.org/dev/docsets.html) for more info about the
4949
structure of the docs.

docs/.vitepress/config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
export default {
22
title: 'Documentation',
3-
description: 'API3 technical documentation',
3+
description: 'Api3 technical documentation',
44
markdown: {
55
lineNumbers: true,
66
toc: ['h2', 'h3', 'h4', 'h5'],

docs/dapps/integration/security-considerations.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Therefore, as long as you continue to use it, there will be ongoing security con
1212

1313
::: info ℹ️ Info
1414

15-
API3 data feeds have never misreported or experienced an outage.
15+
Api3 data feeds have never misreported or experienced an outage.
1616
This page merely discusses theoretical scenarios that apply to any data feed.
1717

1818
:::
@@ -30,10 +30,10 @@ Our [contract developer docs](https://github.com/api3dao/contracts/tree/main/doc
3030

3131
## Privileged accounts
3232

33-
Api3ReaderProxyV1 is a [UUPS-upgradeable](https://eips.ethereum.org/EIPS/eip-1822) contract, which can be upgraded by [a 4-of-8 multisig](https://github.com/api3dao/contracts/blob/main/data/manager-multisig-metadata.json#L2) that is owned by members of the API3 technical team.
33+
Api3ReaderProxyV1 is a [UUPS-upgradeable](https://eips.ethereum.org/EIPS/eip-1822) contract, which can be upgraded by [a 4-of-8 multisig](https://github.com/api3dao/contracts/blob/main/data/manager-multisig-metadata.json#L2) that is owned by members of the Api3 technical team.
3434
This upgradeability feature is intended to be used only in exceptional occasions to respond to newly discovered compiler, library or contract vulnerabilities, or to migrate users to potential new versions of the contracts.
3535

36-
[A 4-of-4 multisig,](https://github.com/api3dao/contracts/blob/main/data/dapi-management-metadata.json#L2) which again is owned by members of the API3 technical team, approves the root of a Merkle tree containing data feed configurations.
36+
[A 4-of-4 multisig,](https://github.com/api3dao/contracts/blob/main/data/dapi-management-metadata.json#L2) which again is owned by members of the Api3 technical team, approves the root of a Merkle tree containing data feed configurations.
3737
This means adding, removing or replacing API providers that contribute to the aggregation of data feeds requires signatures from all owners of this multisig.
3838

3939
::: info ℹ️ Info
@@ -45,13 +45,13 @@ Multisig signers have access to this data and are responsible for its verificati
4545

4646
## Update parameters
4747

48-
Once a plan is purchased on API3 Market, the respective data feed will maintain the advertised deviation threshold and heartbeat interval until plan expiration.
49-
This depends on the API3 technical team to keep the wallets that will send the update transactions funded, and maintain the infrastructure that will use these wallets to send the update transactions.
48+
Once a plan is purchased on Api3 Market, the respective data feed will maintain the advertised deviation threshold and heartbeat interval until plan expiration.
49+
This depends on the Api3 technical team to keep the wallets that will send the update transactions funded, and maintain the infrastructure that will use these wallets to send the update transactions.
5050
The operation is backed by dedicated monitoring personnel, automated alerts, and redundant infrastructure layers.
5151

5252
::: info ℹ️ Info
5353

54-
We have been providing oracle services as early as [2019](https://etherscan.io/txs?a=0x78e76126719715eddf107cd70f3a31dddf31f85a&p=1029), and were listed as the [best responding oracle](/assets/reputation-link.CxhU2iIj.png) among all Chainlink oracles by [`reputation.link`](https://www.google.com/search?q=%22reputation.link%22+chainlink) as of September 2020, which is when we published the [API3 whitepaper](https://github.com/api3dao/api3-whitepaper) and requested to be removed from Chainlink data feeds.
54+
We have been providing oracle services as early as [2019](https://etherscan.io/txs?a=0x78e76126719715eddf107cd70f3a31dddf31f85a&p=1029), and were listed as the [best responding oracle](/assets/reputation-link.CxhU2iIj.png) among all Chainlink oracles by [`reputation.link`](https://www.google.com/search?q=%22reputation.link%22+chainlink) as of September 2020, which is when we published the [Api3 whitepaper](https://github.com/api3dao/api3-whitepaper) and requested to be removed from Chainlink data feeds.
5555
An important driving factor for this was our insight into systemic issues that could harm users and our confidence in building a better solution.
5656
With this understanding, we designed our architecture and operations from the ground up, leading to our current performance.
5757

@@ -67,11 +67,11 @@ Similarly, our OEV implementation uses this mechanism, ensuring OEV updates cont
6767

6868
## Correctness of data
6969

70-
The [API3 whitepaper](https://github.com/api3dao/api3-whitepaper) poses that all oracle data comes from API providers in practice, and the trust-minimized way to receive data from an API provider is for there to be no third-party intermediaries.
70+
The [Api3 whitepaper](https://github.com/api3dao/api3-whitepaper) poses that all oracle data comes from API providers in practice, and the trust-minimized way to receive data from an API provider is for there to be no third-party intermediaries.
7171
We have coined the term _first-party oracle_ to refer to this architecture, where API providers deliver oracle services without needing third parties to facilitate.
7272

73-
API3 data feeds are on-chain aggregations of data feeds powered by individual first-party oracles.
74-
Each API provider powers a single-source data feed on-chain, and the API3 data feed is an on-chain median of the these individual data feeds, which provides the strongest security guarantees (for example, compared to off-chain aggregation).
73+
Api3 data feeds are on-chain aggregations of data feeds powered by individual first-party oracles.
74+
Each API provider powers a single-source data feed on-chain, and the Api3 data feed is an on-chain median of the these individual data feeds, which provides the strongest security guarantees (for example, compared to off-chain aggregation).
7575

7676
::: info ⚠️ Warning
7777

@@ -87,7 +87,7 @@ Consequently, when dApps use Pyth data on Ethereum, users pay Ethereum gas fees
8787

8888
:::
8989

90-
API3 maintains a roster of first-party oracle partners and curates data feeds through continuous performance analysis.
90+
Api3 maintains a roster of first-party oracle partners and curates data feeds through continuous performance analysis.
9191
This focused approach produces better aggregation than alternatives that rely on numerous downstream oracle service providers.
9292

9393
## Oracle Extractable Value (OEV)
@@ -105,8 +105,8 @@ The lifecycle of a data point consists of three phases:
105105
dApps using our system will experience a 30–60 second delay in their data feed.
106106
While this delay concerns some users, we can evaluate its impact through a simple framework:
107107
Consider a dApp that generates `X1` revenue with its current oracle solution.
108-
Using API3 data feeds would generate `X2` revenue (potentially lower than `X1` due to the delay) plus `Y` in OEV Rewards.
109-
When `X1 < X2 + Y`—which is common—API3 feeds are the more secure choice.
108+
Using Api3 data feeds would generate `X2` revenue (potentially lower than `X1` due to the delay) plus `Y` in OEV Rewards.
109+
When `X1 < X2 + Y`—which is common—Api3 feeds are the more secure choice.
110110

111111
::: info 💡 Tip
112112

docs/dapps/oev-rewards/index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,27 @@ pageHeader: dApps → OEV Rewards
99

1010
dApps that use traditional data feeds are constantly exploited by MEV bots that manipulate the order of operations around individual data feed updates.
1111
In practice, this causes dApps to suffer significant and continuous financial losses.
12-
As the antidote, API3's OEV Network auctions off to OEV searchers the privilege to determine the order of operations around data feed updates.
12+
As the antidote, Api3's OEV Network auctions off to OEV searchers the privilege to determine the order of operations around data feed updates.
1313
The resulting auction proceeds are paid to the dApp in the form of OEV Rewards.
1414
Assuming competitive auctions, OEV Rewards will be equal to the amount that would otherwise have been lost to the MEV bots.
1515

16-
API3 data feeds work identically to traditional data feeds, which means that you do not need to modify your contracts in any way to use them.
17-
You can drop in API3 data feeds to replace your current data feeds and immediately start earning OEV Rewards.
16+
Api3 data feeds work identically to traditional data feeds, which means that you do not need to modify your contracts in any way to use them.
17+
You can drop in Api3 data feeds to replace your current data feeds and immediately start earning OEV Rewards.
1818
If you want to maximize your OEV Rewards, make sure to check out our [guide for best practices.](/dapps/oev-rewards/best-practices)
1919

2020
## How to get onboard
2121

22-
Use [this form](https://api3dao.typeform.com/to/FHhFIL41) to get in contact with an API3 representative who will walk you through the following steps:
22+
Use [this form](https://api3dao.typeform.com/to/FHhFIL41) to get in contact with an Api3 representative who will walk you through the following steps:
2323

24-
1. We register your dApp for it to show up on the API3 Market [integration page.](/dapps/integration/index.md#integration-information)
24+
1. We register your dApp for it to show up on the Api3 Market [integration page.](/dapps/integration/index.md#integration-information)
2525
2. You let us know which chains you operate on so we can start running the respective auctions.
2626
::: info 💡 Tip
2727
Don't forget to notify us if you expand to new chains later on.
2828
:::
2929
3. You let us know which data feeds you will use.
3030
If a gas grant is applicable, we purchase subscriptions for you and deploy an OEV Rewards-enabled Api3ReaderProxyV1 contract for each data feed.
3131
::: info 💡 Tip
32-
Alternatively, you can complete this step on your own using [API3 Market.](https://market.api3.org/)
32+
Alternatively, you can complete this step on your own using [Api3 Market.](https://market.api3.org/)
3333
:::
3434
4. You let us know an address where to receive the OEV Rewards.
3535
::: info 💡 Tip
@@ -38,11 +38,11 @@ Use [this form](https://api3dao.typeform.com/to/FHhFIL41) to get in contact with
3838
:::
3939
5. You [integrate](/dapps/integration/contract-integration) the OEV Rewards-enabled Api3ReaderProxyV1 contracts.
4040

41-
At the end of each month, API3 will make available a report and 80% of the OEV revenue in the native gas token of the network where your dApp is deployed, with the remaining auction proceeds retained as the protocol fee.
41+
At the end of each month, Api3 will make available a report and 80% of the OEV revenue in the native gas token of the network where your dApp is deployed, with the remaining auction proceeds retained as the protocol fee.
4242

4343
::: info 💰 Financial
4444

45-
API3 provides data feeds [at cost](/dapps/integration/index#pricing) and enables dApps to benefit from OEV Rewards on top.
45+
Api3 provides data feeds [at cost](/dapps/integration/index#pricing) and enables dApps to benefit from OEV Rewards on top.
4646
You might ask, "What's the catch?"
4747
There is none; OEV Rewards come at the expense of third parties who would otherwise solely benefit from MEV.
4848

docs/dapps/quickstart/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ pageHeader: dApps
77

88
# Quickstart
99

10-
[API3 Market](https://market.api3.org/) serves a large and dynamic catalog of data feeds on all major EVM networks.
11-
Follow this guide to learn how to use API3 Market to integrate a data feed into an example contract.
10+
[Api3 Market](https://market.api3.org/) serves a large and dynamic catalog of data feeds on all major EVM networks.
11+
Follow this guide to learn how to use Api3 Market to integrate a data feed into an example contract.
1212

13-
## Using API3 Market
13+
## Using Api3 Market
1414

1515
- Go to [market.api3.org.](https://market.api3.org/)
1616

@@ -87,12 +87,12 @@ If you prefer using Hardhat, you can clone [`data-feed-reader-example`](https://
8787

8888
::: info 💡 Tip
8989

90-
If you just purchased a plan on API3 Market, your MetaMask wallet should be connected to the correct network.
90+
If you just purchased a plan on Api3 Market, your MetaMask wallet should be connected to the correct network.
9191
If not, ensure your wallet is connected to the network where the data feed exists, where we'll deploy DataFeedReaderExample.
9292

9393
:::
9494

95-
- Return to the data feed page on API3 Market and click "Integrate".
95+
- Return to the data feed page on Api3 Market and click "Integrate".
9696

9797
<img src="./images/integrate.png">
9898

@@ -116,5 +116,5 @@ For information about using this selection on mainnets, refer to [this section.]
116116
## What next?
117117

118118
This guide should help you get started with a hackathon project.
119-
For production use of API3 data feeds, please continue to the [integration section.](/dapps/integration/)
120-
You can also learn how to [get paid](/dapps/oev-rewards/) for using API3 data feeds."
119+
For production use of Api3 data feeds, please continue to the [integration section.](/dapps/integration/)
120+
You can also learn how to [get paid](/dapps/oev-rewards/) for using Api3 data feeds."

docs/dev/containers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ should be used in `vitepress-docs`.
1313

1414
::: info
1515

16-
The info box is the default go-to for the API3 technical documentation.
16+
The info box is the default go-to for the Api3 technical documentation.
1717

1818
:::
1919

docs/dev/ssr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ outline: deep
88

99
# {{$frontmatter.title}}
1010

11-
API3 uses CloudFlare for DNS records which includes the docs. If SSR is turned
11+
Api3 uses CloudFlare for DNS records which includes the docs. If SSR is turned
1212
on for any domain related to the docs, then CloudFlare will minify the already
1313
minified build files from Firebase. This will result in the merging of pages
1414
visible to the reader.

docs/oev-searchers/glossary.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ provides a source of truth for [dAPIs](#dapi) and can be used to obtain which
7171
An API provider is a business that has productized their services in the form of
7272
an API.
7373

74-
### API3 Market
74+
### Api3 Market
7575

76-
[API3 Market](https://market.api3.org/) is a [dApp](#dapp) where users can
76+
[Api3 Market](https://market.api3.org/) is a [dApp](#dapp) where users can
7777
purchase [dAPI](#dapi) plans, which get reflected on-chain immediately.
7878

7979
### Api3ServerV1 Contract
@@ -153,12 +153,12 @@ after they've paid the bid amount.
153153
### dAPI
154154

155155
The
156-
[API3 whitepaper](https://github.com/api3dao/api3-whitepaper/blob/master/api3-whitepaper.pdf)
156+
[Api3 whitepaper](https://github.com/api3dao/api3-whitepaper/blob/master/api3-whitepaper.pdf)
157157
definition of a dAPI is a [first-party oracle](#first-party-oracles)-based data
158158
feed that is managed decentrally.
159159

160160
In practice, a dAPI is mapped to a particular [data feed](#data-feed). The
161-
mapping is managed by API3 DAO.
161+
mapping is managed by Api3 DAO.
162162

163163
### dApp
164164

@@ -168,9 +168,9 @@ An application that uses smart contracts. Usually referred to as a source of
168168

169169
### dApp ID
170170

171-
API3 holds separate [OEV auctions](#oev-auction) for different [dApps](#dapp) to
171+
Api3 holds separate [OEV auctions](#oev-auction) for different [dApps](#dapp) to
172172
keep their [proceeds](#oev-proceeds) isolated. In this scheme, dApps are
173-
identified by IDs that are assigned by API3 DAO.
173+
identified by IDs that are assigned by Api3 DAO.
174174

175175
### Data Feed
176176

@@ -234,15 +234,15 @@ Oracle extractable value (OEV) is a subset of [MEV](#mev) that can be extracted
234234
by guaranteeing a specific relative order of oracle updates and related
235235
interactions within a transaction.
236236

237-
API3 monetizes its [dAPI](#dapi) services by holding
237+
Api3 monetizes its [dAPI](#dapi) services by holding
238238
[OEV auctions](#oev-auction) and forwarding the [proceeds](#oev-proceeds) to the
239239
respective [dApps](#dapp). This is both a net gain for the dApps (which
240240
otherwise would have bled these funds to [MEV](#mev) bots and validators) and a
241-
fair and scalable business model for API3 DAO.
241+
fair and scalable business model for Api3 DAO.
242242

243243
### OEV Auction
244244

245-
API3 periodically holds [OEV](#oev) auctions on [OEV Network](#oev-network)
245+
Api3 periodically holds [OEV](#oev) auctions on [OEV Network](#oev-network)
246246
where [searchers](#searcher) [bid](#bid) to receive exclusive update rights to
247247
update the data feeds for a specific [dApp](#dapp) for a limited amount of time.
248248

@@ -290,7 +290,7 @@ Chainlink's AggregatorV2V3Interface for convenience.
290290

291291
When [Auctioneer](#auctioneer) confirms a [fulfillment](#fulfillment) and
292292
releases the [collateral amount](#collateral), it deducts a protocol fee which
293-
is kept by API3 DAO. The protocol fee is currently set to 0.
293+
is kept by Api3 DAO. The protocol fee is currently set to 0.
294294

295295
### Searcher
296296

0 commit comments

Comments
 (0)