Skip to content

Commit 7d4fc7d

Browse files
authored
Fix app fees docs to read balance instead of fees (#166)
1 parent e8d337a commit 7d4fc7d

File tree

6 files changed

+17
-13
lines changed

6 files changed

+17
-13
lines changed

docs.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,8 @@
127127
"references/api/get-token-price",
128128
"references/api/transactions-index",
129129
"references/api/transactions-single",
130+
"references/api/get-app-fee-balances",
131+
"references/api/claim-app-fees",
130132
"references/api/advanced",
131133
"references/api/swap-multi-input",
132134
"references/api/fast-fill",

features/app-fees.mdx

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Add App Fees on any route and collect in stablecoins "
55

66
## What are App Fees?
77

8-
App fees are additional fees set by third-party developers on top of existing fees. These fees are specified when generating a quote. To improve the gas costs of fee setting, App fees are not paid out in real-time. Rather, App Fees accrue in base _USDC,_ and can be claimed as desired at your convenience.
8+
App fees are additional fees set by third-party developers on top of existing fees. These fees are specified when generating a quote. To improve the gas costs of fee setting, App fees are not paid out in real-time. Rather, App Fees accrue in an offchain base _USDC,_ balance and can be withdrawn as desired at your convenience.
99

1010
## Setting App Fees
1111

@@ -27,15 +27,15 @@ App Fees are measured in basis points (bps) based on the input value of an order
2727
- App Fee Recipients _must_ be an EVM compatible wallet address, even for non-EVM chains.
2828
- App fees _can_ be an array, for setting multiple fees at once
2929

30-
## Claiming App Fees
30+
## Withdrawing App Balance
3131

32-
App fees accrue in USDC, and can be claimed on any chain. Fees are free to claim on Base, and Relay exchange fees apply to claim on any other chain or in any other currency.
32+
App balance accrue in USDC from app fees, and can be claimed on any chain. The balance is free to claim on Base, and Relay app balance apply to claim on any other chain or in any other currency.
3333

34-
The easiest way to claim your App fees is to use the [Relay App](https://relay.link/claim-app-fees). The Relay App also works for claiming via a multisig. Here’s how you can claim via API:
34+
The easiest way to claim your App Balance is to use the [Relay App](https://relay.link/claim-app-fees). The Relay App Balance page also supports withdrawing via a multisig. Here’s how you can withdraw via the API:
3535

36-
### Check App Fees Balance
36+
### Get App Balance
3737

38-
To check your accrued App fees, use the App fee balances API. Here’s an example curl command:
38+
To check your accrued App Balance, use the App fee balances API. Here’s an example curl command:
3939

4040
```bash cURL
4141
curl --location 'https://api.relay.link/app-fees/0x03508bb71268bba25ecacc8f620e01866650532c/balances'
@@ -64,9 +64,11 @@ The response includes the `balances.currency` field reflecting your off-chain ba
6464
}
6565
```
6666

67-
### **How to claim your off-chain balance?**
67+
To learn more about this api, see the [Get App Fee Balance](/references/api/get-app-fee-balances) API reference.
6868

69-
To claim your app fees, use the app fees claim API. If using the API, the response will guide you through signing and submitting a message to the `/execute/permit` endpoint to verify ownership of your claim address. The SDK automates this process for you.
69+
### **How to withdraw your off-chain balance?**
70+
71+
To withdraw your app fees, use the app fees claim API. If using the API, the response will guide you through signing and submitting a message to the `/execute/permit` endpoint to verify ownership of your claim address. The SDK automates this process for you.
7072

7173
**API/SDK**
7274

@@ -127,4 +129,4 @@ curl -X POST \
127129
}'
128130
```
129131

130-
Once done, you can check your balance again to verify the claim.
132+
Once done, you can check your balance again to verify the withdrawal. To learn more about this api, see the [Claim App Fee Balance](/references/api/claim-app-fees) API reference.

references/api/claim-app-fees.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ description: "This API claims app fees for a specific wallet."
44
openapi: post /app-fees/{wallet}/claim
55
---
66

7-
[What are app fees?](/how-it-works/fees#what-are-app-fees)
7+
[What are app fees?](/features/app-fees)

references/api/get-app-fee-balances.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ description: "This API returns app fee balances for a specific wallet."
44
openapi: get /app-fees/{wallet}/balances
55
---
66

7-
[What are app fees?](/how-it-works/fees#what-are-app-fees)
7+
[What are app fees?](/features/app-fees)

references/sdk/actions/claimAppFees.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: claimAppFees
33
description: Claim app fees for a wallet
44
---
55

6-
[What are app fees?](/how-it-works/fees#what-are-app-fees)
6+
[What are app fees?](/features/app-fees)
77

88
### Parameters
99

references/sdk/actions/getAppFees.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: getAppFees
33
description: Retrieve app fee balances for a specific wallet
44
---
55

6-
[What are app fees?](/how-it-works/fees#what-are-app-fees)
6+
[What are app fees?](/features/app-fees)
77

88
### Parameters
99

0 commit comments

Comments
 (0)