Skip to content

Commit

Permalink
Nffl demo examples (#265)
Browse files Browse the repository at this point in the history
* Operator set update script

* State Root update script

* Add script to get storage value

* Integrate rlp package for encoding

* Add demo nffl cli tool

* Get private key from environment variable

* chore: Restructure nffl-cli directories

* refactor: Port CLI to TS

* docs: Add README to demo CLI

* feat: Add block-height arg to storage-proof

* feat: Add commands as npm scripts

* chore: Update ABI

---------

Co-authored-by: Franco Barpp Gomes <[email protected]>
  • Loading branch information
mikhailUshakoff and Hyodar authored Oct 3, 2024
1 parent 424bd20 commit b4a45eb
Show file tree
Hide file tree
Showing 16 changed files with 3,307 additions and 0 deletions.
144 changes: 144 additions & 0 deletions examples/nffl-cli/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
# Created by https://www.toptal.com/developers/gitignore/api/node
# Edit at https://www.toptal.com/developers/gitignore?templates=node

### Node ###
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# vuepress v2.x temp and cache directory
.temp

# Docusaurus cache and generated files
.docusaurus

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

### Node Patch ###
# Serverless Webpack directories
.webpack/

# Optional stylelint cache

# SvelteKit build / generate output
.svelte-kit

# End of https://www.toptal.com/developers/gitignore/api/node
43 changes: 43 additions & 0 deletions examples/nffl-cli/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
## How to build
```sh
npm install
```

## Commands

### `storage-proof`

Get the proof for a storage slot of a target contract from the source chain.

```bash
npm run storage-proof -- \
--rpc-url https://sepolia.optimism.io\
--contract-address 0xB90101779CC5EB84162f72A80e44307752b778b6\
--storage-key 0x0000000000000000000000000000000000000000000000000000000000000000\
--block-height 14095733
```

### `update-state-root`

Update the state root for a given rollup in a SFFLRegistryRollup contract.

```bash
PRIVATE_KEY=<> npm run update-state-root -- \
--rpc-url https://sepolia-rollup.arbitrum.io/rpc\
--rollup-id 11155420\
--block-height 14095733\
--contract-address 0x23e252b4Ec7cDd3ED84f039EF53DEa494CE878E0\
--aggregator-url http://127.0.0.1:4002\
```

### `update-operator-set`

Update the operator set for a given SFFLRegistryRollup contract.

```bash
PRIVATE_KEY=<> npm run update-operator-set -- \
--rpc-url https://sepolia-rollup.arbitrum.io/rpc\
--contract-address 0x23e252b4Ec7cDd3ED84f039EF53DEa494CE878E0\
--id 10\
--aggregator-url http://127.0.0.1:4002\
```
1 change: 1 addition & 0 deletions examples/nffl-cli/abi/SFFLRegistryRollup.json

Large diffs are not rendered by default.

Loading

0 comments on commit b4a45eb

Please sign in to comment.