Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/1-intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ Its native data protocols - [Flare Time Series Oracle](/ftso/overview) and [Flar
item={{
type: "link",
label: "Get technical support",
href: "https://flare.network/resources/developer-support",
href: "https://flare.network/resources/technical-support",
description: "Consult with Flare experts for dedicated support.",
docId: undefined,
}}
Expand Down
2 changes: 1 addition & 1 deletion docs/fassets/developer-guides/2-fassets-fxrp-address.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Before you begin, make sure you have:

## Understanding FXRP Address

The FXRP address is the contract address of the [ERC-20 token](https://ethereum.org/en/developers/docs/standards/tokens/erc-20/) that represents XRP on the Flare network and is essential for:
The FXRP address is the contract address of the [ERC-20 token](https://ethereum.org/developers/docs/standards/tokens/erc-20/) that represents XRP on the Flare network and is essential for:

- Interacting with FXRP in smart contracts.
- Transferring FXRP tokens.
Expand Down
4 changes: 2 additions & 2 deletions docs/fassets/developer-guides/4-fassets-settings-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ This guide is a perfect first step for developers working with FAssets.
## Prerequisites

- [Node.js](https://nodejs.org/en/download/)
- [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
- [TypeScript](https://www.typescriptlang.org/download)
- [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm/)
- [TypeScript](https://www.typescriptlang.org/download/)
- [Ethers.js](https://docs.ethers.org/v5/)
- [TypeChain](https://www.npmjs.com/package/typechain)
- [Flare Periphery Contract Artifacts](https://www.npmjs.com/package/@flarenetwork/flare-periphery-contract-artifacts)
Expand Down
2 changes: 1 addition & 1 deletion docs/fassets/guides/6-agent-bot-notifications.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ It helps monitor the health of the agent and the network.

## Flare Hosted Telegram Notifications Alert Configuration

1. Get the API key from the [FAssets Telegram Bot](http://t.me/FlareFAssetsSongbirdBot) by sending `/events` and selecting `Subscribe to Events`.
1. Get the API key from the [FAssets Telegram Bot](https://t.me/FlareFAssetsSongbirdBot) by sending `/events` and selecting `Subscribe to Events`.
2. Add the following configuration to the `apiNotifierConfigs` list in the `config.json` file, replacing `API_KEY` with the key obtained from the bot.

```json
Expand Down
2 changes: 1 addition & 1 deletion docs/fdc/attestation-types/_addresses.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -158,5 +158,5 @@ Decoded to hexadecimal:

#### Resources

- [XRPL Base58 Encodings](https://xrpl.org/base58-encodings.html)
- [XRPL Base58 Encodings](https://xrpl.org/docs/references/protocol/data-types/base58-encodings)
- [XRPL Addresses](https://xrpl.org/accounts.html#addresses)
2 changes: 1 addition & 1 deletion docs/fdc/attestation-types/evm-transaction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Information about an Ethereum Virtual Machine (EVM) transaction, including detai

## Response

The response fields align with EVM's [JSON-RPC API](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gettransactionbyhash):
The response fields align with EVM's [JSON-RPC API](https://ethereum.org/developers/docs/apis/json-rpc/#eth_gettransactionbyhash):

| Field | Solidity Type | Description |
| ------------------ | ------------- | ----------------------------------------------------------------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion docs/fdc/attestation-types/payment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ The payment summary on XRPL is applicable only for transactions of type `Payment

#### Data Sources

- Transaction details are obtained via the [`tx`](https://xrpl.org/tx.html) method.
- Transaction details are obtained via the [`tx`](https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx) method.
- Changes made by the transaction are recorded in the `meta` field (or `metaData` if fetched via the `ledger` method) under `AffectedNodes`.
Balance changes are found within `ModifiedNodes`, by comparing `FinalFields` and `PreviousFields`.

Expand Down
2 changes: 1 addition & 1 deletion docs/fdc/guides/hardhat/detect-balance-decrease.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The primary contract interface for this attestation type is [`IConfirmedBlockHei

## Balance Decreasing Transaction

[Full specification on GitHub](https://github.com/flare-foundation/songbird-state-connector-protocol/blob/main/specs/attestations/active-types).
[Full specification on GitHub](https://github.com/flare-foundation/songbird-state-connector-protocol/tree/main/specs/attestations/active-types).

This attestation type is designed to prove that a transaction either decreases the balance of an address or is signed by the source address.

Expand Down
2 changes: 1 addition & 1 deletion docs/ftso/0-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ The FTSOv2 architecture consists of four key components:

:::tip[Interested in learning more?]

For a detailed explanation of the FTSOv2 mechanism, read the [FTSOv2 whitepaper](https://flare.network/wp-content/uploads/FTSOv2-White-Paper.pdf).
For a detailed explanation of the FTSOv2 mechanism, read the [FTSOv2 whitepaper](https://dev.flare.network/pdf/whitepapers/20240223-FlareTimeSeriesOracleV2.pdf).

:::

Expand Down
10 changes: 5 additions & 5 deletions docs/ftso/guides/build-first-app.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import FtsoV2ConsumerHardhat from "!!raw-loader!/examples/developer-hub-solidity
import FtsoV2ConsumerTestHardhat from "!!raw-loader!/examples/developer-hub-javascript/ftso_v2_consumer_hardhat.ts";
import FtsoV2ConsumerHardhatDeploy from "!!raw-loader!/examples/developer-hub-javascript/deployFTSOConsumer.ts";

This guide is for developers who want to build an FTSOv2 application using either [Foundry](https://book.getfoundry.sh) or [Hardhat](https://hardhat.org).
This guide is for developers who want to build an FTSOv2 application using either [Foundry](https://getfoundry.sh/) or [Hardhat](https://hardhat.org).

<Tabs groupId="framework">
<TabItem value="foundry" label="Foundry" default>
Expand All @@ -34,9 +34,9 @@ This guide is for developers who want to build an FTSOv2 application using eithe

- Create a contract to read the price of FLR/USD from FTSOv2 using [flare-periphery-contracts](https://www.npmjs.com/package/@flarenetwork/flare-periphery-contracts).

- Compile your contract using Foundry [forge](https://book.getfoundry.sh/reference/forge/).
- Compile your contract using Foundry [forge](https://getfoundry.sh/).

- Deploy your contract to Flare Testnet Coston2, and interact with it using Foundry [cast](https://book.getfoundry.sh/reference/cast/).
- Deploy your contract to Flare Testnet Coston2, and interact with it using Foundry [cast](https://getfoundry.sh/).

</TabItem>
<TabItem value="hardhat" label="Hardhat">
Expand All @@ -59,7 +59,7 @@ This guide is for developers who want to build an FTSOv2 application using eithe

Ensure you have the following tools installed:

- [Foundry](https://book.getfoundry.sh/getting-started/installation)
- [Foundry](https://getfoundry.sh/)
- [Node.js](https://nodejs.org/en/download/)

</TabItem>
Expand Down Expand Up @@ -269,7 +269,7 @@ This guide is for developers who want to build an FTSOv2 application using eithe
<Tabs groupId="framework">
<TabItem value="foundry" label="Foundry" default>

1. Generate a new wallet using the [cast](https://book.getfoundry.sh/reference/cast/):
1. Generate a new wallet using the [cast](https://getfoundry.sh/):

```bash
cast wallet new
Expand Down
2 changes: 1 addition & 1 deletion docs/ftso/scaling/1-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ This structured approach not only maintains data integrity and accuracy but also

:::tip[Interested in learning more?]

For a detailed explanation of the Scaling mechanism, read Section 2 of the [FTSOv2 whitepaper](https://flare.network/wp-content/uploads/FTSOv2-White-Paper.pdf).
For a detailed explanation of the Scaling mechanism, read Section 2 of the [FTSOv2 whitepaper](https://dev.flare.network/pdf/whitepapers/20240223-FlareTimeSeriesOracleV2.pdf).

:::

Expand Down
8 changes: 4 additions & 4 deletions docs/network/0-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -329,13 +329,13 @@ Resources for interacting with Flare's DA Layer and FDC verifiers.
## Supported wallets

A variety of wallets across desktop, browser extension, and mobile platforms support Flare.
Discover suitable options for your needs on the [Flare Wallets](https://flare.network/wallets/) page.
Discover suitable options for your needs on the [Flare Wallets](https://flare.network/wallets) page.

## Transaction format

- **Address space:** Matches Ethereum, 20-byte addresses using ECDSA.

- **Transaction format:** Matches Ethereum, complies with [EIP-2718](https://eips.ethereum.org/EIPS/eip-2718), encoded with [RLP](https://ethereum.org/en/developers/docs/data-structures-and-encoding/rlp/).
- **Transaction format:** Matches Ethereum, complies with [EIP-2718](https://eips.ethereum.org/EIPS/eip-2718), encoded with [RLP](https://ethereum.org/developers/docs/data-structures-and-encoding/rlp/).

- **Transaction fees:**
- **Type0** (Legacy) - Fee is calculated as `gasUsed * gasPrice`.
Expand All @@ -347,13 +347,13 @@ Discover suitable options for your needs on the [Flare Wallets](https://flare.ne

- **Compatibility:** Fully EVM-compatible. Contracts written in Solidity, Vyper, or other EVM languages can be deployed directly.

- **RPC-API:** [Ethereum RPC API](https://ethereum.org/en/developers/docs/apis/json-rpc/)
- **RPC-API:** [Ethereum RPC API](https://ethereum.org/developers/docs/apis/json-rpc/)

- **Supported opcodes:** Supports all EVM [opcodes](https://www.evm.codes/?fork=shanghai) up to and including the Shanghai hard fork.

## Consensus mechanism

- **Consensus Protocol:** Snowman++ (from [Avalanche](https://build.avax.network/docs)) provides a high-throughput, totally ordered consensus with fast finality. Learn more on the [Consensus](/network/consensus) page.
- **Consensus Protocol:** Snowman++ (from [Avalanche](https://build.avax.network/docs/quick-start)) provides a high-throughput, totally ordered consensus with fast finality. Learn more on the [Consensus](/network/consensus) page.

- **Sybil resistance mechanism:** Proof-of-Stake (PoS)

Expand Down
2 changes: 1 addition & 1 deletion docs/network/1-getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ import UpdateMessage from "/static/img/deploy-first-contract/17-update-message.p
import ConfirmMetamaskUpdateMessage from "/static/img/deploy-first-contract/18-confirm-metamask-update-message.png";
import QueryUpdatedMessage from "/static/img/deploy-first-contract/19-query-updated-message.png";

You can deploy your first smart contract and run it in your browser without prior knowledge of Flare. This guide demonstrates how easy it is to develop smart contracts using the [Solidity language](https://soliditylang.org/), a [MetaMask wallet](https://metamask.io/) and the [Remix Development Environment](https://remix.ethereum.org/). All these tools are accessible in your browser for free, without requiring any sign-up.
You can deploy your first smart contract and run it in your browser without prior knowledge of Flare. This guide demonstrates how easy it is to develop smart contracts using the [Solidity language](https://www.soliditylang.org/), a [MetaMask wallet](https://metamask.io/) and the [Remix Development Environment](https://remix.ethereum.org/). All these tools are accessible in your browser for free, without requiring any sign-up.

## Goals

Expand Down
2 changes: 1 addition & 1 deletion docs/network/4-consensus.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import CodeBlock from "@theme/CodeBlock";
import ThemedImage from "@theme/ThemedImage";
import useBaseUrl from "@docusaurus/useBaseUrl";

The consensus protocol running on all Flare networks is Snowman++, introduced by [Avalanche](https://build.avax.network/docs).
The consensus protocol running on all Flare networks is Snowman++, introduced by [Avalanche](https://build.avax.network/docs/quick-start).
This runs on both the P- and C-chains.

<div style={{ textAlign: "center", margin: "30px 0" }}>
Expand Down
2 changes: 1 addition & 1 deletion docs/network/fsp/2-rewarding.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Sub-protocols implement their own contracts to gather rewarding inputs, which ar

## Minimal Conditions

The [FIP.10](https://proposals.flare.network/FIP/FIP_10.html) and [SIP.04](http://proposals.flare.network/SIP/SIP_4.html) governance proposals introduced an incentive structure for participating in all protocols.
The [FIP.10](https://proposals.flare.network/FIP/FIP_10.html) and [SIP.04](https://proposals.flare.network/SIP/SIP_4.html) governance proposals introduced an incentive structure for participating in all protocols.
The proposals implemented a set of minimum participation requirements from the data providers in a reward epoch for all Flare protocols.
These proposals ensure that participation in Flare's **enshrined protocols** is not merely symbolic, but actively upheld by the network's validators through meaningful engagement.
Failure to meet **all** these requirements can ultimately lead to loss of rewards across all protocols.
Expand Down
2 changes: 1 addition & 1 deletion docs/network/guides/flare-for-go-developers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import DeployContractFlare from "!!raw-loader!/examples/developer-hub-go/flare/d
This guide is for developers who want to interact with Flare using Go. In this guide, using Go, you will learn how to:

- Query a contract on Flare using the Go API for [Geth](https://github.com/ethereum/go-ethereum), a client that implements the full Ethereum JSON-RPC API.
- Compile a Solidity contract using the CLI interface of [solc](https://github.com/ethereum/solidity), the Solidity compiler.
- Compile a Solidity contract using the CLI interface of [solc](https://github.com/argotorg/solidity), the Solidity compiler.
- Deploy your compiled contract on Flare.

:::tip
Expand Down
2 changes: 1 addition & 1 deletion docs/network/guides/flare-for-javascript-developers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import DeployContractFlare from "!!raw-loader!/examples/developer-hub-javascript
This guide is for developers who want to interact with Flare using JavaScript. In this guide, using JavaScript, you will learn how to:

- Query a contract on Flare using [web3.js](https://github.com/web3/web3.js), an async/sync library for interacting with Ethereum-like chains.
- Compile a Solidity contract using the CLI interface of [solc](https://github.com/ethereum/solidity), the Solidity compiler.
- Compile a Solidity contract using the CLI interface of [solc](https://github.com/argotorg/solidity), the Solidity compiler.
- Deploy your compiled contract on Flare.

:::tip
Expand Down
2 changes: 1 addition & 1 deletion docs/network/guides/flare-for-rust-developers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import Config from "@site/examples/developer-hub-rust/config.json";
This guide is for developers who want to interact with Flare using Rust. In this guide, using Rust, you will learn how to:

- Query a contract on Flare using [alloy-rs](https://github.com/alloy-rs), an async library for interacting with Ethereum-like chains.
- Compile a Solidity contract using the CLI interface of [solc](https://github.com/ethereum/solidity), the Solidity compiler.
- Compile a Solidity contract using the CLI interface of [solc](https://github.com/argotorg/solidity), the Solidity compiler.
- Deploy your compiled contract on Flare.

:::tip
Expand Down
4 changes: 2 additions & 2 deletions docs/network/guides/gasless-usdt0-transfers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,9 @@ Before you begin, ensure you have the following:
- An **EVM compatible wallet** (e.g., Metamask). You can find suitable options on the [Flare Wallets](https://flare.network/wallets) page.
- A **Relayer Account:** An EOA on Flare Mainnet, funded with sufficient FLR to cover the gas costs of relaying transactions.
- **Development Environment:**
- [Node.js](https://nodejs.org/) (v18 or later)
- [Node.js](https://nodejs.org/en) (v18 or later)
- A package manager (`npm` or `yarn`)
- A [React](https://reactjs.org/) frontend setup, preferably using [Vite](https://vitejs.dev/) for quick project scaffolding.
- A [React](https://react.dev/) frontend setup, preferably using [Vite](https://vite.dev/) for quick project scaffolding.
- **USD₮0 Contract Details:**
- Official USD₮0 contract address (`TetherTokenOFTExtension`) for Flare Mainnet.
Always refer to the [official USD₮0 documentation](https://docs.usdt0.to/technical-documentation/developer#flare) for the latest addresses.
Expand Down
2 changes: 1 addition & 1 deletion docs/network/guides/hardhat-foundry-starter-kit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The starter kit includes a basic setup for configuring Hardhat and Foundry, alon

Install the following tools:

- [Foundry](https://book.getfoundry.sh/getting-started/installation.html)
- [Foundry](https://getfoundry.sh/)

</TabItem>
</Tabs>
Expand Down
2 changes: 1 addition & 1 deletion docs/network/guides/manage-flaredrops.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ keywords: [intermediate, solidity, smart-contract, flare-network]
sidebar_position: 8
---

[FlareDrops](https://flare.network/flaredrop-guide/) are a series of 36 monthly drops totalling 24.2 billion FLR can be claimed by active Flare community members who have wrapped their Flare tokens.
[FlareDrops](https://flare.network/news/flaredrop-guide) are a series of 36 monthly drops totalling 24.2 billion FLR can be claimed by active Flare community members who have wrapped their Flare tokens.
This guide explains how to manage FlareDrop functionality in applications.

<details>
Expand Down
8 changes: 4 additions & 4 deletions docs/network/guides/using-flare-stake-tool.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ After the staking period expires and funds are unlocked, they can be transferred

Install the following tools:

- [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
- [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm/)

## Setup

Expand Down Expand Up @@ -86,7 +86,7 @@ Install the following tools:
### Using Ledger (recommended)

1. Connect your Ledger device to your computer and unlock it.
Launch the [Ledger Live](https://www.ledger.com/ledger-live) application and navigate to the **My Ledger** tab and ensure your device firmware is up-to-date.
Launch the [Ledger Wallet](https://shop.ledger.com/pages/ledger-wallet) (previously called Ledger Live) application and navigate to the **My Ledger** tab and ensure your device firmware is up-to-date.

2. In the **App Catalog** tab, search for **Avalanche**, Click **Install**.

Expand All @@ -97,7 +97,7 @@ Install the following tools:

:::

3. Exit Ledger Live and ensure the device is not connected to any other applications like MetaMask.
3. Exit Ledger Wallet and ensure the device is not connected to any other applications like MetaMask.
Open the Avalanche app on your Ledger device. The screen should display **Avalanche Ready**.

4. Open a terminal and run the following command to start the staking tool in interactive mode:
Expand Down Expand Up @@ -555,7 +555,7 @@ At the end of every reward epoch, participants are rewarded according to how wel
Make sure:

- The device is connected, the Avalanche app is opened, and it shows the "Avalanche Ready" message.
- No other application like Ledger Live or MetaMask is connected to the device.
- No other application like Ledger Wallet or MetaMask is connected to the device.
- The device is not in stand-by mode.
- You are not running on Windows from a Linux terminal (WSL). Use a native Windows console instead.

Expand Down
2 changes: 1 addition & 1 deletion docs/network/guides/wnat.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import Withdraw from "!!raw-loader!/examples/developer-hub-javascript/wnat-withd

This guide will show you how to deposit and withdraw wrapped native tokens on Flare.
Wrapped tokens are required to delegate your vote power to FTSO data providers and to vote on decisions that affect how Flare networks operate.
Wrapped tokens are stored on the blockchain in an [`ERC-20`](https://ethereum.org/en/developers/docs/standards/tokens/erc-20/) token standard in a smart contract called `WNat`.
Wrapped tokens are stored on the blockchain in an [`ERC-20`](https://ethereum.org/developers/docs/standards/tokens/erc-20/) token standard in a smart contract called `WNat`.

The [`IWNat`](/network/solidity-reference/IWNat) contract is the interface for the Wrapped Native Token contract.

Expand Down
4 changes: 2 additions & 2 deletions docs/run-node/2-from-source.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ Make sure to check the [hardware requirements](/run-node/system-requirements) be
## Prerequisites

- A machine meeting the [minimum hardware requirements](/run-node/system-requirements).
- [Go](https://golang.org/doc/install) (`1.21.8`)
- [git](https://git-scm.com/downloads)
- [Go](https://go.dev/doc/install) (`1.21.8`)
- [git](https://git-scm.com/install/)
- [GCC](https://gcc.gnu.org/install/)
- [jq](https://stedolan.github.io/jq/download/)
- [rsync](https://rsync.samba.org/download.html)
Expand Down
Loading
Loading