merge conflict

taikoxyz · Dec 15, 2022 · 791337e · 791337e
2 parents 80994d8 + ba3b73a
commit 791337e
Show file tree

Hide file tree

Showing 26 changed files with 275 additions and 218 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,74 +1,93 @@
 # Contributing guide
 
-## Table of contents
+This contributing guide is divided into the following sections:
 
-1. [Issue guide](#issue-guide)
-2. [Coding style guide](#coding-style-guide)
-3. [Documentation style guide](#documentation-style-guide)
-4. [Git workflow](#git-workflow)
+1. [Make a contribution](#make-a-contribution)
+2. [Claim a GitPOAP](#claim-a-gitpoap)
+3. [Git standards](#git-standards)
+4. [Documentation style guide](#documentation-style-guide)
 
-## Issue guide
+# Make a contribution
 
-As an open source project, you are free to open issues and work on issues. Please comment on the issue discussion if you are thinking of contributing or picking something up, so as to not overlap on any work.
+We use [GitHub issues](https://github.com/taikoxyz/taiko-mono/issues) to track work. We use [GitHub discussions](https://github.com/taikoxyz/taiko-mono/discussions) to ask questions and talk about ideas.
 
-### Finding an issue to work on
+## Opening a new issue
 
-If you are looking for a good issue to start with, look for issues tagged with "good first issue".
+If you are opening a new issue, try to be descriptive as possible. Also please check if an existing issue already exists for it already.
 
-### Opening a new issue
+## Working on an issue
 
-If you are opening a new issue, try to be descriptive as possible. Also please check if an existing issue already exists for it already.
+If you are looking for a good issue to start with, look for issues tagged with [good first issue](https://github.com/taikoxyz/taiko-mono/labels/good%20first%20issue). Once you've found an issue to work on, you can assign it to yourself on GitHub and/or leave a comment that you're picking it up. Take a look at our [git standards](#git-standards).
 
-## Coding style guide
+## Ask questions and start discussions
 
-### Source code comments
+You can participate in questions and discussions under our [GitHub discussions](https://github.com/taikoxyz/taiko-mono/discussions).
 
-Follow the [NatSpec format](https://docs.soliditylang.org/en/v0.8.16/natspec-format.html) for documenting smart contract source code. Please adhere to a few additional standards:
+# Claim a GitPOAP
 
-- Choose `/** */` over `///` for multi-line NatSpec comments, to save column space
-- Omit the usage of `@notice`, this will be automatically picked up so it will save column space and improve readability
-- Take advantage of inheritance for docs (such as documenting the interface), if you need to specify inherited docs use `@inheritdoc`
+We are rewarding community contributions with a GitPOAP. This guide explains the requirements to claim a GitPOAP.
+
+## XXXX Taiko Contributor GitPOAP
 
-### Git standards
+The XXXX Taiko Contributor GitPOAP is intended for anyone who makes a meaningful contribution to Taiko during the year XXXX. You can only earn this in the following ways:
 
-#### Commits
+- Receive an accepted answer under [GitHub Discussions](https://github.com/taikoxyz/taiko-mono/discussions)
+- Merge in a change to one of [our GitHub repos](https://github.com/taikoxyz)
+
+## How do I receive my GitPOAP?
+
+There are two ways to receive a GitPOAP:
+
+- If you merged in a pull request, the gitpoap-bot should have left you a comment to receive your GitPOAP like so:
+  ![](/assets/images/2022-12-14-09-30-37.png)
+- If you made another contribution which fits the requirements of the GitPOAP, please ping the team on Discord so we can issue a GitPOAP manually.
+
+# Git standards
+
+## Creating commits
 
 Try to specify the scope of your change via a [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) (eg. `enhance(docs): improve some section`) or specifying the scope in brackets (eg. `[docs] improve some section`).
 
-## Documentation style guide
+## Submitting a PR
+
+Please make sure to use a conventional commit in your PR title (eg. `feat(scope): description of feature`). This will be squashed and merged into the `main` branch.
 
-### Document types
+## GitHub Actions
 
-Group documentation under one of the four categories:
+Each commit will automatically trigger the GitHub Actions to run. If any commit message in your push or the HEAD commit of your PR contains the strings [skip ci], [ci skip], [no ci], [skip actions], or [actions skip] workflows triggered on the push or pull_request events will be skipped.
 
-- Tutorials
-- Guides
-- Concepts
-- Reference
+# Documentation style guide
+
+Many standards are adopted from [Google dev docs highlights](https://developers.google.com/style/highlights).
 
-### Philosophy
+## Philosophy
 
-- Aim for "better" instead of "perfect" -- any enhancement is a worthwhile improvement.
-- Create the minimum viable documentation.
+- Create the [minimum viable documentation](https://google.github.io/styleguide/docguide/best_practices.html#minimum-viable-documentation).
 - Don't repeat yourself, use links to existing documentation or inherit it.
-- Generate documentation automatically from source code whenever possible.
-- Keep your comments as close as possible to the actual source code it is describing.
+- Keep documentation close to what it's describing, also called high cohesion (eg. describing a smart contract should be documented as comments in the source code).
 
-### Standards
+## Document types
+
+Group documentation under one of the four categories (adopted from [Diátaxis](https://diataxis.fr/)):
+
+- Tutorials
+- Guides
+- Concepts
+- Reference
 
-#### Tone and content
+## Tone and content
 
 - [Use descriptive link text](https://developers.google.com/style/link-text).
 - [Write accessibly](https://developers.google.com/style/accessibility).
 - [Write for a global audience](https://developers.google.com/style/translation).
 
-#### Language and grammar
+## Language and grammar
 
 - [Use second person](https://developers.google.com/style/person): "you" rather than "we".
 - [Use active voice](https://developers.google.com/style/voice): make clear who's performing the action.
 - [Put conditional clauses before instructions](https://developers.google.com/style/clause-order), not after.
 
-#### Formatting, punctuation, and organization
+## Formatting, punctuation, and organization
 
 - [Use sentence case](https://developers.google.com/style/capitalization) for document titles and section headings.
 - [Use numbered lists](https://developers.google.com/style/lists#types-of-lists) for sequences.
@@ -77,55 +96,15 @@ Group documentation under one of the four categories:
 - [Use serial commas](https://developers.google.com/style/commas).
 - [Use unambiguous date formatting](https://developers.google.com/style/dates-times).
 
-#### Images
+## Source code comments
 
-- Use SVG files or crushed PNG images.
-- Provide alt text.
-
-#### Code blocks
-
-- Do not use `$` in shell blocks.
-
-  Incorrect ❌:
-
-  ```sh
-  $ echo "this is worse for copy paste"
-  ```
-
-  Correct ✅:
-
-  ```sh
-  echo "this is better for copy paste"
-  ```
-
-- Escape new lines.
-
-  Incorrect ❌:
-
-  ```sh
-  echo "going to pretend that this"
-  && echo "is some really long command"
-  ```
-
-  Correct ✅:
-
-  ```sh
-  echo "at least the command" \
-  && echo "looks good when copy pastad"
-  ```
-
-## Git workflow
-
-### Submitting a PR
-
-Please make sure to use a conventional commit in your PR title (eg. `feat(scope): description of feature`). This will be squashed and merged into the `main` branch.
-
-### GitHub Actions
+Follow the [NatSpec format](https://docs.soliditylang.org/en/v0.8.16/natspec-format.html) for documenting smart contract source code. Please adhere to a few additional standards:
 
-Each commit will automatically trigger the GitHub Actions to run. If any commit message in your push or the HEAD commit of your PR contains the strings [skip ci], [ci skip], [no ci], [skip actions], or [actions skip] workflows triggered on the push or pull_request events will be skipped.
+- Choose `/** */` over `///` for multi-line NatSpec comments, to save column space
+- Omit the usage of `@notice`, this will be automatically picked up so it will save column space and improve readability
+- Take advantage of inheritance for docs (such as documenting the interface), if you need to specify inherited docs use `@inheritdoc`
 
-## References
+## Images
 
-- [Diátaxis](https://diataxis.fr/)
-- [Google dev docs highlights](https://developers.google.com/style/highlights)
-- [Google docs styleguide](https://google.github.io/styleguide/docguide/)
+- Use SVG files or crushed PNG images.
+- Provide alt text.
diff --git a/README.md b/README.md
@@ -33,6 +33,12 @@
 
 Most documentation can be found on the website, at [taiko.xyz](https://taiko.xyz). There should also be a README in each package, as well as comments in the source code.
 
+## Questions and discussions
+
+Ask questions and start discussions for new ideas under [GitHub Discussions](https://github.com/taikoxyz/taiko-mono/discussions).
+
+If you have a specific request/report, you can [open an issue](https://github.com/taikoxyz/taiko-mono/issues/new/choose).
+
 ## Project structure
 
 <pre>

diff --git a/packages/bridge-ui/src/components/form/BridgeForm.svelte b/packages/bridge-ui/src/components/form/BridgeForm.svelte
@@ -270,7 +270,7 @@
       placeholder="0.01"
       min="0"
       on:input={updateAmount}
-      class="input input-primary bg-dark-4 input-md md:input-lg w-full"
+      class="input input-primary bg-dark-4 input-md md:input-lg w-full focus:ring-0"
       name="amount"
     />
     <SelectToken />
@@ -312,3 +312,13 @@
     {$_("home.approve")}
   </button>
 {/if}
+
+<style>
+  /* hide number input arrows */
+  input[type="number"]::-webkit-outer-spin-button,
+  input[type="number"]::-webkit-inner-spin-button {
+    -webkit-appearance: none;
+    margin: 0;
+    -moz-appearance: textfield !important;
+  }
+</style>
diff --git a/packages/relayer/.default.env b/packages/relayer/.default.env
@@ -18,4 +18,5 @@ MYSQL_CONN_MAX_LIFETIME_IN_MS=
 NUM_GOROUTINES=20
 SUBSCRIPTION_BACKOFF_IN_SECONDS=3
 CONFIRMATIONS_BEFORE_PROCESSING=15
-CORS_ORIGINS=*
+CORS_ORIGINS=*
+HEADER_SYNC_INTERVAL_IN_SECONDS=60
diff --git a/packages/relayer/.golangci.yml b/packages/relayer/.golangci.yml
@@ -28,10 +28,10 @@ linters:
 
 linters-settings:
   funlen:
-    lines: 123
-    statements: 50
+    lines: 130
+    statements: 52
   gocognit:
-    min-complexity: 37
+    min-complexity: 40
 
 issues:
   exclude-rules:

diff --git a/packages/relayer/cli/cli.go b/packages/relayer/cli/cli.go
@@ -42,10 +42,11 @@ var (
 		"PROMETHEUS_HTTP_PORT",
 	}
 
-	defaultBlockBatchSize      = 2
-	defaultNumGoroutines       = 10
-	defaultSubscriptionBackoff = 2 * time.Second
-	defaultConfirmations       = 15
+	defaultBlockBatchSize                = 2
+	defaultNumGoroutines                 = 10
+	defaultSubscriptionBackoff           = 2 * time.Second
+	defaultConfirmations                 = 15
+	defaultHeaderSyncIntervalSeconds int = 60
 )
 
 func Run(
@@ -150,12 +151,17 @@ func makeIndexers(
 	var subscriptionBackoff time.Duration
 
 	subscriptionBackoffInSeconds, err := strconv.Atoi(os.Getenv("SUBSCRIPTION_BACKOFF_IN_SECONDS"))
-	if err != nil || numGoroutines <= 0 {
+	if err != nil || subscriptionBackoffInSeconds <= 0 {
 		subscriptionBackoff = defaultSubscriptionBackoff
 	} else {
 		subscriptionBackoff = time.Duration(subscriptionBackoffInSeconds) * time.Second
 	}
 
+	headerSyncIntervalInSeconds, err := strconv.Atoi(os.Getenv("HEADER_SYNC_INTERVAL_IN_SECONDS"))
+	if err != nil || headerSyncIntervalInSeconds <= 0 {
+		headerSyncIntervalInSeconds = defaultHeaderSyncIntervalSeconds
+	}
+
 	confirmations, err := strconv.Atoi(os.Getenv("CONFIRMATIONS_BEFORE_PROCESSING"))
 	if err != nil || confirmations <= 0 {
 		confirmations = defaultConfirmations
@@ -198,11 +204,12 @@ func makeIndexers(
 			DestTaikoAddress:  common.HexToAddress(os.Getenv("L2_TAIKO_ADDRESS")),
 			SrcTaikoAddress:   common.HexToAddress(os.Getenv("L1_TAIKO_ADDRESS")),
 
-			BlockBatchSize:      uint64(blockBatchSize),
-			NumGoroutines:       numGoroutines,
-			SubscriptionBackoff: subscriptionBackoff,
-			Confirmations:       uint64(confirmations),
-			ProfitableOnly:      profitableOnly,
+			BlockBatchSize:              uint64(blockBatchSize),
+			NumGoroutines:               numGoroutines,
+			SubscriptionBackoff:         subscriptionBackoff,
+			Confirmations:               uint64(confirmations),
+			ProfitableOnly:              profitableOnly,
+			HeaderSyncIntervalInSeconds: int64(headerSyncIntervalInSeconds),
 		})
 		if err != nil {
 			log.Fatal(err)
@@ -225,11 +232,12 @@ func makeIndexers(
 			DestBridgeAddress: common.HexToAddress(os.Getenv("L1_BRIDGE_ADDRESS")),
 			DestTaikoAddress:  common.HexToAddress(os.Getenv("L1_TAIKO_ADDRESS")),
 
-			BlockBatchSize:      uint64(blockBatchSize),
-			NumGoroutines:       numGoroutines,
-			SubscriptionBackoff: subscriptionBackoff,
-			Confirmations:       uint64(confirmations),
-			ProfitableOnly:      profitableOnly,
+			BlockBatchSize:              uint64(blockBatchSize),
+			NumGoroutines:               numGoroutines,
+			SubscriptionBackoff:         subscriptionBackoff,
+			Confirmations:               uint64(confirmations),
+			ProfitableOnly:              profitableOnly,
+			HeaderSyncIntervalInSeconds: int64(headerSyncIntervalInSeconds),
 		})
 		if err != nil {
 			log.Fatal(err)

diff --git a/packages/relayer/indexer/service.go b/packages/relayer/indexer/service.go
@@ -50,22 +50,23 @@ type Service struct {
 }
 
 type NewServiceOpts struct {
-	EventRepo           relayer.EventRepository
-	BlockRepo           relayer.BlockRepository
-	EthClient           *ethclient.Client
-	DestEthClient       *ethclient.Client
-	RPCClient           *rpc.Client
-	DestRPCClient       *rpc.Client
-	ECDSAKey            string
-	BridgeAddress       common.Address
-	DestBridgeAddress   common.Address
-	SrcTaikoAddress     common.Address
-	DestTaikoAddress    common.Address
-	BlockBatchSize      uint64
-	NumGoroutines       int
-	SubscriptionBackoff time.Duration
-	Confirmations       uint64
-	ProfitableOnly      relayer.ProfitableOnly
+	EventRepo                   relayer.EventRepository
+	BlockRepo                   relayer.BlockRepository
+	EthClient                   *ethclient.Client
+	DestEthClient               *ethclient.Client
+	RPCClient                   *rpc.Client
+	DestRPCClient               *rpc.Client
+	ECDSAKey                    string
+	BridgeAddress               common.Address
+	DestBridgeAddress           common.Address
+	SrcTaikoAddress             common.Address
+	DestTaikoAddress            common.Address
+	BlockBatchSize              uint64
+	NumGoroutines               int
+	SubscriptionBackoff         time.Duration
+	Confirmations               uint64
+	ProfitableOnly              relayer.ProfitableOnly
+	HeaderSyncIntervalInSeconds int64
 }
 
 func NewService(opts NewServiceOpts) (*Service, error) {
@@ -144,17 +145,18 @@ func NewService(opts NewServiceOpts) (*Service, error) {
 	}
 
 	processor, err := message.NewProcessor(message.NewProcessorOpts{
-		Prover:           prover,
-		ECDSAKey:         privateKey,
-		RPCClient:        opts.RPCClient,
-		DestETHClient:    opts.DestEthClient,
-		DestBridge:       destBridge,
-		EventRepo:        opts.EventRepo,
-		DestHeaderSyncer: destHeaderSyncer,
-		RelayerAddress:   relayerAddr,
-		Confirmations:    opts.Confirmations,
-		SrcETHClient:     opts.EthClient,
-		ProfitableOnly:   opts.ProfitableOnly,
+		Prover:                    prover,
+		ECDSAKey:                  privateKey,
+		RPCClient:                 opts.RPCClient,
+		DestETHClient:             opts.DestEthClient,
+		DestBridge:                destBridge,
+		EventRepo:                 opts.EventRepo,
+		DestHeaderSyncer:          destHeaderSyncer,
+		RelayerAddress:            relayerAddr,
+		Confirmations:             opts.Confirmations,
+		SrcETHClient:              opts.EthClient,
+		ProfitableOnly:            opts.ProfitableOnly,
+		HeaderSyncIntervalSeconds: opts.HeaderSyncIntervalInSeconds,
 	})
 	if err != nil {
 		return nil, errors.Wrap(err, "message.NewProcessor")