Skip to content

Commit 3b79ff1

Browse files
committed
0.0.17
1 parent 8c1c495 commit 3b79ff1

File tree

2 files changed

+52
-56
lines changed

2 files changed

+52
-56
lines changed

README.md

Lines changed: 51 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,18 @@ A tool for configuring, managing, and testing [Scroll SDK](https://docs.scroll.i
1818

1919

2020
<!-- toc -->
21+
* [Scroll SDK CLI](#scroll-sdk-cli)
2122
* [Usage](#usage)
2223
* [Commands](#commands)
2324
<!-- tocstop -->
2425
# Usage
2526
<!-- usage -->
2627
```sh-session
27-
$ npm install -g scroll-sdk-cli
28+
$ npm install -g @scroll-tech/scroll-sdk-cli
2829
$ scrollsdk COMMAND
2930
running command...
3031
$ scrollsdk (--version)
31-
scroll-sdk-cli/0.0.16 linux-x64 node-v20.11.0
32+
@scroll-tech/scroll-sdk-cli/0.0.17 darwin-arm64 node-v20.13.1
3233
$ scrollsdk --help [COMMAND]
3334
USAGE
3435
$ scrollsdk COMMAND
@@ -37,39 +38,34 @@ USAGE
3738
<!-- usagestop -->
3839
# Commands
3940
<!-- commands -->
40-
- [Scroll SDK CLI](#scroll-sdk-cli)
41-
- [Introduction](#introduction)
42-
- [Other Scroll SDK Repos](#other-scroll-sdk-repos)
43-
- [Usage](#usage)
44-
- [Commands](#commands)
45-
- [`scrollsdk help [COMMAND]`](#scrollsdk-help-command)
46-
- [`scrollsdk helper activity`](#scrollsdk-helper-activity)
47-
- [`scrollsdk helper clear-accounts`](#scrollsdk-helper-clear-accounts)
48-
- [`scrollsdk helper derive-enode NODEKEY`](#scrollsdk-helper-derive-enode-nodekey)
49-
- [`scrollsdk helper fund-accounts`](#scrollsdk-helper-fund-accounts)
50-
- [`scrollsdk helper set-scalars`](#scrollsdk-helper-set-scalars)
51-
- [`scrollsdk plugins`](#scrollsdk-plugins)
52-
- [`scrollsdk plugins add PLUGIN`](#scrollsdk-plugins-add-plugin)
53-
- [`scrollsdk plugins:inspect PLUGIN...`](#scrollsdk-pluginsinspect-plugin)
54-
- [`scrollsdk plugins install PLUGIN`](#scrollsdk-plugins-install-plugin)
55-
- [`scrollsdk plugins link PATH`](#scrollsdk-plugins-link-path)
56-
- [`scrollsdk plugins remove [PLUGIN]`](#scrollsdk-plugins-remove-plugin)
57-
- [`scrollsdk plugins reset`](#scrollsdk-plugins-reset)
58-
- [`scrollsdk plugins uninstall [PLUGIN]`](#scrollsdk-plugins-uninstall-plugin)
59-
- [`scrollsdk plugins unlink [PLUGIN]`](#scrollsdk-plugins-unlink-plugin)
60-
- [`scrollsdk plugins update`](#scrollsdk-plugins-update)
61-
- [`scrollsdk setup configs`](#scrollsdk-setup-configs)
62-
- [`scrollsdk setup db-init`](#scrollsdk-setup-db-init)
63-
- [`scrollsdk setup domains [FILE]`](#scrollsdk-setup-domains-file)
64-
- [`scrollsdk setup gas-token`](#scrollsdk-setup-gas-token)
65-
- [`scrollsdk setup gen-keystore`](#scrollsdk-setup-gen-keystore)
66-
- [`scrollsdk setup prep-charts`](#scrollsdk-setup-prep-charts)
67-
- [`scrollsdk setup push-secrets`](#scrollsdk-setup-push-secrets)
68-
- [`scrollsdk setup tls`](#scrollsdk-setup-tls)
69-
- [`scrollsdk test contracts`](#scrollsdk-test-contracts)
70-
- [`scrollsdk test dependencies`](#scrollsdk-test-dependencies)
71-
- [`scrollsdk test e2e`](#scrollsdk-test-e2e)
72-
- [`scrollsdk test ingress`](#scrollsdk-test-ingress)
41+
* [`scrollsdk help [COMMAND]`](#scrollsdk-help-command)
42+
* [`scrollsdk helper activity`](#scrollsdk-helper-activity)
43+
* [`scrollsdk helper clear-accounts`](#scrollsdk-helper-clear-accounts)
44+
* [`scrollsdk helper derive-enode NODEKEY`](#scrollsdk-helper-derive-enode-nodekey)
45+
* [`scrollsdk helper fund-accounts`](#scrollsdk-helper-fund-accounts)
46+
* [`scrollsdk helper set-scalars`](#scrollsdk-helper-set-scalars)
47+
* [`scrollsdk plugins`](#scrollsdk-plugins)
48+
* [`scrollsdk plugins add PLUGIN`](#scrollsdk-plugins-add-plugin)
49+
* [`scrollsdk plugins:inspect PLUGIN...`](#scrollsdk-pluginsinspect-plugin)
50+
* [`scrollsdk plugins install PLUGIN`](#scrollsdk-plugins-install-plugin)
51+
* [`scrollsdk plugins link PATH`](#scrollsdk-plugins-link-path)
52+
* [`scrollsdk plugins remove [PLUGIN]`](#scrollsdk-plugins-remove-plugin)
53+
* [`scrollsdk plugins reset`](#scrollsdk-plugins-reset)
54+
* [`scrollsdk plugins uninstall [PLUGIN]`](#scrollsdk-plugins-uninstall-plugin)
55+
* [`scrollsdk plugins unlink [PLUGIN]`](#scrollsdk-plugins-unlink-plugin)
56+
* [`scrollsdk plugins update`](#scrollsdk-plugins-update)
57+
* [`scrollsdk setup configs`](#scrollsdk-setup-configs)
58+
* [`scrollsdk setup db-init`](#scrollsdk-setup-db-init)
59+
* [`scrollsdk setup domains [FILE]`](#scrollsdk-setup-domains-file)
60+
* [`scrollsdk setup gas-token`](#scrollsdk-setup-gas-token)
61+
* [`scrollsdk setup gen-keystore`](#scrollsdk-setup-gen-keystore)
62+
* [`scrollsdk setup prep-charts`](#scrollsdk-setup-prep-charts)
63+
* [`scrollsdk setup push-secrets`](#scrollsdk-setup-push-secrets)
64+
* [`scrollsdk setup tls`](#scrollsdk-setup-tls)
65+
* [`scrollsdk test contracts`](#scrollsdk-test-contracts)
66+
* [`scrollsdk test dependencies`](#scrollsdk-test-dependencies)
67+
* [`scrollsdk test e2e`](#scrollsdk-test-e2e)
68+
* [`scrollsdk test ingress`](#scrollsdk-test-ingress)
7369

7470
## `scrollsdk help [COMMAND]`
7571

@@ -97,7 +93,7 @@ Generate transactions on the specified network(s) to produce more blocks
9793

9894
```
9995
USAGE
100-
$ scrollsdk helper activity [-c <value>] [-i <value>] [-o] [-t] [-p] [-k <value>] [-x <value>] [-r <value>] [-d]
96+
$ scrollsdk helper activity [-c <value>] [-d] [-i <value>] [-o] [-t] [-p] [-k <value>] [-x <value>] [-r <value>]
10197
10298
FLAGS
10399
-c, --config=<value> [default: ./config.toml] Path to config.toml file
@@ -114,7 +110,7 @@ DESCRIPTION
114110
Generate transactions on the specified network(s) to produce more blocks
115111
```
116112

117-
_See code: [src/commands/helper/activity.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/helper/activity.ts)_
113+
_See code: [src/commands/helper/activity.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/helper/activity.ts)_
118114

119115
## `scrollsdk helper clear-accounts`
120116

@@ -139,7 +135,7 @@ DESCRIPTION
139135
Clear pending transactions and optionally transfer remaining funds on Layer 2
140136
```
141137

142-
_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)_
138+
_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)_
143139

144140
## `scrollsdk helper derive-enode NODEKEY`
145141

@@ -159,16 +155,16 @@ EXAMPLES
159155
$ scrollsdk helper derive-enode 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
160156
```
161157

162-
_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)_
158+
_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)_
163159

164160
## `scrollsdk helper fund-accounts`
165161

166162
Fund L1 and L2 accounts for contracts
167163

168164
```
169165
USAGE
170-
$ scrollsdk helper fund-accounts [-a <value>] [-c <value>] [-n <value>] [-d] [-o <value>] [-t <value>] [-m] [-p] [-k
171-
<value>] [-i] [-f <value>] [-l 1|2]
166+
$ scrollsdk helper fund-accounts [-a <value>] [-f <value>] [-c <value>] [-n <value>] [-d] [-i] [-o <value>] [-t <value>]
167+
[-l 1|2] [-m] [-p] [-k <value>]
172168
173169
FLAGS
174170
-a, --account=<value> Additional account to fund
@@ -189,7 +185,7 @@ DESCRIPTION
189185
Fund L1 and L2 accounts for contracts
190186
```
191187

192-
_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)_
188+
_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)_
193189

194190
## `scrollsdk helper set-scalars`
195191

@@ -213,7 +209,7 @@ DESCRIPTION
213209
Set commit and blob scalars for Scroll SDK
214210
```
215211

216-
_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)_
212+
_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)_
217213

218214
## `scrollsdk plugins`
219215

@@ -527,7 +523,7 @@ EXAMPLES
527523
$ scrollsdk setup configs --configs-dir custom-configs
528524
```
529525

530-
_See code: [src/commands/setup/configs.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/setup/configs.ts)_
526+
_See code: [src/commands/setup/configs.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/setup/configs.ts)_
531527

532528
## `scrollsdk setup db-init`
533529

@@ -558,7 +554,7 @@ EXAMPLES
558554
$ scrollsdk setup db-init --update-db-port=25061
559555
```
560556

561-
_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)_
557+
_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)_
562558

563559
## `scrollsdk setup domains [FILE]`
564560

@@ -582,7 +578,7 @@ EXAMPLES
582578
$ scrollsdk setup domains
583579
```
584580

585-
_See code: [src/commands/setup/domains.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/setup/domains.ts)_
581+
_See code: [src/commands/setup/domains.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/setup/domains.ts)_
586582

587583
## `scrollsdk setup gas-token`
588584

@@ -599,7 +595,7 @@ EXAMPLES
599595
$ scrollsdk setup gas-token
600596
```
601597

602-
_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)_
598+
_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)_
603599

604600
## `scrollsdk setup gen-keystore`
605601

@@ -621,7 +617,7 @@ EXAMPLES
621617
$ scrollsdk setup gen-keystore --no-accounts
622618
```
623619

624-
_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)_
620+
_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)_
625621

626622
## `scrollsdk setup prep-charts`
627623

@@ -651,7 +647,7 @@ EXAMPLES
651647
$ scrollsdk setup prep-charts --skip-auth-check
652648
```
653649

654-
_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)_
650+
_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)_
655651

656652
## `scrollsdk setup push-secrets`
657653

@@ -676,7 +672,7 @@ EXAMPLES
676672
$ scrollsdk setup push-secrets --values-dir custom-values
677673
```
678674

679-
_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)_
675+
_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)_
680676

681677
## `scrollsdk setup tls`
682678

@@ -701,7 +697,7 @@ EXAMPLES
701697
$ scrollsdk setup tls --values-dir custom-values
702698
```
703699

704-
_See code: [src/commands/setup/tls.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/setup/tls.ts)_
700+
_See code: [src/commands/setup/tls.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/setup/tls.ts)_
705701

706702
## `scrollsdk test contracts`
707703

@@ -720,7 +716,7 @@ DESCRIPTION
720716
Test contracts by checking deployment and initialization
721717
```
722718

723-
_See code: [src/commands/test/contracts.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/test/contracts.ts)_
719+
_See code: [src/commands/test/contracts.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/test/contracts.ts)_
724720

725721
## `scrollsdk test dependencies`
726722

@@ -737,7 +733,7 @@ DESCRIPTION
737733
Check for required dependencies
738734
```
739735

740-
_See code: [src/commands/test/dependencies.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/test/dependencies.ts)_
736+
_See code: [src/commands/test/dependencies.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/test/dependencies.ts)_
741737

742738
## `scrollsdk test e2e`
743739

@@ -760,7 +756,7 @@ DESCRIPTION
760756
Test contracts by checking deployment and initialization
761757
```
762758

763-
_See code: [src/commands/test/e2e.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/test/e2e.ts)_
759+
_See code: [src/commands/test/e2e.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/test/e2e.ts)_
764760

765761
## `scrollsdk test ingress`
766762

@@ -779,5 +775,5 @@ DESCRIPTION
779775
Check for required ingress hosts and validate frontend URLs
780776
```
781777

782-
_See code: [src/commands/test/ingress.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.16/src/commands/test/ingress.ts)_
778+
_See code: [src/commands/test/ingress.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.0.17/src/commands/test/ingress.ts)_
783779
<!-- commandsstop -->

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@scroll-tech/scroll-sdk-cli",
33
"description": "A tool for managing and testing Scroll SDK deployments",
4-
"version": "0.0.16",
4+
"version": "0.0.17",
55
"author": "Daniel Helm",
66
"bin": {
77
"scrollsdk": "bin/run.js"

0 commit comments

Comments
 (0)