The FordefiWeb3Provider class implements EIP-1193 powered by the Fordefi API. It provides a request() function to execute JSON-RPC methods and emits the relevant events.

See full documentation.

Installation

Use yarn or npm to install the package.

yarn add @fordefi/web3-provider

npm add --save @fordefi/web3-provider

Usage

Create a provider

Each instance manages a single address (vault) on a specific chain.

import { FordefiWeb3Provider, FordefiProviderConfig } from "@fordefi/web3-provider";

const config: FordefiProviderConfig = {
  chainId: 11155111,
  address: "0x1234567890123456789012345678901234567890",
  apiUserToken: process.env.FORDEFI_API_USER_TOKEN,
  apiPayloadSignKey: process.env.FORDEFI_API_PAYLOAD_SIGNING_KEY,
};

const provider = new FordefiWeb3Provider(config)

See the reference for a full description of the available configuration options.

Connect

The spec requires a provider to be connected to submit requests.

This provider automatically connects to Fordefi when a new instance is constructed, and emits a connect event once communication with the Fordefi platform has been established.

To subscribe to the event:

// callback to act upon a `connect` event
const onConnect = ({ chainId }: ProviderConnectInfo) => {
  console.log(`Connected to chain ${chainId}`);
}

// option 1: subscribe using a callback
provider.on('connect', onConnect);

// option 2: wait for a promise to be resolved
const result = await provider.waitForEmittedEvent('connect');
onConnect(result);
// or
provider
  .waitForEmittedEvent('connect')
  .then(onConnect);

For more information, see Events.

Submit JSON-RPC Requests

The request({ method, params }) method sends JSON-RPC requests to the provider. It returns a promise that resolves to the result of the request.

All methods related to creating and/or signing transactions will resolve once the transaction was successfully signed by an API Signer.

An example of sending a transaction:

const txHash = await provider.request({
  method: 'eth_sendTransaction',
  params: [{
    from: '0x1234567890123456789012345678901234567890',
    to: '0x1234567890123456789012345678901234567890',
    value: 1_500_000_000_000n,
  }],
});

console.log(`Transaction hash: ${txHash}`);