Index
Classes
Section titled “Classes”| Class | Description |
|---|---|
| AbiCoder | The AbiCoder is a low-level class responsible for encoding JavaScript values into binary data and decoding binary data into JavaScript values. |
| BaseContract | An interface for objects which have an address, and can resolve it asyncronously. |
| Block | A Block represents the data associated with a full block on Ethereum. |
| ConstructorFragment | A Fragment which represents a constructor. |
| Contract | A [[BaseContract]] with no type guards on its methods or events. |
| ContractTransactionReceipt | A ContractTransactionReceipt includes the parsed logs from a [[TransactionReceipt]]. |
| ContractTransactionResponse | A ContractTransactionResponse will return a [[ContractTransactionReceipt]] when waited on. |
| ErrorDescription | When using the [[Interface-parseError]] to automatically match an error for a call result for parsing, an ErrorDescription is returned. |
| ErrorFragment | A Fragment which represents a //Custom Error//. |
| EventFragment | A Fragment which represents an Event. |
| EventLog | An EventLog contains additional properties parsed from the [[Log]]. |
| FallbackFragment | A Fragment which represents a method. |
| FeeData | A FeeData wraps all the fee-related values associated with the network. |
| Fragment | An abstract class to represent An individual fragment from a parse ABI. |
| FunctionFragment | A Fragment which represents a method. |
| Interface | An Interface abstracts many of the low-level details for encoding and decoding the data on the blockchain. |
| Log | A Log in Ethereum represents an event that has been included in a transaction using the LOG* opcodes, which are most commonly used by Solidity’s emit for announcing events. |
| LogDescription | When using the [[Interface-parseLog]] to automatically match a Log to its event for parsing, a LogDescription is returned. |
| NamedFragment | An abstract class to represent An individual fragment which has a name from a parse ABI. |
| Network | A Network provides access to a chain’s properties and allows for plug-ins to extend functionality. |
| NetworkPlugin | A NetworkPlugin provides additional functionality on a [[Network]]. |
| ParamType | Each input and output of a [[Fragment]] is an Array of ParamType. |
| ProviderResolver | - |
| Result | A [[Result]] is a sub-class of Array, which allows accessing any of its values either positionally by its index or, if keys are provided by its name. |
| Signature | A Signature |
| SPRegistryService | - |
| StructFragment | A Fragment which represents a structure. |
| TransactionDescription | When using the [[Interface-parseTransaction]] to automatically match a transaction data to its function for parsing, a TransactionDescription is returned. |
| TransactionReceipt | A TransactionReceipt includes additional information about a transaction that is only available after it has been mined. |
| TransactionResponse | A TransactionResponse includes all properties about a transaction that was sent to the network, which may or may not be included in a block. |
| Typed | The Typed class to wrap values providing explicit type information. |
Interfaces
Section titled “Interfaces”| Interface | Description |
|---|---|
| AbortSignal | - |
| AbortSignal | - |
| AddEventListenerOptions | - |
| Addressable | An interface for objects which have an address, and can resolve it asyncronously. |
| ArrayIterator | - |
| ArrayLike | - |
| AsyncIterable | - |
| AsyncIterator | - |
| Authorization | - |
| AuthorizationRequest | - |
| BaseContractMethod | A Contract method can be called directly, or used in various ways. |
| BlockParams | a BlockParams encodes the minimal required properties for a formatted block. |
| CallExceptionError | This Error indicates a transaction reverted. |
| ConcatArray | - |
| ContractEvent | - |
| ContractInterface | A Contract with no method constraints. |
| ContractMethod | A contract method on a Contract. |
| ContractRunner | A ContractRunner is a generic interface which defines an object capable of interacting with a Contract on the network. |
| ContractTransaction | When populating a transaction this type is returned. |
| DeferredTopicFilter | When creating a filter using the contract.filters, this is returned. |
| EthersError | All errors in Ethers include properties to assist in machine-readable errors. |
| Event | - |
| Event | - |
| EventEmitterable | An EventEmitterable behaves similar to an EventEmitter except provides async access to its methods. |
| EventFilter | An EventFilter allows efficiently filtering logs (also known as events) using bloom filters included within blocks. |
| EventInit | - |
| EventListener | - |
| EventListenerObject | - |
| EventListenerOptions | - |
| EventTarget | - |
| EventTarget | - |
| Filter | A Filter allows searching a specific range of blocks for mathcing logs. |
| FilterByBlockHash | A FilterByBlockHash allows searching a specific block for mathcing logs. |
| Iterable | - |
| Iterator | - |
| IteratorReturnResult | - |
| IteratorYieldResult | - |
| JsonFragment | A fragment for a method, event or error in a JSON ABI format. |
| JsonFragmentType | A Type description in a JSON ABI format. |
| KzgLibrary | A KZG Library with the necessary functions to compute BLOb commitments and proofs. |
| LogParams | a LogParams encodes the minimal required properties for a formatted log. |
| MinedBlock | An Interface to indicate a [[Block]] has been included in the blockchain. This asserts a Type Guard that necessary properties are non-null. |
| MinedTransactionResponse | A MinedTransactionResponse is an interface representing a transaction which has been mined and allows for a type guard for its property values being defined. |
| NameResolver | An interface for any object which can resolve an ENS name. |
| Overrides | The overrides for a contract transaction. |
| PDPOffering | PDP offering details (decoded from productData) |
| PDPServiceInfo | PDP service info returned from getPDPService |
| PreparedTransactionRequest | A PreparedTransactionRequest is identical to a [[TransactionRequest]] except all the property types are strictly enforced. |
| PromiseLike | - |
| Provider | A Provider is the primary method to interact with the read-only content on Ethereum. |
| ProviderRegistrationInfo | Provider registration info for new providers |
| ServicePriceInfo | Service price information |
| ServiceProduct | Polymorphic service product interface |
| Signer | A Signer represents an account on the Ethereum Blockchain, and is most often backed by a private key represented by a mnemonic or residing on a Hardware Wallet. |
| StorageManagerDownloadOptions | Download options Currently empty, reserved for future options |
| StorageManagerUploadOptions | Upload options for StorageManager.upload() - the all-in-one upload method |
| TransactionLike | A TransactionLike is an object which is appropriate as a loose input for many operations which will populate missing properties of a transaction. |
| TransactionReceiptParams | a TransactionReceiptParams encodes the minimal required properties for a formatted transaction receipt. |
| TransactionRequest | A TransactionRequest is a transactions with potentially various properties not defined, or with less strict types for its values. |
| TransactionResponseParams | a TransactionResponseParams encodes the minimal required properties for a formatted transaction response. |
| TypedBigInt | A Typed that represents a numeric value. |
| TypedData | A Typed that represents a binary sequence of data as bytes. |
| TypedDataDomain | The domain for an [[link-eip-712]] payload. |
| TypedDataField | A specific field of a structured [[link-eip-712]] type. |
| TypedString | A Typed that represents a UTF-8 sequence of bytes. |
| WrappedFallback | A Fallback or Receive function on a Contract. |
Type Aliases
Section titled “Type Aliases”| Type Alias | Description |
|---|---|
| _AbortSignal | - |
| _Event | - |
| _EventTarget | - |
| AccessList | An ordered collection of [[AccessList]] entries. |
| AccessListEntry | A single [[AccessList]] entry of storage keys (slots) for an address. |
| AccessListish | Any ethers-supported access list structure. |
| AddressLike | Anything that can be used to return or resolve an address. |
| ArrayBufferLike | - |
| AuthorizationLike | - |
| BigNumberish | Any type that can be used where a big number is needed. |
| BlobLike | A BLOb object that can be passed for [[link-eip-4844]] transactions. |
| BlockTag | A BlockTag specifies a specific block. |
| BuiltinIteratorReturn | Defines the TReturn type used for built-in iterators produced by Array, Map, Set, and others. This is undefined when strictBuiltInIteratorReturn is true; otherwise, this is any. |
| BytesLike | An object that can be used to represent binary data. |
| CallExceptionAction | The action that resulted in the call exception. |
| CallExceptionTransaction | The related transaction that caused the error. |
| CombinedCallbacks | - |
| ContractEventArgs | Each argument of an event is nullable (to indicate matching //any//. |
| ContractEventName | The name for an event used for subscribing to Contract events. |
| ContractMethodArgs | Arguments to a Contract method can always include an additional and optional overrides parameter, and each parameter can optionally be [[Typed]]. |
| DataHexString | A [[HexString]] whose length is even, which ensures it is a valid representation of binary data. |
| ErrorCode | All errors emitted by ethers have an ErrorCode to help identify and coalesce errors to simplify programmatic analysis. |
| Exclude | Exclude from T those types that are assignable to U |
| FlatArray | - |
| FormatType | The format to serialize the output as. |
| FragmentType | The type of a [[Fragment]]. |
| InterfaceAbi | An InterfaceAbi may be any supported ABI format. |
| IteratorResult | - |
| KzgLibraryLike | A KZG Library with any of the various API configurations. As the library is still experimental and the API is not stable, depending on the version used the method names and signatures are still in flux. |
| Listener | A callback function called when a an event is triggered. |
| Networkish | A Networkish can be used to allude to a Network, by specifing: - a [[Network]] object - a well-known (or registered) network name - a well-known (or registered) chain ID - an object with sufficient details to describe a network |
| Numeric | Any type that can be used where a numeric value is needed. |
| Omit | Construct a type with the properties of T except for those in type K. |
| OrphanFilter | An Orphan Filter allows detecting when an orphan block has resulted in dropping a block or transaction or has resulted in transactions changing order. |
| ParamTypeWalkAsyncFunc | When walking asynchronously a [[ParamType]], this is called on each component. |
| ParamTypeWalkFunc | When walking a [[ParamType]], this is called on each component. |
| Partial | Make all properties in T optional |
| Pick | From T, pick a set of properties whose keys are in the union K |
| PostfixOverrides | Arguments to a Contract method can always include an additional and optional overrides parameter. |
| ProviderEvent | A ProviderEvent provides the types of events that can be subscribed to on a [[Provider]]. |
| Record | Construct a type with a set of properties K of type T |
| SignatureLike | A SignatureLike |
| TopicFilter | A TopicFilter provides a struture to define bloom-filter queries. |
Variables
Section titled “Variables”| Variable | Description |
|---|---|
| AbortSignal | - |
| Contract_base | - |
| Event | - |
| EventTarget | - |
Accessors
Section titled “Accessors”arrayLength
Section titled “arrayLength”Get Signature
Section titled “Get Signature”get arrayLength(): null | number;Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/typed.d.ts:132
Returns the length of the array type or -1 if it is dynamic.
Throws if the type is not an array.
Returns
Section titled “Returns”null | number
Get Signature
Section titled “Get Signature”get date(): | null | Date;Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:428
The [[link-js-date]] this block was included at.
Returns
Section titled “Returns”| null
| Date
tupleName
Section titled “tupleName”Get Signature
Section titled “Get Signature”get tupleName(): null | string;Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/typed.d.ts:126
Returns the tuple name, if this is a tuple. Throws otherwise.
Returns
Section titled “Returns”null | string