web3-typescript-typings

  • Version 0.10.2
  • Published
  • 19.6 kB
  • 1 dependency
  • Apache-2.0 license

Install

npm i web3-typescript-typings
yarn add web3-typescript-typings
pnpm add web3-typescript-typings

Overview

Typescript type definitions for web3

Index

Namespaces

namespace *.json

module '*.json' {}

    variable json

    const json: any;

      namespace web3

      module 'web3' {}

        class Web3

        class Web3 {}

          constructor

          public constructor(provider?: Web3.Provider);

            property currentProvider

            currentProvider: Web3.Provider;

              property eth

              eth: Web3.EthApi;

                property net

                net: Web3.NetApi;

                  property personal

                  personal: Web3.PersonalApi;

                    property providers

                    static providers: typeof providers;

                      property version

                      version: Web3.VersionApi;

                        method fromAscii

                        fromAscii: (ascii: string, padding?: number) => string;

                          method fromDecimal

                          fromDecimal: (value: number | string) => string;

                            method fromWei

                            fromWei: {
                            (value: number | string, unit: Web3.Unit): string;
                            (value: BigNumber.BigNumber, unit: Web3.Unit): BigNumber.BigNumber;
                            };

                              method isAddress

                              isAddress: (address: string) => boolean;

                                method isChecksumAddress

                                isChecksumAddress: (address: string) => boolean;

                                  method isConnected

                                  isConnected: () => boolean;

                                    method reset

                                    reset: (keepIsSyncing: boolean) => void;

                                      method setProvider

                                      setProvider: (provider: Web3.Provider) => void;

                                        method sha3

                                        sha3: (value: string, options?: Web3.Sha3Options) => string;

                                          method toAscii

                                          toAscii: (hex: string) => string;

                                            method toBigNumber

                                            toBigNumber: (value: number | string) => BigNumber.BigNumber;

                                              method toDecimal

                                              toDecimal: (hex: string) => number;

                                                method toHex

                                                toHex: (data: MixedData) => string;

                                                  method toWei

                                                  toWei: {
                                                  (amount: number | string, unit: Web3.Unit): string;
                                                  (amount: BigNumber.BigNumber, unit: Web3.Unit): BigNumber.BigNumber;
                                                  };

                                                    interface AbstractBlock

                                                    interface AbstractBlock {}

                                                      property difficulty

                                                      difficulty: BigNumber.BigNumber;

                                                        property extraData

                                                        extraData: string;

                                                          property gasLimit

                                                          gasLimit: number;

                                                            property gasUsed

                                                            gasUsed: number;

                                                              property hash

                                                              hash: string | null;

                                                                property logsBloom

                                                                logsBloom: string | null;

                                                                  property miner

                                                                  miner: string;

                                                                    property nonce

                                                                    nonce: string | null;

                                                                      property number

                                                                      number: number | null;

                                                                        property parentHash

                                                                        parentHash: string;

                                                                          property sha3Uncles

                                                                          sha3Uncles: string;

                                                                            property size

                                                                            size: number;

                                                                              property stateRoot

                                                                              stateRoot: string;

                                                                                property timestamp

                                                                                timestamp: number;

                                                                                  property totalDifficulty

                                                                                  totalDifficulty: BigNumber.BigNumber;

                                                                                    property transactionsRoot

                                                                                    transactionsRoot: string;

                                                                                      property uncles

                                                                                      uncles: string[];

                                                                                        interface BlockWithoutTransactionData

                                                                                        interface BlockWithoutTransactionData extends AbstractBlock {}

                                                                                          property transactions

                                                                                          transactions: string[];

                                                                                            interface BlockWithTransactionData

                                                                                            interface BlockWithTransactionData extends AbstractBlock {}

                                                                                              property transactions

                                                                                              transactions: Transaction[];

                                                                                                interface CallData

                                                                                                interface CallData extends CallTxDataBase {}

                                                                                                  property from

                                                                                                  from?: string;

                                                                                                    interface CallTxDataBase

                                                                                                    interface CallTxDataBase {}

                                                                                                      property data

                                                                                                      data?: string;

                                                                                                        property gas

                                                                                                        gas?: number | string | BigNumber.BigNumber;

                                                                                                          property gasPrice

                                                                                                          gasPrice?: number | string | BigNumber.BigNumber;

                                                                                                            property nonce

                                                                                                            nonce?: number;

                                                                                                              property to

                                                                                                              to?: string;

                                                                                                                property value

                                                                                                                value?: number | string | BigNumber.BigNumber;

                                                                                                                  interface ConstructorAbi

                                                                                                                  interface ConstructorAbi {}

                                                                                                                    property inputs

                                                                                                                    inputs: DataItem[];

                                                                                                                      property payable

                                                                                                                      payable: boolean;

                                                                                                                        property stateMutability

                                                                                                                        stateMutability: ConstructorStateMutability;

                                                                                                                          property type

                                                                                                                          type: AbiType.Constructor;

                                                                                                                            interface Contract

                                                                                                                            interface Contract<A extends ContractInstance> {}

                                                                                                                              method 'new'

                                                                                                                              new: (...args: any[]) => A;

                                                                                                                                method at

                                                                                                                                at: (address: string) => A;

                                                                                                                                  method getData

                                                                                                                                  getData: (...args: any[]) => string;

                                                                                                                                    interface ContractInstance

                                                                                                                                    interface ContractInstance {}

                                                                                                                                      property abi

                                                                                                                                      abi: Web3.ContractAbi;

                                                                                                                                        property address

                                                                                                                                        address: string;

                                                                                                                                          index signature

                                                                                                                                          [name: string]: any;

                                                                                                                                            interface DataItem

                                                                                                                                            interface DataItem {}

                                                                                                                                              property components

                                                                                                                                              components: DataItem[];

                                                                                                                                                property name

                                                                                                                                                name: string;

                                                                                                                                                  property type

                                                                                                                                                  type: string;

                                                                                                                                                    interface DecodedLogEntry

                                                                                                                                                    interface DecodedLogEntry<A> extends LogEntry {}

                                                                                                                                                      property args

                                                                                                                                                      args: A;

                                                                                                                                                        property event

                                                                                                                                                        event: string;

                                                                                                                                                          interface DecodedLogEntryEvent

                                                                                                                                                          interface DecodedLogEntryEvent<A> extends DecodedLogEntry<A> {}

                                                                                                                                                            property removed

                                                                                                                                                            removed: boolean;

                                                                                                                                                              interface EthApi

                                                                                                                                                              interface EthApi {}

                                                                                                                                                                property accounts

                                                                                                                                                                accounts: string[];

                                                                                                                                                                  property blockNumber

                                                                                                                                                                  blockNumber: number;

                                                                                                                                                                    property coinbase

                                                                                                                                                                    coinbase: string;

                                                                                                                                                                      property compile

                                                                                                                                                                      compile: {
                                                                                                                                                                      solidity(
                                                                                                                                                                      sourceString: string,
                                                                                                                                                                      cb?: (err: Error, result: any) => void
                                                                                                                                                                      ): object;
                                                                                                                                                                      };

                                                                                                                                                                        property defaultAccount

                                                                                                                                                                        defaultAccount?: string;

                                                                                                                                                                          property defaultBlock

                                                                                                                                                                          defaultBlock: Web3.BlockParam;

                                                                                                                                                                            property gasPrice

                                                                                                                                                                            gasPrice: BigNumber.BigNumber;

                                                                                                                                                                              property hashrate

                                                                                                                                                                              hashrate: number;

                                                                                                                                                                                property mining

                                                                                                                                                                                mining: boolean;

                                                                                                                                                                                  property syncing

                                                                                                                                                                                  syncing: Web3.SyncingResult;

                                                                                                                                                                                    method call

                                                                                                                                                                                    call: {
                                                                                                                                                                                    (callData: Web3.CallData): string;
                                                                                                                                                                                    (callData: CallData, callback: (err: Error, result: string) => void): void;
                                                                                                                                                                                    };

                                                                                                                                                                                      method contract

                                                                                                                                                                                      contract: (abi: Web3.AbiDefinition[]) => Web3.Contract<any>;

                                                                                                                                                                                        method estimateGas

                                                                                                                                                                                        estimateGas: {
                                                                                                                                                                                        (callData: Web3.CallData): number;
                                                                                                                                                                                        (callData: CallData, callback: (err: Error, gas: number) => void): void;
                                                                                                                                                                                        };

                                                                                                                                                                                          method filter

                                                                                                                                                                                          filter: (value: string | Web3.FilterObject) => Web3.FilterResult;

                                                                                                                                                                                            method getAccounts

                                                                                                                                                                                            getAccounts: (cd: (err: Error, accounts: string[]) => void) => void;

                                                                                                                                                                                              method getBalance

                                                                                                                                                                                              getBalance: {
                                                                                                                                                                                              (addressHexString: string): BigNumber.BigNumber;
                                                                                                                                                                                              (
                                                                                                                                                                                              addressHexString: string,
                                                                                                                                                                                              callback: (err: Error, result: BigNumber.BigNumber) => void
                                                                                                                                                                                              ): void;
                                                                                                                                                                                              };

                                                                                                                                                                                                method getBlock

                                                                                                                                                                                                getBlock: {
                                                                                                                                                                                                (
                                                                                                                                                                                                hashStringOrBlockNumber: string | Web3.BlockParam
                                                                                                                                                                                                ): Web3.BlockWithoutTransactionData;
                                                                                                                                                                                                (
                                                                                                                                                                                                hashStringOrBlockNumber: string | number,
                                                                                                                                                                                                callback: (err: Error, blockObj: BlockWithoutTransactionData) => void
                                                                                                                                                                                                ): void;
                                                                                                                                                                                                (
                                                                                                                                                                                                hashStringOrBlockNumber: string | number,
                                                                                                                                                                                                returnTransactionObjects: true
                                                                                                                                                                                                ): BlockWithTransactionData;
                                                                                                                                                                                                (
                                                                                                                                                                                                hashStringOrBlockNumber: string | number,
                                                                                                                                                                                                returnTransactionObjects: true,
                                                                                                                                                                                                callback: (err: Error, blockObj: BlockWithTransactionData) => void
                                                                                                                                                                                                ): void;
                                                                                                                                                                                                };

                                                                                                                                                                                                  method getBlockNumber

                                                                                                                                                                                                  getBlockNumber: (callback: (err: Error, blockNumber: number) => void) => void;

                                                                                                                                                                                                    method getBlockTransactionCount

                                                                                                                                                                                                    getBlockTransactionCount: {
                                                                                                                                                                                                    (hashStringOrBlockNumber: string | Web3.BlockParam): number;
                                                                                                                                                                                                    (
                                                                                                                                                                                                    hashStringOrBlockNumber: string | number,
                                                                                                                                                                                                    callback: (err: Error, blockTransactionCount: number) => void
                                                                                                                                                                                                    ): void;
                                                                                                                                                                                                    };

                                                                                                                                                                                                      method getCode

                                                                                                                                                                                                      getCode: {
                                                                                                                                                                                                      (addressHexString: string): string;
                                                                                                                                                                                                      (
                                                                                                                                                                                                      addressHexString: string,
                                                                                                                                                                                                      callback: (err: Error, code: string) => void
                                                                                                                                                                                                      ): void;
                                                                                                                                                                                                      };

                                                                                                                                                                                                        method getGasPrice

                                                                                                                                                                                                        getGasPrice: (cd: (err: Error, gasPrice: BigNumber.BigNumber) => void) => void;

                                                                                                                                                                                                          method getHashrate

                                                                                                                                                                                                          getHashrate: (cd: (err: Error, hashrate: number) => void) => void;

                                                                                                                                                                                                            method getMining

                                                                                                                                                                                                            getMining: (cd: (err: Error, mining: boolean) => void) => void;

                                                                                                                                                                                                              method getStorageAt

                                                                                                                                                                                                              getStorageAt: {
                                                                                                                                                                                                              (address: string, position: number): string;
                                                                                                                                                                                                              (
                                                                                                                                                                                                              address: string,
                                                                                                                                                                                                              position: number,
                                                                                                                                                                                                              callback: (err: Error, storage: string) => void
                                                                                                                                                                                                              ): void;
                                                                                                                                                                                                              };

                                                                                                                                                                                                                method getSyncing

                                                                                                                                                                                                                getSyncing: (cd: (err: Error, syncing: Web3.SyncingResult) => void) => void;

                                                                                                                                                                                                                  method getTransaction

                                                                                                                                                                                                                  getTransaction: {
                                                                                                                                                                                                                  (transactionHash: string): Web3.Transaction;
                                                                                                                                                                                                                  (
                                                                                                                                                                                                                  transactionHash: string,
                                                                                                                                                                                                                  callback: (err: Error, transaction: Transaction) => void
                                                                                                                                                                                                                  ): void;
                                                                                                                                                                                                                  };

                                                                                                                                                                                                                    method getTransactionCount

                                                                                                                                                                                                                    getTransactionCount: {
                                                                                                                                                                                                                    (address: string): number;
                                                                                                                                                                                                                    (address: string, callback: (err: Error, count: number) => void): void;
                                                                                                                                                                                                                    };

                                                                                                                                                                                                                      method getTransactionFromBlock

                                                                                                                                                                                                                      getTransactionFromBlock: {
                                                                                                                                                                                                                      (
                                                                                                                                                                                                                      hashStringOrBlockNumber: string | Web3.BlockParam,
                                                                                                                                                                                                                      indexNumber: number
                                                                                                                                                                                                                      ): Web3.Transaction;
                                                                                                                                                                                                                      (
                                                                                                                                                                                                                      hashStringOrBlockNumber: string | number,
                                                                                                                                                                                                                      indexNumber: number,
                                                                                                                                                                                                                      callback: (err: Error, transaction: Transaction) => void
                                                                                                                                                                                                                      ): void;
                                                                                                                                                                                                                      };

                                                                                                                                                                                                                        method getTransactionReceipt

                                                                                                                                                                                                                        getTransactionReceipt: {
                                                                                                                                                                                                                        (txHash: string): Web3.TransactionReceipt | null;
                                                                                                                                                                                                                        (
                                                                                                                                                                                                                        txHash: string,
                                                                                                                                                                                                                        callback: (err: Error, receipt: TransactionReceipt) => void
                                                                                                                                                                                                                        ): void;
                                                                                                                                                                                                                        };

                                                                                                                                                                                                                          method getUncle

                                                                                                                                                                                                                          getUncle: {
                                                                                                                                                                                                                          (
                                                                                                                                                                                                                          hashStringOrBlockNumber: string | Web3.BlockParam,
                                                                                                                                                                                                                          uncleNumber: number
                                                                                                                                                                                                                          ): Web3.BlockWithoutTransactionData;
                                                                                                                                                                                                                          (
                                                                                                                                                                                                                          hashStringOrBlockNumber: string | number,
                                                                                                                                                                                                                          uncleNumber: number,
                                                                                                                                                                                                                          callback: (err: Error, uncle: BlockWithoutTransactionData) => void
                                                                                                                                                                                                                          ): void;
                                                                                                                                                                                                                          };

                                                                                                                                                                                                                            method isSyncing

                                                                                                                                                                                                                            isSyncing: (
                                                                                                                                                                                                                            cb: (err: Error, isSyncing: boolean, syncingState: Web3.SyncingState) => void
                                                                                                                                                                                                                            ) => Web3.IsSyncing;

                                                                                                                                                                                                                              method sendRawTransaction

                                                                                                                                                                                                                              sendRawTransaction: {
                                                                                                                                                                                                                              (rawTxData: string): string;
                                                                                                                                                                                                                              (rawTxData: string, callback: (err: Error, value: string) => void): void;
                                                                                                                                                                                                                              };

                                                                                                                                                                                                                                method sendTransaction

                                                                                                                                                                                                                                sendTransaction: {
                                                                                                                                                                                                                                (txData: Web3.TxData): string;
                                                                                                                                                                                                                                (txData: TxData, callback: (err: Error, value: string) => void): void;
                                                                                                                                                                                                                                };

                                                                                                                                                                                                                                  method sign

                                                                                                                                                                                                                                  sign: {
                                                                                                                                                                                                                                  (address: string, data: string): string;
                                                                                                                                                                                                                                  (
                                                                                                                                                                                                                                  address: string,
                                                                                                                                                                                                                                  data: string,
                                                                                                                                                                                                                                  callback: (err: Error, signature: string) => void
                                                                                                                                                                                                                                  ): void;
                                                                                                                                                                                                                                  };

                                                                                                                                                                                                                                    interface EventAbi

                                                                                                                                                                                                                                    interface EventAbi {}

                                                                                                                                                                                                                                      property anonymous

                                                                                                                                                                                                                                      anonymous: boolean;

                                                                                                                                                                                                                                        property inputs

                                                                                                                                                                                                                                        inputs: EventParameter[];

                                                                                                                                                                                                                                          property name

                                                                                                                                                                                                                                          name: string;

                                                                                                                                                                                                                                            property type

                                                                                                                                                                                                                                            type: AbiType.Event;

                                                                                                                                                                                                                                              interface EventParameter

                                                                                                                                                                                                                                              interface EventParameter extends DataItem {}

                                                                                                                                                                                                                                                property indexed

                                                                                                                                                                                                                                                indexed: boolean;

                                                                                                                                                                                                                                                  interface FallbackAbi

                                                                                                                                                                                                                                                  interface FallbackAbi {}

                                                                                                                                                                                                                                                    property payable

                                                                                                                                                                                                                                                    payable: boolean;

                                                                                                                                                                                                                                                      property type

                                                                                                                                                                                                                                                      type: AbiType.Fallback;

                                                                                                                                                                                                                                                        interface FilterObject

                                                                                                                                                                                                                                                        interface FilterObject {}

                                                                                                                                                                                                                                                          property address

                                                                                                                                                                                                                                                          address?: string;

                                                                                                                                                                                                                                                            property fromBlock

                                                                                                                                                                                                                                                            fromBlock?: number | string;

                                                                                                                                                                                                                                                              property toBlock

                                                                                                                                                                                                                                                              toBlock?: number | string;

                                                                                                                                                                                                                                                                property topics

                                                                                                                                                                                                                                                                topics?: LogTopic[];

                                                                                                                                                                                                                                                                  interface FilterResult

                                                                                                                                                                                                                                                                  interface FilterResult {}

                                                                                                                                                                                                                                                                    method get

                                                                                                                                                                                                                                                                    get: (callback: () => void) => void;

                                                                                                                                                                                                                                                                      method stopWatching

                                                                                                                                                                                                                                                                      stopWatching: (callback?: () => void) => void;

                                                                                                                                                                                                                                                                        method watch

                                                                                                                                                                                                                                                                        watch: (callback: (err: Error, result: LogEntryEvent) => void) => void;

                                                                                                                                                                                                                                                                          interface IsSyncing

                                                                                                                                                                                                                                                                          interface IsSyncing {}

                                                                                                                                                                                                                                                                            method addCallback

                                                                                                                                                                                                                                                                            addCallback: (
                                                                                                                                                                                                                                                                            cb: (err: Error, isSyncing: boolean, syncingState: SyncingState) => void
                                                                                                                                                                                                                                                                            ) => void;

                                                                                                                                                                                                                                                                              method stopWatching

                                                                                                                                                                                                                                                                              stopWatching: () => void;

                                                                                                                                                                                                                                                                                interface JSONRPCRequestPayload

                                                                                                                                                                                                                                                                                interface JSONRPCRequestPayload {}

                                                                                                                                                                                                                                                                                  property id

                                                                                                                                                                                                                                                                                  id: number;

                                                                                                                                                                                                                                                                                    property jsonrpc

                                                                                                                                                                                                                                                                                    jsonrpc: string;

                                                                                                                                                                                                                                                                                      property method

                                                                                                                                                                                                                                                                                      method: string;

                                                                                                                                                                                                                                                                                        property params

                                                                                                                                                                                                                                                                                        params: any[];

                                                                                                                                                                                                                                                                                          interface JSONRPCResponsePayload

                                                                                                                                                                                                                                                                                          interface JSONRPCResponsePayload {}

                                                                                                                                                                                                                                                                                            property id

                                                                                                                                                                                                                                                                                            id: number;

                                                                                                                                                                                                                                                                                              property jsonrpc

                                                                                                                                                                                                                                                                                              jsonrpc: string;

                                                                                                                                                                                                                                                                                                property result

                                                                                                                                                                                                                                                                                                result: any;

                                                                                                                                                                                                                                                                                                  interface LogEntry

                                                                                                                                                                                                                                                                                                  interface LogEntry {}

                                                                                                                                                                                                                                                                                                    property address

                                                                                                                                                                                                                                                                                                    address: string;

                                                                                                                                                                                                                                                                                                      property blockHash

                                                                                                                                                                                                                                                                                                      blockHash: string | null;

                                                                                                                                                                                                                                                                                                        property blockNumber

                                                                                                                                                                                                                                                                                                        blockNumber: number | null;

                                                                                                                                                                                                                                                                                                          property data

                                                                                                                                                                                                                                                                                                          data: string;

                                                                                                                                                                                                                                                                                                            property logIndex

                                                                                                                                                                                                                                                                                                            logIndex: number | null;

                                                                                                                                                                                                                                                                                                              property topics

                                                                                                                                                                                                                                                                                                              topics: string[];

                                                                                                                                                                                                                                                                                                                property transactionHash

                                                                                                                                                                                                                                                                                                                transactionHash: string;

                                                                                                                                                                                                                                                                                                                  property transactionIndex

                                                                                                                                                                                                                                                                                                                  transactionIndex: number | null;

                                                                                                                                                                                                                                                                                                                    interface LogEntryEvent

                                                                                                                                                                                                                                                                                                                    interface LogEntryEvent extends LogEntry {}

                                                                                                                                                                                                                                                                                                                      property removed

                                                                                                                                                                                                                                                                                                                      removed: boolean;

                                                                                                                                                                                                                                                                                                                        interface MethodAbi

                                                                                                                                                                                                                                                                                                                        interface MethodAbi {}

                                                                                                                                                                                                                                                                                                                          property constant

                                                                                                                                                                                                                                                                                                                          constant: boolean;

                                                                                                                                                                                                                                                                                                                            property inputs

                                                                                                                                                                                                                                                                                                                            inputs: DataItem[];

                                                                                                                                                                                                                                                                                                                              property name

                                                                                                                                                                                                                                                                                                                              name: string;

                                                                                                                                                                                                                                                                                                                                property outputs

                                                                                                                                                                                                                                                                                                                                outputs: DataItem[];

                                                                                                                                                                                                                                                                                                                                  property payable

                                                                                                                                                                                                                                                                                                                                  payable: boolean;

                                                                                                                                                                                                                                                                                                                                    property stateMutability

                                                                                                                                                                                                                                                                                                                                    stateMutability: StateMutability;

                                                                                                                                                                                                                                                                                                                                      property type

                                                                                                                                                                                                                                                                                                                                      type: AbiType.Function;

                                                                                                                                                                                                                                                                                                                                        interface NetApi

                                                                                                                                                                                                                                                                                                                                        interface NetApi {}

                                                                                                                                                                                                                                                                                                                                          property listening

                                                                                                                                                                                                                                                                                                                                          listening: boolean;

                                                                                                                                                                                                                                                                                                                                            property peerCount

                                                                                                                                                                                                                                                                                                                                            peerCount: number;

                                                                                                                                                                                                                                                                                                                                              method getListening

                                                                                                                                                                                                                                                                                                                                              getListening: (cd: (err: Error, listening: boolean) => void) => void;

                                                                                                                                                                                                                                                                                                                                                method getPeerCount

                                                                                                                                                                                                                                                                                                                                                getPeerCount: (cd: (err: Error, peerCount: number) => void) => void;

                                                                                                                                                                                                                                                                                                                                                  interface PersonalApi

                                                                                                                                                                                                                                                                                                                                                  interface PersonalApi {}

                                                                                                                                                                                                                                                                                                                                                    property listAccounts

                                                                                                                                                                                                                                                                                                                                                    listAccounts: string[] | undefined;

                                                                                                                                                                                                                                                                                                                                                      method lockAccount

                                                                                                                                                                                                                                                                                                                                                      lockAccount: (address: string) => boolean;

                                                                                                                                                                                                                                                                                                                                                        method newAccount

                                                                                                                                                                                                                                                                                                                                                        newAccount: (password?: string) => string;

                                                                                                                                                                                                                                                                                                                                                          method sign

                                                                                                                                                                                                                                                                                                                                                          sign: {
                                                                                                                                                                                                                                                                                                                                                          (message: string, account: string, password: string): string;
                                                                                                                                                                                                                                                                                                                                                          (
                                                                                                                                                                                                                                                                                                                                                          hexMessage: string,
                                                                                                                                                                                                                                                                                                                                                          account: string,
                                                                                                                                                                                                                                                                                                                                                          callback: (error: Error, signature: string) => void
                                                                                                                                                                                                                                                                                                                                                          ): void;
                                                                                                                                                                                                                                                                                                                                                          };

                                                                                                                                                                                                                                                                                                                                                            method unlockAccount

                                                                                                                                                                                                                                                                                                                                                            unlockAccount: (
                                                                                                                                                                                                                                                                                                                                                            address: string,
                                                                                                                                                                                                                                                                                                                                                            password?: string,
                                                                                                                                                                                                                                                                                                                                                            duration?: number
                                                                                                                                                                                                                                                                                                                                                            ) => boolean;

                                                                                                                                                                                                                                                                                                                                                              interface Provider

                                                                                                                                                                                                                                                                                                                                                              interface Provider {}

                                                                                                                                                                                                                                                                                                                                                                method sendAsync

                                                                                                                                                                                                                                                                                                                                                                sendAsync: (
                                                                                                                                                                                                                                                                                                                                                                payload: JSONRPCRequestPayload,
                                                                                                                                                                                                                                                                                                                                                                callback: (err: Error, result: JSONRPCResponsePayload) => void
                                                                                                                                                                                                                                                                                                                                                                ) => void;

                                                                                                                                                                                                                                                                                                                                                                  interface Sha3Options

                                                                                                                                                                                                                                                                                                                                                                  interface Sha3Options {}

                                                                                                                                                                                                                                                                                                                                                                    property encoding

                                                                                                                                                                                                                                                                                                                                                                    encoding: 'hex';

                                                                                                                                                                                                                                                                                                                                                                      interface StructLog

                                                                                                                                                                                                                                                                                                                                                                      interface StructLog {}

                                                                                                                                                                                                                                                                                                                                                                        property depth

                                                                                                                                                                                                                                                                                                                                                                        depth: number;

                                                                                                                                                                                                                                                                                                                                                                          property error

                                                                                                                                                                                                                                                                                                                                                                          error: string;

                                                                                                                                                                                                                                                                                                                                                                            property gas

                                                                                                                                                                                                                                                                                                                                                                            gas: number;

                                                                                                                                                                                                                                                                                                                                                                              property gasCost

                                                                                                                                                                                                                                                                                                                                                                              gasCost: number;

                                                                                                                                                                                                                                                                                                                                                                                property memory

                                                                                                                                                                                                                                                                                                                                                                                memory: string[];

                                                                                                                                                                                                                                                                                                                                                                                  property op

                                                                                                                                                                                                                                                                                                                                                                                  op: OpCode;

                                                                                                                                                                                                                                                                                                                                                                                    property pc

                                                                                                                                                                                                                                                                                                                                                                                    pc: number;

                                                                                                                                                                                                                                                                                                                                                                                      property stack

                                                                                                                                                                                                                                                                                                                                                                                      stack: string[];

                                                                                                                                                                                                                                                                                                                                                                                        property storage

                                                                                                                                                                                                                                                                                                                                                                                        storage: { [location: string]: string };

                                                                                                                                                                                                                                                                                                                                                                                          interface SyncingState

                                                                                                                                                                                                                                                                                                                                                                                          interface SyncingState {}

                                                                                                                                                                                                                                                                                                                                                                                            property currentBlock

                                                                                                                                                                                                                                                                                                                                                                                            currentBlock: number;

                                                                                                                                                                                                                                                                                                                                                                                              property highestBlock

                                                                                                                                                                                                                                                                                                                                                                                              highestBlock: number;

                                                                                                                                                                                                                                                                                                                                                                                                property startingBlock

                                                                                                                                                                                                                                                                                                                                                                                                startingBlock: number;

                                                                                                                                                                                                                                                                                                                                                                                                  interface Transaction

                                                                                                                                                                                                                                                                                                                                                                                                  interface Transaction {}

                                                                                                                                                                                                                                                                                                                                                                                                    property blockHash

                                                                                                                                                                                                                                                                                                                                                                                                    blockHash: string | null;

                                                                                                                                                                                                                                                                                                                                                                                                      property blockNumber

                                                                                                                                                                                                                                                                                                                                                                                                      blockNumber: number | null;

                                                                                                                                                                                                                                                                                                                                                                                                        property from

                                                                                                                                                                                                                                                                                                                                                                                                        from: string;

                                                                                                                                                                                                                                                                                                                                                                                                          property gas

                                                                                                                                                                                                                                                                                                                                                                                                          gas: number;

                                                                                                                                                                                                                                                                                                                                                                                                            property gasPrice

                                                                                                                                                                                                                                                                                                                                                                                                            gasPrice: BigNumber.BigNumber;

                                                                                                                                                                                                                                                                                                                                                                                                              property hash

                                                                                                                                                                                                                                                                                                                                                                                                              hash: string;

                                                                                                                                                                                                                                                                                                                                                                                                                property input

                                                                                                                                                                                                                                                                                                                                                                                                                input: string;

                                                                                                                                                                                                                                                                                                                                                                                                                  property nonce

                                                                                                                                                                                                                                                                                                                                                                                                                  nonce: number;

                                                                                                                                                                                                                                                                                                                                                                                                                    property to

                                                                                                                                                                                                                                                                                                                                                                                                                    to: string | null;

                                                                                                                                                                                                                                                                                                                                                                                                                      property transactionIndex

                                                                                                                                                                                                                                                                                                                                                                                                                      transactionIndex: number | null;

                                                                                                                                                                                                                                                                                                                                                                                                                        property value

                                                                                                                                                                                                                                                                                                                                                                                                                        value: BigNumber.BigNumber;

                                                                                                                                                                                                                                                                                                                                                                                                                          interface TransactionReceipt

                                                                                                                                                                                                                                                                                                                                                                                                                          interface TransactionReceipt {}

                                                                                                                                                                                                                                                                                                                                                                                                                            property blockHash

                                                                                                                                                                                                                                                                                                                                                                                                                            blockHash: string;

                                                                                                                                                                                                                                                                                                                                                                                                                              property blockNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              blockNumber: number;

                                                                                                                                                                                                                                                                                                                                                                                                                                property contractAddress

                                                                                                                                                                                                                                                                                                                                                                                                                                contractAddress: string | null;

                                                                                                                                                                                                                                                                                                                                                                                                                                  property cumulativeGasUsed

                                                                                                                                                                                                                                                                                                                                                                                                                                  cumulativeGasUsed: number;

                                                                                                                                                                                                                                                                                                                                                                                                                                    property from

                                                                                                                                                                                                                                                                                                                                                                                                                                    from: string;

                                                                                                                                                                                                                                                                                                                                                                                                                                      property gasUsed

                                                                                                                                                                                                                                                                                                                                                                                                                                      gasUsed: number;

                                                                                                                                                                                                                                                                                                                                                                                                                                        property logs

                                                                                                                                                                                                                                                                                                                                                                                                                                        logs: LogEntry[];

                                                                                                                                                                                                                                                                                                                                                                                                                                          property status

                                                                                                                                                                                                                                                                                                                                                                                                                                          status: null | string | 0 | 1;

                                                                                                                                                                                                                                                                                                                                                                                                                                            property to

                                                                                                                                                                                                                                                                                                                                                                                                                                            to: string;

                                                                                                                                                                                                                                                                                                                                                                                                                                              property transactionHash

                                                                                                                                                                                                                                                                                                                                                                                                                                              transactionHash: string;

                                                                                                                                                                                                                                                                                                                                                                                                                                                property transactionIndex

                                                                                                                                                                                                                                                                                                                                                                                                                                                transactionIndex: number;

                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface TransactionTrace

                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface TransactionTrace {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                    property gas

                                                                                                                                                                                                                                                                                                                                                                                                                                                    gas: number;

                                                                                                                                                                                                                                                                                                                                                                                                                                                      property returnValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                      returnValue: any;

                                                                                                                                                                                                                                                                                                                                                                                                                                                        property structLogs

                                                                                                                                                                                                                                                                                                                                                                                                                                                        structLogs: StructLog[];

                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface TxData

                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface TxData extends CallTxDataBase {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                            property from

                                                                                                                                                                                                                                                                                                                                                                                                                                                            from: string;

                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface VersionApi

                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface VersionApi {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                property api

                                                                                                                                                                                                                                                                                                                                                                                                                                                                api: string;

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  property ethereum

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ethereum: string;

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    property network

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    network: string;

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      property node

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      node: string;

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        property whisper

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        whisper: string;

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          method getEthereum

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getEthereum: (cd: (err: Error, ethereum: string) => void) => void;

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            method getNetwork

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getNetwork: (cd: (err: Error, networkId: string) => void) => void;

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              method getNode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getNode: (cd: (err: Error, nodeVersion: string) => void) => void;

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                method getWhisper

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getWhisper: (cd: (err: Error, whisper: string) => void) => void;

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  enum AbiType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  enum AbiType {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function = 'function',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructor = 'constructor',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Event = 'event',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Fallback = 'fallback',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    member Constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructor = 'constructor'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      member Event

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Event = 'event'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        member Fallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Fallback = 'fallback'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          member Function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function = 'function'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type AbiDefinition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type AbiDefinition = FunctionAbi | EventAbi;

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type BlockParam

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type BlockParam = number | 'earliest' | 'latest' | 'pending';

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type ConstructorStateMutability

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type ConstructorStateMutability = 'nonpayable' | 'payable';

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type ContractAbi

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type ContractAbi = AbiDefinition[];

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type FunctionAbi

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type FunctionAbi = MethodAbi | ConstructorAbi | FallbackAbi;

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type LogTopic

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type LogTopic = null | string | string[];

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type OpCode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type OpCode = string;

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type StateMutability

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type StateMutability = 'pure' | 'view' | ConstructorStateMutability;

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type SyncingResult

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type SyncingResult = false | SyncingState;

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type Unit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type Unit =
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | 'kwei'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | 'ada'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | 'mwei'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | 'babbage'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | 'gwei'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | 'shannon'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | 'szabo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | 'finney'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | 'ether'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | 'kether'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | 'grand'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | 'einstein'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | 'mether'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | 'gether'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | 'tether';

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Package Files (2)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Dependencies (1)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Dev Dependencies (7)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Peer Dependencies (0)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                No peer dependencies.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Badge

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/web3-typescript-typings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Markdown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/web3-typescript-typings)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • HTML
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  <a href="https://www.jsdocs.io/package/web3-typescript-typings"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>