PkgFoundry
Catalog npm
Back to packageRELEASE DETAILS

0.5.0

npm

@0xmetropolis/metal

Smart contract visualization tool.

Published28 Sept 2023
Direct dependencies36
Transitive dependenciesNot calculated

README

Current package documentation

Metal CLI

by @0xmetropolis

Metal is a smart contract visualization tool. This repo contains the CLI for Metal.

Getting Started

Dependencies

Installation

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

# with yarn
yarn global add @0xmetropolis/metal

Development

The first time you set up metal for local development, you will need to run a setup script via:

yarn run dev

Whenever adding new features to metal, it can be helpful to auto-recompile the app:

yarn watch

In a new terminal, you can then issue commands to your local metal repo with the mdev command:

mdev help

Usage

Generate A Preview

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

metal preview --chain-id 1 $PATH_TO_DEPLOY_SCRIPT

NOTE: Metal wraps around forge commands, but metal 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

Integration Tests 🌁

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 36

Native requirements
36 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
jose
Environment
{
  "local_name": "jose",
  "alias": false,
  "peer_metadata": null
}
^4.14.6runtime
toml
Environment
{
  "local_name": "toml",
  "alias": false,
  "peer_metadata": null
}
^3.0.0runtime
chalk
Environment
{
  "local_name": "chalk",
  "alias": false,
  "peer_metadata": null
}
^2.0.1runtime
yargs
Environment
{
  "local_name": "yargs",
  "alias": false,
  "peer_metadata": null
}
^17.7.2runtime
inquirer
Environment
{
  "local_name": "inquirer",
  "alias": false,
  "peer_metadata": null
}
^8.0.0runtime
node-emoji
Environment
{
  "local_name": "node-emoji",
  "alias": false,
  "peer_metadata": null
}
^1.7.0runtime
node-fetch
Environment
{
  "local_name": "node-fetch",
  "alias": false,
  "peer_metadata": null
}
^2.6.12runtime
inquirer-file-tree-selection-prompt
Environment
{
  "local_name": "inquirer-file-tree-selection-prompt",
  "alias": false,
  "peer_metadata": null
}
^1runtime
jest
Environment
{
  "local_name": "jest",
  "alias": false,
  "peer_metadata": null
}
^29.6.2development
test
Environment
{
  "local_name": "test",
  "alias": false,
  "peer_metadata": null
}
^0.6.0development
husky
Environment
{
  "local_name": "husky",
  "alias": false,
  "peer_metadata": null
}
^0.14.3development
eslint
Environment
{
  "local_name": "eslint",
  "alias": false,
  "peer_metadata": null
}
^8.47.0development
ts-jest
Environment
{
  "local_name": "ts-jest",
  "alias": false,
  "peer_metadata": null
}
^29.1.1development
ts-node
Environment
{
  "local_name": "ts-node",
  "alias": false,
  "peer_metadata": null
}
^10.9.1development
prettier
Environment
{
  "local_name": "prettier",
  "alias": false,
  "peer_metadata": null
}
^2.8.8development
bdd-stdin
Environment
{
  "local_name": "bdd-stdin",
  "alias": false,
  "peer_metadata": null
}
^0.2.0development
supertest
Environment
{
  "local_name": "supertest",
  "alias": false,
  "peer_metadata": null
}
^6.3.3development
typescript
Environment
{
  "local_name": "typescript",
  "alias": false,
  "peer_metadata": null
}
^5.1.6development
@types/cors
Environment
{
  "local_name": "@types/cors",
  "alias": false,
  "peer_metadata": null
}
^2.8.13development
@types/jest
Environment
{
  "local_name": "@types/jest",
  "alias": false,
  "peer_metadata": null
}
^29.5.3development
@types/node
Environment
{
  "local_name": "@types/node",
  "alias": false,
  "peer_metadata": null
}
^18.17.5development
lint-staged
Environment
{
  "local_name": "lint-staged",
  "alias": false,
  "peer_metadata": null
}
^4.0.2development
ts-node-dev
Environment
{
  "local_name": "ts-node-dev",
  "alias": false,
  "peer_metadata": null
}
^2.0.0development
@types/chalk
Environment
{
  "local_name": "@types/chalk",
  "alias": false,
  "peer_metadata": null
}
^0.4.31development
@types/yargs
Environment
{
  "local_name": "@types/yargs",
  "alias": false,
  "peer_metadata": null
}
^8.0.1development
babel-eslint
Environment
{
  "local_name": "babel-eslint",
  "alias": false,
  "peer_metadata": null
}
^7.2.3development
@types/inquirer
Environment
{
  "local_name": "@types/inquirer",
  "alias": false,
  "peer_metadata": null
}
^8.0.0development
@types/supertest
Environment
{
  "local_name": "@types/supertest",
  "alias": false,
  "peer_metadata": null
}
^2.0.12development
@types/node-emoji
Environment
{
  "local_name": "@types/node-emoji",
  "alias": false,
  "peer_metadata": null
}
^1.4.0development
@types/node-fetch
Environment
{
  "local_name": "@types/node-fetch",
  "alias": false,
  "peer_metadata": null
}
^2.6.4development
eslint-config-buildo
Environment
{
  "local_name": "eslint-config-buildo",
  "alias": false,
  "peer_metadata": null
}
^0.2.2development
eslint-config-prettier
Environment
{
  "local_name": "eslint-config-prettier",
  "alias": false,
  "peer_metadata": null
}
^8.10.0development
eslint-plugin-prettier
Environment
{
  "local_name": "eslint-plugin-prettier",
  "alias": false,
  "peer_metadata": null
}
^4.2.1development
typescript-eslint-parser
Environment
{
  "local_name": "typescript-eslint-parser",
  "alias": false,
  "peer_metadata": null
}
^4.0.0development
@typescript-eslint/parser
Environment
{
  "local_name": "@typescript-eslint/parser",
  "alias": false,
  "peer_metadata": null
}
^5.60.1development
@typescript-eslint/eslint-plugin
Environment
{
  "local_name": "@typescript-eslint/eslint-plugin",
  "alias": false,
  "peer_metadata": null
}
^5.62.0development

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "shasum": "6d703cbf2cf2363ddbc704de7bbc27a3268725aa",
  "tarball": "https://registry.npmjs.org/@0xmetropolis/metal/-/metal-0.5.0.tgz",
  "fileCount": 65,
  "integrity": "sha512-Q6sMKg9R+34rkX+/Ps9EQO9hORO5AAkVDxDGS89Cm9qqGiSke8MlPA0fY0WELzqXlOFLAQ96YdtdMcaiKuaFEg==",
  "signatures": [
    {
      "sig": "MEUCICpiMNqSbA53rWOCUNUMHA4jN2/hT8rjbBrISIOjDmF2AiEAkxHa4cEin4M4/OcdyGsDoaExeJUMZY0az5v4AbPYYPs=",
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"
    }
  ],
  "unpackedSize": 239301
}

Repository

PENDING
0xmetropolis/metal

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 21 Oct, 09:08 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:8687e83f35fcdab08cd232d4a3d95d75f3bfc67b2d176da45cb100b15c4554ea

Other collected versions

0.9.02 Jul0.8.311 Jun0.8.225 Mar0.8.17 Mar0.8.027 Feb0.7.108 DecView all collected versions →