Create plugin developers Guide for Middleware implementation:
Types of Middleware:
1 - Request Middleware: can be use to modify request before sent to RPC node by web3.js and/or modify response before returning back to web3.js, steps:

Middleware Interface and methods specs:

web3.js/packages/web3-core/src/types.ts

Line 39 in 9afaa61

export interface RequestManagerMiddleware<API> {

( examples are linked in following steps)
A. Implement middleware.
B. Create its instance based on your logic in plugin
C. set middleware in link method
Once its set , any JSON RPC request from all web3 packages will go through this middleware

2- Transaction Middleware: ( works for Eth and Contracts package )
steps:

Middleware Interface and methods specs:

web3.js/packages/web3-eth/src/types.ts

Line 100 in 9afaa61

export interface TransactionMiddleware{

A. Example implementation
B. Create Instance in plugin example
C. Set Transaction middleware example
Once its set , web3 will call Transaction middleware before signing transaction.

Some code snippets in tests:
Requests middleware:

web3.js/tools/web3-plugin-example/test/unit/request_manager_middleware.test.ts

Line 24 in 9afaa61

const web3 = new Web3('http://127.0.0.1:8545');

Eth Transaction middleware:

web3.js/tools/web3-plugin-example/test/unit/transaction_middleware.test.ts

Line 26 in 9afaa61

const web3 = new Web3('http://127.0.0.1:8545');

Contract Transaction middleware:

web3.js/tools/web3-plugin-example/test/unit/contract_transaction_middleware.test.ts

Line 30 in 9afaa61

const plugin: TransactionMiddlewarePlugin = new TransactionMiddlewarePlugin();

Middleware documentation / Guide #6963

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions