https://github.com/disco-project/smart-sync

Smart Sync enables the creation of smart contract forks and verifiable synchronization across EVM-compatible blockchain networks.
https://github.com/disco-project/smart-sync

blockchain blockchain-interoperability

Last synced: about 1 year ago
JSON representation

Smart Sync enables the creation of smart contract forks and verifiable synchronization across EVM-compatible blockchain networks.

Host: GitHub
URL: https://github.com/disco-project/smart-sync
Owner: disco-project
License: gpl-3.0
Created: 2020-11-06T10:03:47.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2023-01-06T17:21:14.000Z (over 3 years ago)
Last Synced: 2025-04-19T16:25:49.316Z (about 1 year ago)
Topics: blockchain, blockchain-interoperability
Language: TypeScript
Homepage:
Size: 3.13 MB
Stars: 13
Watchers: 1
Forks: 4
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Getting started

## Installation CLI

To globally install the latest package of smart-sync cli, run:

```
$ npm i smart-sync -g
```

To compile the project yourself and install it, see section [Getting started (Dev)](#getting-started-dev)

Under `{INSTALL_DIR}/config` you can find the default configuration for the cli. Adjust the fields according to your needs or pass them as options in the command line.

To execute tests, please refer to the [test](#tests) section.

## Usage

### Smart Contract Fork

```bash
$ smart-sync help fork
Usage: smart-sync fork|f [options] [relay_contract_address]

Migrates a given contract address to a target chain and deploys a proxy contract. If no relay contract is provided, a relay contract will be deployed too.

### Synchronizing a Smart Contract

```bash
$ smart-sync help synchronize
Usage: smart-sync synchronize|s [options]

Synchronizes the storage of a proxy contract with its source contracts storage up to an optionally provided block nr on the source chain.

Options:
-l, --log-level verbose level of logging (choices: "fatal", "error", "warn", "info", "debug", "trace", "silly", default: "debug")
-s, --src-chain-rpc-host url of src chain rpc
-t, --target-chain-rpc-url url of target chain rpc
-c, --config-file path to the config file (default: "./config/cli-config.json")
--connection-timeout connection timeout in ms
--src-blocknr block number of src chain to use
--diff-mode Diff function to use. When using storage, option --src-BlockNr equals block on srcChain and --target-BlockNr block on targetChain. When using srcTx
--src-BlockNr describes block from where to replay tx until --target-blockNr. (choices: "storage", "srcTx")
--target-blocknr see --diff-mode for further explanation
--gas-limit gas limit for tx on target chain
-h, --help display help for command
```

Example usage:
```bash
$ smart-sync s 0x010A3d554c8d772aAC357e079B4D57B6dA28a43a --target-blockNr 450
```

### Continuously synchronizing Smart Contracts
```bash
$ smart-sync continuous-synch --help
Usage: smart-sync continuous-synch|c [options]

Periodically synch state updates.

Arguments:
proxy_contract_address
period Define the updating period. Be sure to pass the period within " (Example: "*/2 * * * *"). The crontab syntax is based on the GNU crontab syntax. For information visit https://www.npmjs.com/package/node-cron.

Options:
-l, --log-level verbose level of logging (choices: "fatal", "error", "warn", "info", "debug", "trace", "silly", default: "info")
-s, --src-chain-rpc-host url of src chain rpc
-t, --target-chain-rpc-url url of target chain rpc
-c, --config-file path to the config file (default: "./config/cli-config.json")
--connection-timeout connection timeout in ms
--src-blocknr block number of src chain to use
--gas-limit
--diff-mode Diff function to use. When using storage, option --src-BlockNr equals block on srcChain and --target-BlockNr block on targetChain. When using srcTx --src-BlockNr describes block from where to replay tx until --target-blockNr. (choices: "storage",
"srcTx")
--target-blocknr see --diff-mode for further explanation
-h, --help display help for command
```

Example usage:
```bash
$ smart-sync c 0x010A3d554c8d772aAC357e079B4D57B6dA28a43a "*/2 * * * *"
```

### Retrieve migration status
```bash
$ smart-sync help migration-status
Usage: smart-sync migration-status|status [options]

Checks if the storage root of the proxy contract equals the current storage root of the source contract in the relay contract on the target chain.

Get the synched block number of src chain for the provided proxy contract.

### Retrieve state diff
```bash
$ smart-sync help state-diff
Usage: smart-sync state-diff|diff [options] [proxy_contract_address]

Shows the state diff between source contract and proxy contract on target chain. If diff-mode == storage, proxy_contract_address has to be provided.

Options:
-l, --log-level verbose level of logging (choices: "fatal", "error", "warn", "info", "debug", "trace", "silly", default: "debug")
-s, --src-chain-rpc-host url of src chain rpc
-t, --target-chain-rpc-url url of target chain rpc
-c, --config-file path to the config file (default: "./config/cli-config.json")
--connection-timeout connection timeout in ms
--src-blocknr block number of src chain to use
--diff-mode Diff function to use. When using storage, option --src-BlockNr equals block on srcChain and --target-BlockNr block on targetChain. When using srcTx
--src-BlockNr describes block from where to replay tx until --target-blockNr. If no blocks are given when using srcTx, then only the latest block
is examined. (choices: "storage", "srcTx")
--target-blocknr see --diff-mode for further explanation
-h, --help display help for command
```
Example usage:
```bash
$ smart-sync diff 0x20a508640B446990c781Cd541B9a2828ACA3a350 0xf8f22ab160e8a09fbf404a44139d9b5da936e3cb --diff-mode storage --src-blocknr 450
```

# Getting started (Dev)

This project uses [hardhat](https://hardhat.org/getting-started/) and [ethers](https://docs.ethers.io/v5/) among other things.

### Install dev packages

```bash
$ npm i --development
```

### Compile project
To execute the compile-pipeline of this project run:

```bash
$ npx grunt compile-project
```

This cleans the dist folder, compiles the contracts, lints the src files and executes tsc. If you want to execute those steps individually see `npx grunt --help` for all available individual commands:

Available tasks:
Command | Description
------------ | -------------
eslint | Validate files with ESLint *
mochaTest | Run node unit tests with Mocha *
clean | Clean files and folders. *
default | Alias for "eslint" task.
start-chains | Startup chain
stop-chains | Stopping chain
compile-project | Generate js-files
compile-contracts | Generate contract type info
tsc | Compile ts files
install | Install smart-sync locally
install-global | Install smart-sync globally
pack | npm pack smart-sync
npm-pack | npm packaging command
full-pipeline-test | Testing precompiled *.ts project
full-pipeline-dist-test | Testing compiled *.js project inside dist folder
full-pipeline-evaluation | Evaluating project
evaluate | Run evaluation
test | Run tests

### Install CLI
To compile and install the CLI run:
```bash
$ npx grunt install
```
## Chain
Generally, you don't need to start the chain individually since its already started if you execute the command:
``` bash
$ npm run test
```
See [readme](chain/README.md) on how to start the test chains.

## Linter
We use the code style from [airbnb](https://www.npmjs.com/package/eslint-config-airbnb-base).
To execute the linter just type:

```bash
$ npx grunt eslint
```

## Tests
To run all the tests run (requires a running ethereum node, see [hardhat.config.ts](./hardhat.config.ts) and [hardhat.org/config](https://hardhat.org/config/)):

```bash
$ npm run test
```

### Adjusting ports of the test chains
If you want to adjust the ports of the test chains, you just have to change them in the test-config file located at `test/config/test-cli-config.json`. Our scripts will then adjust the ports for the docker containers automatically when you run the command from above.

Alternatively, you can adjust them over the optional parameter `test-chain-port` inside our Grunt task. With `test-config-path` you can even change the test config file path if you changed the location:

```bash
$ npx grunt full-pipeline-test --test-chain-port=9545 --test-config-path=./test/config/test-cli-config.json
```

If you just want to adjust the ports without triggering the tests, execute the following:

```bash
$ npx grunt update-ports --test-chain-port=9545
```

### Running single tests
You can also run single tests (chains need to be started manually):

```bash
$ npx hardhat test test/list-storage-test.ts
```

## Evaluation
To run the evaluation run:

```bash
$ npm run evaluate
```

Or a specific evaluation (chain needs to be started manually):

```bash
$ npx hardhat test evaluation/update-multiple-values-with-map-sizes-1-1000.ts
```

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/disco-project/smart-sync

Awesome Lists containing this project

README