@stableops/wallet-sdk 0.1.0

package/LICENSE

@@ -0,0 +1,184 @@
+Apache License
+Version 2.0, January 2004
+https://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
+
+    https://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

@@ -0,0 +1,148 @@
+# StableOps Wallet SDK
+
+Official TypeScript wallet helper for StableOps checkout flows.
+
+[中文文档](./README.zh-CN.md)
+
+StableOps Wallet SDK helps browser applications send on-chain stablecoin
+payments from mainstream self-custody wallets to the chain-specific payment
+instructions returned by StableOps. StableOps still owns payment order
+creation, idempotency, address allocation, chain scanning, confirmation
+tracking, and webhook delivery. The wallet helper is responsible only for
+selecting a payable instruction and asking the user's wallet to sign and
+broadcast the transfer.
+
+This SDK is intended for browser applications that already receive a payment
+order from a trusted backend and need to complete the on-chain payment step.
+
+## Documentation
+
+For complete guides, API references, wallet integration examples, and payment
+flow details, see the official documentation:
+
+- English docs: https://stableops.dev/en/docs
+- Chinese docs: https://stableops.dev/zh/docs
+
+## Features
+
+- Browser-first helper for StableOps payment instructions.
+- EVM wallet support via EIP-1193 providers.
+- TRON wallet support via TronLink / TronWeb providers.
+- Solana wallet support via wallet adapters.
+- Automatic candidate selection from available injected wallets.
+- Chain-specific token transfer helpers for ERC-20, TRC-20, and SPL tokens.
+- Self-contained public types with no StableOps workspace dependencies.
+- Dual CJS and ESM builds with generated TypeScript declarations.
+
+## Requirements
+
+- A browser environment.
+- A payment order created by your backend.
+- An injected or supplied wallet provider.
+
+Do not expose `STABLEOPS_API_KEY` in the browser. Create payment orders on your
+server and send only the order id, amount, and `paymentInstructions` to the
+frontend.
+
+## Installation
+
+```bash
+pnpm add @stableops/wallet-sdk
+```
+
+```bash
+npm install @stableops/wallet-sdk
+```
+
+```bash
+yarn add @stableops/wallet-sdk
+```
+
+## Quick Start
+
+Use the order returned by your backend and let the SDK choose a compatible
+wallet provider from the browser.
+
+```ts
+import {
+  getInjectedWalletProviders,
+  sendOrderWalletPayment,
+} from '@stableops/wallet-sdk'
+
+const sent = await sendOrderWalletPayment({
+  order,
+  providers: getInjectedWalletProviders(),
+})
+
+console.log(sent.txHash)
+```
+
+This is the highest-level path. It selects a payable instruction from the
+order's candidate list and sends the on-chain transfer through the first
+matching provider.
+
+## Manual Selection
+
+If you want to control which chain the user pays on, select the instruction and
+provider yourself, then call the lower-level sender.
+
+```ts
+import {
+  getInjectedWalletProviders,
+  selectWalletPaymentInstruction,
+  sendWalletPayment,
+} from '@stableops/wallet-sdk'
+
+const { instruction, provider } = selectWalletPaymentInstruction(
+  order.paymentInstructions,
+  getInjectedWalletProviders(),
+)
+
+const sent = await sendWalletPayment({
+  provider,
+  amount: order.amount,
+  instruction,
+})
+
+console.log(sent)
+```
+
+## Supported Wallet Flows
+
+The SDK currently supports:
+
+- EVM networks through EIP-1193 wallets such as MetaMask and compatible providers.
+- TRON through TronLink / TronWeb providers.
+- Solana through wallet adapters that support `signAndSendTransaction` or `signTransaction`.
+
+The transfer flow is chain-aware:
+
+- EVM: switches or adds the network when needed, then sends an ERC-20 `transfer`.
+- TRON: builds, signs, and broadcasts a TRC-20 `transfer`.
+- Solana: creates the associated token account idempotently and sends an SPL Token `TransferChecked`.
+
+## Supported Chains and Assets
+
+This SDK supports:
+
+- Chains: Ethereum, Base, Arbitrum, Polygon, TRON, Solana, and supported testnets.
+- Assets: USDC and USDT.
+
+See the official docs for the latest supported chains, assets, and environment
+guidance:
+
+- https://stableops.dev/en/docs
+- https://stableops.dev/zh/docs
+
+## Common Usage Notes
+
+- Create the payment order on your backend with `@stableops/api-sdk`.
+- Pass only `amount` and `paymentInstructions` to the browser.
+- Use the browser wallet to send the transfer to the order-specific address.
+- Let StableOps confirm the transfer and dispatch webhook updates back to your server.
+
+For a full end-to-end flow, see the official quickstart and wallet SDK docs.
+
+## License
+
+This SDK is licensed under `Apache-2.0`. See [LICENSE](./LICENSE).

package/README.zh-CN.md

@@ -0,0 +1,133 @@
+# StableOps Wallet SDK
+
+StableOps 官方浏览器钱包支付辅助 SDK。
+
+[View English README](./README.md)
+
+StableOps Wallet SDK 用于浏览器侧从主流自托管钱包发起链上稳定币支付，并把资金转到 StableOps 返回的链上 `paymentInstructions`。StableOps 仍然负责 Payment Order 创建、幂等、地址分配、链上扫描、确认数推进和 Webhook 投递；这个钱包 SDK 只负责选择可支付的指令，并请求用户的钱包签名和广播转账。
+
+这个 SDK 适合已经从可信后端拿到支付订单，并且需要在前端完成链上付款步骤的浏览器应用。
+
+## 官方文档
+
+完整接入指南、API Reference、钱包集成示例和支付流程说明，请查看官方文档：
+
+- 中文文档：https://stableops.dev/zh/docs
+- English docs：https://stableops.dev/en/docs
+
+## 功能
+
+- 面向浏览器的 StableOps 支付指令发送助手。
+- 通过 EIP-1193 provider 支持 EVM 钱包。
+- 通过 TronLink / TronWeb provider 支持 TRON 钱包。
+- 通过 wallet adapter 支持 Solana 钱包。
+- 可从浏览器当前可用的钱包中自动选择候选支付指令。
+- 内置 ERC-20、TRC-20、SPL Token 的链上转账辅助逻辑。
+- Public types 已内联，不依赖 StableOps 内部 workspace 包。
+- 同时输出 CJS、ESM 和 TypeScript 类型声明。
+
+## 环境要求
+
+- 浏览器运行环境。
+- 由后端创建好的 Payment Order。
+- 浏览器注入的钱包 provider，或你主动传入的钱包 provider。
+
+不要把 `STABLEOPS_API_KEY` 暴露到浏览器。Payment Order 必须在服务端创建，前端只接收订单 id、金额和 `paymentInstructions`。
+
+## 安装
+
+```bash
+pnpm add @stableops/wallet-sdk
+```
+
+```bash
+npm install @stableops/wallet-sdk
+```
+
+```bash
+yarn add @stableops/wallet-sdk
+```
+
+## 快速开始
+
+使用后端返回的订单，并让 SDK 从浏览器里自动选择兼容的钱包 provider：
+
+```ts
+import {
+  getInjectedWalletProviders,
+  sendOrderWalletPayment,
+} from '@stableops/wallet-sdk'
+
+const sent = await sendOrderWalletPayment({
+  order,
+  providers: getInjectedWalletProviders(),
+})
+
+console.log(sent.txHash)
+```
+
+这是最高层的调用方式。它会从订单候选链列表里选择一条当前浏览器可支付的指令，并通过匹配的钱包发起链上转账。
+
+## 手动选择支付链
+
+如果你希望自己控制用户用哪条链支付，可以先选择指令和 provider，再调用底层发送方法：
+
+```ts
+import {
+  getInjectedWalletProviders,
+  selectWalletPaymentInstruction,
+  sendWalletPayment,
+} from '@stableops/wallet-sdk'
+
+const { instruction, provider } = selectWalletPaymentInstruction(
+  order.paymentInstructions,
+  getInjectedWalletProviders(),
+)
+
+const sent = await sendWalletPayment({
+  provider,
+  amount: order.amount,
+  instruction,
+})
+
+console.log(sent)
+```
+
+## 支持的钱包流程
+
+当前支持：
+
+- EVM 网络：通过 EIP-1193 钱包，例如 MetaMask 及兼容 provider。
+- TRON：通过 TronLink / TronWeb provider。
+- Solana：通过支持 `signAndSendTransaction` 或 `signTransaction` 的 wallet adapter。
+
+不同链的发送逻辑如下：
+
+- EVM：必要时自动切链或加链，然后发送 ERC-20 `transfer`。
+- TRON：构造、签名并广播 TRC-20 `transfer`。
+- Solana：幂等创建 Associated Token Account，并发送 SPL Token `TransferChecked`。
+
+## 支持的链和资产
+
+当前 SDK 支持：
+
+- 链：Ethereum、Base、Arbitrum、Polygon、TRON、Solana 以及支持的测试网。
+- 资产：USDC 和 USDT。
+
+最新支持范围和环境配置请参考官方文档：
+
+- https://stableops.dev/zh/docs
+- https://stableops.dev/en/docs
+
+## 常见使用方式
+
+- 后端使用 `@stableops/api-sdk` 创建 Payment Order。
+- 前端只接收 `amount` 和 `paymentInstructions`。
+- 前端使用浏览器钱包把资金打到订单专属收款地址。
+- StableOps 负责后续链上确认和 Webhook 回调到你的服务端。
+
+完整的端到端流程请参考官方 Quickstart 和 Wallet SDK 文档。
+
+## License
+
+本 SDK 使用 `Apache-2.0` 许可证。详见 [LICENSE](./LICENSE)。

package/dist/index.d.mts

@@ -0,0 +1,131 @@
+import { Transaction, Connection } from '@solana/web3.js';
+
+type ChainId = 'ethereum' | 'base' | 'base-sepolia' | 'arbitrum' | 'polygon' | 'tron' | 'solana' | 'ethereum-sepolia' | 'arbitrum-sepolia' | 'polygon-amoy' | 'solana-devnet' | 'tron-nile';
+type Asset = 'USDC' | 'USDT';
+type EvmWalletChainId = Exclude<ChainId, 'tron' | 'solana' | 'tron-nile' | 'solana-devnet'>;
+type Eip1193Provider = {
+    request<T = unknown>(args: {
+        method: string;
+        params?: unknown[] | Record<string, unknown>;
+    }): Promise<T>;
+};
+type TronWalletProvider = TronWebLike | {
+    tronWeb?: TronWebLike;
+    tronLink?: {
+        request: <T = unknown>(args: {
+            method: string;
+            params?: unknown;
+        }) => Promise<T>;
+    };
+    request?<T = unknown>(args: {
+        method: string;
+        params?: unknown;
+    }): Promise<T>;
+};
+type SolanaWalletProvider = {
+    publicKey?: SolanaPublicKeyLike | string | null;
+    connect?(): Promise<{
+        publicKey?: SolanaPublicKeyLike | string | null;
+    } | void>;
+    signAndSendTransaction?(transaction: Transaction): Promise<string | {
+        signature?: string;
+    }>;
+    signTransaction?(transaction: Transaction): Promise<Transaction>;
+};
+type WalletProvider = Eip1193Provider | TronWalletProvider | SolanaWalletProvider;
+type TronWebLike = {
+    defaultAddress?: {
+        base58?: string;
+    };
+    transactionBuilder: {
+        triggerSmartContract(contractAddress: string, functionSelector: string, options: Record<string, unknown>, parameters: Array<{
+            type: string;
+            value: string | bigint;
+        }>, issuerAddress?: string): Promise<{
+            transaction?: unknown;
+            result?: {
+                result?: boolean;
+                message?: string;
+            };
+        }>;
+    };
+    trx: {
+        sign(transaction: unknown): Promise<unknown>;
+        sendRawTransaction(transaction: unknown): Promise<{
+            txid?: string;
+            transaction?: {
+                txID?: string;
+            };
+            result?: boolean;
+        }>;
+    };
+};
+type SolanaPublicKeyLike = {
+    toBase58(): string;
+};
+type WalletPaymentInstruction = {
+    chain: ChainId;
+    asset: Asset;
+    address: string;
+};
+type WalletPaymentOrder = {
+    amount: string;
+    paymentInstructions: WalletPaymentInstruction[];
+};
+type EvmWalletChainConfig = {
+    chainId: EvmWalletChainId;
+    eip155ChainId: number;
+    chainName: string;
+    nativeCurrency: {
+        name: string;
+        symbol: string;
+        decimals: number;
+    };
+    rpcUrls: string[];
+    blockExplorerUrls?: string[];
+};
+type SendWalletPaymentInput = {
+    provider: WalletProvider;
+    instruction: WalletPaymentInstruction | null;
+    amount: string;
+    fromAddress?: string;
+    chainConfigs?: Partial<Record<EvmWalletChainId, EvmWalletChainConfig>>;
+    solanaRpcUrl?: string;
+    solanaConnection?: Pick<Connection, 'getLatestBlockhash' | 'sendRawTransaction'>;
+};
+type WalletProviderByChain = Partial<Record<ChainId, WalletProvider | undefined>>;
+type SendOrderWalletPaymentInput = Omit<SendWalletPaymentInput, 'provider' | 'instruction' | 'amount'> & {
+    order: WalletPaymentOrder;
+    providers: WalletProviderByChain;
+    preferredChains?: ChainId[];
+};
+type SentWalletPayment = {
+    txHash: string;
+    chain: ChainId;
+    asset: Asset;
+    fromAddress: string;
+    toAddress: string;
+    tokenContract: string;
+    amount: string;
+    amountUnits: string;
+};
+declare class StableOpsWalletError extends Error {
+    readonly code: string;
+    readonly details?: unknown | undefined;
+    constructor(message: string, code: string, details?: unknown | undefined);
+}
+declare const EvmWalletChainConfigs: Readonly<Record<EvmWalletChainId, EvmWalletChainConfig>>;
+declare function getInjectedEthereumProvider(): Eip1193Provider | undefined;
+declare function getInjectedTronProvider(): TronWalletProvider | undefined;
+declare function getInjectedSolanaProvider(): SolanaWalletProvider | undefined;
+declare function getInjectedWalletProviders(): WalletProviderByChain;
+declare function selectWalletPaymentInstruction(instructions: readonly WalletPaymentInstruction[], providers: WalletProviderByChain, preferredChains?: readonly ChainId[]): {
+    instruction: WalletPaymentInstruction;
+    provider: WalletProvider;
+};
+declare function sendOrderWalletPayment(input: SendOrderWalletPaymentInput): Promise<SentWalletPayment>;
+declare function sendWalletPayment(input: SendWalletPaymentInput): Promise<SentWalletPayment>;
+declare function encodeErc20Transfer(toAddress: string, amountUnits: bigint): string;
+declare function parseTokenAmount(amount: string, decimals: number): bigint;
+
+export { type Asset, type ChainId, type Eip1193Provider, type EvmWalletChainConfig, EvmWalletChainConfigs, type SendOrderWalletPaymentInput, type SendWalletPaymentInput, type SentWalletPayment, type SolanaWalletProvider, StableOpsWalletError, type TronWalletProvider, type WalletPaymentInstruction, type WalletPaymentOrder, type WalletProvider, type WalletProviderByChain, encodeErc20Transfer, getInjectedEthereumProvider, getInjectedSolanaProvider, getInjectedTronProvider, getInjectedWalletProviders, parseTokenAmount, selectWalletPaymentInstruction, sendOrderWalletPayment, sendWalletPayment };