tronweb-mobile 6.2.1-m-2.0.3

package/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright (c) 2022 tronweb3
+
+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,140 @@
+# tronweb-mobile
+
+tronweb-mobile is a JavaScript library provided for use within the **TronLink App**, designed to integrate Tron-related capabilities into DApp environments.
+
+The library is based on [TronWeb](https://tronweb.network), integrating its methods and functions while overriding signature-related capabilities. This allows DApps to invoke **TronLink App’s internal signing workflow** directly through global objects.
+
+## Features
+
+- Integrates core methods and functions from [TronWeb](https://tronweb.network)
+- Automatically injected into the page environment when a DApp is opened in the TronLink App
+- Exposes unified global objects to maintain compatibility with existing Tron DApps
+- Overrides signature methods so that all signing operations are handled internally by the TronLink App
+- Supports TIP-6963 multi injected provider discovery for seamless wallet detection
+
+## Injection Mechanism
+
+When a user opens a DApp using the **TronLink App**:
+
+- `tronweb-mobile.js` is automatically injected into the WebView
+- DApps do not need to manually import or initialize the library
+- The TronLink App's capabilities can be accessed directly through global objects
+
+## Global Objects
+
+tronweb-mobile injects the following global objects into the page environment:
+
+- `window.tronWeb`
+- `window.tron`
+- `window.tronLink`
+
+DApps can use these objects to interact with the Tron network and perform signing operations.
+
+## Overridden Signature Methods
+
+tronweb-mobile overrides and intercepts the following signature-related methods:
+
+- `sign`
+- `multiSign`
+- `signTransaction`
+- `signMessageV2`
+- `_signTypedData`
+
+When a DApp invokes any of these methods, the process is as follows:
+
+1. The call is intercepted by tronweb-mobile
+2. The request is forwarded to the TronLink App via global objects (`tron`, `tronLink`, or `tronWeb`)
+3. The TronLink App prompts the user for confirmation and completes the signing process internally
+4. The signature result is returned to the DApp
+
+All signing operations are completed inside the TronLink App. DApps never have direct access to the user’s private keys.
+
+## TIP-6963: Multi Injected Provider Discovery
+
+tronweb-mobile implements [TIP-6963](https://github.com/tronprotocol/tips), a provider discovery protocol mirroring [EIP-6963](https://eips.ethereum.org/EIPS/eip-6963) for the TRON ecosystem. It allows DApps to discover injected wallet providers via window events rather than relying on the race condition of `window.tronWeb`.
+
+### How It Works
+
+1. **Wallet announces** — On initialization, tronweb-mobile dispatches a `TIP6963:announceProvider` event containing provider info (`uuid`, `name`, `icon`, `rdns`) and the provider object
+2. **DApp requests** — A DApp dispatches `TIP6963:requestProvider` to request announcement from all available wallets
+3. **Wallet re-announces** — tronweb-mobile listens for `TIP6963:requestProvider` and re-announces itself
+
+### DApp Integration
+
+```javascript
+// Discover all injected TRON wallets
+window.addEventListener('TIP6963:announceProvider', (event) => {
+    const { info, provider } = event.detail;
+    console.log(`Discovered wallet: ${info.name} (${info.rdns})`);
+    // Use `provider` to interact with the wallet
+});
+
+// Trigger discovery
+window.dispatchEvent(new Event('TIP6963:requestProvider'));
+```
+
+### Provider Info
+
+| Field  | Value             |
+|--------|-------------------|
+| `name` | TronLink          |
+| `rdns` | io.tronlink       |
+| `uuid` | (per-session UUID) |
+| `icon` | TronLink logo     |
+
+## Usage Examples
+
+To get started, retrieve the global objects in your JavaScript file:
+
+```javascript
+const { tronWeb, tron, tronLink } = window;
+```
+
+Transaction signing example:
+
+```javascript
+const signedTx = await tronWeb.trx.sign(transaction)
+```
+
+Message signing example:
+
+```javascript
+const signature = await tronWeb.trx.signMessageV2(message)
+```
+
+When running inside the TronLink App environment, the above calls will automatically trigger the in-app signing confirmation flow.
+
+## Applicable Scenarios
+
+- DApps running inside the **TronLink App WebView**
+- Decentralized applications that need to interact with the Tron network
+- Projects built on [TronWeb](https://tronweb.network) that require API compatibility
+
+## Notes
+
+- tronweb-mobile is only injected in the **TronLink App environment**
+- The library will not be available in standard browser environments
+- DApps should check for the existence of `window.tronWeb` or `window.tronLink` at runtime
+
+## Contribution
+
+If you would like to contribute to tronweb-mobile, you can follow these steps:
+
+### Prerequisites
+
+- **Node.js**: `v18.19.0` (recommended to use [nvm](https://github.com/nvm-sh/nvm) for version management)
+- **pnpm**: `v7.32.0` (install via `npm install -g pnpm@7.32.0`)
+
+### Steps
+
+- Fork this repository and clone it locally
+- Install the dependencies: `pnpm install`
+- Make your changes to the code
+- Build the tronweb-mobile distribution files: `pnpm build`
+- (Optional) Open a DApp inside the TronLink App to verify that the injection works correctly
+- Run the tests: `pnpm test`
+- Push your changes and submit a Pull Request
+
+## License
+
+[MIT](https://opensource.org/licenses/MIT)