Skip to content

Commit 505ffe7

Browse files
authored
chore: remove direct mentions of 3rd-party commercial TON products (#2266)
1 parent f94f89c commit 505ffe7

61 files changed

Lines changed: 284 additions & 904 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.cspell.jsonc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@
114114
},
115115
{
116116
"filename": "content/**/appkit/reference/appkit*.mdx",
117-
"ignoreWords": ["providerId", "AppkitUIToken"],
117+
"ignoreWords": ["providerId", "AppkitUIToken", "LayerswapCryptoOnrampProvider"],
118118
},
119119
{
120120
"filename": "content/**/foundations/whitepapers/overview.mdx",

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,5 +42,7 @@ next-env.d.ts
4242
/build
4343
*.tsbuildinfo
4444

45-
# Temporary folders cloned for technical accuracy checks
45+
# Temporary folders or files for technical accuracy checks
4646
/.ctx
47+
/AGENTS.md
48+
/CLAUDE.md

content/api/price.mdx

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,9 @@ Each swap operation, whether between a native asset (Gram) and Jetton or between
77

88
## Off-chain API
99

10-
The most common use case for the price API is to fetch Jetton info on the web2 backend and use aggregated data inside the service. There are several historical Jetton price providers in TON:
10+
The most common use case for the price API is to fetch Jetton info on the web2 backend and use aggregated data inside the service. There are [several](https://www.coingecko.com/en/api/ton) [historical](https://dyor.io/tonapi) Jetton price providers in TON.
1111

12-
- [CoinGecko](https://www.coingecko.com/en/api/ton)
13-
- [Dyor.io](https://dyor.io/tonapi)
14-
15-
You can find detailed information about API usage and technical details in the provider docs.
16-
17-
There is no established solution for real-time jetton swap market data; however, one can explore [CoinGecko websocket API](https://docs.coingecko.com/websocket).
12+
There is no established solution for real-time jetton swap market data; however, one can explore [this websocket API](https://docs.coingecko.com/websocket).
1813

1914
## On-chain API
2015

@@ -24,16 +19,19 @@ Currently, it is not possible to retrieve **historical** jetton prices on-chain
2419
Since the TON [execution model is asynchronous](/from-ethereum#execution-model), the jetton price might change between the moment of the response from the price provider and the moment the contract processes the response. Consider this factor in smart contract logic.
2520
</Callout>
2621

27-
For example, on the [DeDust](https://dedust.io) DEX, it is possible to retrieve pool information on-chain using an internal message with the following [TL-B](/foundations/tlb/overview) schema:
22+
For example, on a [popular DEX](https://dedust.io), it is possible to retrieve pool information on-chain using an internal message with the following [TL-B](/foundations/tlb/overview) schema:
2823

2924
```tlb
3025
provide_pool_state#6e24728d query_id:uint64 include_assets:Bool = InMsgBody;
3126
3227
take_pool_state#bddd4954 query_id:uint64 reserve0:Coins reserve1:Coins total_supply:Coins
3328
assets:(Maybe ^[ asset0:Asset asset1:Asset ]) = InMsgBody;
29+
30+
# See:
31+
# https://hub.dedust.io/contracts/v2/reference/core/pool#operation-provide_pool_stat
3432
```
3533

36-
Here is a smart contract snippet in [Tolk](/tolk/overview) illustrating how you can send the 'provide' message:
34+
Here is a smart contract snippet in [Tolk](/tolk/overview) illustrating how one can send the `provide_pool_state` message:
3735

3836
```tolk title="Tolk"
3937
struct (0x6e24728d) ProvideDeDustPool {

content/applications/appkit/get-started/providers.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ export const appKit = new AppKit({
2828
});
2929
```
3030

31-
Omniston requires its own SDK package — install it before registering the provider:
31+
Some providers require their own SDK package — install it before registering the provider:
3232

3333
```bash
3434
npm i @ston-fi/omniston-sdk
3535
```
3636

3737
## Add a staking provider
3838

39-
Use `createTonstakersProvider({})` from `@ton/appkit/staking/tonstakers` the same way:
39+
Use the provider from `@ton/appkit/staking/tonstakers` the same way:
4040

4141
```ts
4242
import { AppKit } from '@ton/appkit';

content/applications/appkit/howto/providers.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,21 @@ A provider is not a wallet and not a connector. The wallet still signs every tra
2020

2121
## Swaps
2222

23-
A swap provider integrates a DEX or aggregator. It returns a **quote** for a route (input asset, output asset, amount, fees, and execution assumptions), then builds a `TransactionRequest` when the user accepts the quote. AppKit does not price markets itself; `SwapManager` coordinates the registered providers. Bundled options include Omniston and DeDust. See [Perform swaps](/applications/appkit/howto/swaps) for the full quote-then-build flow.
23+
A swap provider integrates a DEX or aggregator. It returns a **quote** for a route (input asset, output asset, amount, fees, and execution assumptions), then builds a `TransactionRequest` when the user accepts the quote. AppKit does not price markets itself; `SwapManager` coordinates the registered providers. Bundled options include popular DEX platforms. See [Perform swaps](/applications/appkit/howto/swaps) for the full quote-then-build flow.
2424

2525
## Staking
2626

2727
A staking provider quotes a stake or unstake intent for a specific pool or protocol, then builds the matching `TransactionRequest`.
2828

2929
Liquid-staking positions may appear in the wallet as derivative balances, such as tsTON. AppKit exposes pool metadata and APY as provider-supplied **display data**, not a guarantee of future yield or redemption timing.
3030

31-
Unstake mechanics — instant, delayed, or round-end — are provider-specific. The bundled staking provider is Tonstakers. See [Stake and unstake](/applications/appkit/howto/staking) for the full flow.
31+
Unstake mechanics — instant, delayed, or round-end — are provider-specific. See [Stake and unstake](/applications/appkit/howto/staking) for the full flow.
3232

3333
## How they are registered
3434

3535
Provider setup uses three registration paths. **API clients** are bound to a network through the `networks` field of `AppKitConfig`. **Streaming providers** are also network-specific and are registered directly on `appKit.streamingManager`. **Swap** and **staking** providers are network-aware DeFi providers: pass them in `providers` at construction or register them later with `registerProvider`. Each DeFi provider declares its `type` so AppKit can route it to the correct manager.
3636

37-
Omniston requires its own SDK package — install it before registering the provider:
37+
Some providers require their own SDK package — install it before registering the provider:
3838

3939
```bash
4040
npm i @ston-fi/omniston-sdk
@@ -60,7 +60,7 @@ const appKit = new AppKit({
6060
registerProvider(appKit, createTonstakersProvider());
6161
```
6262

63-
When a network entry does not provide a custom API client, AppKit creates a TON Center client for that network. TON Center streaming provider is available through WalletKit and can be registered on `appKit.streamingManager`. Omniston and DeDust are available as swap providers, and Tonstakers is available as a staking provider. Custom DeFi backends can use the same `registerProvider` path by implementing the swap or staking interface.
63+
When a network entry does not provide a custom API client, AppKit creates a TON Center client for that network. TON Center streaming provider is available through WalletKit and can be registered on `appKit.streamingManager`. Custom DeFi backends can use the same `registerProvider` path by implementing the swap or staking interface.
6464

6565
`registerProvider` returns `void`. To replace a provider, call `registerProvider` again with the same `providerId` — the registry entry is overwritten. If the previous provider owns resources you need to clean up, hold the reference and dispose of it yourself before re-registering.
6666

content/applications/appkit/howto/staking.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ Quote a stake or unstake, build the transaction, and send it through the connect
99

1010
The `StakingManager` routes each quote call and each build call to a single registered staking provider — by default the first one you registered, or the one you pass as `providerId`. `setDefaultProvider` on the manager overrides the default; an unknown `providerId` throws. A quote describes the intent (`direction: 'stake' | 'unstake'`, `amount`, optional `unstakeMode`), and `useBuildStakeTransaction` turns an accepted quote into a `TransactionRequest`.
1111

12-
The protocol shape — derivative jetton, unstake modes, settlement timing, pool model — is provider-specific. Tonstakers, the bundled provider, issues `tsTON` and supports `INSTANT`, `WHEN_AVAILABLE`, and `ROUND_END` unstake modes. Read the user's staked-token balance with `useStakedBalance`, or query the jetton balance directly. `apy` and `instantUnstakeAvailable` from `useStakingProviderInfo` are provider-supplied display data, not guarantees of future yield or withdrawal timing.
12+
The protocol shape — derivative jetton, unstake modes, settlement timing, pool model — is provider-specific. The bundled provider issues `tsTON` and supports `INSTANT`, `WHEN_AVAILABLE`, and `ROUND_END` unstake modes. Read the user's staked-token balance with `useStakedBalance`, or query the jetton balance directly. `apy` and `instantUnstakeAvailable` from `useStakingProviderInfo` are provider-supplied display data, not guarantees of future yield or withdrawal timing.
1313

1414
## Before you begin
1515

16-
You need a connected wallet and a staking provider registered on the AppKit instance. Tonstakers ships bundled — see [Use providers → How they are registered](/applications/appkit/howto/providers#how-they-are-registered).
16+
You need a connected wallet and a staking provider registered on the AppKit instance. Some popular staking providers are bundled — see [Use providers → How they are registered](/applications/appkit/howto/providers#how-they-are-registered).
1717

1818
## Hooks
1919

content/applications/appkit/howto/swaps.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The quote is provider-supplied data and can expire. Refresh it close to the mome
1313

1414
## Before you begin
1515

16-
You need a connected wallet and at least one swap provider registered on the AppKit instance. Omniston and DeDust ship bundled — see [Use providers → How they are registered](/applications/appkit/howto/providers#how-they-are-registered).
16+
You need a connected wallet and at least one swap provider registered on the AppKit instance. Some popular swap providers are bundled — see [Use providers → How they are registered](/applications/appkit/howto/providers#how-they-are-registered).
1717

1818
## Hooks
1919

content/applications/appkit/howto/use-ui-widgets.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ The required prop is `tokens`. `defaultFromSymbol`, `defaultToSymbol`, `defaultS
180180

181181
## Staking widget
182182

183-
`<StakingWidget />` is the complete staking UI: stake/unstake tabs, amount input, balance readout, current APY, exchange rate, and provider. The widget reads the registered staking provider (Tonstakers ships bundled — see [Use providers → How they are registered](/applications/appkit/howto/providers#how-they-are-registered)) and handles quote, build, and the wallet call internally.
183+
`<StakingWidget />` is the complete staking UI: stake/unstake tabs, amount input, balance readout, current APY, exchange rate, and provider. The widget reads the [registered staking provider](/applications/appkit/howto/providers#how-they-are-registered) and handles quote, build, and the wallet call internally.
184184

185185
```tsx
186186
import { StakingWidget } from '@ton/appkit-react';

content/applications/appkit/overview.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ AppKit builds on top of the following components:
6060
| `@ton/appkit/queries` | Query and mutation helpers for data fetching |
6161
| `@ton/appkit-react` | React provider, hooks, components, and core re-exports |
6262
| `@ton/appkit-react/styles.css` | Default component styles |
63-
| `@ton/appkit/swap/omniston` | Omniston swap provider |
64-
| `@ton/appkit/swap/dedust` | DeDust swap provider |
65-
| `@ton/appkit/staking/tonstakers` | Tonstakers staking provider |
63+
| `@ton/appkit/swap/omniston` | Swap provider |
64+
| `@ton/appkit/swap/dedust` | Swap provider |
65+
| `@ton/appkit/staking/tonstakers` | Staking provider |
6666

6767
## Examples
6868

content/applications/appkit/reference/appkit-react.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1167,7 +1167,7 @@ Drop-in widget for buying TON-side tokens with a crypto payment from another cha
11671167

11681168
```tsx
11691169
// Uses built-in defaults for tokens, payment methods and chain display info.
1170-
// Make sure a crypto-onramp provider (Layerswap / swaps.xyz) is registered on AppKit.
1170+
// Make sure a crypto-onramp provider is registered in AppKit.
11711171
return <CryptoOnrampWidget defaultTokenId="gram" />;
11721172
```
11731173

@@ -1758,7 +1758,7 @@ Drop-in swap UI that walks the user through picking the source/target tokens, en
17581758
**Example**
17591759

17601760
```tsx
1761-
// Make sure a swap provider (e.g. DeDust / Omniston) is registered on AppKit.
1761+
// Make sure a swap provider is registered in AppKit.
17621762
return <SwapWidget tokens={tokens} defaultFromSymbol="GRAM" defaultToSymbol="USDT" defaultSlippage={100} />;
17631763
```
17641764

0 commit comments

Comments
 (0)