Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support contracts verification #6

Merged
merged 2 commits into from
Nov 22, 2024
Merged

feat: support contracts verification #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
504a297
feat: support contracts verification
yiweichi Nov 22, 2024
05bc4e2
0.1.1
yiweichi Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 70 additions & 52 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ $ npm install -g @scroll-tech/scroll-sdk-cli
$ scrollsdk COMMAND
running command...
$ scrollsdk (--version)
@scroll-tech/scroll-sdk-cli/0.1.0 darwin-arm64 node-v20.13.1
@scroll-tech/scroll-sdk-cli/0.1.1 darwin-arm64 node-v20.10.0
$ scrollsdk --help [COMMAND]
USAGE
$ scrollsdk COMMAND
Expand All @@ -38,39 +38,35 @@ USAGE
<!-- usagestop -->
# Commands
<!-- 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 setup verify-contracts`](#scrollsdk-setup-verify-contracts)
* [`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]`

Expand Down Expand Up @@ -115,7 +111,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.1.0/src/commands/helper/activity.ts)_
_See code: [src/commands/helper/activity.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.1/src/commands/helper/activity.ts)_

## `scrollsdk helper clear-accounts`

Expand All @@ -140,7 +136,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.1.0/src/commands/helper/clear-accounts.ts)_
_See code: [src/commands/helper/clear-accounts.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.1/src/commands/helper/clear-accounts.ts)_

## `scrollsdk helper derive-enode NODEKEY`

Expand All @@ -160,7 +156,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.1.0/src/commands/helper/derive-enode.ts)_
_See code: [src/commands/helper/derive-enode.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.1/src/commands/helper/derive-enode.ts)_

## `scrollsdk helper fund-accounts`

Expand Down Expand Up @@ -190,7 +186,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.1.0/src/commands/helper/fund-accounts.ts)_
_See code: [src/commands/helper/fund-accounts.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.1/src/commands/helper/fund-accounts.ts)_

## `scrollsdk helper set-scalars`

Expand All @@ -214,7 +210,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.1.0/src/commands/helper/set-scalars.ts)_
_See code: [src/commands/helper/set-scalars.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.1/src/commands/helper/set-scalars.ts)_

## `scrollsdk plugins`

Expand Down Expand Up @@ -523,12 +519,12 @@ DESCRIPTION
EXAMPLES
$ scrollsdk setup configs

$ scrollsdk setup configs --image-tag gen-configs-2eba3d2c418b16f4a66d9baadeb1c1bafdca81b1
$ scrollsdk setup configs --image-tag gen-configs-8ff2948aa2b9cbd24a7644b060097765a6faee10

$ scrollsdk setup configs --configs-dir custom-configs
```

_See code: [src/commands/setup/configs.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.0/src/commands/setup/configs.ts)_
_See code: [src/commands/setup/configs.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.1/src/commands/setup/configs.ts)_

## `scrollsdk setup db-init`

Expand Down Expand Up @@ -559,7 +555,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.1.0/src/commands/setup/db-init.ts)_
_See code: [src/commands/setup/db-init.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.1/src/commands/setup/db-init.ts)_

## `scrollsdk setup domains [FILE]`

Expand All @@ -583,7 +579,7 @@ EXAMPLES
$ scrollsdk setup domains
```

_See code: [src/commands/setup/domains.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.0/src/commands/setup/domains.ts)_
_See code: [src/commands/setup/domains.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.1/src/commands/setup/domains.ts)_

## `scrollsdk setup gas-token`

Expand All @@ -600,7 +596,7 @@ EXAMPLES
$ scrollsdk setup gas-token
```

_See code: [src/commands/setup/gas-token.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.0/src/commands/setup/gas-token.ts)_
_See code: [src/commands/setup/gas-token.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.1/src/commands/setup/gas-token.ts)_

## `scrollsdk setup gen-keystore`

Expand All @@ -622,7 +618,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.1.0/src/commands/setup/gen-keystore.ts)_
_See code: [src/commands/setup/gen-keystore.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.1/src/commands/setup/gen-keystore.ts)_

## `scrollsdk setup prep-charts`

Expand Down Expand Up @@ -652,7 +648,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.1.0/src/commands/setup/prep-charts.ts)_
_See code: [src/commands/setup/prep-charts.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.1/src/commands/setup/prep-charts.ts)_

## `scrollsdk setup push-secrets`

Expand All @@ -677,7 +673,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.1.0/src/commands/setup/push-secrets.ts)_
_See code: [src/commands/setup/push-secrets.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.1/src/commands/setup/push-secrets.ts)_

## `scrollsdk setup tls`

Expand All @@ -702,7 +698,29 @@ 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.1.0/src/commands/setup/tls.ts)_
_See code: [src/commands/setup/tls.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.1/src/commands/setup/tls.ts)_

## `scrollsdk setup verify-contracts`

Set up contracts verification

```
USAGE
$ scrollsdk setup verify-contracts [--image-tag <value>]

FLAGS
--image-tag=<value> Specify the Docker image tag to use

DESCRIPTION
Set up contracts verification

EXAMPLES
$ scrollsdk setup verify-contracts

$ scrollsdk setup verify-contracts --image-tag verify-8ff2948aa2b9cbd24a7644b060097765a6faee10
```

_See code: [src/commands/setup/verify-contracts.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.1/src/commands/setup/verify-contracts.ts)_

## `scrollsdk test contracts`

Expand All @@ -721,7 +739,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.1.0/src/commands/test/contracts.ts)_
_See code: [src/commands/test/contracts.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.1/src/commands/test/contracts.ts)_

## `scrollsdk test dependencies`

Expand All @@ -738,7 +756,7 @@ DESCRIPTION
Check for required dependencies
```

_See code: [src/commands/test/dependencies.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.0/src/commands/test/dependencies.ts)_
_See code: [src/commands/test/dependencies.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.1/src/commands/test/dependencies.ts)_

## `scrollsdk test e2e`

Expand All @@ -761,7 +779,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.1.0/src/commands/test/e2e.ts)_
_See code: [src/commands/test/e2e.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.1/src/commands/test/e2e.ts)_

## `scrollsdk test ingress`

Expand All @@ -780,5 +798,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.1.0/src/commands/test/ingress.ts)_
_See code: [src/commands/test/ingress.ts](https://github.com/scroll-tech/scroll-sdk-cli/blob/v0.1.1/src/commands/test/ingress.ts)_
<!-- commandsstop -->
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@scroll-tech/scroll-sdk-cli",
"description": "A tool for managing and testing Scroll SDK deployments",
"version": "0.1.0",
"version": "0.1.1",
"author": "Daniel Helm",
"bin": {
"scrollsdk": "bin/run.js"
Expand Down
4 changes: 2 additions & 2 deletions src/commands/setup/configs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export default class SetupConfigs extends Command {

static override examples = [
'<%= config.bin %> <%= command.id %>',
'<%= config.bin %> <%= command.id %> --image-tag gen-configs-2eba3d2c418b16f4a66d9baadeb1c1bafdca81b1',
'<%= config.bin %> <%= command.id %> --image-tag gen-configs-8ff2948aa2b9cbd24a7644b060097765a6faee10',
'<%= config.bin %> <%= command.id %> --configs-dir custom-configs',
]

Expand Down Expand Up @@ -465,7 +465,7 @@ export default class SetupConfigs extends Command {
}

private async getDockerImageTag(providedTag: string | undefined): Promise<string> {
const defaultTag = 'gen-configs-2eba3d2c418b16f4a66d9baadeb1c1bafdca81b1'
const defaultTag = 'gen-configs-8ff2948aa2b9cbd24a7644b060097765a6faee10'

if (!providedTag) {
return defaultTag
Expand Down
Loading
Loading