Skip to content

Commit bc550d4

Browse files
dineshpintodineshpinto
authored
fix(api): update da layer api docs (#831)
2 parents 32866fb + b1af437 commit bc550d4

File tree

9 files changed

+214
-588
lines changed

9 files changed

+214
-588
lines changed

‎docs/1-intro.mdx‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,12 @@ sidebar_position: 1
33
slug: /
44
title: Flare Developer Hub ☀️
55
sidebar_label: Home
6-
description: Build on Flare, the EVM Layer 1 engineered for a data-rich, interconnected future
6+
description: Official documentation for Flare.
77
keywords:
88
[
99
flare-network,
10+
flare-docs,
11+
flare-documentation,
1012
blockchain,
1113
evm-compatible,
1214
solidity,
@@ -21,8 +23,6 @@ keywords:
2123
fassets,
2224
defi,
2325
ai,
24-
identity,
25-
tradfi,
2626
oracle,
2727
]
2828
---
@@ -31,7 +31,9 @@ import ThemedImage from "@theme/ThemedImage";
3131
import useBaseUrl from "@docusaurus/useBaseUrl";
3232
import DocCard from "@theme/DocCard";
3333

34-
Build once and run everywhere on Flare - the interoperable EVM L1 with enshrined data, fast finality, robust SDKs, and soon, verifiable compute with TEEs - all engineered for a data-rich, interconnected future.
34+
Start building on Flare, the interoperable EVM L1 engineered for a data-rich, interconnected future.
35+
Flare Developer Hub is your central resource, containing the tutorials, SDKs, and API documentation you need to succeed.
36+
Dive in to Flare's enshrined data, fast finality, and soon, verifiable compute with TEEs.
3537

3638
## Getting Started
3739

‎docs/fassets/1-overview.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: FAssets
33
description: FAssets is a trustless over-collateralized bridge to non smart contract networks to Flare.
4-
keywords: [fassets, xrp, bitcoin, dogecoin, flare-network]
4+
keywords: [fassets, flare-fassets, xrp, bitcoin, dogecoin, flare-network]
55
---
66

77
import ThemedImage from "@theme/ThemedImage";

‎docs/fdc/1-overview.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: FDC
55
authors: [lukaavbreht, filipkoprivec]
66
description: The Flare Data Connector (FDC) enables secure, onchain attestation of external data.
77
tags: [intermediate, ethereum, fdc]
8-
keywords: [ethereum, flare-data-connector, evm, flare-network]
8+
keywords: [flare-fdc, ethereum, flare-data-connector, evm, flare-network]
99
unlisted: false
1010
---
1111

‎docs/fdc/reference/data-availability-api.mdx‎

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,5 @@ sidebar_position: 1
66
---
77

88
import OpenApiDoc from "@site/src/components/OpenApiDoc/OpenApiDoc";
9-
import Tabs from "@theme/Tabs";
10-
import TabItem from "@theme/TabItem";
119

12-
<Tabs block>
13-
<TabItem
14-
value="base"
15-
label="Flare Mainnet, Songbird Canary-Network & Songbird Testnet Coston"
16-
>
17-
<OpenApiDoc url="openapi/data-availability-api.yaml" />
18-
</TabItem>
19-
<TabItem value="coston2" label="Flare Testnet Coston2">
20-
<OpenApiDoc url="openapi/ctn2-data-availability-api.yaml" />
21-
</TabItem>
22-
</Tabs>
10+
<OpenApiDoc url="openapi/data-availability-api.yaml" />

‎docs/ftso/0-overview.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
slug: overview
33
title: FTSOv2
44
description: FTSOv2 is an enshrined oracle that provides decentralized data feeds to the Flare network.
5-
keywords: [ftso, oracle, flare-time-series-oracle, flare-network]
5+
keywords: [ftso, flare-ftso, oracle, flare-time-series-oracle, flare-network]
66
---
77

88
import ThemedImage from "@theme/ThemedImage";

‎docs/network/0-overview.mdx‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -274,9 +274,9 @@ Resources for interacting with Flare's DA Layer and FDC verifiers.
274274
<Tabs block groupId="network">
275275
<TabItem value="flare" label="Flare Mainnet" default>
276276

277-
| **DA Layer** | [`https://flr-data-availability.flare.network/api-doc#/`](https://flr-data-availability.flare.network/api-doc#/) |
277+
| **DA Layer** | [`https://flr-data-availability.flare.network/api-doc`](https://flr-data-availability.flare.network/api-doc) |
278278
| :--------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------- |
279-
| **FDC Verifier (EVM chain)** | [`https://fdc-verifiers-mainnet.flare.network/verifier/api-doc`](https://fdc-verifiers-mainnet.flare.network/verifier/api-doc) |
279+
| **FDC Verifier (EVM)** | [`https://fdc-verifiers-mainnet.flare.network/verifier/api-doc`](https://fdc-verifiers-mainnet.flare.network/verifier/api-doc) |
280280
| **FDC Verifier (BTC)** | [`https://fdc-verifiers-mainnet.flare.network/verifier/btc/api-doc`](https://fdc-verifiers-mainnet.flare.network/verifier/btc/api-doc) |
281281
| **FDC Verifier (XRP)** | [`https://fdc-verifiers-mainnet.flare.network/verifier/xrp/api-doc`](https://fdc-verifiers-mainnet.flare.network/verifier/xrp/api-doc) |
282282
| **FDC Verifier (DOGE)** | [`https://fdc-verifiers-mainnet.flare.network/verifier/doge/api-doc`](https://fdc-verifiers-mainnet.flare.network/verifier/doge/api-doc) |
@@ -285,35 +285,35 @@ Resources for interacting with Flare's DA Layer and FDC verifiers.
285285
</TabItem>
286286
<TabItem value="coston2" label="Flare Testnet Coston2">
287287

288-
| **DA Layer** | [`https://ctn2-data-availability.flare.network/api-doc#/`](https://flr-data-availability.flare.network/api-doc#/) |
289-
| :--------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------- |
290-
| **FDC Verifier (EVM chain)** | [`https://fdc-verifiers-testnet.flare.network/verifier/api-doc`](https://fdc-verifiers-testnet.flare.network/verifier/api-doc) |
288+
| **DA Layer** | [`https://ctn2-data-availability.flare.network/api-doc`](https://flr-data-availability.flare.network/api-doc) |
289+
| :--------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
290+
| **FDC Verifier (EVM)** | [`https://fdc-verifiers-testnet.flare.network/verifier/api-doc`](https://fdc-verifiers-testnet.flare.network/verifier/api-doc) |
291291
| **FDC Verifier (BTC)** | [`https://fdc-verifiers-testnet.flare.network/verifier/btc_testnet4/api-doc`](https://fdc-verifiers-testnet.flare.network/verifier/btc_testnet4/api-doc) |
292-
| **FDC Verifier (XRP)** | [`https://fdc-verifiers-testnet.flare.network/verifier/xrp/api-doc`](https://fdc-verifiers-testnet.flare.network/verifier/xrp/api-doc) |
293-
| **FDC Verifier (DOGE)** | [`https://fdc-verifiers-testnet.flare.network/verifier/doge/api-doc`](https://fdc-verifiers-testnet.flare.network/verifier/doge/api-doc) |
294-
| **FDC Verifier (Web2Json)** | [`https://jq-verifier-test.flare.rocks/`](https://jq-verifier-test.flare.rocks/) |
292+
| **FDC Verifier (XRP)** | [`https://fdc-verifiers-testnet.flare.network/verifier/xrp/api-doc`](https://fdc-verifiers-testnet.flare.network/verifier/xrp/api-doc) |
293+
| **FDC Verifier (DOGE)** | [`https://fdc-verifiers-testnet.flare.network/verifier/doge/api-doc`](https://fdc-verifiers-testnet.flare.network/verifier/doge/api-doc) |
294+
| **FDC Verifier (Web2Json)** | [`https://jq-verifier-test.flare.rocks/`](https://jq-verifier-test.flare.rocks/) |
295295

296296
</TabItem>
297297
<TabItem value="songbird" label="Songbird Canary Network">
298298

299-
| **DA Layer** | [`https://sgb-data-availability.flare.network/api-doc#/`](https://flr-data-availability.flare.network/api-doc#/) |
299+
| **DA Layer** | [`https://sgb-data-availability.flare.network/api-doc`](https://flr-data-availability.flare.network/api-doc) |
300300
| :--------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------- |
301-
| **FDC Verifier (EVM chain)** | [`https://fdc-verifiers-mainnet.flare.network/verifier/api-doc`](https://fdc-verifiers-mainnet.flare.network/verifier/api-doc) |
301+
| **FDC Verifier (EVM)** | [`https://fdc-verifiers-mainnet.flare.network/verifier/api-doc`](https://fdc-verifiers-mainnet.flare.network/verifier/api-doc) |
302302
| **FDC Verifier (BTC)** | [`https://fdc-verifiers-mainnet.flare.network/verifier/btc/api-doc`](https://fdc-verifiers-mainnet.flare.network/verifier/btc/api-doc) |
303303
| **FDC Verifier (XRP)** | [`https://fdc-verifiers-mainnet.flare.network/verifier/xrp/api-doc`](https://fdc-verifiers-mainnet.flare.network/verifier/xrp/api-doc) |
304304
| **FDC Verifier (DOGE)** | [`https://fdc-verifiers-mainnet.flare.network/verifier/doge/api-doc`](https://fdc-verifiers-mainnet.flare.network/verifier/doge/api-doc) |
305-
| **FDC Verifier (Web2Json)** | - |
305+
| **FDC Verifier (Web2Json)** | - |
306306

307307
</TabItem>
308308
<TabItem value="coston" label="Songbird Testnet Coston">
309309

310-
| **DA Layer** | [`https://ctn-data-availability.flare.network/api-doc#/`](https://flr-data-availability.flare.network/api-doc#/) |
311-
| :--------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------- |
312-
| **FDC Verifier (EVM chain)** | [`https://fdc-verifiers-testnet.flare.network/verifier/api-doc`](https://fdc-verifiers-testnet.flare.network/verifier/api-doc) |
310+
| **DA Layer** | [`https://ctn-data-availability.flare.network/api-doc`](https://flr-data-availability.flare.network/api-doc) |
311+
| :--------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
312+
| **FDC Verifier (EVM)** | [`https://fdc-verifiers-testnet.flare.network/verifier/api-doc`](https://fdc-verifiers-testnet.flare.network/verifier/api-doc) |
313313
| **FDC Verifier (BTC)** | [`https://fdc-verifiers-testnet.flare.network/verifier/btc_testnet4/api-doc`](https://fdc-verifiers-testnet.flare.network/verifier/btc_testnet4/api-doc) |
314-
| **FDC Verifier (XRP)** | [`https://fdc-verifiers-testnet.flare.network/verifier/xrp/api-doc`](https://fdc-verifiers-testnet.flare.network/verifier/xrp/api-doc) |
315-
| **FDC Verifier (DOGE)** | [`https://fdc-verifiers-testnet.flare.network/verifier/doge/api-doc`](https://fdc-verifiers-testnet.flare.network/verifier/doge/api-doc) |
316-
| **FDC Verifier (Web2Json)** | [`https://jq-verifier-test.flare.rocks/`](https://jq-verifier-test.flare.rocks/) |
314+
| **FDC Verifier (XRP)** | [`https://fdc-verifiers-testnet.flare.network/verifier/xrp/api-doc`](https://fdc-verifiers-testnet.flare.network/verifier/xrp/api-doc) |
315+
| **FDC Verifier (DOGE)** | [`https://fdc-verifiers-testnet.flare.network/verifier/doge/api-doc`](https://fdc-verifiers-testnet.flare.network/verifier/doge/api-doc) |
316+
| **FDC Verifier (Web2Json)** | [`https://jq-verifier-test.flare.rocks/`](https://jq-verifier-test.flare.rocks/) |
317317

318318
</TabItem>
319319
</Tabs>

‎docusaurus.config.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import rehypeKatex from "rehype-katex";
66

77
const config: Config = {
88
title: "Flare Developer Hub",
9-
tagline: "The decentralized origin for Flare builders.",
9+
tagline: "Official documentation for Flare.",
1010
favicon: "/img/favicon.ico",
1111

1212
// Set the production url of your site here

0 commit comments

Comments
 (0)