tronlink-signer 0.1.0 → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 TronLink
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,165 @@
+# tronlink-signer
+
+Standalone SDK for signing TRON transactions via the TronLink browser wallet. Private keys never leave TronLink — all signing happens in the browser through a local approval page.
+
+## Installation
+
+```bash
+npm install tronlink-signer
+```
+
+## Quick Start
+
+```ts
+import { TronSigner } from "tronlink-signer";
+
+const signer = new TronSigner();
+await signer.start();
+
+const { address } = await signer.connectWallet();
+const { txId } = await signer.sendTrx("TXxx...", 1);
+const { balance } = await signer.getBalance("TXxx...");
+
+await signer.stop();
+```
+
+## API
+
+### `new TronSigner(config?: Partial<AppConfig>)`
+
+Creates a new signer instance. If no config is provided, it reads from environment variables via `loadConfig()`.
+
+### `signer.start(): Promise<void>`
+
+Starts the local HTTP server for browser approval.
+
+### `signer.stop(): Promise<void>`
+
+Stops the server and clears all pending requests.
+
+### `signer.getConfig(): AppConfig`
+
+Returns the current configuration.
+
+### `signer.connectWallet(network?: TronNetwork): Promise<{ address: string }>`
+
+Opens the browser to connect TronLink and retrieve the wallet address.
+
+### `signer.sendTrx(to, amount, network?): Promise<{ txId: string }>`
+
+Sends TRX to a recipient address. Opens a browser approval page for the user to confirm.
+
+| Parameter | Type | Description |
+| --------- | ---- | ----------- |
+| `to` | `string` | Recipient Tron address (base58) |
+| `amount` | `number` | Amount of TRX to send |
+| `network` | `TronNetwork` | Optional network override |
+
+### `signer.sendTrc20(contractAddress, to, amount, decimals?, network?): Promise<{ txId: string }>`
+
+Sends TRC20 tokens. Opens a browser approval page.
+
+| Parameter | Type | Description |
+| --------- | ---- | ----------- |
+| `contractAddress` | `string` | TRC20 token contract address |
+| `to` | `string` | Recipient Tron address (base58) |
+| `amount` | `string` | Amount in smallest unit |
+| `decimals` | `number` | Token decimals (default: 6) |
+| `network` | `TronNetwork` | Optional network override |
+
+### `signer.signMessage(message, network?): Promise<{ signature: string }>`
+
+Signs a plain text message.
+
+### `signer.signTypedData(typedData, network?): Promise<{ signature: string }>`
+
+Signs EIP-712 typed data.
+
+```ts
+const { signature } = await signer.signTypedData({
+  domain: { name: "MyDApp", version: "1", chainId: 728126428 },
+  types: {
+    Greeting: [{ name: "contents", type: "string" }],
+  },
+  primaryType: "Greeting",
+  message: { contents: "Hello Tron!" },
+});
+```
+
+### `signer.signTransaction(transaction, network?): Promise<{ signedTransaction: Record<string, unknown> }>`
+
+Signs a raw transaction without broadcasting it.
+
+### `signer.getBalance(address, network?): Promise<{ balance: string; balanceSun: number }>`
+
+Gets TRX balance for an address. No browser approval needed.
+
+## How It Works
+
+1. Your code calls a signing method (e.g., `signMessage`)
+2. A local HTTP server starts on port 3386 and the browser opens an approval page
+3. The approval page discovers the wallet via **TIP-6963** protocol (fallback to `window.tron`)
+4. Auto-unlocks wallet and switches network if needed
+5. User reviews and clicks Approve / Reject
+6. TronLink handles signing in the browser
+7. The result is returned to your code
+
+The local server binds to `127.0.0.1` only. If port 3386 is in use, it auto-increments. Requests timeout after 5 minutes.
+
+## Networks
+
+All signing methods accept an optional `network` parameter:
+
+| Network | Full Host | Explorer |
+| ------- | --------- | -------- |
+| `mainnet` (default) | `https://api.trongrid.io` | `https://tronscan.org` |
+| `nile` | `https://nile.trongrid.io` | `https://nile.tronscan.org` |
+| `shasta` | `https://api.shasta.trongrid.io` | `https://shasta.tronscan.org` |
+
+## Environment Variables
+
+| Variable | Description | Default |
+| -------- | ----------- | ------- |
+| `TRON_NETWORK` | Default network | `mainnet` |
+| `TRON_HTTP_PORT` | Local HTTP server port | `3386` |
+| `TRON_API_KEY` | TronGrid API key (optional) | - |
+
+## Types
+
+```ts
+type TronNetwork = "mainnet" | "nile" | "shasta";
+
+interface AppConfig {
+  network: TronNetwork;
+  httpPort: number;
+  apiKey?: string;
+}
+
+interface NetworkConfig {
+  name: string;
+  fullHost: string;
+  explorerUrl: string;
+}
+```
+
+## Exports
+
+```ts
+// Class
+export { TronSigner } from "./tron-signer.js";
+
+// Config
+export { NETWORKS, DEFAULT_HTTP_PORT, REQUEST_TIMEOUT_MS, loadConfig } from "./config.js";
+
+// Types
+export type {
+  TronNetwork, NetworkConfig, AppConfig,
+  PendingRequestType, PendingRequest,
+  ConnectData, SendTrxData, SendTrc20Data,
+  SignMessageData, SignTypedDataData, SignTransactionData,
+} from "./types.js";
+```
+
+## License
+
+MIT License Copyright (c) 2026 TronLink

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tronlink-signer",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "TronLink browser wallet signer SDK for TRON transactions",
   "type": "module",
   "main": "./dist/index.js",
@@ -11,21 +11,28 @@
       "types": "./dist/index.d.ts"
     }
   },
-  "scripts": {
-    "build": "tsup",
-    "typecheck": "tsc --noEmit"
-  },
   "keywords": [
     "tron",
     "tronlink",
+    "tronweb",
     "wallet",
     "signer",
+    "blockchain",
     "tip-6963"
   ],
   "files": [
     "dist"
   ],
   "license": "MIT",
+  "homepage": "https://github.com/TronLink/mcp-tronlink-signer/tree/main/packages/tronlink-signer#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TronLink/mcp-tronlink-signer.git",
+    "directory": "packages/tronlink-signer"
+  },
+  "bugs": {
+    "url": "https://github.com/TronLink/mcp-tronlink-signer/issues"
+  },
   "engines": {
     "node": ">=18"
   },
@@ -39,5 +46,9 @@
     "@types/node": "^25.5.0",
     "tsup": "^8.5.1",
     "typescript": "^5.7.3"
+  },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit"
   }
-}
+}