From 3b79ff12f9439be7a1103796b0a553731be6f5b4 Mon Sep 17 00:00:00 2001 From: Daniel Helm Date: Thu, 31 Oct 2024 05:06:37 -0500 Subject: [PATCH] 0.0.17 --- README.md | 106 +++++++++++++++++++++++++-------------------------- package.json | 2 +- 2 files changed, 52 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index 4848a5d..62ea642 100644 --- a/README.md +++ b/README.md @@ -18,17 +18,18 @@ A tool for configuring, managing, and testing [Scroll SDK](https://docs.scroll.i +* [Scroll SDK CLI](#scroll-sdk-cli) * [Usage](#usage) * [Commands](#commands) # Usage ```sh-session -$ npm install -g scroll-sdk-cli +$ npm install -g @scroll-tech/scroll-sdk-cli $ scrollsdk COMMAND running command... $ scrollsdk (--version) -scroll-sdk-cli/0.0.16 linux-x64 node-v20.11.0 +@scroll-tech/scroll-sdk-cli/0.0.17 darwin-arm64 node-v20.13.1 $ scrollsdk --help [COMMAND] USAGE $ scrollsdk COMMAND @@ -37,39 +38,34 @@ USAGE # Commands -- [Scroll SDK CLI](#scroll-sdk-cli) - - [Introduction](#introduction) - - [Other Scroll SDK Repos](#other-scroll-sdk-repos) -- [Usage](#usage) -- [Commands](#commands) - - [`scrollsdk help [COMMAND]`](#scrollsdk-help-command) - - [`scrollsdk helper activity`](#scrollsdk-helper-activity) - - [`scrollsdk helper clear-accounts`](#scrollsdk-helper-clear-accounts) - - [`scrollsdk helper derive-enode NODEKEY`](#scrollsdk-helper-derive-enode-nodekey) - - [`scrollsdk helper fund-accounts`](#scrollsdk-helper-fund-accounts) - - [`scrollsdk helper set-scalars`](#scrollsdk-helper-set-scalars) - - [`scrollsdk plugins`](#scrollsdk-plugins) - - [`scrollsdk plugins add PLUGIN`](#scrollsdk-plugins-add-plugin) - - [`scrollsdk plugins:inspect PLUGIN...`](#scrollsdk-pluginsinspect-plugin) - - [`scrollsdk plugins install PLUGIN`](#scrollsdk-plugins-install-plugin) - - [`scrollsdk plugins link PATH`](#scrollsdk-plugins-link-path) - - [`scrollsdk plugins remove [PLUGIN]`](#scrollsdk-plugins-remove-plugin) - - [`scrollsdk plugins reset`](#scrollsdk-plugins-reset) - - [`scrollsdk plugins uninstall [PLUGIN]`](#scrollsdk-plugins-uninstall-plugin) - - [`scrollsdk plugins unlink [PLUGIN]`](#scrollsdk-plugins-unlink-plugin) - - [`scrollsdk plugins update`](#scrollsdk-plugins-update) - - [`scrollsdk setup configs`](#scrollsdk-setup-configs) - - [`scrollsdk setup db-init`](#scrollsdk-setup-db-init) - - [`scrollsdk setup domains [FILE]`](#scrollsdk-setup-domains-file) - - [`scrollsdk setup gas-token`](#scrollsdk-setup-gas-token) - - [`scrollsdk setup gen-keystore`](#scrollsdk-setup-gen-keystore) - - [`scrollsdk setup prep-charts`](#scrollsdk-setup-prep-charts) - - [`scrollsdk setup push-secrets`](#scrollsdk-setup-push-secrets) - - [`scrollsdk setup tls`](#scrollsdk-setup-tls) - - [`scrollsdk test contracts`](#scrollsdk-test-contracts) - - [`scrollsdk test dependencies`](#scrollsdk-test-dependencies) - - [`scrollsdk test e2e`](#scrollsdk-test-e2e) - - [`scrollsdk test ingress`](#scrollsdk-test-ingress) +* [`scrollsdk help [COMMAND]`](#scrollsdk-help-command) +* [`scrollsdk helper activity`](#scrollsdk-helper-activity) +* [`scrollsdk helper clear-accounts`](#scrollsdk-helper-clear-accounts) +* [`scrollsdk helper derive-enode NODEKEY`](#scrollsdk-helper-derive-enode-nodekey) +* [`scrollsdk helper fund-accounts`](#scrollsdk-helper-fund-accounts) +* [`scrollsdk helper set-scalars`](#scrollsdk-helper-set-scalars) +* [`scrollsdk plugins`](#scrollsdk-plugins) +* [`scrollsdk plugins add PLUGIN`](#scrollsdk-plugins-add-plugin) +* [`scrollsdk plugins:inspect PLUGIN...`](#scrollsdk-pluginsinspect-plugin) +* [`scrollsdk plugins install PLUGIN`](#scrollsdk-plugins-install-plugin) +* [`scrollsdk plugins link PATH`](#scrollsdk-plugins-link-path) +* [`scrollsdk plugins remove [PLUGIN]`](#scrollsdk-plugins-remove-plugin) +* [`scrollsdk plugins reset`](#scrollsdk-plugins-reset) +* [`scrollsdk plugins uninstall [PLUGIN]`](#scrollsdk-plugins-uninstall-plugin) +* [`scrollsdk plugins unlink [PLUGIN]`](#scrollsdk-plugins-unlink-plugin) +* [`scrollsdk plugins update`](#scrollsdk-plugins-update) +* [`scrollsdk setup configs`](#scrollsdk-setup-configs) +* [`scrollsdk setup db-init`](#scrollsdk-setup-db-init) +* [`scrollsdk setup domains [FILE]`](#scrollsdk-setup-domains-file) +* [`scrollsdk setup gas-token`](#scrollsdk-setup-gas-token) +* [`scrollsdk setup gen-keystore`](#scrollsdk-setup-gen-keystore) +* [`scrollsdk setup prep-charts`](#scrollsdk-setup-prep-charts) +* [`scrollsdk setup push-secrets`](#scrollsdk-setup-push-secrets) +* [`scrollsdk setup tls`](#scrollsdk-setup-tls) +* [`scrollsdk test contracts`](#scrollsdk-test-contracts) +* [`scrollsdk test dependencies`](#scrollsdk-test-dependencies) +* [`scrollsdk test e2e`](#scrollsdk-test-e2e) +* [`scrollsdk test ingress`](#scrollsdk-test-ingress) ## `scrollsdk help [COMMAND]` @@ -97,7 +93,7 @@ Generate transactions on the specified network(s) to produce more blocks ``` USAGE - $ scrollsdk helper activity [-c ] [-i ] [-o] [-t] [-p] [-k ] [-x ] [-r ] [-d] + $ scrollsdk helper activity [-c ] [-d] [-i ] [-o] [-t] [-p] [-k ] [-x ] [-r ] FLAGS -c, --config= [default: ./config.toml] Path to config.toml file @@ -114,7 +110,7 @@ DESCRIPTION Generate transactions on the specified network(s) to produce more blocks ``` -_See code: [src/commands/helper/activity.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/helper/activity.ts)_ +_See code: [src/commands/helper/activity.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/helper/activity.ts)_ ## `scrollsdk helper clear-accounts` @@ -139,7 +135,7 @@ DESCRIPTION Clear pending transactions and optionally transfer remaining funds on Layer 2 ``` -_See code: [src/commands/helper/clear-accounts.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/helper/clear-accounts.ts)_ +_See code: [src/commands/helper/clear-accounts.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/helper/clear-accounts.ts)_ ## `scrollsdk helper derive-enode NODEKEY` @@ -159,7 +155,7 @@ EXAMPLES $ scrollsdk helper derive-enode 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef ``` -_See code: [src/commands/helper/derive-enode.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/helper/derive-enode.ts)_ +_See code: [src/commands/helper/derive-enode.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/helper/derive-enode.ts)_ ## `scrollsdk helper fund-accounts` @@ -167,8 +163,8 @@ Fund L1 and L2 accounts for contracts ``` USAGE - $ scrollsdk helper fund-accounts [-a ] [-c ] [-n ] [-d] [-o ] [-t ] [-m] [-p] [-k - ] [-i] [-f ] [-l 1|2] + $ scrollsdk helper fund-accounts [-a ] [-f ] [-c ] [-n ] [-d] [-i] [-o ] [-t ] + [-l 1|2] [-m] [-p] [-k ] FLAGS -a, --account= Additional account to fund @@ -189,7 +185,7 @@ DESCRIPTION Fund L1 and L2 accounts for contracts ``` -_See code: [src/commands/helper/fund-accounts.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/helper/fund-accounts.ts)_ +_See code: [src/commands/helper/fund-accounts.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/helper/fund-accounts.ts)_ ## `scrollsdk helper set-scalars` @@ -213,7 +209,7 @@ DESCRIPTION Set commit and blob scalars for Scroll SDK ``` -_See code: [src/commands/helper/set-scalars.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/helper/set-scalars.ts)_ +_See code: [src/commands/helper/set-scalars.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/helper/set-scalars.ts)_ ## `scrollsdk plugins` @@ -527,7 +523,7 @@ EXAMPLES $ scrollsdk setup configs --configs-dir custom-configs ``` -_See code: [src/commands/setup/configs.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/setup/configs.ts)_ +_See code: [src/commands/setup/configs.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/setup/configs.ts)_ ## `scrollsdk setup db-init` @@ -558,7 +554,7 @@ EXAMPLES $ scrollsdk setup db-init --update-db-port=25061 ``` -_See code: [src/commands/setup/db-init.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/setup/db-init.ts)_ +_See code: [src/commands/setup/db-init.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/setup/db-init.ts)_ ## `scrollsdk setup domains [FILE]` @@ -582,7 +578,7 @@ EXAMPLES $ scrollsdk setup domains ``` -_See code: [src/commands/setup/domains.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/setup/domains.ts)_ +_See code: [src/commands/setup/domains.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/setup/domains.ts)_ ## `scrollsdk setup gas-token` @@ -599,7 +595,7 @@ EXAMPLES $ scrollsdk setup gas-token ``` -_See code: [src/commands/setup/gas-token.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/setup/gas-token.ts)_ +_See code: [src/commands/setup/gas-token.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/setup/gas-token.ts)_ ## `scrollsdk setup gen-keystore` @@ -621,7 +617,7 @@ EXAMPLES $ scrollsdk setup gen-keystore --no-accounts ``` -_See code: [src/commands/setup/gen-keystore.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/setup/gen-keystore.ts)_ +_See code: [src/commands/setup/gen-keystore.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/setup/gen-keystore.ts)_ ## `scrollsdk setup prep-charts` @@ -651,7 +647,7 @@ EXAMPLES $ scrollsdk setup prep-charts --skip-auth-check ``` -_See code: [src/commands/setup/prep-charts.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/setup/prep-charts.ts)_ +_See code: [src/commands/setup/prep-charts.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/setup/prep-charts.ts)_ ## `scrollsdk setup push-secrets` @@ -676,7 +672,7 @@ EXAMPLES $ scrollsdk setup push-secrets --values-dir custom-values ``` -_See code: [src/commands/setup/push-secrets.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/setup/push-secrets.ts)_ +_See code: [src/commands/setup/push-secrets.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/setup/push-secrets.ts)_ ## `scrollsdk setup tls` @@ -701,7 +697,7 @@ EXAMPLES $ scrollsdk setup tls --values-dir custom-values ``` -_See code: [src/commands/setup/tls.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/setup/tls.ts)_ +_See code: [src/commands/setup/tls.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/setup/tls.ts)_ ## `scrollsdk test contracts` @@ -720,7 +716,7 @@ DESCRIPTION Test contracts by checking deployment and initialization ``` -_See code: [src/commands/test/contracts.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/test/contracts.ts)_ +_See code: [src/commands/test/contracts.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/test/contracts.ts)_ ## `scrollsdk test dependencies` @@ -737,7 +733,7 @@ DESCRIPTION Check for required dependencies ``` -_See code: [src/commands/test/dependencies.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/test/dependencies.ts)_ +_See code: [src/commands/test/dependencies.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/test/dependencies.ts)_ ## `scrollsdk test e2e` @@ -760,7 +756,7 @@ DESCRIPTION Test contracts by checking deployment and initialization ``` -_See code: [src/commands/test/e2e.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/test/e2e.ts)_ +_See code: [src/commands/test/e2e.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/test/e2e.ts)_ ## `scrollsdk test ingress` @@ -779,5 +775,5 @@ DESCRIPTION Check for required ingress hosts and validate frontend URLs ``` -_See code: [src/commands/test/ingress.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/test/ingress.ts)_ +_See code: [src/commands/test/ingress.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/test/ingress.ts)_ diff --git a/package.json b/package.json index 6965a1f..81e0ea0 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@scroll-tech/scroll-sdk-cli", "description": "A tool for managing and testing Scroll SDK deployments", - "version": "0.0.16", + "version": "0.0.17", "author": "Daniel Helm", "bin": { "scrollsdk": "bin/run.js"