@layerzerolabs/lz-corekit-tron 2.3.8

package/dist/index.d.mts

@@ -0,0 +1,134 @@
+import { Finality } from '@solana/web3.js';
+import { ethers } from 'ethers';
+import TronWeb, { TransactionInfo } from 'tronweb';
+import { Provider, Block, BlockWithTransactions, TransactionResponse, TransactionReceipt, BlockTag, SignedTransaction, TransactionPending, Signer, TransactionRequest } from '@layerzerolabs/lz-core';
+
+/**
+ * TronProvider is a wrapper around TronWeb that implements the Provider interface
+ * It is implemented using ethers.js
+ */
+declare class TronProvider implements Provider {
+    nativeProvider: ethers.providers.StaticJsonRpcProvider;
+    /**
+     *
+     * @param url RPC endpoint of the Tron full node, e.g. 'https://api.trongrid.io'
+     * @param apiKey
+     */
+    private constructor();
+    static from(url: string, apiKey?: string): TronProvider;
+    static from(client: TronWeb): TronProvider;
+    /**
+     * Returns the native provider
+     */
+    get native(): unknown;
+    private buildTronWebFrom;
+    getBalance(address: string): Promise<string>;
+    getBlock(blockTag: string | number): Promise<Block>;
+    getBlockWithTransactions(blockTag: string | number): Promise<BlockWithTransactions>;
+    getBlockNumber(): Promise<number>;
+    getBlockTimestamp(blockTag: string | number): Promise<number>;
+    getSlot(_finality?: Finality): Promise<number>;
+    getTransaction(txHash: string): Promise<TransactionResponse>;
+    getTransactionReceipt(txHash: string): Promise<TransactionReceipt>;
+    getTransactionCount(_addressOrName: string | Promise<string>, _blockTag?: BlockTag | Promise<BlockTag>): Promise<number>;
+    sendTransaction(transaction: SignedTransaction, _sendOptions?: object): Promise<TransactionPending>;
+    sendAndConfirm(transaction: SignedTransaction, opts?: object): Promise<TransactionReceipt>;
+}
+
+/**
+ * TronWebProvider is a wrapper around TronWeb that implements the Provider interface
+ *
+ * PITFALL:
+ * - This class is not compatible with ethers.js and is not fully tested.
+ * - The format of the response from sendTransaction and the receipt from getTransactionReceipt differs
+ *   from that of the ethers provider.
+ */
+declare class TronWebProvider implements Provider {
+    private url;
+    private apiKey?;
+    nativeProvider: TronWeb;
+    /**
+     * Create a new TronProvider
+     * @param url RPC endpoint of the Tron full node, e.g. 'https://api.trongrid.io'
+     * @param apiKey
+     */
+    constructor(url: string, apiKey?: string | undefined);
+    static from(url: string, apiKey?: string): TronWebProvider;
+    get native(): unknown;
+    getBalance(address: string): Promise<string>;
+    getBlock(blockTag: string | number): Promise<Block>;
+    getBlockWithTransactions(blockTag: string | number): Promise<BlockWithTransactions>;
+    getBlockNumber(): Promise<number>;
+    getBlockTimestamp(blockTag: string | number): Promise<number>;
+    getSlot(_finality?: Finality): Promise<number>;
+    getTransaction(txHash: string): Promise<TransactionResponse>;
+    getTransactionReceipt(txHash: string): Promise<TransactionReceipt>;
+    getTransactionCount(_addressOrName: string | Promise<string>, _blockTag?: BlockTag | Promise<BlockTag>): Promise<number>;
+    sendTransaction(transaction: SignedTransaction, sendOptions?: {
+        confirmations?: number;
+    }): Promise<TransactionPending>;
+    waitTransaction(txHash: string, confirmations?: number): Promise<TransactionInfo | undefined>;
+    sendAndConfirm(transaction: SignedTransaction, opts?: {
+        confirmations?: number;
+    }): Promise<TransactionReceipt>;
+}
+
+/**
+ * TronSigner is a wrapper around TronWeb that implements the Signer interface
+ * It is implemented using ethers.js
+ */
+declare class TronSigner implements Signer {
+    private readonly nativeSigner;
+    private constructor();
+    static from(source: ethers.Signer): Signer;
+    static from(client: TronWeb): Signer;
+    static from(privKey: string): Signer;
+    static from(mnemonic: string, path: string): Signer;
+    get native(): unknown;
+    connect(provider: Provider): Signer;
+    static buildTronWebFrom(signer: ethers.Signer): TronWeb;
+    static createTronWeb: (url: string, privateKey: string, apiKey?: string) => TronWeb;
+    getAddress(): Promise<string>;
+    sendAndConfirm(transaction: SignedTransaction, _opts?: object): Promise<TransactionReceipt>;
+    signTransaction(transaction: TransactionRequest): Promise<SignedTransaction>;
+    sendTransaction(transaction: SignedTransaction, _sendOptions?: object): Promise<TransactionPending>;
+    signBuffer(buffer: Uint8Array): Promise<Uint8Array>;
+    static validateTransaction(transaction: ethers.PopulatedTransaction): boolean;
+}
+
+/**
+ * TronWebSigner is a wrapper around TronWeb that implements the Signer interface
+ *
+ * PITFALL:
+ * - This class is not compatible with ethers.js and is not fully tested.
+ * - The signature produced by signBuffer is different from the ethers signer
+ *   when the message length is not 32 bytes
+ * - The format of the response from sendTransaction differs from that of the ethers signer.
+ */
+declare class TronWebSigner implements Signer {
+    private readonly nativeSigner;
+    private constructor();
+    static from(signer: TronWeb): Signer;
+    static from(privKey: string): Signer;
+    static from(mnemonic: string, path?: string): Signer;
+    get native(): unknown;
+    connect(provider: Provider): Signer;
+    getAddress(): Promise<string>;
+    sendAndConfirm(transaction: SignedTransaction, _sendOptions?: object): Promise<TransactionReceipt>;
+    signTransaction(transaction: TransactionRequest): Promise<SignedTransaction>;
+    sendTransaction(transaction: SignedTransaction, _sendOptions?: object): Promise<TransactionPending>;
+    /**
+     * signBuffer signs a buffer using the native signer
+     * but the signString function of native signer is different from the ethers signer,
+     * TronWeb uses a message header with a fixed 32 bytes length, which means that only if
+     * the message length is 32 bytes, the signature will be the same as the ethereum signature.
+     * you can find the signString function here:
+     * https://github.com/tronprotocol/tronweb/blob/master/src/lib/trx.js
+     * @param buffer
+     * @returns
+     */
+    signBuffer(buffer: Uint8Array): Promise<Uint8Array>;
+    static validateTransaction(transaction: ethers.PopulatedTransaction): boolean;
+}
+
+export { TronProvider, TronSigner, TronWebProvider, TronWebSigner };

package/dist/index.d.ts

@@ -0,0 +1,134 @@
+import { Finality } from '@solana/web3.js';
+import { ethers } from 'ethers';
+import TronWeb, { TransactionInfo } from 'tronweb';
+import { Provider, Block, BlockWithTransactions, TransactionResponse, TransactionReceipt, BlockTag, SignedTransaction, TransactionPending, Signer, TransactionRequest } from '@layerzerolabs/lz-core';
+
+/**
+ * TronProvider is a wrapper around TronWeb that implements the Provider interface
+ * It is implemented using ethers.js
+ */
+declare class TronProvider implements Provider {
+    nativeProvider: ethers.providers.StaticJsonRpcProvider;
+    /**
+     *
+     * @param url RPC endpoint of the Tron full node, e.g. 'https://api.trongrid.io'
+     * @param apiKey
+     */
+    private constructor();
+    static from(url: string, apiKey?: string): TronProvider;
+    static from(client: TronWeb): TronProvider;
+    /**
+     * Returns the native provider
+     */
+    get native(): unknown;
+    private buildTronWebFrom;
+    getBalance(address: string): Promise<string>;
+    getBlock(blockTag: string | number): Promise<Block>;
+    getBlockWithTransactions(blockTag: string | number): Promise<BlockWithTransactions>;
+    getBlockNumber(): Promise<number>;
+    getBlockTimestamp(blockTag: string | number): Promise<number>;
+    getSlot(_finality?: Finality): Promise<number>;
+    getTransaction(txHash: string): Promise<TransactionResponse>;
+    getTransactionReceipt(txHash: string): Promise<TransactionReceipt>;
+    getTransactionCount(_addressOrName: string | Promise<string>, _blockTag?: BlockTag | Promise<BlockTag>): Promise<number>;
+    sendTransaction(transaction: SignedTransaction, _sendOptions?: object): Promise<TransactionPending>;
+    sendAndConfirm(transaction: SignedTransaction, opts?: object): Promise<TransactionReceipt>;
+}
+
+/**
+ * TronWebProvider is a wrapper around TronWeb that implements the Provider interface
+ *
+ * PITFALL:
+ * - This class is not compatible with ethers.js and is not fully tested.
+ * - The format of the response from sendTransaction and the receipt from getTransactionReceipt differs
+ *   from that of the ethers provider.
+ */
+declare class TronWebProvider implements Provider {
+    private url;
+    private apiKey?;
+    nativeProvider: TronWeb;
+    /**
+     * Create a new TronProvider
+     * @param url RPC endpoint of the Tron full node, e.g. 'https://api.trongrid.io'
+     * @param apiKey
+     */
+    constructor(url: string, apiKey?: string | undefined);
+    static from(url: string, apiKey?: string): TronWebProvider;
+    get native(): unknown;
+    getBalance(address: string): Promise<string>;
+    getBlock(blockTag: string | number): Promise<Block>;
+    getBlockWithTransactions(blockTag: string | number): Promise<BlockWithTransactions>;
+    getBlockNumber(): Promise<number>;
+    getBlockTimestamp(blockTag: string | number): Promise<number>;
+    getSlot(_finality?: Finality): Promise<number>;
+    getTransaction(txHash: string): Promise<TransactionResponse>;
+    getTransactionReceipt(txHash: string): Promise<TransactionReceipt>;
+    getTransactionCount(_addressOrName: string | Promise<string>, _blockTag?: BlockTag | Promise<BlockTag>): Promise<number>;
+    sendTransaction(transaction: SignedTransaction, sendOptions?: {
+        confirmations?: number;
+    }): Promise<TransactionPending>;
+    waitTransaction(txHash: string, confirmations?: number): Promise<TransactionInfo | undefined>;
+    sendAndConfirm(transaction: SignedTransaction, opts?: {
+        confirmations?: number;
+    }): Promise<TransactionReceipt>;
+}
+
+/**
+ * TronSigner is a wrapper around TronWeb that implements the Signer interface
+ * It is implemented using ethers.js
+ */
+declare class TronSigner implements Signer {
+    private readonly nativeSigner;
+    private constructor();
+    static from(source: ethers.Signer): Signer;
+    static from(client: TronWeb): Signer;
+    static from(privKey: string): Signer;
+    static from(mnemonic: string, path: string): Signer;
+    get native(): unknown;
+    connect(provider: Provider): Signer;
+    static buildTronWebFrom(signer: ethers.Signer): TronWeb;
+    static createTronWeb: (url: string, privateKey: string, apiKey?: string) => TronWeb;
+    getAddress(): Promise<string>;
+    sendAndConfirm(transaction: SignedTransaction, _opts?: object): Promise<TransactionReceipt>;
+    signTransaction(transaction: TransactionRequest): Promise<SignedTransaction>;
+    sendTransaction(transaction: SignedTransaction, _sendOptions?: object): Promise<TransactionPending>;
+    signBuffer(buffer: Uint8Array): Promise<Uint8Array>;
+    static validateTransaction(transaction: ethers.PopulatedTransaction): boolean;
+}
+
+/**
+ * TronWebSigner is a wrapper around TronWeb that implements the Signer interface
+ *
+ * PITFALL:
+ * - This class is not compatible with ethers.js and is not fully tested.
+ * - The signature produced by signBuffer is different from the ethers signer
+ *   when the message length is not 32 bytes
+ * - The format of the response from sendTransaction differs from that of the ethers signer.
+ */
+declare class TronWebSigner implements Signer {
+    private readonly nativeSigner;
+    private constructor();
+    static from(signer: TronWeb): Signer;
+    static from(privKey: string): Signer;
+    static from(mnemonic: string, path?: string): Signer;
+    get native(): unknown;
+    connect(provider: Provider): Signer;
+    getAddress(): Promise<string>;
+    sendAndConfirm(transaction: SignedTransaction, _sendOptions?: object): Promise<TransactionReceipt>;
+    signTransaction(transaction: TransactionRequest): Promise<SignedTransaction>;
+    sendTransaction(transaction: SignedTransaction, _sendOptions?: object): Promise<TransactionPending>;
+    /**
+     * signBuffer signs a buffer using the native signer
+     * but the signString function of native signer is different from the ethers signer,
+     * TronWeb uses a message header with a fixed 32 bytes length, which means that only if
+     * the message length is 32 bytes, the signature will be the same as the ethereum signature.
+     * you can find the signString function here:
+     * https://github.com/tronprotocol/tronweb/blob/master/src/lib/trx.js
+     * @param buffer
+     * @returns
+     */
+    signBuffer(buffer: Uint8Array): Promise<Uint8Array>;
+    static validateTransaction(transaction: ethers.PopulatedTransaction): boolean;
+}
+
+export { TronProvider, TronSigner, TronWebProvider, TronWebSigner };