mirror of https://github.com/getwax/bls-wallet.git synced 2026-01-10 06:17:55 -05:00

Files

Jacob Caban-Tomski 21dd23953d Update repo documentation.

Turn main repo README into landing page with relevant sub folder/component links.
Include aggregator-proxy in setup.ts.
Update aggreagator-proxy npm repo.
Clean up all component READMEs. Add more troubleshooting, removing empty sections.
Add docs folder with guides for local & remote setup, system overview, and client usage.
Add image assets for landing & system overview.

2022-06-03 15:12:09 -04:00

.vscode

Expose callback and run functions

2022-05-05 04:54:34 +00:00

manualTests

Enable async transformer

2022-05-05 07:11:02 +00:00

src

Enable async transformer

2022-05-05 07:11:02 +00:00

.gitignore

Get bodyParser working

2022-05-03 04:55:34 +00:00

.npmignore

Set up package

2022-05-05 05:02:43 +00:00

package.json

Update repo documentation.

2022-06-03 15:12:09 -04:00

README.md

Update repo documentation.

2022-06-03 15:12:09 -04:00

tsconfig.json

Set up package

2022-05-05 05:02:43 +00:00

yarn.lock

polyfill fetch, fix post->get

2022-05-05 04:13:04 +00:00

README.md

Aggregator Proxy

This package makes it easy to provide an aggregator by proxying another. The primary use-case is to expose a free aggregator based on one that requires payment by augmenting the bundles with transactions that pay tx.origin.

Setup

npm install bls-wallet-aggregator-proxy
yarn install bls-wallet-aggregator-proxy

Usage

import {
  runAggregatorProxy,

  // AggregatorProxyCallback,
  // ^ Alternatively, for manual control, import AggregatorProxyCallback to
  // just generate the req,res callback for use with http.createServer
} from 'bls-wallet-aggregator-proxy';

runAggregatorProxy(
  'https://arbitrum-testnet.blswallet.org',
  async bundle => {
    console.log('proxying bundle', JSON.stringify(bundle, null, 2));

    // Return a different/augmented bundle to send to the upstream aggregator
    return bundle;
  },
  8080,
  '0.0.0.0',
  () => {
    console.log('Proxying aggregator on port 8080');
  },
);