Gateway examples

This repository contains a number of examples that utilise our @unruggable/gateways package to demonstrate the functionality of our gateway codebase.

We recommend interested users take a look through our extensive Gateway documentation to supplement the code within this repo.

Prerequisites

Before running the examples you must clone the repo:

git clone https://github.com/unruggable-labs/unruggable-gateways-examples.git

install the dependencies using:

bun install

and set SEPOLIA_PROVIDER_URL in .env:

SEPOLIA_PROVIDER_URL=https://eth.public-rpc.com

Running the examples

You can run an example using the following syntax:

bun run examples/EXAMPLE_FILENAME.ts

For example:

bun run examples/6-keccak-of-concat-as-key-with-debug.ts

Troubleshooting

These examples use a verifier deployed on Ethereum Sepolia. We utilse a public RPC defined in .env.

If there are RPC issues you can set up a free account at a service like Alchemy, Ankr, or Infura and set the SEPOLIA_PROVIDER_URL variable in .env.