@sovereign-sdk/web3

A TypeScript client library for interacting with Sovereign SDK rollups.

Installation

npm install @sovereign-sdk/web3

Features

• 🔄 Type-safe transaction submission and signing
• 🔍 Runtime call simulation for gas estimation
• 📦 Borsh serialization with schema validation
• 🎯 Strongly typed rollup interactions with customizable type specifications
• 🌐 Full access to ledger, sequencer, and rollup APIs

Usage

Basic Setup

import { StandardRollup } from "@sovereign-sdk/web3";
import { newMetaMaskSnapSigner } from "@sovereign-sdk/signers";

// Initialize the rollup client
const rollup = new StandardRollup({
  url: "https://your-rollup-node.com",
  defaultTxDetails: {
    max_priority_fee_bips: 0,
    max_fee: 1000000,
    gas_limit: null,
    chain_id: 4321,
  },
});

// Initialize a signer
const signer = newMetaMaskSnapSigner({
  curve: "ed25519",
  schema: yourSchema,
  snapId: "npm:@sovereign-sdk/metamask-snap",
});

Submitting Transactions

// Submit a transaction
// Sends a `ValueSetter` call message of `SetValue` type.
// This particular call message has `value` and `gas` fields.
const result = await rollup.call(
  {
    value_setter: {
      set_value: {
        value: 100,
        gas: null,
      },
    },
  },
  { signer }
);

Type Safety

type MyRollupTypes = RollupTypeSpec<{
  RuntimeCall: {
    value_setter: {
      set_value: {
        value: number;
        gas: number[] | null;
      };
    };
  };
  // Add other type specifications as needed
}>;

const typedRollup = new StandardRollup<MyRollupTypes>({
  // ... config
});

// Now your calls will be type-checked!
const result = await typedRollup.call(
  {
    value_setter: {
      set_value: 100, // Type checked and automatically serialized to Borsh bytes
    },
  },
  { signer }
);

Simulation

// Simulate a call to estimate gas
const simulation = await rollup.simulate(
  {
    value_setter: {
      set_value: 100,
    },
  },
  {
    signer,
    txDetails: {
      max_priority_fee_bips: 1000,
      max_fee: 1000000,
      chain_id: 1,
    },
  }
);

API Reference

The package exports the following main components:

• StandardRollup: The main client class for interacting with rollups
• RollupTypeSpec: Type utility for creating type-safe rollup interactions
• createSerializer: Function to create a Borsh serializer for your rollup schema

For detailed API documentation, please refer to the inline TypeScript documentation in the source code.