DevelopersNode OperatorsMiners
Developers
Introduction
Cross-Chain Token Transfer
Introduction
Interchain Tokens
IntroductionCreate TokenUpgrade TokenInterchain Token ExecutableRate Limit
Developer Guides
Programmatically Create a TokenProgrammatically Create a Canonical TokenLink Custom Tokens Into Interchain Tokens
GlossaryRoadmap
General Message Passing
IntroductionExamplesSend MessagesSend Messages with TokensMonitor Transaction StateQuantum Portal ExecutableVerify GMP Transaction
Debug
Error MessagesDebug a Smart ContractFork Mainnet for Local TestingTransaction Recovery
Developer Guides
Cross-Chain Swaps with CCTPHello World GMP Example
Express Service
Quantum Portal SDK
IntroductionToken Transfer via Deposit AddressGMP Transaction Status and RecoveryQuantum Portal Query API
Indexers
IntroductionSubQuery
Chain and Contract Reference
Mainnet Chain NamesMainnet Contract AddressesTestnet Chain NamesTestnet Contract Addresses
QP DevToolsExamples
Contract and SDK reference
InterchainTokenServiceInterchainTokenFactoryTokenManagerQPGateway QPGasServiceQPExecutableQPJS SDK
Resources
Contract addresses
MainnetTestnet
RPCs
Ferrum Network
QP Explorer
How to use QP explorer
Bug Bounty

Forking mainnet for local testing

For development and debugging purposes, it is often useful to be able to fork preexisting chains. This can easily be done using ganache. You can simply install QP-local-dev by typing npm i @QP-network/QP-local-dev and writing a simple script:

const { forkAndExport } = '@QP-network/QP-local-dev';
forkAndExport();

This will clone mainnet by default and export local RPC endpoints at http:/localhost:8500/n with n staring from 0.

Aditional Options

forkAndExport can take an object of type CloneLocalOptions that can specify:

  • chainOutputPath: a path to save a JSON file with all the information for the chains that are set up. Defaults to ./local.json.
  • accountsToFund: a list of addresses to fund.
  • fundAmount: a string representing the amount of ether to fund accounts with. Defaults to 100 ETH.
  • env: a string whose value is either mainnet or testnet, or an array of ChainCloneData. See the repo for details.
  • chains: now acts as a filter for which chains to fork. Defaults to all the chains.
  • relayInterval: amount of time between relay of events in miliseconds. Defaults to 2000.
  • port: port to listen to. Defaults to 8500.
  • afterRelay: a function (relayData: RelayData) => void that will be called after each relay. Mainly to be used for debugging.
  • callback: a function (network: Network, info: any) => Promise<null> that will be called right after setting up each network. Use this to set up additional features, like deploying additional contracts or funding accounts.
  • networkInfo: the NetworkInfo which overwrites the default parameters. See the repo for details.

Usage

After creating the desired fork, you have access to RPCs (look into the JSON file saved) to them. You can update MetaMask (or any other wallet) to these RPCs and access any dApp online, and everything will happen in the local fork instead of the actual network. All Quantum Portal functionality will happen more quickly (2s by default), and you can get debigging capabilites via the afterRelay option. Make sure you change MetaMask’s RPCs back to the endpoints you trust, to go back to using actual mainnet/testnet.

Forking requires the use of RPCs to the actual networks being forked. For mainnet and testnet some RPCs are provided as part of QP-local-dev, but we cannot guarantee that they will all work in the future. If you want, you can either tweak them in ./node_modules/@QP-network/QP-local-dev/info/ or provide an env variable that specifies your own RPCs. You can also copy the files in the info directory, alter them, load them and pass either of them as the env variable.

Edit this page