moonbeam-tools
Advanced tools
Tools related to Moonbeam blockchains.
Installation: npm install
Test: bun run test
Build: bun run build
Publish: bun publish
You can use DEBUG=helper:* for logs on the state manipation
Allows to monitor a Moonbeam network. To do so, run the following command:
bunx moonbeam-tools --networks moonbeam moonriver
Options:
--help Show help [boolean]
--version Show version number [boolean]
--url WebSocket url [string]
--networks Known networks
[array] [choices: "stagenet", "alphanet", "moonsama", "moonsilver",
"moonriver"]
--finalized listen to finalized only [boolean] [default: false]
<!DOCTYPE html>
<html>
<head>
<title>Monitoring</title>
<link rel="modulepreload" href="https://unpkg.com/moonbeam-tools@0.1.2/dist/index.esm.js" charset="UTF-8" integrity="sha384-YQ+IMhoNgwPmfCEeD4eY1O7I2Tyr/Ebtk6dENIlj+eY4Kf2iTbE8amYdW3NUH/kS" crossorigin="anonymous"></script>
<style>
body {
padding: 2rem;
}
pre {
margin: 0;
}
</style>
</head>
<body>
<div id="main-alphanet"></div>
<div id="main-moonriver"></div>
<div id="main-moonbeam"></div>
<script type="module">
import * as mbTools from "https://unpkg.com/moonbeam-tools@0.1.2/dist/index.esm.js";
const monitorNetwork = async (api, networkName) => {
const pre = document.createElement("pre");
const title = document.createElement("h2");
title.append(networkName);
const main = document.getElementById(`main-${networkName}`);
main.appendChild(title);
main.appendChild(pre);
let previousBlockDetails = null;
mbTools.listenBlocks(api, false, async (blockDetails) => {
const line = `${mbTools.generateBlockDetailsLog(
blockDetails,
{},
previousBlockDetails
)}\n`;
pre.prepend(line);
previousBlockDetails = blockDetails;
});
return api;
};
const start = async () => {
const api = await mbTools.getApiFor({ network: "moonriver" });
// You can also directly to the node using url
// const api = await mbTools.getApiFor({ url: "ws://127.0.0.1:9944" });
const networkName =
mbTools.NETWORK_CHAIN_MAPPING[
(await api.rpc.system.chain()).toString()
];
monitorNetwork(api, networkName);
};
start();
</script>
</body>
</html>
The script run-moonbeam-fork.ts has been provided which allows you to fork the live state of the network and run them locally.
The simplest way to run a forked-network of Moonbeam is by calling:
bun run fork
Which will grab the latest polkadot and moonbeam binaries, grab the latest snapshot of live state, modify some values (such as validator keys, and inject balances), and run it as a new local network. From here you can perform any interaction as if it was the real state, such as runtime upgrades, interactions on deployed contracts, staking operations etc.
If however, you are more interested in intereacting with the contracts in the Moonbeam emulated EVM environment, but not so much parachain staking or XCM, you can run the forked network in development mode. This allows for manual sealing of blocks which dramatically reduces execution times of tests (reduction of 12s blocktime into milliseconds).
bun ./src/tools/run-moonbeam-fork.ts -n moonbeam --dev
Calling the script directly can be done via: bun ./src/tools/run-moonbeam-fork.ts
The minimal command is: bun ./src/tools/run-moonbeam-fork.ts -n moonbeam
By default the polkadot and moonbeam binaries will be downloaded from github if none found in the binaries folder, but if for whatever reason you need to provide your own (e.g. you are on an Apple Silicon chip)
use the --polkadot-binary option to provide the path to the binary to use (or copy them into the folder). If doing this option, make sure the correct binary version is supplied via --moonbeam-version and
--polkadot-version respectively, otherwise the script will still attempt to download the latest.
:information_source: When running the node in manual-seal mode, to create a block you can run the following curl command:
curl --location --request POST 'http://127.0.0.1:9933/' \
--header 'Content-Type: application/json' \
--data-raw '{
"jsonrpc":"2.0",
"id" :1,
"method" :"engine_createBlock",
"params" :[true,true]
}'
The full list of options can be found in the --help :
Options:
--help Show help [boolean]
--version Show version number [boolean]
-n, --network Network to retrieve the exported state for.
[string] [required]
-l, --latest Verifies if a more recent state snapshot is able to
download. [boolean] [default: false]
-r, --reset-to-genesis Resets the network back to the initial state at
genesis block. [boolean] [default: false]
-k, --purge-all Removes ALL files at the base-path directory, use with
CAUTION. [boolean] [default: false]
-s, --sealing Specify block sealing strategy for the forked chain
when running a development node (i.e. only works with
--dev/-d). [string] [default: "manual"]
-g, --regenerate Creates a new genesis file based on state
manipulators. [boolean] [default: false]
-d, --dev Runs network as a single manual-sealed development
node. [boolean] [default: false]
-t, --ephemeral Closes network immediately after it has completed
setup, used for CI. [boolean] [default: false]
-m, --moonbeam-binary Absolute file path (e.g. /tmp/fork-chain/moonbeam) of
moonbeam binary OR version number (e.g. 0.31) to
download. [string] [default: "latest"]
-p, --polkadot-binary Absolute file path (e.g. /tmp/fork-chain/polkadot) of
polkadot binary OR version number (e.g. 0.9.28) to
download. [string] [default: "latest"]
-o, --base-path Specifies where all generated files are to be stored.
[string] [default: "/tmp/fork-data/"]
Each precompile on-chain should contain some dummy code to allow Smart Contracts checking code before calling it to be able to call them.
Verify currently existing precompiles
bun src/tools/list-precompiles.ts --network moonbeam
would output something like:
To update the dummy code, you can use the PrecompileRegistry with a funded account:
bun src/tools/list-precompiles.ts --network moonbeam --update-dummy-code --private-key $PRIVATE_KEY
This will update each missing precompile (or you can use --address 9 to upgrade only contract at address 9)
FAQs
Set of tools for Moonbeam blockchain
The npm package moonbeam-tools receives a total of 16 weekly downloads. As such, moonbeam-tools popularity was classified as not popular.
We found that moonbeam-tools demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.