npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@upnode/opstack-cli

v1.1.3

Published

command line interface for management opstack rollup

Downloads

908

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

frongrider2frongrider2

Keywords

Readme

Opstack CLI Tool

Opstack CLI Tool by Upnode Deploy allows chain operators and developers to quickly launch their OP Stack chain with the necessary infrastructure, including an explorer, bridge, faucet, and monitoring system, by modifying a few environment variables related to the RPC endpoint, private keys, and chain information.

With easy method by run just command and config your chain by just run ops run

Unlike Conduit, Opstack CLI Tool provides developers and chain operators with a tool to deploy OP Stack chains on their own servers instead of relying on third-party managed servers. Upnode Deploy is free, open-source, and fully transparent, whereas Conduit is a paid, closed-source solution.

Opstack CLI Tool supports the latest OP Stack v1.9.0 and is prepared for the upcoming migration

How to use

IMAGE ALT TEXT HERE

Hardware requirements

Hardware requirements for OP Mainnet nodes can vary depending on the type of node you plan to run. Archive nodes generally require significantly more resources than full nodes. Below are suggested minimum hardware requirements for each type of node.

16GB RAM Reasonably modern CPU Optimism official document requirement

SSD capacity requirements

Given the growing size of the blockchain state, choosing the right SSD size is important. Below are the storage needs as of April 2024:

  • Full Node: The snapshot size for a full node is approximately 1.6TB, with the data directory's capacity increasing by about 1TB every six months.
  • Archive Node: The snapshot size for an archive node is approximately 5TB, with the data directory's capacity increasing by about 3TB every six months. Optimism official document requirement

Support

Installation

If you run on server, see how to install the depencies by following the instruction

Install Opstack CLI Tool

$ npm install -g @upnode/opstack-cli

Verify version

$ ops version

Update version

$ npm update -g @upnode/opstack-cli

Quick Start

To start the cli for the first time you need to run cmd

$ ops run

and then you need to config the environtment As follows | Value | description | | ------------- | ------------- | | user_name | User name of backend, indexer database , traefik dashboard | | user_password | Password of database | | domain_name | The domain name (must be hostname) (Example : localhost, example.test, test.app) use for bridge, blockscout, rpc, indexer etc. | | protocol | Select protocol for domain => http, https |

After completing the initial configuration, the CLI will clone the opstack-deployment repository and run the Docker Compose setup, which includes the REST API for our CLI tool, the frontend, and the Traefik proxy. Traefik is used to route requests to the appropriate services.

Note: If you are running this on a local machine, set the domain name to localhost and use the http protocol. Additionally, remember to add localhost to your /etc/hosts file.

/etc/hosts add this line

127.0.0.1       localhost

Deploy new chain with CLI

$ ops run

=> Deploy Opstack Rollup include (Deployment UI, Grafana, Blockscout, Bridge UI)

After deploying a new rollup, you need to configure the subdomain (domain name service) in Cloudflare so that it points to the ${DOMAIN_NAME} you specified during the initial setup.

Example

DNS Setup Ensure that all the CNAME records listed above are properly configured in your DNS provider. Replace ${DOMAIN_NAME} with your actual domain name.

Example DNS Entry For example, if your domain name is example.com, the CNAME dashboard.${DOMAIN_NAME} should resolve to dashboard.example.com.

| CNAME | Service description | Type | Upnode Testnet | | --------------------------------- | --------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------- | | chain | Core blockchain service (op-geth), responsible for handling the Layer 2 node operations. | Node RPC | https://chain.upnode-test.com | | blockscout-backend | Backend service for Blockscout, handling API calls and blockchain data processing. | Backend | https://blockscout-backend.upnode-test.com | | blockscout-stats | Service for providing statistical data and insights related to the blockchain via Blockscout. | Backend | https://blockscout-stats.upnode-test.com | | blockscout-visualizer | Advanced visualization tool for detailed blockchain analytics and charts. | Backend | https://blockscout-visualizer.upnode-test.com | | dashboard | Traefik dashboard use username and password that you set when run the cli | Backend | https://dashboard.upnode-test.com | | deploy-api | deployment backend Rest API | Backend | https://deploy-api.upnode-test.com | | opstack-bridge-indexer-server | Backend service for indexing transactions and data for the Optimism stack bridge. | Backend | https://opstack-bridge-indexer-server.upnode-test.com | | deploy | Frontend of deployment handle you rollup | Frontend | https://deploy.upnode-test.com | | bridge | Frontend service for the cross-chain or cross-layer bridge, enabling seamless asset transfers. | Frontend | https://bridge.upnode-test.com | | blockscout | Frontend interface for Blockscout, allowing users to explore blockchain transactions and data. | Frontend | https://blockscout.upnode-test.com | | grafana | Grafana monitoring dashboard for visualizing system metrics and performance insights. use username and password | Frontend | https://grafana.upnode-test.com | | prometheus | Prometheus monitoring service for collecting and storing time-series metrics. | Frontend | https://prometheus.upnode-test.com |

Parameter

This document outlines the configuration parameters for Layer 1 (L1) setup. Below is a table that provides detailed descriptions of each parameter along with an example configuration for the Holesky Testnet.

Config your Wallet

| Parameter | Description | | ----------------------------------- | ---------------------------------------- | | Enter the Batcher Private Key | Private key of batcher account | | Enter the Proposer Private Key | Private key of proposer account | | Enter the Sequencer Private Key | Private key of sequencer account | | Enter the Deployer Private Key | Private key of contract deployer account | | Enter the Admin Private Key | Private key of admin account |

Config your Layer 1

| Parameter | Description | Holesky (Testnet) Example | | ------------------------------------------ | -------------------------------- | -------------------------------------------------------------------------------------------------- | | Enter the L1 RPC URL | Layer 1 RPC URL | https://quick-serene-pine.ethereum-holesky.quiknode.pro/a5c5ac0df0f0656d58699a732b567738f0ef6542 | | Enter the L1 Chain ID | Layer 1 Chain ID | 17000 | | Enter the L1 Chain Name | Layer 1 Chain Name | Ethereum mainnet | | Enter the L1 Logo URL | Layer 1 Logo URL | https://cryptologos.cc/logos/ethereum-eth-logo.png | | Enter the L1 Native Currency Name | Layer 1 Native Currency Name | Ethereum | | Enter the L1 Native Currency Symbol | Layer 1 Native Currency Symbol | ETH | | Enter the L1 Native Currency Decimals | Layer 1 Native Currency Decimals | 18 | | Enter the L1 Block Explorer URL | Layer 1 Block Explorer URL | https://holesky.beaconcha.in | | Enter the L1 Block Explorer API | Layer 1 Block Explorer API | - | | Select RPC Kind for L1 | RPC Kind for Layer 1 | quicknode | | Enter the L1 Multi Call3 Address | Layer 1 Multi Call3 Address | 0xcA11bde05977b3631167028862bE2a173976CA11 | | Enter the L1 Multi Call3 Block Created | Multi Call3 Block Created | 77 |

Config your Rollup | Config | Description | Example Value | |-------------------------------------------|--------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------| | Enter the Rollup Name (Chain name): | Name of the Layer 2 Rollup chain | Optimism | | Enter the Rollup Chain ID: | Unique Chain ID for the Rollup | 43333 | | Enter the Rollup Logo URL: | URL of the Rollup's logo | https://cryptologos.cc/logos/optimism-ethereum-op-logo.png | | Enter the Rollup Native Currency Name:| Name of the native currency used in the Rollup | Optimism Ethereum | | Enter the Rollup Native Currency Symbol: | Symbol of the Rollup's native currency | ETH | | Enter the Rollup Native Currency Decimals: | Number of decimals used in the native currency | 18 | | Enter the Governance Token Name: | Name of the governance token used for managing the Rollup | Optimism | | Enter the Governance Token Symbol: | Symbol of the governance token | OP | | Number of seconds between each L2 block: | Time (in seconds) between generating two consecutive L2 blocks. Must be less than L1 block time | 2 | | Number of blocks between proposals to the L2OutputOracle: | Interval of blocks between proposals to the L2 Output Oracle | 90 | | Number of seconds that a proposal must be available to challenge: | Time (in seconds) before a proposal is finalized in the OptimismPortal | 300

Config your bridge user interface | Config | Description | Example Value | |-------------------------------------|--------------------------------------------------|-------------------------------------------| | Enter the App Logo URL | URL for the app's logo | https://i.ibb.co/r36YpbK/upnode.png | | Enter the Primary Color | Primary color for the app's theme | #27005D | | Enter the Secondary Color | Secondary color for the app's theme | #9EDDFF | | Enter the WalletConnect Project ID | Project ID for WalletConnect integration | 00000 |

Config your grafana user and password | Config | Description | |-------------------------------------|--------------------------------------------------| | Enter the Grafana User | User name of grafana | | Enter the Grafana Password | Password of grafana user |

Stop all services

This command will stop all services. We plan to add the ability to stop individual services in the future.

$ ops run

=> Stop the deployment

Start all services

This command will start all services. We plan to add the ability to start individual services in the future.

$ ops run

=> Start the deployment

Status of the deployment

This command displays the deployment status of all services and checks the Docker container status for each service.

$ ops run

=> Status of the deployment

View logs

This command displays the logs and status of each service.

$ ops run

=> Views logs

Chain Info

This command displays the config of deployment rollup.

$ ops run

=> Chain Info
  • Data Volume path = rollup data
  • deploy-config = path of deploy-config.json (rollup config)
  • genesis.json = path of genesis.json (genesis config data)
  • allocs.json = path of allocs.json
  • artifact.json = path of artifact.json (Layer 1 Contract addresses)