polymer-ethers v1.0.1

Polymer Ethers Plugin

A plugin for Ethers.js v6 that adds Polymer proof capabilities, allowing you to request proofs for transactions across different blockchains.

Overview

The Polymer Ethers Plugin extends Ethers.js with the ability to generate proofs from the Polymer Prove API for transactions. These proofs can be used to verify the existence and validity of transaction events across different blockchains, enabling secure cross-chain communication.

What is Polymer?

Polymer makes cross-rollup interoperability fast and easy for application builders. Find out more at Polymer Labs.

Installation

npm install polymer-ethers ethers

Usage

Standalone API Usage

const { ethers } = require("ethers");
const { addPolymerToEthers } = require("polymer-ethers");

// Initialize the plugin with your API key
addPolymerToEthers(ethers, {
  apiKey: process.env.POLYMER_API_KEY,
});

// Request a proof for a specific block, transaction, and log
const proof = await ethers.polymer.requestProof({
  srcChainId: 11155420, // Optimism Sepolia
  srcBlockNumber: 123456,
  txIndex: 0,
  logIndex: 0, // The index of the log to generate a proof for, or
  eventSignature: "Transfer(address,address,uint256)", // The event signature to generate a proof for
});

console.log("Proof:", proof);

With Transaction Receipt

const { ethers } = require("ethers");
const { addPolymerToEthers } = require("polymer-ethers");

// Initialize the plugin with your API key
addPolymerToEthers(ethers, {
  apiKey: process.env.POLYMER_API_KEY,
});

// Load a transaction receipt (in this example, we use a known good receipt from Optimism Sepolia)
const receipt = await ethers.provider.getTransactionReceipt(
  "0x5138b0d6ffe7bfe8f1d7dca24d396dab804fa664930ef96bb9e6ebbc86426fbb"
);

// Option 1: Generate proof using logIndex
const { jobId } = await receipt.polymerProof({
  logIndex: 1, // The index of the log to generate a proof for
  returnJob: true, // Return the job ID instead of waiting for the proof
});

// Option 2: Generate proof using eventSignature (automatically finds the log index)
const { jobId } = await receipt.polymerProof({
  eventSignature: "ValueSet(address,string,bytes,uint256,bytes32,uint256)", // The event signature to generate a proof for
  returnJob: true, // Return the job ID instead of waiting for the proof
});

// Wait for the proof to be generated
const proofResult = await ethers.polymer.wait(jobId);
console.log("Proof:", proofResult);

API Reference

Plugin Configuration

When initializing the plugin, you can provide the following configuration options:

addPolymerToEthers(ethers, {
  apiKey: "YOUR_API_KEY", // Required
  apiUrl: "POLYMER_API_URL", // Optional, defaults to Polymer testnet
  maxAttempts: 20, // Optional, default: 20
  interval: 3000, // Optional, default: 3000ms
  timeout: 60000, // Optional, default: 60000ms
  debug: false, // Optional, default: false
});

Configuration Options

Methods

The plugin adds the following methods to the ethers library:

ethers.polymer.requestProof(options)

Requests a proof for a specific block, transaction, and log.

Parameters:

• options (Object):
  • srcChainId (number): The source chain ID
  • srcBlockNumber (number): The source block number
  • txIndex (number): The transaction index in the block
  • logIndex (number, optional): The log index in the transaction
  • eventSignature (string, optional): The event signature to generate a proof for (e.g., "Transfer(address,address,uint256)")
  • returnJob (boolean, optional): If true, returns the job ID without waiting

Note: Either logIndex or eventSignature must be provided.

Returns:

• Promise<{ jobId: string, proof: Object }>: A promise that resolves to the job ID and proof result

ethers.polymer.wait(jobId, maxAttempts, interval)

Waits for a proof to be generated. This method replaces the previous pollForProof method.

Parameters:

• jobId (string): The job ID from the proof request
• maxAttempts (number, optional): Maximum number of polling attempts
• interval (number, optional): Polling interval in milliseconds

Returns:

• Promise<Object>: A promise that resolves to the proof result

ethers.polymer.getProofStatus(jobId)

Checks the status of a proof generation job.

Parameters:

• jobId (string): The job ID from the proof request

Returns:

• Promise<Object>: A promise that resolves to the job status

receipt.polymerProof(options)

Requests a proof for a transaction receipt.

Parameters:

• options (Object):
  • logIndex (number, optional): The log index of the event to generate a proof for
  • eventSignature (string, optional): The event signature to generate a proof for (e.g., "Transfer(address,address,uint256)")
  • maxAttempts (number, optional): Maximum number of polling attempts
  • interval (number, optional): Polling interval in milliseconds
  • returnJob (boolean, optional): If true, returns the job ID without waiting

Note: Either eventSignature or logIndex must be provided.

Returns:

• Promise<Object>: A promise that resolves to the proof result or job ID

receipt.polymerProofStatus(jobId)

Checks the status of a proof for a transaction receipt.

Parameters:

• jobId (string): The job ID from the proof request

Returns:

• Promise<Object>: A promise that resolves to the job status

Examples

Check out the examples directory for complete working examples.

To run the example:

1. Install dependencies:

   npm install

2. Create a .env file with your Polymer API key:

   cp .env.example .env
   # Edit .env and add your Polymer API key

3. Run the example:

   npm run standalone # Standalone API
   npm run receipt # With Transaction Receipt

License

MIT