@gasfree-kit/ton-gasless 0.2.0 → 0.3.1

package/README.md

@@ -6,7 +6,7 @@ With this package, the user only needs USDT. The relay pays the TON gas and char
 
 ## What This Package Does
 
-- creates a WDK-backed TON wallet
+- creates a TON wallet from a seed phrase
 - quotes the relay fee in USDT
 - checks that balance covers transfer amount plus fee
 - submits the gasless transfer
@@ -26,7 +26,7 @@ With this package, the user only needs USDT. The relay pays the TON gas and char
         │             │
         v             v
  ┌────────────┐ ┌───────────────┐
- │  WDK TON   │ │  Relay fee    │
+ │  TON       │ │  Relay fee    │
  │  wallet    │ │  quote (USDT) │
  └──────┬─────┘ └───────┬───────┘
         │               │
@@ -46,29 +46,24 @@ With this package, the user only needs USDT. The relay pays the TON gas and char
  └──────────────────────────┘
 ```
 
-```mermaid
-flowchart TD
-  A["Your app"] --> B["@gasfree-kit/ton-gasless"]
-  B --> C["WDK TON wallet"]
-  B --> D["Relay fee quote"]
-  C --> E["Sponsored relay"]
-  D --> E
-  E -->|pays TON gas| F["TON blockchain"]
-  E -->|deducts fee| G["USDT commission"]
-```
+## Prerequisites
 
-## Installation
+This package depends on [`@gasfree-kit/core`](../core/README.md) for:
 
-```bash
-npm install @gasfree-kit/ton-gasless
-```
+- **Seed phrase generation** — `generateSeedPhrase()` creates the mnemonic used to set up wallets
+- **Address validation** — `validateTonAddress()` catches malformed addresses before sending
+- **Error classes** — `GasfreeError`, `InsufficientBalanceError`, etc. for consistent error handling
 
-Peer dependencies:
+`@gasfree-kit/core` is installed automatically as a dependency.
+
+## Installation
 
 ```bash
-npm install @tetherto/wdk-wallet-ton-gasless tonweb
+npm install @gasfree-kit/ton-gasless @gasfree-kit/core
 ```
 
+After installing, your package manager will prompt you to install the peer dependencies listed in `package.json`.
+
 ## Configuration
 
 ```ts
@@ -170,15 +165,15 @@ console.log(result.data.fee);
 
 ## Main Exports
 
-| Export                   | What it does                                               |
-| ------------------------ | ---------------------------------------------------------- |
-| `setupTonGaslessWallet`  | Creates the WDK-backed TON wallet and resolves the address |
-| `TonTransfer`            | Checks balances, estimates fees, and sends transfers       |
-| `getTonGaslessConfig`    | Expands and validates the runtime config                   |
-| `tonUsdtTokenRoot`       | Built-in TON USDT root address                             |
-| `usdtTonBaseUnits`       | Converts human-readable USDT to base units                 |
-| `fromTonBaseUnitsToUsdt` | Converts base units back to readable USDT                  |
-| `getTonUsdtValue`        | Utility helper for TON to USDT conversions                 |
+| Export                   | What it does                                                       |
+| ------------------------ | ------------------------------------------------------------------ |
+| `setupTonGaslessWallet`  | Creates the TON wallet from a seed phrase and resolves the address |
+| `TonTransfer`            | Checks balances, estimates fees, and sends transfers               |
+| `getTonGaslessConfig`    | Expands and validates the runtime config                           |
+| `tonUsdtTokenRoot`       | Built-in TON USDT root address                                     |
+| `usdtTonBaseUnits`       | Converts human-readable USDT to base units                         |
+| `fromTonBaseUnitsToUsdt` | Converts base units back to readable USDT                          |
+| `getTonUsdtValue`        | Utility helper for TON to USDT conversions                         |
 
 ## Safety Notes
 

package/dist/index.d.mts

@@ -26,10 +26,10 @@ type TonGaslessClientConfig = {
 declare function getTonGaslessConfig(config: TonGaslessClientConfig): TonGaslessNetworkConfig;
 
 /**
- * Set up a TON gasless wallet via WDK.
+ * Set up a TON gasless wallet.
  *
- * Uses legacy derivation path (m/44'/607'/0'/0/{index}) for compatibility
- * with wallets created by wdk-wallet-ton <= beta.5.
+ * Pins the BIP-44 derivation path at m/44'/607'/0'/0/{index} so the
+ * resulting address stays stable across underlying-library upgrades.
  */
 declare function setupTonGaslessWallet(seedPhrase: string, config: TonGaslessClientConfig, derivationPath?: string): Promise<{
     wallet: _tetherto_wdk_wallet_ton_gasless.default;

package/dist/index.d.ts

@@ -26,10 +26,10 @@ type TonGaslessClientConfig = {
 declare function getTonGaslessConfig(config: TonGaslessClientConfig): TonGaslessNetworkConfig;
 
 /**
- * Set up a TON gasless wallet via WDK.
+ * Set up a TON gasless wallet.
  *
- * Uses legacy derivation path (m/44'/607'/0'/0/{index}) for compatibility
- * with wallets created by wdk-wallet-ton <= beta.5.
+ * Pins the BIP-44 derivation path at m/44'/607'/0'/0/{index} so the
+ * resulting address stays stable across underlying-library upgrades.
  */
 declare function setupTonGaslessWallet(seedPhrase: string, config: TonGaslessClientConfig, derivationPath?: string): Promise<{
     wallet: _tetherto_wdk_wallet_ton_gasless.default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gasfree-kit/ton-gasless",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "Gasless USDT transfers on TON via sponsored relay",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -17,12 +17,25 @@
     "README.md"
   ],
   "dependencies": {
-    "@gasfree-kit/core": "0.2.0"
+    "@gasfree-kit/core": "0.2.1"
   },
   "peerDependencies": {
     "@tetherto/wdk-wallet-ton-gasless": "^1.0.0-beta.4",
     "tonweb": "^0.0.66"
   },
+  "keywords": [
+    "gasless",
+    "gas-free",
+    "ton",
+    "toncoin",
+    "usdt",
+    "transfer",
+    "sponsored",
+    "relay",
+    "web3",
+    "sdk",
+    "meta-transactions"
+  ],
   "license": "MIT",
   "publishConfig": {
     "access": "public"