Ethers

https://docs.ethers.org/v6
Admin
Ethers.js is a complete and compact library for interacting with the Ethereum Blockchain and its...
Tokens:269,193
Snippets:2,885
Trust Score:8
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install ethers with npm

Source: https://docs.ethers.org/v6/getting-started

Install the ethers library using npm.

```bash
npm install ethers
```

--------------------------------

### npm install ethers

Source: https://docs.ethers.org/v6/single-page

Installation command for the ethers library.

```APIDOC
## [INSTALL] npm install ethers

### Description
Install the ethers library using npm.

### Method
npm install

### Endpoint
npm install ethers

### Parameters
None

### Request Example
```bash
npm install ethers
```

### Response
#### Success Response
- **status** (string) - Installation completed successfully.

#### Response Example
```bash
added 1 package in 1s
```
```

--------------------------------

### Install ethers via npm

Source: https://docs.ethers.org/v6/getting-started

Installs the ethers package using npm. Run this in your project directory.

```bash
# Install ethers /home/ricmoo/test-ethers> npm install ethers
```

--------------------------------

### npm install ethers

Source: https://docs.ethers.org/v6/single-page

Installation command for the ethers library.

```APIDOC
## [INSTALL] npm install ethers

### Description
Install the ethers library using npm.

### Command
npm install ethers

### Example
```bash
npm install ethers
```
```

--------------------------------

### GET /websites/ethers_v6

Source: https://docs.ethers.org/v6/single-page

This snippet represents the documentation page for the ethers v6 library, covering installation, error interfaces, event emitter patterns, and web content fetching abstractions.

```APIDOC
## [GET] /websites/ethers_v6

### Description
This documentation page covers the ethers v6 library installation and various error interfaces, event emitter patterns, and web content fetching abstractions.

### Method
GET

### Endpoint
/websites/ethers_v6

### Parameters
#### Path Parameters
- **project** (string) - Required - The project path identifier.

### Response
#### Success Response (200)
- **content** (string) - The documentation content.

#### Response Example
{
  "content": "# Install ethers /home/ricmoo/test-ethers> npm install ethers ..."
}
```

--------------------------------

### Install @ethers-ext/provider-multicall

Source: https://docs.ethers.org/v6/single-page

Installs the @ethers-ext/provider-multicall package, required for the ENS text records recipe that uses a MulticallProvider to batch eth_call queries.

```bash
npm install @ethers-ext/provider-multicall
```

--------------------------------

### SigningKey.computePublicKey example

Source: https://docs.ethers.org/v6/api/crypto

Shows how to compute both uncompressed and compressed public keys from a private key or an existing public key using SigningKey.computePublicKey. The optional compressed parameter controls the output format.

```javascript
sign = new SigningKey(id("some-secret"));
// Compute the uncompressed public key for a private key
SigningKey.computePublicKey(sign.privateKey)
// '0x04925bec9818e11ac806bf8b142a7965ac9231aaa9d23f256795d63b1d8d7f203f7481609b6a6964a0f5b459585e9d18a9ec9070d0baf24689138868811c974c96'
// Compute the compressed public key for a private key
SigningKey.computePublicKey(sign.privateKey, true)
// '0x02925bec9818e11ac806bf8b142a7965ac9231aaa9d23f256795d63b1d8d7f203f'
// Compute the uncompressed public key
SigningKey.computePublicKey(sign.publicKey, false);
// '0x04925bec9818e11ac806bf8b142a7965ac9231aaa9d23f256795d63b1d8d7f203f7481609b6a6964a0f5b459585e9d18a9ec9070d0baf24689138868811c974c96'
// Compute the Compressed a public key
SigningKey.computePublicKey(sign.publicKey, true);
// '0x02925bec9818e11ac806bf8b142a7965ac9231aaa9d23f256795d63b1d8d7f203f'
```

--------------------------------

### subscriber.start() ⇒ void

Source: https://docs.ethers.org/v6/api/providers/abstract-provider

Called initially when a subscriber is added the first time.

```APIDOC
## subscriber.start() ⇒ void

### Description
Called initially when a subscriber is added the first time.

### Method
start

### Returns
- **void** - No return value.
```

--------------------------------

### new BrowserProvider(ethereum, network?, options?)

Source: https://docs.ethers.org/v6/api/providers

Constructor for creating a BrowserProvider instance.

```APIDOC
## new BrowserProvider(ethereum, network?, options?)

### Description
Creates a new BrowserProvider instance, connecting to an EIP-1193 compatible provider (e.g., injected wallet). Optionally forces a specific network.

### Parameters
- **ethereum** (Eip1193Provider) - Required - The EIP-1193 provider to wrap.
- **network** (Networkish) - Optional - The network to force, if any.
- **options** (BrowserProviderOptions) - Optional - Additional options.

### Returns
- **BrowserProvider** - The new provider instance.
```

--------------------------------

### pbkdf2 example

Source: https://docs.ethers.org/v6/api/crypto

Computes the PBKDF2 for keylen bytes using the password, salt, iterations, and algorithm. The password must be converted to bytes, and normalization is recommended. This PBKDF is outdated and should not be used in new projects, but is required to decrypt older files.

```javascript
// The password must be converted to bytes, and it is generally
// best practices to ensure the string has been normalized. Many
// formats explicitly indicate the normalization form to use.
password = "hello"
passwordBytes = toUtf8Bytes(password, "NFKC")
salt = id("some-salt")
// Compute the PBKDF2
pbkdf2(passwordBytes, salt, 1024, 16, "sha256")
// '0x226addf5b6d87544337e9733b99ceb9d'
```

--------------------------------

### GET /browserProvider/signer/{address}

Source: https://docs.ethers.org/v6/single-page

Gets a signer for the specified address.

```APIDOC
## [GET] /browserProvider/signer/{address}

### Description
Gets a signer for the specified address.

### Method
GET

### Endpoint
/browserProvider/signer/{address}

### Parameters
#### Path Parameters
- **address** (number | string) - Required - The address or index.

### Response
#### Success Response (200)
- **signer** (JsonRpcSigner) - The signer.
```

--------------------------------

### Third-party Provider Constructors and Static Methods

Source: https://docs.ethers.org/v6/api/providers/thirdparty

This code snippet provides the constructor and static method signatures for the InfuraProvider, InfuraWebSocketProvider, PocketProvider, and QuickNodeProvider classes, including their parameters and return types.

```APIDOC
## new InfuraProvider(network?: Networkish, projectId?: null | string, projectSecret?: null | string)

### Description
Creates a new InfuraProvider instance that connects to the INFURA JSON-RPC end-points. By default, a highly-throttled API key is used, which is appropriate for quick prototypes and simple scripts.

### Parameters
- **network** (Networkish) - Optional - The network to connect to.
- **projectId** (null | string) - Optional - The Project ID for the INFURA connection.
- **projectSecret** (null | string) - Optional - The Project Secret for authenticated requests. If null, no authenticated requests are made.

### Returns
- **InfuraProvider** - A new InfuraProvider instance.
```

```APIDOC
## InfuraProvider.getRequest(network: Network, projectId?: null | string, projectSecret?: null | string) => FetchRequest

### Description
Returns a prepared request for connecting to the specified network with the given projectId and projectSecret.

### Parameters
- **network** (Network) - Required - The network to connect to.
- **projectId** (null | string) - Optional - The Project ID for the INFURA connection.
- **projectSecret** (null | string) - Optional - The Project Secret for authenticated requests.

### Returns
- **FetchRequest** - A prepared request for connecting to the network.
```

```APIDOC
## InfuraProvider.getWebSocketProvider(network?: Networkish, projectId?: string) => InfuraWebSocketProvider

### Description
Creates a new InfuraWebSocketProvider instance that connects to the INFURA WebSocket end-points.

### Parameters
- **network** (Networkish) - Optional - The network to connect to.
- **projectId** (string) - Optional - The Project ID for the INFURA connection.

### Returns
- **InfuraWebSocketProvider** - A new InfuraWebSocketProvider instance.
```

```APIDOC
## new InfuraWebSocketProvider(network?: Networkish, projectId?: string)

### Description
Creates a new InfuraWebSocketProvider instance that connects to the INFURA WebSocket end-points. By default, a highly-throttled API key is used.

### Parameters
- **network** (Networkish) - Optional - The network to connect to.
- **projectId** (string) - Optional - The Project ID for the INFURA connection.

### Returns
- **InfuraWebSocketProvider** - A new InfuraWebSocketProvider instance.
```

```APIDOC
## new PocketProvider(network?: Networkish, applicationId?: null | string, applicationSecret?: null | string)

### Description
Creates a new PocketProvider instance that connects to the Pocket Network JSON-RPC end-points. By default, it connects to mainnet with a highly throttled API key.

### Parameters
- **network** (Networkish) - Optional - The network to connect to.
- **applicationId** (null | string) - Optional - The Application ID for the Pocket connection.
- **applicationSecret** (null | string) - Optional - The Application Secret for authenticated requests.

### Returns
- **PocketProvider** - A new PocketProvider instance.
```

```APIDOC
## PocketProvider.getRequest(network: Network, applicationId?: null | string, applicationSecret?: null | string) => FetchRequest

### Description
Returns a prepared request for connecting to the specified network with the given applicationId and applicationSecret.

### Parameters
- **network** (Network) - Required - The network to connect to.
- **applicationId** (null | string) - Optional - The Application ID for the Pocket connection.
- **applicationSecret** (null | string) - Optional - The Application Secret for authenticated requests.

### Returns
- **FetchRequest** - A prepared request for connecting to the network.
```

```APIDOC
## new QuickNodeProvider(network?: Networkish, token?: null | string)

### Description
Creates a new QuickNodeProvider instance that connects to the QuickNode JSON-RPC end-points. By default, a highly-throttled API token is used.

### Parameters
- **network** (Networkish) - Optional - The network to connect to.
- **token** (null | string) - Optional - The API token.

### Returns
- **QuickNodeProvider** - A new QuickNodeProvider instance.
```

```APIDOC
## QuickNodeProvider.getRequest(network: Network, token?: null | string) => FetchRequest

### Description
Returns a new request prepared for the specified network and token.

### Parameters
- **network** (Network) - Required - The network to connect to.
- **token** (null | string) - Optional - The API token.

### Returns
- **FetchRequest** - A prepared request for connecting to the network.
```

--------------------------------

### Build documentation with Flatworm v2

Source: https://docs.ethers.org/v6/contributing

Commands to clone the Flatworm repository, check out the tsdocs branch, install dependencies, and build the documentation to an ./output/ folder. The final command requires the path to the WRM root.

```bash
/home/ricmoo> git clone https://github.com/ricmoo/flatworm.git
/home/ricmoo> cd flatworm
/home/ricmoo/flatworm> git checkout tsdocs
/home/ricmoo/flatworm> npm install
/home/ricmoo/flatworm> node lib/cli-test PATH_TO_WRM_ROOT
```

--------------------------------

### signer.getAddress

Source: https://docs.ethers.org/v6/api/providers

Gets the address of the Signer.

```APIDOC
## signer.getAddress

### Description
Gets the address of the Signer.

### Method
GET

### Endpoint
signer.getAddress()

### Response
#### Success Response (200)
- **address** (string) - The address of the Signer.

#### Response Example
```json
{
  "address": "0x..."
}
```
```

--------------------------------

### Build documentation with flatworm tsdocs branch

Source: https://docs.ethers.org/v6/single-page

Clone the flatworm repository, check out the tsdocs branch, install dependencies, and run the CLI to build documentation into ./output/. The tsdocs branch is under active development, so checkout a specific hash for stability.

```shell
/home/ricmoo> git clone https://github.com/ricmoo/flatworm.git
/home/ricmoo> cd flatworm
# Check out the tsdocs branch
/home/ricmoo/flatworm> git checkout tsdocs
# Install the necessary dependencies
/home/ricmoo/flatworm> npm install
# Ready to build the docs; output to a folder ./output/
/home/ricmoo/flatworm> node lib/cli-test PATH_TO_WRM_ROOT
```

--------------------------------

### getNetwork()

Source: https://docs.ethers.org/v6/api/providers

Gets the connected network.

```APIDOC
## getNetwork() => Promise<Network>

### Description
Get the connected Network.

### Method
getNetwork

### Returns
- **Promise<Network>** - The connected network.
```

--------------------------------

### Importing in v6

Source: https://docs.ethers.org/v6/migrating

Shows v6 import patterns: everything from the root package and granular access via ethers/providers.

```javascript
// Everything is available on the root package
import { ethers } from "ethers"
import { InfuraProvider } from "ethers"

// The pkg.exports provides granular access
import { InfuraProvider } from "ethers/providers"
```

--------------------------------

### GET /v1/wordlistowla/decodeWords

Source: https://docs.ethers.org/v6/single-page

Decodes all the words for the wordlist.

```APIDOC
## [GET] /v1/wordlistowla/decodeWords

### Description
Decodes all the words for the wordlist.

### Method
GET

### Endpoint
/v1/wordlistowla/decodeWords

### Response
#### Success Response (200)
- **words** (Array<string>) - The decoded words.

#### Response Example
```
{
  "words": ["word1", "word2"]
}
```
```

--------------------------------

### new Wallet(key, provider?)

Source: https://docs.ethers.org/v6/single-page

Creates a new Wallet instance from a private key or SigningKey, optionally connected to a provider.

```APIDOC
## [CONSTRUCTOR] new Wallet(key: string | SigningKey, provider?: null | Provider)

### Description
Creates a new Wallet instance for the given private key, optionally connected to a provider. The Wallet class manages a single private key and is the main entry point for developers using a private key directly.

### Method
Constructor

### Endpoint
new Wallet(key: string | SigningKey, provider?: null | Provider)

### Parameters
- **key** (string | SigningKey) - Required - The private key or SigningKey instance.
- **provider** (null | Provider) - Optional - The provider to connect the wallet to.
```

--------------------------------

### GET /v1/wordlistowl/decodeWords

Source: https://docs.ethers.org/v6/single-page

Decodes all the words for the wordlist.

```APIDOC
## [GET] /v1/wordlistowl/decodeWords

### Description
Decodes all the words for the wordlist.

### Method
GET

### Endpoint
/v1/wordlistowl/decodeWords

### Response
#### Success Response (200)
- **words** (Array<string>) - The decoded words.

#### Response Example
```
{
  "words": ["word1", "word2"]
}
```
```

--------------------------------

### new BlockscoutProvider(network?: Networkish, apiKey?: null | string)

Source: https://docs.ethers.org/v6/api/providers/thirdparty

Constructor for creating a new BlockscoutProvider instance.

```APIDOC
## new BlockscoutProvider(network?: Networkish, apiKey?: null | string)

### Description
Creates a new BlockscoutProvider instance that connects to the Blockscout JSON-RPC endpoints. By default, a highly-throttled API key is used, which is appropriate for quick prototypes and simple scripts. To gain access to an increased rate-limit, it is highly recommended to sign up here.

### Method
Constructor

### Parameters
- **network** (Networkish) - Optional - The network to connect to.
- **apiKey** (null | string) - Optional - The API key to use. If not provided, a default throttled key is used.

### Returns
- **BlockscoutProvider** - A new BlockscoutProvider instance.

### Example
```javascript
const provider = new BlockscoutProvider();
```
```

--------------------------------

### getFeeData()

Source: https://docs.ethers.org/v6/api/providers

Gets the recommended fee data.

```APIDOC
## getFeeData() => Promise<FeeData>

### Description
Get the best guess at the recommended FeeData.

### Method
getFeeData

### Returns
- **Promise<FeeData>** - The recommended fee data.
```

--------------------------------

### getBlockNumber()

Source: https://docs.ethers.org/v6/api/providers

Gets the current block number.

```APIDOC
## getBlockNumber() => Promise<number>

### Description
Get the current block number.

### Method
getBlockNumber

### Returns
- **Promise<number>** - The current block number.
```

--------------------------------

### decodeBase64 example

Source: https://docs.ethers.org/v6/api/utils

Decodes a Base64-encoded string into a Uint8Array. The decoded value is always binary data; use toUtf8String to convert it to a string. The example shows decoding 'SGVsbG8gV29ybGQhIQ==' to 'Hello World!!' and decoding 'EjQ=' to Uint8Array(2) [ 18, 52 ].

```javascript
result = decodeBase64("SGVsbG8gV29ybGQhIQ==")
// Uint8Array(13) [
//   72, 101, 108, 108, 111,
//   32, 87, 111, 114, 108,
//   100, 33, 33
// ]
// ...use toUtf8String to convert it to a string.
toUtf8String(result)
// 'Hello World!!'
// Decoding binary data
decodeBase64("EjQ=")
// Uint8Array(2) [ 18, 52 ]
```

--------------------------------

### new BasicMulticoinProviderPlugin()

Source: https://docs.ethers.org/v6/api/providers/ens-resolver

Creates a new BasicMulticoinProviderPlugin instance.

```APIDOC
## new BasicMulticoinProviderPlugin()

### Description
Creates a new BasicMulticoinProviderPlugin instance.

### Returns
- **BasicMulticoinProviderPlugin** - A new instance.
```

--------------------------------

### GET /ens/resolver/get-ens-address

Source: https://docs.ethers.org/v6/single-page

Resolves the ENS address for a provider.

```APIDOC
## [GET] /ens/resolver/get-ens-address

### Description
Resolves the ENS address for a provider.

### Method
GET

### Endpoint
/ens/resolver/get-ens-address

### Parameters
#### Path Parameters
- **provider** (Provider) - Required - The provider.

### Response
#### Success Response (200)
- **address** (string) - The ENS address.

#### Response Example
{
  "address": "0x..."
}
```

--------------------------------

### GET /ens/resolver/content-hash

Source: https://docs.ethers.org/v6/single-page

Resolves the content-hash for an ENS name.

```APIDOC
## [GET] /ens/resolver/content-hash

### Description
Resolves the content-hash for an ENS name, or null if unconfigured.

### Method
GET

### Endpoint
/ens/resolver/content-hash

### Parameters
#### Path Parameters
- **name** (string) - Required - The ENS name to resolve.

### Response
#### Success Response (200)
- **contentHash** (null | string) - The content-hash or null if unconfigured.

#### Response Example
{
  "contentHash": "ipfs://Qm..."
}
```

--------------------------------

### new SocketProvider(network?, options?)

Source: https://docs.ethers.org/v6/api/providers/abstract-provider

Constructor for creating a new SocketProvider instance.

```APIDOC
## new SocketProvider(network?: Networkish, options?: JsonRpcApiProviderOptions)

### Description
Creates a new SocketProvider connected to network. If unspecified, the network will be discovered.

### Method
Constructor

### Parameters
- **network** (Networkish) - Optional - The network to connect to.
- **options** (JsonRpcApiProviderOptions) - Optional - Configuration options for the provider.

### Returns
A new SocketProvider instance.
```

--------------------------------

### getTransaction(hash: string)

Source: https://docs.ethers.org/v6/api/providers

Gets a transaction by hash.

```APIDOC
## getTransaction(hash: string) => Promise<null | TransactionResponse>

### Description
Resolves to the transaction for hash. If the transaction is unknown or on pruning nodes which discard old transactions this resolves to null.

### Method
getTransaction

### Parameters
- **hash** (string) - Required - The transaction hash.

### Returns
- **Promise<null | TransactionResponse>** - The transaction response or null.
```

--------------------------------

### Build Ethers with npm run auto-build

Source: https://docs.ethers.org/v6/contributing

Commands to clone the Ethers repository (placeholder URL), install dependencies, and run the auto-build script. The clone URL is marked as @TODO.

```bash
/home/ricmoo> git clone @TODO
/home/ricmoo> cd ethers
/home/ricmoo/ethers> npm install
/home/ricmoo/ethers> npm run auto-build
```

--------------------------------

### DeferredTopicFilter.getTopicFilter

Source: https://docs.ethers.org/v6/api/contract

Gets the topic filter for a deferred filter.

```APIDOC
## DeferredTopicFilter.getTopicFilter

### Description
Resolves to the topic filter for the deferred filter.

### Method
METHOD

### Signature
`deferredTopicFilter.getTopicFilter() ⇒ Promise<TopicFilter>`

### Returns
- **Promise<TopicFilter>** - The topic filter.
```

--------------------------------

### SigningKey.recoverPublicKey example

Source: https://docs.ethers.org/v6/api/crypto

Demonstrates recovering the public key from a signature and digest using SigningKey.recoverPublicKey. The recovered public key matches the original signer's public key.

```javascript
key = new SigningKey(id("some-secret"))
digest = id("hello world")
sig = key.sign(digest)
// Notice the signer public key...
key.publicKey
// '0x04925bec9818e11ac806bf8b142a7965ac9231aaa9d23f256795d63b1d8d7f203f7481609b6a6964a0f5b459585e9d18a9ec9070d0baf24689138868811c974c96'
// ...is equal to the recovered public key
SigningKey.recoverPublicKey(digest, sig)
// '0x04925bec9818e11ac806bf8b142a7965ac9231aaa9d23f256795d63b1d8d7f203f7481609b6a6964a0f5b459585e9d18a9ec9070d0baf24689138868811c974c96'
```

--------------------------------

### POST /contracts

Source: https://docs.ethers.org/v6/single-page

Deploys a new contract instance using the provided constructor arguments.

```APIDOC
## [POST] /contracts

### Description
Deploys a new contract instance using the provided constructor arguments.

### Method
POST

### Endpoint
/contracts

### Parameters
#### Request Body
- **args** (ContractMethodArgs<A>) - Required - The constructor arguments for the contract.

### Request Example
{
  "args": ["arg1", "arg2"]
}

### Response
#### Success Response (200)
- **contract** (BaseContract) - The deployed contract instance.

#### Response Example
{
  "contract": {
    "address": "0x...",
    "deploymentTransaction": "0x..."
  }
}
```

--------------------------------

### ContractUnknownEventPayload.getTransaction

Source: https://docs.ethers.org/v6/api/contract

Gets the transaction in which the unknown event occurred.

```APIDOC
## ContractUnknownEventPayload.getTransaction

### Description
Resolves to the transaction the event occurred in.

### Method
METHOD

### Signature
`contractUnknownEventPayload.getTransaction() ⇒ Promise<TransactionResponse>`

### Returns
- **Promise<TransactionResponse>** - The transaction in which the event occurred.
```

--------------------------------

### BrowserProvider.discover(options?)

Source: https://docs.ethers.org/v6/api/providers

Static method to discover and connect to a browser provider via EIP-6963.

```APIDOC
## BrowserProvider.discover(options?)

### Description
Discovers and connects to a provider in the browser using the EIP-6963 discovery mechanism. Resolves to null if no providers are present.

### Parameters
- **options** (BrowserDiscoverOptions) - Optional - Options for discovery, including timeout and window context.

### Returns
- **Promise<null | BrowserProvider>** - A BrowserProvider or null if none found.
```

--------------------------------

### ContractUnknownEventPayload.getBlock

Source: https://docs.ethers.org/v6/api/contract

Gets the block in which the unknown event occurred.

```APIDOC
## ContractUnknownEventPayload.getBlock

### Description
Resolves to the block the event occurred in.

### Method
METHOD

### Signature
`contractUnknownEventPayload.getBlock() ⇒ Promise<Block>`

### Returns
- **Promise<Block>** - The block where the event occurred.
```

--------------------------------

### GET /v1/wordlist/getWordIndex

Source: https://docs.ethers.org/v6/single-page

Maps a word to its corresponding 11-bit value.

```APIDOC
## [GET] /v1/wordlist/getWordIndex

### Description
Maps a word to its corresponding 11-bit value.

### Method
GET

### Endpoint
/v1/wordlist/getWordIndex

### Parameters
#### Query Parameters
- **word** (string) - Required - The word to map.

### Response
#### Success Response (200)
- **index** (number) - The corresponding 11-bit value.

#### Response Example
```
{
  "index": 123
}
```
```

--------------------------------

### Create providers with getDefaultProvider

Source: https://docs.ethers.org/v6/api/providers

Shows three ways to create a provider with getDefaultProvider: connecting to a local Geth node, connecting to Ethereum mainnet with default third-party services, and connecting to Polygon with an Etherscan API key while restricting to only Etherscan and INFURA services.

```javascript
// Connect to a local Geth node
provider = getDefaultProvider("http://localhost:8545/");

// Connect to Ethereum mainnet with any current and future
// third-party services available
provider = getDefaultProvider("mainnet");

// Connect to Polygon, but only allow Etherscan and
// INFURA and use "MY_API_KEY" in calls to Etherscan.
provider = getDefaultProvider("matic", {
    etherscan: "MY_API_KEY",
    exclusive: [ "etherscan", "infura" ]
});
```

--------------------------------

### fetchRequest.getHeader(key)

Source: https://docs.ethers.org/v6/single-page

Get the header for key, ignoring case.

```APIDOC
## [GET] [fetchRequest.getHeader(key)]

### Description
Get the header for key, ignoring case.

### Method
GET

### Endpoint
fetchRequest.getHeader(key: string)

### Parameters
#### Path Parameters
- **key** (string) - Required - The header key.

### Response
#### Success Response (200)
- **string** - The header value.
```

--------------------------------

### new SigningKey

Source: https://docs.ethers.org/v6/api/crypto

Constructor for creating a SigningKey instance from a private key.

```APIDOC
## new SigningKey(privateKey: BytesLike)

### Description
Creates a new SigningKey instance for the given private key.

### Method
Constructor

### Parameters
- **privateKey** (BytesLike) - Required - The private key bytes.

### Example
```js
new SigningKey(id("some-secret"))
```
```

--------------------------------

### Sign and verify a message with Wallet

Source: https://docs.ethers.org/v6/getting-started

Create a wallet from a private key (using id("test")), sign a message, and verify it. Signing does not require a provider. The verification returns the signer's address.

```javascript
// Our signer; Signing messages does not require a Provider
signer = new Wallet(id("test"))
// Wallet {
//   address: '0xC08B5542D177ac6686946920409741463a15dDdB',
//   provider: null
// }

message = "sign into ethers.org?"

// Signing the message
sig = await signer.signMessage(message);
// '0xefc6e1d2f21bb22b1013d05ecf1f06fd73cdcb34388111e4deec58605f3667061783be1297d8e3bee955d5b583bac7b26789b4a4c12042d59799ca75d98d23a51c'

// Validating a message; notice the address matches the signer
verifyMessage(message, sig)
// '0xC08B5542D177ac6686946920409741463a15dDdB'
```

--------------------------------

### GET /ens/resolver/lookup-address

Source: https://docs.ethers.org/v6/single-page

Resolves the primary ENS name for an address.

```APIDOC
## [GET] /ens/resolver/lookup-address

### Description
Resolves the primary ENS name for an address, optionally specifying a coin type.

### Method
GET

### Endpoint
/ens/resolver/lookup-address

### Parameters
#### Path Parameters
- **provider** (AbstractProvider) - Required - The provider.
- **address** (string) - Required - The address to look up.
- **coinType** (BigNumberish) - Optional - The coin type.

### Response
#### Success Response (200)
- **name** (null | string) - The primary ENS name or null.

#### Response Example
{
  "name": "ricmoo.eth"
}
```
Tokens:
Raw