Add sequencer data to stream server

config/default.go

@@ -110,6 +110,9 @@ MaxTxLifetime = "3h"
 		ByteGasCost = 16
 		MarginFactor = 1
 		Enabled = false
+	[Sequencer.StreamServer]
+		Port = 0
+		Filename = ""
 
 [SequenceSender]
 WaitPeriodSendSequence = "5s"

config/environments/local/local.node.config.toml

@@ -93,6 +93,9 @@ MaxTxLifetime = "3h"
 		ByteGasCost = 16
 		MarginFactor = 1
 		Enabled = false
+	[Sequencer.StreamServer]
+		Port = 0
+		Filename = ""
 
 [SequenceSender]
 WaitPeriodSendSequence = "5s"

docs/config-file/node-config-doc.html

@@ -42,7 +42,7 @@
 </pre></div> </div><div id=Sequencer_DBManager_PoolRetrievalInterval_ex2 class="jumbotron examples"><div class=highlight><pre><span></span><span class=s2>&quot;300ms&quot;</span>
 </pre></div> </div> <hr> <div class=breadcrumbs> <!-- None --><!-- None --><!-- None --><a href=#Sequencer.DBManager.L2ReorgRetrievalInterval onclick="anchorLink('Sequencer.DBManager.L2ReorgRetrievalInterval')">Sequencer.DBManager.L2ReorgRetrievalInterval=</a> </div> <span class="badge badge-success default-value">Default: "5s"</span><span class="badge badge-dark value-type">Type: string</span><br> <br> <div class="badge badge-secondary">Examples:</div> <br><div id=Sequencer_DBManager_L2ReorgRetrievalInterval_ex1 class="jumbotron examples"><div class=highlight><pre><span></span><span class=s2>&quot;1m&quot;</span>
 </pre></div> </div><div id=Sequencer_DBManager_L2ReorgRetrievalInterval_ex2 class="jumbotron examples"><div class=highlight><pre><span></span><span class=s2>&quot;300ms&quot;</span>
-</pre></div> </div> <hr> </div> </div> </div> </div> <div class=accordion id=accordionSequencer_EffectiveGasPrice> <div class=card> <div class=card-header id=headingSequencer_EffectiveGasPrice> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#Sequencer_EffectiveGasPrice aria-expanded aria-controls=Sequencer_EffectiveGasPrice onclick="setAnchor('#Sequencer_EffectiveGasPrice')"><span class=property-name> <div class=breadcrumbs>[<a href=#Sequencer onclick="anchorLink('Sequencer')">Sequencer</a> . <a href=#Sequencer_EffectiveGasPrice onclick="anchorLink('Sequencer_EffectiveGasPrice')">EffectiveGasPrice</a>] </div></span></button> </h2> EffectiveGasPrice is the config for the gas price </div> <div id=Sequencer_EffectiveGasPrice class="collapse property-definition-div" aria-labelledby=headingSequencer_EffectiveGasPrice data-parent=#accordionSequencer_EffectiveGasPrice> <div class="card-body pl-5"> <div class=breadcrumbs> <!-- None --><!-- None --><!-- None --><a href=#Sequencer.EffectiveGasPrice.MaxBreakEvenGasPriceDeviationPercentage onclick="anchorLink('Sequencer.EffectiveGasPrice.MaxBreakEvenGasPriceDeviationPercentage')">Sequencer.EffectiveGasPrice.MaxBreakEvenGasPriceDeviationPercentage=</a> </div> <span class="badge badge-success default-value">Default: 10</span><span class="badge badge-dark value-type">Type: integer</span><br> <span class=description><p>MaxBreakEvenGasPriceDeviationPercentage is the max allowed deviation percentage BreakEvenGasPrice on re-calculation</p> </span> <hr> <div class=breadcrumbs> <!-- None --><!-- None --><!-- None --><a href=#Sequencer.EffectiveGasPrice.L1GasPriceFactor onclick="anchorLink('Sequencer.EffectiveGasPrice.L1GasPriceFactor')">Sequencer.EffectiveGasPrice.L1GasPriceFactor=</a> </div> <span class="badge badge-success default-value">Default: 0.25</span><span class="badge badge-dark value-type">Type: number</span><br> <span class=description><p>L1GasPriceFactor is the percentage of the L1 gas price that will be used as the L2 min gas price</p> </span> <hr> <div class=breadcrumbs> <!-- None --><!-- None --><!-- None --><a href=#Sequencer.EffectiveGasPrice.ByteGasCost onclick="anchorLink('Sequencer.EffectiveGasPrice.ByteGasCost')">Sequencer.EffectiveGasPrice.ByteGasCost=</a> </div> <span class="badge badge-success default-value">Default: 16</span><span class="badge badge-dark value-type">Type: integer</span><br> <span class=description><p>ByteGasCost is the gas cost per byte</p> </span> <hr> <div class=breadcrumbs> <!-- None --><!-- None --><!-- None --><a href=#Sequencer.EffectiveGasPrice.MarginFactor onclick="anchorLink('Sequencer.EffectiveGasPrice.MarginFactor')">Sequencer.EffectiveGasPrice.MarginFactor=</a> </div> <span class="badge badge-success default-value">Default: 1</span><span class="badge badge-dark value-type">Type: number</span><br> <span class=description><p>MarginFactor is the margin factor percentage to be added to the L2 min gas price</p> </span> <hr> <div class=breadcrumbs> <!-- None --><!-- None --><!-- None --><a href=#Sequencer.EffectiveGasPrice.Enabled onclick="anchorLink('Sequencer.EffectiveGasPrice.Enabled')">Sequencer.EffectiveGasPrice.Enabled=</a> </div> <span class="badge badge-success default-value">Default: false</span><span class="badge badge-dark value-type">Type: boolean</span><br> <span class=description><p>Enabled is a flag to enable/disable the effective gas price</p> </span> <hr> <div class=breadcrumbs> <!-- None --><!-- None --><!-- None --><a href=#Sequencer.EffectiveGasPrice.DefaultMinGasPriceAllowed onclick="anchorLink('Sequencer.EffectiveGasPrice.DefaultMinGasPriceAllowed')">Sequencer.EffectiveGasPrice.DefaultMinGasPriceAllowed=</a> </div> <span class="badge badge-success default-value">Default: 0</span><span class="badge badge-dark value-type">Type: integer</span><br> <span class=description><p>DefaultMinGasPriceAllowed is the default min gas price to suggest<br> This value is assigned from [Pool].DefaultMinGasPriceAllowed</p> </span> <hr> </div> </div> </div> </div> </div> </div> </div> </div> <div class=accordion id=accordionSequenceSender> <div class=card> <div class=card-header id=headingSequenceSender> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#SequenceSender aria-expanded aria-controls=SequenceSender onclick="setAnchor('#SequenceSender')"><span class=property-name> <div class=breadcrumbs>[<a href=#SequenceSender onclick="anchorLink('SequenceSender')">SequenceSender</a>] </div></span></button> </h2> Configuration of the sequence sender service </div> <div id=SequenceSender class="collapse property-definition-div" aria-labelledby=headingSequenceSender data-parent=#accordionSequenceSender> <div class="card-body pl-5"> <div class=breadcrumbs> <!-- None --><!-- None --><a href=#SequenceSender.WaitPeriodSendSequence onclick="anchorLink('SequenceSender.WaitPeriodSendSequence')">SequenceSender.WaitPeriodSendSequence=</a> </div> <span class="badge badge-success default-value">Default: "5s"</span><span class="badge badge-dark value-type">Type: string</span><br> <span class=description><p>WaitPeriodSendSequence is the time the sequencer waits until<br> trying to send a sequence to L1</p> </span> <br> <div class="badge badge-secondary">Examples:</div> <br><div id=SequenceSender_WaitPeriodSendSequence_ex1 class="jumbotron examples"><div class=highlight><pre><span></span><span class=s2>&quot;1m&quot;</span>
+</pre></div> </div> <hr> </div> </div> </div> </div> <div class=accordion id=accordionSequencer_EffectiveGasPrice> <div class=card> <div class=card-header id=headingSequencer_EffectiveGasPrice> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#Sequencer_EffectiveGasPrice aria-expanded aria-controls=Sequencer_EffectiveGasPrice onclick="setAnchor('#Sequencer_EffectiveGasPrice')"><span class=property-name> <div class=breadcrumbs>[<a href=#Sequencer onclick="anchorLink('Sequencer')">Sequencer</a> . <a href=#Sequencer_EffectiveGasPrice onclick="anchorLink('Sequencer_EffectiveGasPrice')">EffectiveGasPrice</a>] </div></span></button> </h2> EffectiveGasPrice is the config for the gas price </div> <div id=Sequencer_EffectiveGasPrice class="collapse property-definition-div" aria-labelledby=headingSequencer_EffectiveGasPrice data-parent=#accordionSequencer_EffectiveGasPrice> <div class="card-body pl-5"> <div class=breadcrumbs> <!-- None --><!-- None --><!-- None --><a href=#Sequencer.EffectiveGasPrice.MaxBreakEvenGasPriceDeviationPercentage onclick="anchorLink('Sequencer.EffectiveGasPrice.MaxBreakEvenGasPriceDeviationPercentage')">Sequencer.EffectiveGasPrice.MaxBreakEvenGasPriceDeviationPercentage=</a> </div> <span class="badge badge-success default-value">Default: 10</span><span class="badge badge-dark value-type">Type: integer</span><br> <span class=description><p>MaxBreakEvenGasPriceDeviationPercentage is the max allowed deviation percentage BreakEvenGasPrice on re-calculation</p> </span> <hr> <div class=breadcrumbs> <!-- None --><!-- None --><!-- None --><a href=#Sequencer.EffectiveGasPrice.L1GasPriceFactor onclick="anchorLink('Sequencer.EffectiveGasPrice.L1GasPriceFactor')">Sequencer.EffectiveGasPrice.L1GasPriceFactor=</a> </div> <span class="badge badge-success default-value">Default: 0.25</span><span class="badge badge-dark value-type">Type: number</span><br> <span class=description><p>L1GasPriceFactor is the percentage of the L1 gas price that will be used as the L2 min gas price</p> </span> <hr> <div class=breadcrumbs> <!-- None --><!-- None --><!-- None --><a href=#Sequencer.EffectiveGasPrice.ByteGasCost onclick="anchorLink('Sequencer.EffectiveGasPrice.ByteGasCost')">Sequencer.EffectiveGasPrice.ByteGasCost=</a> </div> <span class="badge badge-success default-value">Default: 16</span><span class="badge badge-dark value-type">Type: integer</span><br> <span class=description><p>ByteGasCost is the gas cost per byte</p> </span> <hr> <div class=breadcrumbs> <!-- None --><!-- None --><!-- None --><a href=#Sequencer.EffectiveGasPrice.MarginFactor onclick="anchorLink('Sequencer.EffectiveGasPrice.MarginFactor')">Sequencer.EffectiveGasPrice.MarginFactor=</a> </div> <span class="badge badge-success default-value">Default: 1</span><span class="badge badge-dark value-type">Type: number</span><br> <span class=description><p>MarginFactor is the margin factor percentage to be added to the L2 min gas price</p> </span> <hr> <div class=breadcrumbs> <!-- None --><!-- None --><!-- None --><a href=#Sequencer.EffectiveGasPrice.Enabled onclick="anchorLink('Sequencer.EffectiveGasPrice.Enabled')">Sequencer.EffectiveGasPrice.Enabled=</a> </div> <span class="badge badge-success default-value">Default: false</span><span class="badge badge-dark value-type">Type: boolean</span><br> <span class=description><p>Enabled is a flag to enable/disable the effective gas price</p> </span> <hr> <div class=breadcrumbs> <!-- None --><!-- None --><!-- None --><a href=#Sequencer.EffectiveGasPrice.DefaultMinGasPriceAllowed onclick="anchorLink('Sequencer.EffectiveGasPrice.DefaultMinGasPriceAllowed')">Sequencer.EffectiveGasPrice.DefaultMinGasPriceAllowed=</a> </div> <span class="badge badge-success default-value">Default: 0</span><span class="badge badge-dark value-type">Type: integer</span><br> <span class=description><p>DefaultMinGasPriceAllowed is the default min gas price to suggest<br> This value is assigned from [Pool].DefaultMinGasPriceAllowed</p> </span> <hr> </div> </div> </div> </div> <div class=accordion id=accordionSequencer_StreamServer> <div class=card> <div class=card-header id=headingSequencer_StreamServer> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#Sequencer_StreamServer aria-expanded aria-controls=Sequencer_StreamServer onclick="setAnchor('#Sequencer_StreamServer')"><span class=property-name> <div class=breadcrumbs>[<a href=#Sequencer onclick="anchorLink('Sequencer')">Sequencer</a> . <a href=#Sequencer_StreamServer onclick="anchorLink('Sequencer_StreamServer')">StreamServer</a>] </div></span></button> </h2> StreamServer is the config for the stream server </div> <div id=Sequencer_StreamServer class="collapse property-definition-div" aria-labelledby=headingSequencer_StreamServer data-parent=#accordionSequencer_StreamServer> <div class="card-body pl-5"> <div class=breadcrumbs> <!-- None --><!-- None --><!-- None --><a href=#Sequencer.StreamServer.Port onclick="anchorLink('Sequencer.StreamServer.Port')">Sequencer.StreamServer.Port=</a> </div> <span class="badge badge-success default-value">Default: 0</span><span class="badge badge-dark value-type">Type: integer</span><br> <hr> <div class=breadcrumbs> <!-- None --><!-- None --><!-- None --><a href=#Sequencer.StreamServer.Filename onclick="anchorLink('Sequencer.StreamServer.Filename')">Sequencer.StreamServer.Filename=</a> </div> <span class="badge badge-success default-value">Default: ""</span><span class="badge badge-dark value-type">Type: string</span><br> <hr> </div> </div> </div> </div> </div> </div> </div> </div> <div class=accordion id=accordionSequenceSender> <div class=card> <div class=card-header id=headingSequenceSender> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#SequenceSender aria-expanded aria-controls=SequenceSender onclick="setAnchor('#SequenceSender')"><span class=property-name> <div class=breadcrumbs>[<a href=#SequenceSender onclick="anchorLink('SequenceSender')">SequenceSender</a>] </div></span></button> </h2> Configuration of the sequence sender service </div> <div id=SequenceSender class="collapse property-definition-div" aria-labelledby=headingSequenceSender data-parent=#accordionSequenceSender> <div class="card-body pl-5"> <div class=breadcrumbs> <!-- None --><!-- None --><a href=#SequenceSender.WaitPeriodSendSequence onclick="anchorLink('SequenceSender.WaitPeriodSendSequence')">SequenceSender.WaitPeriodSendSequence=</a> </div> <span class="badge badge-success default-value">Default: "5s"</span><span class="badge badge-dark value-type">Type: string</span><br> <span class=description><p>WaitPeriodSendSequence is the time the sequencer waits until<br> trying to send a sequence to L1</p> </span> <br> <div class="badge badge-secondary">Examples:</div> <br><div id=SequenceSender_WaitPeriodSendSequence_ex1 class="jumbotron examples"><div class=highlight><pre><span></span><span class=s2>&quot;1m&quot;</span>
 </pre></div> </div><div id=SequenceSender_WaitPeriodSendSequence_ex2 class="jumbotron examples"><div class=highlight><pre><span></span><span class=s2>&quot;300ms&quot;</span>
 </pre></div> </div> <hr> <div class=breadcrumbs> <!-- None --><!-- None --><a href=#SequenceSender.LastBatchVirtualizationTimeMaxWaitPeriod onclick="anchorLink('SequenceSender.LastBatchVirtualizationTimeMaxWaitPeriod')">SequenceSender.LastBatchVirtualizationTimeMaxWaitPeriod=</a> </div> <span class="badge badge-success default-value">Default: "5s"</span><span class="badge badge-dark value-type">Type: string</span><br> <span class=description><p>LastBatchVirtualizationTimeMaxWaitPeriod is time since sequences should be sent</p> </span> <br> <div class="badge badge-secondary">Examples:</div> <br><div id=SequenceSender_LastBatchVirtualizationTimeMaxWaitPeriod_ex1 class="jumbotron examples"><div class=highlight><pre><span></span><span class=s2>&quot;1m&quot;</span>
 </pre></div> </div><div id=SequenceSender_LastBatchVirtualizationTimeMaxWaitPeriod_ex2 class="jumbotron examples"><div class=highlight><pre><span></span><span class=s2>&quot;300ms&quot;</span>

docs/config-file/node-config-doc.md

@@ -1030,6 +1030,7 @@ TrustedSequencerURL=""
 | - [Finalizer](#Sequencer_Finalizer )                                         | No      | object  | No         | -          | Finalizer's specific config properties                                                                                                             |
 | - [DBManager](#Sequencer_DBManager )                                         | No      | object  | No         | -          | DBManager's specific config properties                                                                                                             |
 | - [EffectiveGasPrice](#Sequencer_EffectiveGasPrice )                         | No      | object  | No         | -          | EffectiveGasPrice is the config for the gas price                                                                                                  |
+| - [StreamServer](#Sequencer_StreamServer )                                   | No      | object  | No         | -          | StreamServer is the config for the stream server                                                                                                   |
 
 ### <a name="Sequencer_WaitPeriodPoolIsEmpty"></a>10.1. `Sequencer.WaitPeriodPoolIsEmpty`
 
@@ -1721,6 +1722,40 @@ This value is assigned from [Pool].DefaultMinGasPriceAllowed
 DefaultMinGasPriceAllowed=0
 ```
 
+### <a name="Sequencer_StreamServer"></a>10.19. `[Sequencer.StreamServer]`
+
+**Type:** : `object`
+**Description:** StreamServer is the config for the stream server
+
+| Property                                        | Pattern | Type    | Deprecated | Definition | Title/Description |
+| ----------------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------- |
+| - [Port](#Sequencer_StreamServer_Port )         | No      | integer | No         | -          | -                 |
+| - [Filename](#Sequencer_StreamServer_Filename ) | No      | string  | No         | -          | -                 |
+
+#### <a name="Sequencer_StreamServer_Port"></a>10.19.1. `Sequencer.StreamServer.Port`
+
+**Type:** : `integer`
+
+**Default:** `0`
+
+**Example setting the default value** (0):
+```
+[Sequencer.StreamServer]
+Port=0
+```
+
+#### <a name="Sequencer_StreamServer_Filename"></a>10.19.2. `Sequencer.StreamServer.Filename`
+
+**Type:** : `string`
+
+**Default:** `""`
+
+**Example setting the default value** (""):
+```
+[Sequencer.StreamServer]
+Filename=""
+```
+
 ## <a name="SequenceSender"></a>11. `[SequenceSender]`
 
 **Type:** : `object`

docs/config-file/node-config-schema.json

@@ -642,6 +642,21 @@
 					"additionalProperties": false,
 					"type": "object",
 					"description": "EffectiveGasPrice is the config for the gas price"
+				},
+				"StreamServer": {
+					"properties": {
+						"Port": {
+							"type": "integer",
+							"default": 0
+						},
+						"Filename": {
+							"type": "string",
+							"default": ""
+						}
+					},
+					"additionalProperties": false,
+					"type": "object",
+					"description": "StreamServer is the config for the stream server"
 				}
 			},
 			"additionalProperties": false,