Interface FordefiProviderConfig

Configuration for constructing a provider instance.

Each instance manages a single address in a single chain.

interface FordefiProviderConfig {
    chainId: string | number;
    address: `0x${string}`;
    apiUserToken: string;
    apiPayloadSignKey: string;
    rpcUrl?: string;
    apiBaseUrl?: string;
    skipPrediction?: boolean;
    timeoutDurationMs?: number;
    pollingIntervalMs?: number;
}

Properties

chainId address apiUserToken apiPayloadSignKey rpcUrl? apiBaseUrl? skipPrediction? timeoutDurationMs? pollingIntervalMs?

Properties

chainId

chainId: string | number

Chain ID as a number or a named chain.

For example, assuming Ethereum Sepolia chain:

  • Numeric value: 11155111.
  • Named chain: 'evm_ethereum_sepolia'.

address

address: `0x${string}`

EVM address of a Fordefi vault.

For example: '0x1234567890123456789012345678901234567890'.

apiUserToken

apiUserToken: string

Fordefi API user token (base64 encoded) issued via the Fordefi Web Console.

For example: 'eyJWthEAdEr.eyJwTPaYLoad.SiGNAtUrEBase64=='

apiPayloadSignKey

apiPayloadSignKey: string

Private key in PEM format used to sign the body of requests sent to the Fordefi API. This is the content of the private .pem file. See Create a public/private signature key pair for the API client.

Example of a private ECDSA .pem file:

-----BEGIN EC PRIVATE KEY-----
PrivateKeyBase64==
-----END EC PRIVATE KEY-----

Optional rpcUrl

rpcUrl?: string

Fallback JSON-RPC HTTP node URL. Methods not implemented by this provider will pass through and be handled by this node.

For example: 'https://rpc.sepolia.org'.

Optional apiBaseUrl

apiBaseUrl?: string

Fordefi API base URL (used for development). Defaults to production API URL.

For example: 'https://api.fordefi.com'.

Optional skipPrediction

skipPrediction?: boolean

Whether to skip running a simulation before creating a new transaction, it blocks transaction creation if it fails. Defaults to true.

Optional timeoutDurationMs

timeoutDurationMs?: number

Total duration in ms of polling for transaction lifecycle status changed after a transaction was submitted. By default, it would stop after 24 hours.

Optional pollingIntervalMs

pollingIntervalMs?: number

Duration in ms between checks for transaction lifecycle status updates after a transaction was submitted. The minimum value is 500, and by default it's 5000.

Settings

Member Visibility

Theme

On This Page

chainIdaddressapiUserTokenapiPayloadSignKeyrpcUrlapiBaseUrlskipPredictiontimeoutDurationMspollingIntervalMs