Removed outdated section of primary package.json and add jsdoc comments

.changeset/brown-experts-jam.md

@@ -0,0 +1,5 @@
+---
+'@eth-optimism/contracts': patch
+---
+
+add jsdoc comments

.github/workflows/publish-canary.yml

@@ -24,10 +24,9 @@ jobs:
       hardhat-node: ${{ steps.packages.outputs.hardhat-node }}
       canary-docker-tag: ${{ steps.docker-image-name.outputs.canary-docker-tag }}
       proxyd: ${{ steps.packages.outputs.proxyd }}
-      op-exporter: ${{ steps.packages.outputs.op-exporter }}
-      l2geth-exporter: ${{ steps.packages.outputs.l2geth-exporter }}
-      batch-submitter-service: ${{ steps.packages.outputs.batch-submitter-service }}
-      indexer: ${{ steps.packages.outputs.indexer }}
+      op-exporter : ${{ steps.packages.outputs.op-exporter }}
+      l2geth-exporter : ${{ steps.packages.outputs.l2geth-exporter }}
+      batch-submitter-service : ${{ steps.packages.outputs.batch-submitter-service }}
 
     steps:
       - name: Check out source code
@@ -439,40 +438,3 @@ jobs:
           file: ./ops/docker/Dockerfile.batch-submitter-service
           push: true
           tags: ethereumoptimism/batch-submitter-service:${{ needs.canary-publish.outputs.batch-submitter-service }}
-
-  indexer:
-    name: Publish indexer Version ${{ needs.canary-publish.outputs.canary-docker-tag }}
-    needs: canary-publish
-    if: needs.canary-publish.outputs.indexer != ''
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
-
-      - name: Login to Docker Hub
-        uses: docker/login-action@v1
-        with:
-          username: ${{ secrets.DOCKERHUB_ACCESS_TOKEN_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_ACCESS_TOKEN_SECRET }}
-
-      - name: Set build args
-        id: build_args
-        run: |
-          echo ::set-output name=GITDATE::"$(date +%d-%m-%Y)"
-          echo ::set-output name=GITVERSION::$(jq -r .version ./go/indexer/package.json)
-          echo ::set-output name=GITCOMMIT::"$GITHUB_SHA"
-
-      - name: Build and push
-        uses: docker/build-push-action@v2
-        with:
-          context: .
-          file: ./ops/docker/Dockerfile.indexer
-          push: true
-          tags: ethereumoptimism/batch-submitter-service:${{ needs.canary-publish.outputs.indexer }}
-          build-args: |
-            GITDATE=${{ steps.build_args.outputs.GITDATE }}
-            GITCOMMIT=${{ steps.build_args.outputs.GITCOMMIT }}
-            GITVERSION=${{ steps.build_args.outputs.GITVERSION }}

.github/workflows/release.yml

@@ -19,10 +19,9 @@ jobs:
       replica-healthcheck: ${{ steps.packages.outputs.replica-healthcheck }}
       proxyd: ${{ steps.packages.outputs.proxyd }}
       hardhat-node: ${{ steps.packages.outputs.hardhat-node }}
-      op-exporter: ${{ steps.packages.outputs.op-exporter }}
-      l2geth-exporter: ${{ steps.packages.outputs.l2geth-exporter }}
-      batch-submitter-service: ${{ steps.packages.outputs.batch-submitter-service }}
-      indexer: ${{ steps.packages.outputs.indexer }}
+      op-exporter : ${{ steps.packages.outputs.op-exporter }}
+      l2geth-exporter : ${{ steps.packages.outputs.l2geth-exporter }}
+      batch-submitter-service : ${{ steps.packages.outputs.batch-submitter-service }}
 
     steps:
       - name: Checkout Repo
@@ -417,40 +416,3 @@ jobs:
           file: ./ops/docker/Dockerfile.batch-submitter-service
           push: true
           tags: ethereumoptimism/batch-submitter-service:${{ needs.release.outputs.batch-submitter-service }},ethereumoptimism/batch-submitter-service:latest
-
-  indexer:
-    name: Publish Indexer Version ${{ needs.release.outputs.indexer }}
-    needs: release
-    if: needs.release.outputs.indexer != ''
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Login to Docker Hub
-        uses: docker/login-action@v1
-        with:
-          username: ${{ secrets.DOCKERHUB_ACCESS_TOKEN_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_ACCESS_TOKEN_SECRET }}
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
-
-      - name: Set build args
-        id: build_args
-        run: |
-          echo ::set-output name=GITDATE::"$(date +%d-%m-%Y)"
-          echo ::set-output name=GITVERSION::$(jq -r .version ./go/indexer/package.json)
-          echo ::set-output name=GITCOMMIT::"$GITHUB_SHA"
-
-      - name: Publish Indexer
-        uses: docker/build-push-action@v2
-        with:
-          context: .
-          file: ./ops/docker/Dockerfile.indexer
-          push: true
-          tags: ethereumoptimism/indexer:${{ needs.release.outputs.indexer }},ethereumoptimism/indexer:latest
-          build-args: |
-            GITDATE=${{ steps.build_args.outputs.GITDATE }}
-            GITCOMMIT=${{ steps.build_args.outputs.GITCOMMIT }}
-            GITVERSION=${{ steps.build_args.outputs.GITVERSION }}

CONTRIBUTING.md

@@ -138,8 +138,6 @@ docker-compose build
 docker-compose up
 ```
 
-**If a node process exits with exit code: 137** you may need to increase the default memory limit of docker containers
-
 Finally, **if you're running into weird problems and nothing seems to be working**, run:
 
 ```bash

go/teleportr/api/server.go

@@ -280,7 +280,7 @@ func (s *Server) HandleStatus(
 	balanceAfterMaxDeposit := new(big.Int).Add(
 		curBalance, maxDepositAmount,
 	)
-	isAvailable := maxBalance.Cmp(balanceAfterMaxDeposit) >= 0
+	isAvailable := curBalance.Cmp(balanceAfterMaxDeposit) >= 0
 
 	resp := StatusResponse{
 		CurrentBalanceWei:   curBalance.String(),
@@ -405,7 +405,7 @@ type RPCTeleport struct {
 	TxHash         string           `json:"tx_hash"`
 	BlockNumber    string           `json:"block_number"`
 	BlockTimestamp string           `json:"block_timestamp_unix"`
-	Disbursement   *RPCDisbursement `json:"disbursement"`
+	Disbursement   *RPCDisbursement `json:"disbursement,omitempty"`
 }
 
 func makeRPCTeleport(teleport *db.Teleport) RPCTeleport {
@@ -417,7 +417,7 @@ func makeRPCTeleport(teleport *db.Teleport) RPCTeleport {
 		BlockNumber:    strconv.FormatUint(teleport.Deposit.BlockNumber, 10),
 		BlockTimestamp: strconv.FormatInt(teleport.Deposit.BlockTimestamp.Unix(), 10),
 	}
-	if teleport.Disbursement != nil {
+	if rpcTeleport.Disbursement != nil {
 		rpcTeleport.Disbursement = &RPCDisbursement{
 			TxHash:         teleport.Disbursement.TxnHash.String(),
 			BlockNumber:    strconv.FormatUint(teleport.Disbursement.BlockNumber, 10),
@@ -436,10 +436,10 @@ type RPCDisbursement struct {
 }
 
 type TrackResponse struct {
-	CurrentBlockNumber     string      `json:"current_block_number"`
-	ConfirmationsRequired  string      `json:"confirmations_required"`
-	ConfirmationsRemaining string      `json:"confirmations_remaining"`
-	Teleport               RPCTeleport `json:"teleport"`
+	CurrentBlockNumber     string `json:"current_block_number"`
+	ConfirmationsRequired  string `json:"confirmations_required"`
+	ConfirmationsRemaining string `json:"confirmations_remaining"`
+	Teleport               RPCTeleport
 }
 
 func (s *Server) HandleTrack(

go/teleportr/db/db.go

@@ -147,7 +147,7 @@ func (c Config) WithoutDB() string {
 // sslMode retuns "enabled" if EnableSSL is true, otherwise returns "disabled".
 func (c Config) sslMode() string {
 	if c.EnableSSL {
-		return "require"
+		return "enable"
 	}
 	return "disable"
 }

go/teleportr/db/db_test.go

@@ -495,78 +495,3 @@ func TestDeletePendingTx(t *testing.T) {
 	require.Nil(t, err)
 	require.Nil(t, pendingTxs)
 }
-
-// TestLoadTeleports asserts that LoadTeleportByDepositHash and
-// LoadTeleportsByAddress are able to query for a spcific deposit in various
-// stages through the teleport process.
-func TestLoadTeleports(t *testing.T) {
-	t.Parallel()
-
-	d := newDatabase(t)
-	defer d.Close()
-
-	address := common.HexToAddress("0x01")
-	amount := big.NewInt(1000)
-	depTxnHash := common.HexToHash("0x0d01")
-	depBlockNumber := uint64(1)
-	disTxnHash := common.HexToHash("0x0e01")
-	disBlockNumber := uint64(2)
-
-	// Insert deposit.
-	deposit1 := db.Deposit{
-		ID:      1,
-		Address: address,
-		Amount:  amount,
-		ConfirmationInfo: db.ConfirmationInfo{
-			TxnHash:        depTxnHash,
-			BlockNumber:    depBlockNumber,
-			BlockTimestamp: testTimestamp,
-		},
-	}
-
-	err := d.UpsertDeposits([]db.Deposit{deposit1}, 0)
-	require.Nil(t, err)
-
-	// The same, undisbursed teleport should be retruned by hash and address.
-	expTeleport := db.Teleport{
-		Deposit:      deposit1,
-		Disbursement: nil,
-	}
-
-	teleport, err := d.LoadTeleportByDepositHash(depTxnHash)
-	require.Nil(t, err)
-	require.NotNil(t, teleport)
-	require.Equal(t, expTeleport, *teleport)
-
-	teleports, err := d.LoadTeleportsByAddress(address)
-	require.Nil(t, err)
-	require.Equal(t, []db.Teleport{expTeleport}, teleports)
-
-	// Insert a disbursement for the above deposit.
-	err = d.UpsertDisbursement(
-		1, disTxnHash, disBlockNumber, testTimestamp, true,
-	)
-	require.Nil(t, err)
-
-	// The now-complete teleport should be returned from both queries.
-	expTeleport = db.Teleport{
-		Deposit: deposit1,
-		Disbursement: &db.Disbursement{
-			Success: true,
-			ConfirmationInfo: db.ConfirmationInfo{
-				TxnHash:        disTxnHash,
-				BlockNumber:    disBlockNumber,
-				BlockTimestamp: testTimestamp,
-			},
-		},
-	}
-
-	teleport, err = d.LoadTeleportByDepositHash(depTxnHash)
-	require.Nil(t, err)
-	require.NotNil(t, teleport)
-	require.Equal(t, expTeleport, *teleport)
-
-	teleports, err = d.LoadTeleportsByAddress(address)
-	require.Nil(t, err)
-	require.Equal(t, []db.Teleport{expTeleport}, teleports)
-}