Skip to content

fix typos #174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rootdiae wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

fix typos #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion aggregator/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ type Config struct {
// or batches to generate proofs. It is also used in the isSynced loop
RetryTime types.Duration `mapstructure:"RetryTime"`

// VerifyProofInterval is the interval of time to verify/send an proof in L1
// VerifyProofInterval is the interval of time to verify/send a proof in L1
VerifyProofInterval types.Duration `mapstructure:"VerifyProofInterval"`

// ProofStatePollingInterval is the interval time to polling the prover about the generation state of a proof
Expand Down
2 changes: 1 addition & 1 deletion config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ type Config struct {
EthTxManager ethtxmanager.Config
// Pool service configuration
Pool pool.Config
// Configuration for RPC service. THis one offers a extended Ethereum JSON-RPC API interface to interact with the node
// Configuration for RPC service. THis one offers an extended Ethereum JSON-RPC API interface to interact with the node
RPC jsonrpc.Config
// Configuration of service `Synchronizer`. For this service is also really important the value of `IsTrustedSequencer`
// because depending of this values is going to ask to a trusted node for trusted transactions or not
Expand Down
10 changes: 5 additions & 5 deletions docs/config-file/node-config-doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
| - [Etherman](#Etherman ) | No | object | No | - | Configuration of the etherman (client for access L1) |
| - [EthTxManager](#EthTxManager ) | No | object | No | - | Configuration for ethereum transaction manager |
| - [Pool](#Pool ) | No | object | No | - | Pool service configuration |
| - [RPC](#RPC ) | No | object | No | - | Configuration for RPC service. THis one offers a extended Ethereum JSON-RPC API interface to interact with the node |
| - [RPC](#RPC ) | No | object | No | - | Configuration for RPC service. THis one offers an extended Ethereum JSON-RPC API interface to interact with the node |
| - [Synchronizer](#Synchronizer ) | No | object | No | - | Configuration of service \`Synchronizer\`. For this service is also really important the value of \`IsTrustedSequencer\`<br />because depending of this values is going to ask to a trusted node for trusted transactions or not |
| - [Sequencer](#Sequencer ) | No | object | No | - | Configuration of the sequencer service |
| - [SequenceSender](#SequenceSender ) | No | object | No | - | Configuration of the sequence sender service |
Expand Down Expand Up @@ -246,7 +246,7 @@ Url=""
| - [PrivateKeys](#EthTxManager_PrivateKeys ) | No | array of object | No | - | PrivateKeys defines all the key store files that are going<br />to be read in order to provide the private keys to sign the L1 txs |
| - [ForcedGas](#EthTxManager_ForcedGas ) | No | integer | No | - | ForcedGas is the amount of gas to be forced in case of gas estimation error |
| - [GasPriceMarginFactor](#EthTxManager_GasPriceMarginFactor ) | No | number | No | - | GasPriceMarginFactor is used to multiply the suggested gas price provided by the network<br />in order to allow a different gas price to be set for all the transactions and making it<br />easier to have the txs prioritized in the pool, default value is 1.<br /><br />ex:<br />suggested gas price: 100<br />GasPriceMarginFactor: 1<br />gas price = 100<br /><br />suggested gas price: 100<br />GasPriceMarginFactor: 1.1<br />gas price = 110 |
| - [MaxGasPriceLimit](#EthTxManager_MaxGasPriceLimit ) | No | integer | No | - | MaxGasPriceLimit helps avoiding transactions to be sent over an specified<br />gas price amount, default value is 0, which means no limit.<br />If the gas price provided by the network and adjusted by the GasPriceMarginFactor<br />is greater than this configuration, transaction will have its gas price set to<br />the value configured in this config as the limit.<br /><br />ex:<br /><br />suggested gas price: 100<br />gas price margin factor: 20%<br />max gas price limit: 150<br />tx gas price = 120<br /><br />suggested gas price: 100<br />gas price margin factor: 20%<br />max gas price limit: 110<br />tx gas price = 110 |
| - [MaxGasPriceLimit](#EthTxManager_MaxGasPriceLimit ) | No | integer | No | - | MaxGasPriceLimit helps avoiding transactions to be sent over a specified<br />gas price amount, default value is 0, which means no limit.<br />If the gas price provided by the network and adjusted by the GasPriceMarginFactor<br />is greater than this configuration, transaction will have its gas price set to<br />the value configured in this config as the limit.<br /><br />ex:<br /><br />suggested gas price: 100<br />gas price margin factor: 20%<br />max gas price limit: 150<br />tx gas price = 120<br /><br />suggested gas price: 100<br />gas price margin factor: 20%<br />max gas price limit: 110<br />tx gas price = 110 |

### <a name="EthTxManager_FrequencyToMonitorTxs"></a>6.1. `EthTxManager.FrequencyToMonitorTxs`

Expand Down Expand Up @@ -383,7 +383,7 @@ GasPriceMarginFactor=1

**Default:** `0`

**Description:** MaxGasPriceLimit helps avoiding transactions to be sent over an specified
**Description:** MaxGasPriceLimit helps avoiding transactions to be sent over a specified
gas price amount, default value is 0, which means no limit.
If the gas price provided by the network and adjusted by the GasPriceMarginFactor
is greater than this configuration, transaction will have its gas price set to
Expand Down Expand Up @@ -909,7 +909,7 @@ TxFeeCap=1
## <a name="RPC"></a>8. `[RPC]`

**Type:** : `object`
**Description:** Configuration for RPC service. THis one offers a extended Ethereum JSON-RPC API interface to interact with the node
**Description:** Configuration for RPC service. THis one offers an extended Ethereum JSON-RPC API interface to interact with the node

| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ---------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down Expand Up @@ -2997,7 +2997,7 @@ RetryTime="5s"

**Default:** `"1m30s"`

**Description:** VerifyProofInterval is the interval of time to verify/send an proof in L1
**Description:** VerifyProofInterval is the interval of time to verify/send a proof in L1

**Examples:**

Expand Down
6 changes: 3 additions & 3 deletions docs/config-file/node-config-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@
},
"MaxGasPriceLimit": {
"type": "integer",
"description": "MaxGasPriceLimit helps avoiding transactions to be sent over an specified\ngas price amount, default value is 0, which means no limit.\nIf the gas price provided by the network and adjusted by the GasPriceMarginFactor\nis greater than this configuration, transaction will have its gas price set to\nthe value configured in this config as the limit.\n\nex:\n\nsuggested gas price: 100\ngas price margin factor: 20%\nmax gas price limit: 150\ntx gas price = 120\n\nsuggested gas price: 100\ngas price margin factor: 20%\nmax gas price limit: 110\ntx gas price = 110",
"description": "MaxGasPriceLimit helps avoiding transactions to be sent over a specified\ngas price amount, default value is 0, which means no limit.\nIf the gas price provided by the network and adjusted by the GasPriceMarginFactor\nis greater than this configuration, transaction will have its gas price set to\nthe value configured in this config as the limit.\n\nex:\n\nsuggested gas price: 100\ngas price margin factor: 20%\nmax gas price limit: 150\ntx gas price = 120\n\nsuggested gas price: 100\ngas price margin factor: 20%\nmax gas price limit: 110\ntx gas price = 110",
"default": 0
}
},
Expand Down Expand Up @@ -498,7 +498,7 @@
},
"additionalProperties": false,
"type": "object",
"description": "Configuration for RPC service. THis one offers a extended Ethereum JSON-RPC API interface to interact with the node"
"description": "Configuration for RPC service. THis one offers an extended Ethereum JSON-RPC API interface to interact with the node"
},
"Synchronizer": {
"properties": {
Expand Down Expand Up @@ -1154,7 +1154,7 @@
"VerifyProofInterval": {
"type": "string",
"title": "Duration",
"description": "VerifyProofInterval is the interval of time to verify/send an proof in L1",
"description": "VerifyProofInterval is the interval of time to verify/send a proof in L1",
"default": "1m30s",
"examples": [
"1m",
Expand Down
2 changes: 1 addition & 1 deletion docs/diff/diff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ The main changes on Validium vs Rollup consensus smart contracts are:
- `newEtherman` now depends on the state, needed to instantiate the DA
- `LoadAuthFromKeyStore` returns the raw private key, used to authenticate messages for DAC
- policy CLI added to interact with allow list storage
- needed to change the order of how things are instantiated by adding a `tmpEthMan` as etherman is used to get the L2 chain ID, which is needed for the state, and at the same time the state is needed for for the Etherman. Note that the `tmpEthMan` is used exclusively to get the L2 chain ID
- needed to change the order of how things are instantiated by adding a `tmpEthMan` as etherman is used to get the L2 chain ID, which is needed for the state, and at the same time the state is needed for the Etherman. Note that the `tmpEthMan` is used exclusively to get the L2 chain ID
- `newEtherman` calls `newDataAvailability` as DA is a dependency of Etherman (etherman now pulls data from the DA)
- `newDataAvailability` used to instantiate the DA, in a modular way (switch/case of the supported backends)
- `createSequenceSender` instantiates DA as it's needed to post sequences to the DA layer
Expand Down
2 changes: 1 addition & 1 deletion etherman/etherman.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ func SequencedBatchesSigHash() common.Hash { return sequenceBatchesSignatureHash
// TrustedVerifyBatchesSigHash returns the hash for the `TrustedVerifyBatches` event.
func TrustedVerifyBatchesSigHash() common.Hash { return verifyBatchesTrustedAggregatorSignatureHash }

// EventOrder is the the type used to identify the events order
// EventOrder is the type used to identify the events order
type EventOrder string

const (
Expand Down
2 changes: 1 addition & 1 deletion ethtxmanager/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ type Config struct {
// gas price = 110
GasPriceMarginFactor float64 `mapstructure:"GasPriceMarginFactor"`

// MaxGasPriceLimit helps avoiding transactions to be sent over an specified
// MaxGasPriceLimit helps avoiding transactions to be sent over a specified
// gas price amount, default value is 0, which means no limit.
// If the gas price provided by the network and adjusted by the GasPriceMarginFactor
// is greater than this configuration, transaction will have its gas price set to
Expand Down
2 changes: 1 addition & 1 deletion ethtxmanager/ethtxmanager.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@ func (c *Client) monitorTx(ctx context.Context, mTx monitoredTx, logger *log.Log
}
}

// shouldContinueToMonitorThisTx checks the the tx receipt and decides if it should
// shouldContinueToMonitorThisTx checks the tx receipt and decides if it should
// continue or not to monitor the monitored tx related to the tx from this receipt
func (c *Client) shouldContinueToMonitorThisTx(ctx context.Context, receipt types.Receipt) bool {
// if the receipt has a is successful result, stop monitoring
Expand Down
2 changes: 1 addition & 1 deletion sequencer/finalizer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,7 @@ func (f *finalizer) processTransaction(ctx context.Context, tx *TxTracker, first
if f.effectiveGasPrice.IsEnabled() {
return nil, err
} else {
log.Warnf("effectiveGasPrice is disabled, but failed to to calculate efftive gas price percentage (#1), error: %v", err)
log.Warnf("effectiveGasPrice is disabled, but failed to calculate effective gas price percentage (#1), error: %v", err)
tx.EGPLog.Error = fmt.Sprintf("%s; CalculateEffectiveGasPricePercentage#1: %s", tx.EGPLog.Error, err)
}
} else {
Expand Down
2 changes: 1 addition & 1 deletion state/errors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ var (
// ErrExistingTxGreaterThanProcessedTx indicates that we have more txs stored
// in db than the txs we want to process.
ErrExistingTxGreaterThanProcessedTx = errors.New("there are more transactions in the database than in the processed transaction set")
// ErrOutOfOrderProcessedTx indicates the the processed transactions of an
// ErrOutOfOrderProcessedTx indicates the processed transactions of an
// ongoing batch are not in the same order as the transactions stored in the
// database for the same batch.
ErrOutOfOrderProcessedTx = errors.New("the processed transactions are not in the same order as the stored transactions")
Expand Down