feat: add tron scope types

Author: EdouardBougon

src/index.ts

@@ -35,4 +35,5 @@ export { getMultichainClient, getDefaultTransport, getExternallyConnectableTrans
 export type * from './types/transport';
 export type * from './types/session';
 export type * from './types/multichainApi';
+export type * from './types/scopes';
 export * from './types/errors';

src/types/scopes/index.ts

@@ -1,6 +1,7 @@
 import type { Bip122Rpc } from './bip122.types';
 import type { Eip155Rpc } from './eip155.types';
 import type { SolanaRpc } from './solana.types';
+import type { TronRpc } from './tron.types';
 
 export type RpcApi = Record<
   string,
@@ -34,4 +35,5 @@ export type DefaultRpcApi = {
   eip155: Eip155Rpc;
   solana: SolanaRpc;
   bip122: Bip122Rpc;
+  tron: TronRpc;
 };

src/types/scopes/tron.types.ts

@@ -0,0 +1,90 @@
+import type { RpcMethod } from '.';
+import type { CaipChainId } from '../session';
+
+/**
+ * A TronWeb transaction in serialized base64 format.
+ * @see https://github.com/tronprotocol/tronweb/blob/master/src/types/Transaction.ts
+ *
+ * To serialize a TronWeb transaction object to this format:
+ * ```typescript
+ * import TronWeb from 'tronweb';
+ *
+ * const tronWeb = new TronWeb({
+ *   fullHost: 'https://api.trongrid.io'
+ * });
+ *
+ * // Create your transaction
+ * const transaction = await tronWeb.transactionBuilder.sendTrx(
+ *   'TGehVcNhud84JDCGrNHKVz9jEAVKUpbuiv',
+ *   1000000,
+ *   'TJRabPrwbZy45sbavfcjinPJC18kjpRTv8'
+ * );
+ *
+ * // Serialize to base64
+ * const txPb = tronWeb.utils.transaction.txJsonToPb(transaction);
+ * const base64Transaction = Buffer.from(txPb.serializeBinary()).toString('base64');
+ * ```
+ *
+ * To deserialize back to a transaction object:
+ * ```typescript
+ * const txBytes = Buffer.from(base64Transaction, 'base64');
+ * const txPb = tronWeb.utils.transaction.txPbToTxID(txBytes);
+ * const transaction = tronWeb.utils.transaction.txPbToJson(txPb);
+ * ```
+ */
+export type Base64Transaction = string;
+
+/**
+ * A Tron address in Base58Check format, starting with 'T'.
+ * @example "TJRabPrwbZy45sbavfcjinPJC18kjpRTv8"
+ */
+export type TronAddress = `T${string}`;
+
+/**
+ * A signature.
+ */
+export type Signature = `${string}`;
+
+/**
+ * Signs a plain text message.
+ * The signature can be used to verify ownership of the account.
+ *
+ * @param chainId - CAIP-2 chain ID identifying the Tron network (e.g., "tron:0x2b6653dc")
+ * @param address - The Tron address that will sign the message
+ * @param message - The message string to be signed
+ * @returns An object containing the hexadecimal signature of the message
+ */
+export type SignMessageMethod = RpcMethod<
+  {
+    chainId: CaipChainId;
+    address: TronAddress;
+    message: string;
+  },
+  { signature: Signature }
+>;
+
+/**
+ * Signs a Tron transaction.
+ * The transaction must be provided as a base64-encoded serialized transaction string.
+ *
+ * @param chainId - CAIP-2 chain ID identifying the Tron network (e.g., "tron:0x2b6653dc")
+ * @param address - The Tron address that will sign the transaction
+ * @param transaction - The Tron transaction in serialized base64 format
+ * @returns An object containing the hexadecimal signature of the transaction
+ */
+export type SignTransactionMethod = RpcMethod<
+  {
+    chainId: CaipChainId;
+    address: TronAddress;
+    transaction: Base64Transaction;
+  },
+  { signature: Signature }
+>;
+
+export type TronRpc = {
+  methods: {
+    signMessage: SignMessageMethod;
+    signTransaction: SignTransactionMethod;
+  };
+  events: [];
+};

tests/index.test-d.ts

@@ -46,6 +46,21 @@ expectType<`0x${string}`>(
   }),
 );
 
+// Basic tron signMessage call with correct scope and parameters
+expectType<{ signature: string }>(
+  await client.invokeMethod({
+    scope: 'tron:728126428',
+    request: {
+      method: 'signMessage',
+      params: {
+        chainId: 'tron:728126428',
+        address: 'TJRabPrwbZy45sbavfcjinPJC18kjpRTv8',
+        message: 'hello world',
+      },
+    },
+  }),
+);
+
 // ==========================================
 // Test error cases for invalid inputs
 // ==========================================