A Web3 JSON-RPC provider gateway that handles accounts on its own using Ethers.js, or other SDKs, but delegates chain queries to a 3rd party "destination provider", e.g. Infura, Cloudflare, Conflux, BOBA-L2, etc.
yarn buildThis repository is released automatically in DockerHub and npm using GitHub actions when a new release is detected in the repository. To release:
node dist/bin/ethers/infuraRequired environment variables:
W3GW_PORT: listening port for the server. Can also be passed from command-line as first parameter.W3GW_NETWORK: network name. Infura supports: mainnet, ropsten, rinkeby, kovan and goerli.W3GW_SEED_PHRASE: the seed phrase to use for the server's own wrapped wallet, in BIP-39 mnemonics format.W3GW_PROVIDER_KEY: your Infura project ID.Optional environment variables:
EVM_CALL_INTERLEAVE_BLOCKS: number of blocks before latest knwon upon which EVM read-only calls will be bound to; this variable defaults to zero.INFURA_GAS_LIMIT: default gas limit, if not specified by the client; or maximum gas limit threshold if either estimated by the provider, or provided by the client.INFURA_GAS_PRICE: default gas price, if not specified by the client; or maximum gas price threshold if either estimated by the provider, or provided by the client.INFURA_GAS_PRICE_FACTOR: multiplier applied to gas prices estimated by provider.W3GW_LOG_LEVEL: max log level to be traced, can be any of the following: error, warn, info, http, verbose, debug, silly. If not specified, verbose will apply.W3GW_SEED_PHRASE_WALLETS: number of wallet addresses to be handled by the gateway, derived from path 'm/44'/60'/0'/0/*'.node ./dist/bin/confluxRequired environment variables:
W3GW_PROVIDER_URL: actual URL of the Web3 JSON-RPC provider. Can also be passed from command-line as a first parameter.W3GW_PORT: listening port for the server. Can also be passed from command-line as a second parameter.W3GW_NETWORK: network id. Conflux providers currently supports: 1 for testnet, and 1029 for mainnet.W3GW_PRIVATE_KEYS: array of private keys to be used for signing transactions.Optional environment variables:
CONFLUX_DEFAULT_EPOCH_LABEL: default epoch label to be used on read-only RPC calls, if none is specified by the caller; this variable will default to "latest_finalized" if none is set.CONFLUX_ESTIMATE_GAS_PRICE: if set to true, the provider will be asked to estimate the gas price, before signing the transaction; if the provider-estimated gas price is greater than CONFLUX_GAS_PRICE, the transaction will be rejected by the gateway.CONFLUX_GAS_LIMIT: default gas limit to be used before signing a transaction, if not specified by the caller.CONFLUX_GAS_PRICE: default gas price to be used before signing a transaction, if not specified by the caller.EVM_CALL_INTERLEAVE_BLOCKS: number of epochs before current epoch number upon which EVM read-only calls will be bound to; this variable defaults to zero.W3GW_LOG_LEVEL: max log level to be traced, can be any of the following: error, warn, info, http, verbose, debug, silly. If not specified, verbose will apply.node ./dist/bin/reefRequired environment variables:
W3GW_PROVIDER_URL: actual URL of the Web3 JSON-RPC provider. Can also be passed from command-line as a first parameter.REEF_GRAPHQL_URL: the GraphQL endpoint serving EVM's data. Can also be passed from command-line as a second parameter.W3GW_PORT: listening port for the server. Can also be passed from command-line as a third parameter.W3GW_SEED_PHRASE: seed phrase to be used with either Infura or Ethers.js providers.Optional environment variables:
W3GW_LOG_LEVEL: max log level to be traced, can be any of the following: error, warn, info, http, verbose, debug, silly. If not specified, verbose will apply.W3GW_SEED_PHRASE_WALLETS: number of EVM wallet addresses to be handled by the gateway. EVM addresses will be default ones attached to respective Reef addresses. First Reef address will be derived from '${W3GW_SEED_PHRASE}', while the following one from '${W3GW_SEED_PHRASE}//${j}' (with j > 0).node ./dist/bin/ethersGeneric destination providers need to comply with the JsonRpcProvider type from the Ethers.js library:
Required environment variables:
W3GW_PORT: listening port for the server. Can also be passed from command-line as a second parameter.W3GW_SEED_PHRASE: the seed phrase to use for the server's own wrapped wallet, in BIP-39 mnemonics format.W3GW_PROVIDER_URL: actual URL of the Web3 JSON-RPC provider. Can also be passed from command-line as a first parameter.Optional environment variables:
W3GW_NETWORK: the network name to connect with.W3GW_SEED_PHRASE_WALLETS: number of wallet addresses to be handled by the gateway, derived from path 'm/44'/60'/0'/0/*'.W3GW_LOG_LEVEL: max log level to be traced, can be any of the following: error, warn, info, http, verbose, debug, silly. If not specified, verbose will apply.ETHERS_ALWAYS_SYNCED: if set to true, the gateway will intercept calls to eth_syncing as to return false in all cases.ETHERS_ESTIMATE_GAS_LIMIT: if set to true, the provider will be asked to estimate the gas limit, before signing the transaction; if the provider-estimated gas limit is greater than ETHERS_GAS_LIMIT, the transaction will be rejected by the gateway.ETHERS_ESTIMATE_GAS_PRICE: if set to true, the provider will be asked to estimate the gas price, before signing the transaction; if the provider-estimated gas price is greater than ETHERS_GAS_PRICE, the transaction will be rejected by the gateway.ETHERS_GAS_LIMIT: default gas limit, if not specified by the client; or maximum gas limit threshold if either estimated by the provider, or provided by the client.ETHERS_GAS_PRICE: default gas price, if not specified by the client; or maximum gas price threshold if either estimated by the provider, or provided by the client.ETHERS_GAS_PRICE_FACTOR: multiplier applied to estimated gas price, if ETHERS_ESTIMATE_GAS_PRICE is true.ETHERS_MOCK_FILTERS: makes eth_getFilterChanges to always return latest known block.EVM_CALL_INTERLEAVE_BLOCKS: number of blocks before latest knwon upon which EVM read-only calls will be bound to; this variable defaults to zero.There are several package scripts at your disposal for you to launch specific gateways to multiple WEB3-compatible blockchains, and different possible networks within them.
Important: In order to these batch scripts to work properly, please rename .env_batch_example to .env, and fulfill the following parameters:
EVM_CALL_INTERLEAVE_BLOCKS: number of blocks before latest knwon upon which EVM read-only calls will be bound to; this variable defaults to zero.W3GW_PROVIDER_KEY: your Infura's project id to be used with Infura-connected servers.W3GW_LOG_LEVEL: max log level to be traced, can be any of the following: error, warn, info, http, verbose, debug, silly. If not specified, verbose will apply.W3GW_PRIVATE_KEYS: array of private keys to be used by Conflux and Celo -alike providers.W3GW_SEED_PHRASE: seed phrase to be used with either Infura or Ethers.js providers.npm run ethereum:rinkebynpm run ethereum:goerlinpm run ethereum:kovannpm run ethereum:ropstennpm run ethereum:mainnetnpm run boba:rinkebynpm run boba:mainnetnpm run celo:alfajoresnpm run celo:mainnetnpm run conflux:testnetnpm run conflux:mainnetnpm run harmony:testnet#0npm run kcc:testnetnpm run metis:rinkebynpm run polygon:goerlinpm run reef:testnetTo integrate with a different provider, you can create your own script that creates the provider and then build a server around it. Please, have a look to provided examples in src/bin/**.