Back to packageRELEASE DETAILS

0.2.1

npm

@0xmetropolis/cli

Smart contract visualization tool.

Published11 Aug 2023

Direct dependencies34

Transitive dependenciesNot calculated

README

Current package documentation

This version of the CLI has been deprecated in favor of ✨ Metal

[deprecated] Metropolis CLI

by @0xmetropolis

Metropolis is a smart contract visualization tool.

Getting Started

Dependencies

Foundry

Installation

# with npm
npm install -g @0xmetropolis/metal

# with yarn
yarn global add @0xmetropolis/metal

Usage

Generate A Preview

In the directory of your Foundry project, run the following command:

metro preview --chain-id 1 $PATH_TO_DEPLOY_SCRIPT

NOTE: Metal wraps around forge commands, but metro preview does not send any deployment transactions.

This will compile your contracts and start a deployment simulation. Once the simulation is done, your browser will open to display the results of the simulation.

Setting the Chain Id

The --chain-id flag allows you to choose the network to preview your deployment on.

Testing

Getting Help

If you run into problems or find a bug, consider opening an issue.

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 34

Native requirements

34 direct targetsNot calculated transitive count

Package / target	Requirement	Relationship
toml Environment { "local_name": "toml", "alias": false, "peer_metadata": null }	`^3.0.0`	runtime
chalk Environment { "local_name": "chalk", "alias": false, "peer_metadata": null }	`^2.0.1`	runtime
yargs Environment { "local_name": "yargs", "alias": false, "peer_metadata": null }	`^17.7.2`	runtime
node-emoji Environment { "local_name": "node-emoji", "alias": false, "peer_metadata": null }	`^1.7.0`	runtime
node-fetch Environment { "local_name": "node-fetch", "alias": false, "peer_metadata": null }	`^2.6.12`	runtime
jest Environment { "local_name": "jest", "alias": false, "peer_metadata": null }	`^29.6.2`	development
test Environment { "local_name": "test", "alias": false, "peer_metadata": null }	`^0.6.0`	development
husky Environment { "local_name": "husky", "alias": false, "peer_metadata": null }	`^0.14.3`	development
eslint Environment { "local_name": "eslint", "alias": false, "peer_metadata": null }	`^8.46.0`	development
ts-jest Environment { "local_name": "ts-jest", "alias": false, "peer_metadata": null }	`^29.1.1`	development
ts-node Environment { "local_name": "ts-node", "alias": false, "peer_metadata": null }	`^10.9.1`	development
inquirer Environment { "local_name": "inquirer", "alias": false, "peer_metadata": null }	`^3.2.0`	development
prettier Environment { "local_name": "prettier", "alias": false, "peer_metadata": null }	`^2.8.8`	development
bdd-stdin Environment { "local_name": "bdd-stdin", "alias": false, "peer_metadata": null }	`^0.2.0`	development
supertest Environment { "local_name": "supertest", "alias": false, "peer_metadata": null }	`^6.3.3`	development
typescript Environment { "local_name": "typescript", "alias": false, "peer_metadata": null }	`^5.1.6`	development
@types/cors Environment { "local_name": "@types/cors", "alias": false, "peer_metadata": null }	`^2.8.13`	development
@types/jest Environment { "local_name": "@types/jest", "alias": false, "peer_metadata": null }	`^29.5.3`	development
@types/node Environment { "local_name": "@types/node", "alias": false, "peer_metadata": null }	`^18.17.3`	development
lint-staged Environment { "local_name": "lint-staged", "alias": false, "peer_metadata": null }	`^4.0.2`	development
ts-node-dev Environment { "local_name": "ts-node-dev", "alias": false, "peer_metadata": null }	`^2.0.0`	development
@types/chalk Environment { "local_name": "@types/chalk", "alias": false, "peer_metadata": null }	`^0.4.31`	development
@types/yargs Environment { "local_name": "@types/yargs", "alias": false, "peer_metadata": null }	`^8.0.1`	development
babel-eslint Environment { "local_name": "babel-eslint", "alias": false, "peer_metadata": null }	`^7.2.3`	development
@types/inquirer Environment { "local_name": "@types/inquirer", "alias": false, "peer_metadata": null }	`^0.0.35`	development
@types/supertest Environment { "local_name": "@types/supertest", "alias": false, "peer_metadata": null }	`^2.0.12`	development
@types/node-emoji Environment { "local_name": "@types/node-emoji", "alias": false, "peer_metadata": null }	`^1.4.0`	development
@types/node-fetch Environment { "local_name": "@types/node-fetch", "alias": false, "peer_metadata": null }	`^2.6.4`	development
eslint-config-buildo Environment { "local_name": "eslint-config-buildo", "alias": false, "peer_metadata": null }	`^0.2.2`	development
eslint-config-prettier Environment { "local_name": "eslint-config-prettier", "alias": false, "peer_metadata": null }	`^8.10.0`	development
eslint-plugin-prettier Environment { "local_name": "eslint-plugin-prettier", "alias": false, "peer_metadata": null }	`^4.2.1`	development
typescript-eslint-parser Environment { "local_name": "typescript-eslint-parser", "alias": false, "peer_metadata": null }	`^4.0.0`	development
@typescript-eslint/parser Environment { "local_name": "@typescript-eslint/parser", "alias": false, "peer_metadata": null }	`^5.60.1`	development
@typescript-eslint/eslint-plugin Environment { "local_name": "@typescript-eslint/eslint-plugin", "alias": false, "peer_metadata": null }	`^5.62.0`	development

Distribution files

1 collected

Distribution 1

Source distribution

Source file

Checksums from source

{
  "shasum": "88231766cd8c4e9ca82c82cb486f7b05c04d5251",
  "tarball": "https://registry.npmjs.org/@0xmetropolis/cli/-/cli-0.2.1.tgz",
  "fileCount": 47,
  "integrity": "sha512-2avRS8+aP0vM7vqmozo9jCW7jNc1su/C+8KtZArFnQQ4MU40kvpgCqbRpGVwx9J1Q3gfbO36XMtZda18xb/vfQ==",
  "signatures": [
    {
      "sig": "MEQCIAqUhTiN+C5V5Ne+Lq86R4u9d39EDIZQClnJ/mYJ+46WAiA1UiEPBitu2b8KGaw3BT0GdExvVKLP2DIUWunr77rmGQ==",
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"
    }
  ],
  "unpackedSize": 113840
}