tronweb.d.ts 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  1. import { HttpProvider } from './lib/providers/index.js';
  2. import type { Providers } from './lib/providers/index.js';
  3. import utils from './utils/index.js';
  4. import { BigNumber } from 'bignumber.js';
  5. import EventEmitter from 'eventemitter3';
  6. import { TransactionBuilder } from './lib/TransactionBuilder/TransactionBuilder.js';
  7. import { Trx } from './lib/trx.js';
  8. import { Plugin } from './lib/plugin.js';
  9. import { Event } from './lib/event.js';
  10. import { DefaultAddress, NodeProvider, TronWebOptions, IBigNumber } from './types/TronWeb.js';
  11. import { ContractAbiInterface, ContractInstance } from './types/ABI.js';
  12. import { Address } from './types/Trx.js';
  13. export declare class TronWeb extends EventEmitter {
  14. providers: Providers;
  15. BigNumber: typeof BigNumber;
  16. transactionBuilder: TransactionBuilder;
  17. trx: Trx;
  18. plugin: Plugin;
  19. event: Event;
  20. version: typeof TronWeb.version;
  21. static version: string;
  22. utils: typeof utils;
  23. defaultBlock: number | false | 'earliest' | 'latest';
  24. defaultPrivateKey: string | false;
  25. defaultAddress: DefaultAddress;
  26. fullnodeVersion: string;
  27. feeLimit: number;
  28. fullNode: HttpProvider;
  29. solidityNode: HttpProvider;
  30. eventServer?: HttpProvider;
  31. constructor(options: TronWebOptions);
  32. constructor(fullNode: NodeProvider, solidityNode: NodeProvider, eventServer?: NodeProvider, privateKey?: string);
  33. constructor(fullNode: NodeProvider, solidityNode: NodeProvider, eventServer: NodeProvider, privateKey?: string);
  34. getFullnodeVersion(): Promise<void>;
  35. setDefaultBlock(blockID?: false | 'latest' | 'earliest' | number): number | false | "earliest" | "latest";
  36. setPrivateKey(privateKey: string): void;
  37. setAddress(address: string): void;
  38. fullnodeSatisfies(version: string): boolean;
  39. isValidProvider(provider: unknown): boolean;
  40. setFullNode(fullNode: HttpProvider | string): void;
  41. setSolidityNode(solidityNode: HttpProvider | string): void;
  42. setEventServer(eventServer: NodeProvider, healthcheck?: string): void;
  43. setHeader(headers?: {}): void;
  44. setFullNodeHeader(headers?: {}): void;
  45. setEventHeader(headers?: {}): void;
  46. currentProviders(): {
  47. fullNode: HttpProvider;
  48. solidityNode: HttpProvider;
  49. eventServer: HttpProvider | undefined;
  50. };
  51. currentProvider(): {
  52. fullNode: HttpProvider;
  53. solidityNode: HttpProvider;
  54. eventServer: HttpProvider | undefined;
  55. };
  56. getEventResult(...params: Parameters<Event['getEventsByContractAddress']>): ReturnType<Event['getEventsByContractAddress']>;
  57. getEventByTransactionID(...params: Parameters<Event['getEventsByTransactionID']>): ReturnType<Event['getEventsByTransactionID']>;
  58. contract<Abi extends ContractAbiInterface>(abi?: Abi, address?: Address): ContractInstance<Abi>;
  59. address: typeof TronWeb.address;
  60. static get address(): {
  61. fromHex(address: string): string;
  62. toHex(address: string): string;
  63. toChecksumAddress(address: string): string;
  64. isChecksumAddress(address: string): boolean;
  65. fromPrivateKey(privateKey: string, strict?: boolean): string | false;
  66. };
  67. sha3: typeof TronWeb.sha3;
  68. static sha3(string: string, prefix?: boolean): string;
  69. toHex: typeof TronWeb.toHex;
  70. static toHex(val: string | number | boolean | Record<string | number | symbol, unknown> | unknown[] | IBigNumber): string;
  71. toUtf8: typeof TronWeb.toUtf8;
  72. static toUtf8(hex: string): string;
  73. fromUtf8: typeof TronWeb.fromUtf8;
  74. static fromUtf8(string: string): string;
  75. toAscii: typeof TronWeb.toAscii;
  76. static toAscii(hex: string): string;
  77. fromAscii: typeof TronWeb.fromAscii;
  78. static fromAscii(string: string, padding?: number): string;
  79. toDecimal: typeof TronWeb.toDecimal;
  80. static toDecimal(value: string | number | IBigNumber): number;
  81. fromDecimal: typeof TronWeb.fromDecimal;
  82. static fromDecimal(value: number | IBigNumber): string;
  83. fromSun: typeof TronWeb.fromSun;
  84. static fromSun(sun: number): string | IBigNumber;
  85. toSun: typeof TronWeb.toSun;
  86. static toSun(trx: number): string | IBigNumber;
  87. toBigNumber: typeof TronWeb.toBigNumber;
  88. static toBigNumber(amount?: string | number | IBigNumber): IBigNumber;
  89. isAddress: typeof TronWeb.isAddress;
  90. static isAddress(address?: unknown): boolean;
  91. createAccount: typeof TronWeb.createAccount;
  92. static createAccount(): Promise<{
  93. privateKey: string;
  94. publicKey: string;
  95. address: {
  96. base58: string;
  97. hex: string;
  98. };
  99. }>;
  100. createRandom: typeof TronWeb.createRandom;
  101. static createRandom(...params: Parameters<(typeof utils)['accounts']['generateRandom']>): ReturnType<(typeof utils)['accounts']['generateRandom']>;
  102. fromMnemonic: typeof TronWeb.fromMnemonic;
  103. static fromMnemonic(...params: Parameters<(typeof utils)['accounts']['generateAccountWithMnemonic']>): ReturnType<(typeof utils)['accounts']['generateAccountWithMnemonic']>;
  104. isConnected(): Promise<{
  105. fullNode: boolean | 0;
  106. solidityNode: boolean | 0;
  107. eventServer: boolean | 0 | undefined;
  108. }>;
  109. }
  110. export default TronWeb;