Skip to content

Commit f99604d

Browse files
fix(docs): apply suggested changes
1 parent e44efb6 commit f99604d

15 files changed

Lines changed: 7 additions & 48 deletions

File tree

docs/fassets/developer-guides/13-fassets-agent-details.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ function getAgentDetails(address _managementAddress) external view
9999
In this guide, you learned how to read FAssets agent details using the [AgentOwnerRegistry](/fassets/reference/IAgentOwnerRegistry) smart contract.
100100
This functionality is crucial for building user interfaces that display agent information and for validating agent credentials in your applications.
101101

102-
The complete implementation examples are available in the [Flare Hardhat Starter Kit](/network/guides/hardhat-foundry-starter-kit) — see [`scripts/fassets/agentInfo.ts`](https://github.com/flare-foundation/flare-hardhat-starter/blob/master/scripts/fassets/agentInfo.ts) and the on-chain helper at [`contracts/fassets/FassetsAgentInfo.sol`](https://github.com/flare-foundation/flare-hardhat-starter/blob/master/contracts/fassets/FassetsAgentInfo.sol).
102+
The complete implementation examples are available in the [Flare Hardhat Starter Kit](/network/guides/hardhat-foundry-starter-kit).
103103

104104
:::tip Next Steps
105105
To continue your FAssets development journey, you can:

docs/fassets/developer-guides/14-fassets-redemption-default.mdx

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,6 @@ import YouTubeEmbed from "@site/src/components/YouTubeEmbed";
1111

1212
## Overview
1313

14-
:::note Runnable example
15-
This guide describes the on-chain flow only.
16-
A runnable script that calls `redemptionPaymentDefault` end-to-end is not yet shipped in the starter kits — it will land in a follow-up PR to `flare-hardhat-starter` and `flare-foundry-starter`.
17-
:::
18-
1914
In the FAssets system, once a **redeemer submits a redemption request**, the assigned **agent must send the underlying asset** (e.g., XRP) to the redeemer within a specific time defined in the [operational parameters](/fassets/operational-parameters).
2015

2116
This guide explains:

docs/fassets/developer-guides/7-fassets-mint.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,6 @@ After understanding the underlying payment timeframes, you can use the provided
9999
2. Specify the correct constants from the reserve collateral script:
100100
- `AGENT_ADDRESS` - Agent's XRP Ledger address.
101101
- `AMOUNT_XRP` - XRP amount to send.
102-
**Refresh this between runs** — it must equal `(valueUBA + feeUBA) / 10**assetDecimals` from the `CollateralReserved` event you just emitted.
103102
- `PAYMENT_REFERENCE` - Payment reference from the reserve collateral script.
104103
3. Create a client to connect to the XRP Ledger Testnet.
105104
4. Load the sender wallet.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
:::note Network coverage
22

33
Examples in this guide target the **Coston2** testnet for safety.
4-
For Songbird or Flare mainnet, swap the `coston2/` segment of every `@flarenetwork/flare-periphery-contracts/coston2/...` import for `songbird/` or `flare/` respectively, and resolve the AssetManager via the corresponding network's `IFlareContractRegistry` (e.g. `getAssetManagerFXRP()`, `getAssetManagerFBTC()`, `getAssetManagerFDOGE()`).
4+
For Songbird or Flare mainnet, swap the `coston2/` segment of every `@flarenetwork/flare-periphery-contracts/coston2/...` import for `songbird/` or `flare/` respectively, and resolve the AssetManager via the corresponding network's `IFlareContractRegistry`.
55
RPC endpoints, faucet links, and the FAssets agents available on each network are listed on the [FAssets overview](/fassets/overview).
66

77
:::

docs/fassets/reference/IAgentPing.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ sidebar_position: 9
44
description: On-chain liveness ping/response between users and FAssets agent bots.
55
---
66

7-
:::caution Preview
8-
This page is a hand-written stub extracted directly from the periphery release (`@flarenetwork/flare-periphery-contracts` v0.1.41) while the auto-generated reference catches up.
9-
:::
10-
117
`IAgentPing` exposes a simple ping/response protocol for verifying that an FAssets agent's off-chain bot is alive.
128
Users (or anyone) call `agentPing(agentVault, query)` to emit a `AgentPing` event; the bot listens for these events and replies with `agentPingResponse(agentVault, query, response)`, which emits an `AgentPingResponse` event identifying the owner address.
139

docs/fassets/reference/ICoreVaultClient.mdx

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,6 @@ sidebar_position: 8
44
description: Agent-facing interface for transferring backing assets into and out of the FAssets core vault.
55
---
66

7-
:::caution Preview
8-
This page is a hand-written stub extracted directly from the periphery release (`@flarenetwork/flare-periphery-contracts` v0.1.41) while the auto-generated reference catches up.
9-
Function signatures and events may change between periphery releases — cross-check against the source before pinning your contract code.
10-
:::
11-
127
`ICoreVaultClient` is the agent-facing surface of the FAssets **core vault** subsystem.
138
Agents transfer backing into the core vault to free up capital, and request returns when they need to redeem.
149
Direct minting (FAssets minted without an XRPL payment from the user) and direct redemptions also flow through this client.

docs/fassets/reference/IFAsset.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ sidebar_position: 7
44
description: ERC-20 plus FAsset-specific metadata for FXRP / FBTC / FDOGE / FLTC tokens.
55
---
66

7-
:::caution Preview
8-
This page is a hand-written stub extracted directly from the periphery release (`@flarenetwork/flare-periphery-contracts` v0.1.41) while the auto-generated reference catches up.
9-
:::
10-
117
`IFAsset` is the ERC-20 surface of an FAsset token (FXRP, FBTC, FDOGE, FLTC, ...) with three extra accessors that expose the underlying asset's identity and the `IAssetManager` bound to this FAsset.
128
It extends OpenZeppelin's [`IERC20`](https://docs.openzeppelin.com/contracts/5.x/api/token/erc20#IERC20) and [`IERC20Metadata`](https://docs.openzeppelin.com/contracts/5.x/api/token/erc20#IERC20Metadata).
139

docs/fdc/reference/IWeb2Json.mdx

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,6 @@ sidebar_position: 9
44
description: Attestation type that fetches JSON over HTTP, applies a jq filter, and returns ABI-encoded data.
55
---
66

7-
:::caution Preview
8-
This page is a hand-written stub extracted directly from the periphery release (`@flarenetwork/flare-periphery-contracts` v0.1.41) while the auto-generated reference catches up.
9-
Cross-check against the source before pinning your contract code.
10-
:::
11-
127
The `Web2Json` attestation type fetches data from a URL, post-processes the returned JSON with a `jq` filter, and returns the result as ABI-encoded bytes.
138
The interface only declares the request/response/proof structs — verification is exposed via [`IFdcVerification.verifyWeb2Json`](/fdc/reference/IFdcVerification#verifyweb2json).
149

docs/fdc/reference/IWeb2JsonVerification.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ sidebar_position: 10
44
description: Verifier interface for Web2Json proofs.
55
---
66

7-
:::caution Preview
8-
This page is a hand-written stub extracted directly from the periphery release (`@flarenetwork/flare-periphery-contracts` v0.1.41) while the auto-generated reference catches up.
9-
:::
10-
117
`IWeb2JsonVerification` is the verifier surface for the [`Web2Json`](/fdc/reference/IWeb2Json) attestation type.
128
It is one of the parent interfaces inherited by [`IFdcVerification`](/fdc/reference/IFdcVerification) — in practice most consumers call `verifyWeb2Json` through `ContractRegistry.getFdcVerification()` rather than holding a separate `IWeb2JsonVerification` reference.
139

docs/fxrp/token-interactions/02-usdt0-fxrp-swap.mdx

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,6 @@ import UniswapV3Wrapper from "!!raw-loader!/examples/developer-hub-solidity/Unis
1212
import UniswapV3WrapperScript from "!!raw-loader!/examples/developer-hub-javascript/uniswapV3Wrapper.ts";
1313
import RemixEmbed from "@site/src/components/RemixEmbed";
1414

15-
:::warning Draft
16-
The runnable script `scripts/fassets/uniswapV3Wrapper.ts` referenced from this guide does not yet exist in the Flare Hardhat Starter.
17-
The guide is hidden (`unlisted: true`) until the script lands in the starter.
18-
:::
19-
2015
## Overview
2116

2217
In this guide, you will learn how to swap USDT0 to FXRP using the Uniswap V3 router (SparkDEX).

0 commit comments

Comments
 (0)