@anywalletkit/wallet-ton 0.0.0-stage → 0.2.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,127 @@
-# Temporary Holding Version
+# @anywalletkit/wallet-ton
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+TON accounts at `m/44'/607'/i'` (SLIP-10 ed25519) on Wallet V5R1 — the
+derivation Trust Wallet and Ledger use for a BIP-39 phrase, pinned by
+golden vectors in `@anywalletkit/conformance`. Runtime dependencies: `@ton/core`,
+`@ton/crypto`, `buffer` (no `@ton/ton`: the V5R1 contract and the toncenter
+client are implemented here, byte-for-byte checked against `@ton/ton` in tests).
+
+```ts
+import WalletManagerTon from '@anywalletkit/wallet-ton'
+
+const wallet = new WalletManagerTon(seedPhrase, {
+  tonClient: [{ url: 'https://toncenter.com/api/v2/jsonRPC', secretKey }],   // fails over in order
+  // emulate: {kind: 'tonapi'} is the default (tonapi.io/v2/wallet/emulate, then /traces/emulate);
+  // {kind: 'toncenter-v3', url} switches the emulator, false = estimateFee only.
+  tonApiKey,                                                                  // optional: Bearer key for tonapi
+})
+const account = await wallet.getAccount(0)
+
+account.describe({ to: 'UQ…', value: 100_000_000n, body: 'thanks' })         // offline: kind, items, warnings
+await account.simulateTransaction({ to: 'UQ…', value: 100_000_000n })         // fees + emulation verdict + risk (what leaves the wallet)
+await account.transfer({ recipient: 'UQ…', amount: 100_000_000n })            // 0.1 TON
+await account.transfer({ token: USDT_MASTER, recipient: 'UQ…', amount: 1_000_000n, forwardPayload: 'hi' })
+await account.sendTransaction([                                               // several messages, ONE external
+  { to: 'EQ…', value: 50_000_000n, bodyBoc, stateInit },                      // e.g. an Omniston escrow deploy
+  { to: 'UQ…', value: 1n },
+])
+const receipt = await account.getTransactionReceipt(hash)                     // hash = body hash, via toncenter v3
+wallet.dispose()
+
+// Tonkeeper-style 24-word TON mnemonic (not BIP-39): one account, same surface.
+const tk = await WalletManagerTon.fromTonMnemonic(words, { tonClient })
+```
+
+## Every send
+
+1. Hard checks, before any network call: value > 0, workchain 0/-1 only,
+   friendly-address network flag matches `config.network`, `valid_until` =
+   now + `validUntilSeconds` (default 60, max 600).
+2. Fresh seqno (never cached across sends).
+3. Preflight on the zero-signed body: toncenter `estimateFee` (the fee cap)
+   and a trace emulation — tonapi by default (`POST /v2/wallet/emulate`,
+   falling back to `/v2/traces/emulate`), or a toncenter-v3 `emulateTrace`
+   endpoint via `emulate: {kind: 'toncenter-v3', url}`. A non-zero compute exit,
+   an aborted transaction, a failed action phase or a failed **first-hop**
+   internal message (the operation would bounce) throws `SimulationError`
+   **before signing**; failures deeper in the trace are `warnings`. tonapi's
+   `risk` is returned as `risk` and a body that would carry the whole balance
+   (send mode 128) is refused with `UnsafeTransactionError('drain')` unless
+   `allowDrainingTransactions`. `emulate: false` keeps only `estimateFee`;
+   `simulate: false` skips the preflight entirely.
+4. noble ed25519 over the body hash; the 32-byte seed is the only key material
+   and `dispose()` zeroizes it.
+5. `sendBoc` of the external (with StateInit when the wallet is not deployed).
+
+## Signers
+
+The account never holds a key. Every signature is a `signer.sign(bytes, {scheme: 'ed25519', context})`
+call: `ton-external` over the hash of the V5R1 signing cell (after the preflight, which runs on a
+zero-signed body), `ton-message` over raw message bytes (`sign()`, ton_proof). Seed wallets get a
+`LocalSigner`; a hardware wallet, MPC node or backend is wrapped with `externalSigner()` from
+`@anywalletkit/core`:
+
+```ts
+const signer = externalSigner({ curve: 'ed25519', publicKey, sign: (payload, { context }) => device.sign(payload) })
+const manager = new WalletManagerTon(signer, { tonClient })
+const account = await manager.getAccount() // path 'external'; other indexes throw
+```
+
+A derivable `SeedSigner` at `m/44'/607'` yields `getAccount(i)` children; a leaf signer (including
+`fromTonMnemonic`) is one account. `WalletAccountTon.fromPrivateKey(priv, pub, path)` keeps the
+raw-key shape for callers that derive themselves.
+
+## Describe
+
+`describeTransaction(tx)` / `account.describe(tx)` decode TON transfers (text
+comments), jetton transfers (`0x0f8a7ea5`: amount, destination, forward
+amount/payload, custom payload) and contract calls, also from a prebuilt V5R1
+body, with warnings: `zero-value`, `non-bounceable-contract-call`,
+`unknown-body`, `large-forward-amount`, `testnet-address` / `mainnet-address`,
+`exotic-workchain`.
+
+## Buffer
+
+On import the package installs the `buffer` polyfill as `globalThis.Buffer` if
+none exists (`@ton/core` requires the global). Node, and apps that already set
+it, are untouched.
+
+## React Native
+
+`@ton/crypto-primitives` resolves its `react-native` build on Metro, which
+requires `expo-crypto` (random bytes) at module load and
+`react-native-fast-pbkdf2` for the TON-mnemonic import. Install `expo-crypto`
+in the app (Expo projects already have it). BIP-39 wallets sign through noble
+ed25519 and need neither.
+
+## Activity history
+
+`createTonHistory` is the chain's `HistorySource` (`@anywalletkit/core`): tonapi account events first, toncenter v3 as a reduced fallback.
+
+```ts
+import { createTonHistory } from '@anywalletkit/wallet-ton/history'
+
+const history = createTonHistory({ apiKey: process.env.TONAPI_KEY })
+const page = await history.listActivity('UQCbXJ1-Hd_CyyAt3TNgircduNIn5QH5dj1_LBNz__y4fQaq', { limit: 25 })
+const older = await history.listActivity(address, { cursor: page.cursor })
+const one = await history.getTransaction(page.items[0].hash, address)
+history.explorerTxUrl(one.hash) // https://tonviewer.com/transaction/…
+```
+
+| option | default | notes |
+|---|---|---|
+| `tonapiUrl` | `https://tonapi.io` (`testnet.tonapi.io`) | `null` disables tonapi. |
+| `apiKey` | none | tonapi Bearer key. Keyless tonapi allows ~1 request/s. |
+| `toncenterUrl` | `https://toncenter.com` (`testnet.toncenter.com`) | v3 fallback; `null` disables it. |
+| `toncenterApiKey` | none | `X-API-Key`. |
+| `network` | `mainnet` | `ton:-239` / `ton:-3`. |
+| `rateLimit` | 1 rps keyless, 10 with a key | tonapi requests per second (toncenter: 1 keyless, 10 with a key). |
+| `fetch`, `timeoutMs` | global, 15 000 | |
+
+**tonapi** (`GET /v2/accounts/{a}/events?limit=&before_lt=`, `GET /v2/accounts/{a}/events/{id}`): one event = one trace, with typed actions. `TonTransfer`, `JettonTransfer`, `JettonMint`, `JettonBurn`, `JettonSwap` (TON / jetton in and out against the DEX router), `SmartContractExec` (`ton_attached`), `DepositStake` / `WithdrawStake` (staker ↔ pool), `Subscribe`, `NftPurchase`, elections become transfers; jetton transfers carry the master as `token`, `standard: 'jetton'`, `symbol` and `decimals` from the action's jetton object. The first contract-level action is the `call`: `SmartContractExec` → `to` = contract, hex op in `data`, named op in `method`; `JettonSwap` → router / `swap`; a jetton sent to a contract with a forward payload → recipient / `jetton_transfer` with the op from tonapi's `Call: 0x…` comment; `DepositStake` → pool / `stake`, `WithdrawStakeRequest` → pool / `unstake`, `WithdrawStake` → pool / `withdraw_stake`. tonapi does not spell out the pool-token burn of an unstake request, so for those events the source fetches `/v2/events/{id}` once and turns the account's `value_flow` jetton deltas into transfers (`raw.valueFlow`). `from` is the first action's initiator, `nativeValue` the TON it sent, `fee` = `-extra` (tonapi's "what the account lost beyond its actions", so it includes forward fees the actions do not show), `status` = `pending` while `in_progress`, `failed` when every action failed, `block` = the event's `lt`, `hash` = the event id (the trace root; tonapi resolves any transaction hash of the trace to it). `is_scam` events are flagged `scam: true` (also in `raw.scam`). Addresses stay raw (`0:…`, lowercase) as tonapi returns them.
+
+**toncenter v3** (`GET /api/v3/transactions?account=&limit=&sort=desc&end_lt=`): the account's own transactions only. An external message (the wallet acted) maps its outgoing messages to TON transfers and the first op code to `call` (`data` = `opcode`, `method` = `decoded_opcode`); an incoming message maps its value and op. Jettons are not visible here, `fee` = `total_fees`, `hash` = the transaction hash in hex.
+
+**Cursor.** Base64 JSON `{ v: 1, b: 'tonapi' | 'toncenter', lt }`: an exclusive `lt` upper bound (`before_lt` for tonapi, `end_lt = lt − 1` for toncenter). A cursor from one backend resumes on the other; the backend that issued it is tried first. `since` is applied client-side and ends pagination.
+
+Fixtures in `test/fixtures/history/` were captured on 2026-10-14 from `tonapi.io` and `toncenter.com` (keyless) for the test wallet: one events page, the account-scoped events of the Tonstakers stake / unstake request / payout and of the Omniston STON.fi swap and escrow order (the same transactions as those modules' activity fixtures), the full event with `value_flow` for the unstake, and a toncenter v3 page. `test/history.test.ts` checks that the Tonstakers and Omniston modules describe the rows this source builds (`stake`, `unstake`, `claim`, `swap`, `bridge`). Note: `@anywalletkit/protocol-swap2-core`'s `netTransfers` compares addresses verbatim, so `DescribeActivityContext.own` must contain the raw `0:…` form of the wallet for Omniston (Tonstakers normalizes itself).