tronweb.d.ts 5.1 KB

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