Skip to content
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

chore: fix some comments #780

Merged
merged 2 commits into from
Jan 28, 2025
Merged

chore: fix some comments #780

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03a5b1d
chore: fix some comments
jiangmencity Jan 25, 2025
8aa3418
Merge branch 'master' into master
peterargue Jan 28, 2025
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ There is also a block explorer GUI for the emulator, that will help you speed up

## Configuration

The Flow Emulator can be run in different modes and settings, all of them are described in the table bellow.
The Flow Emulator can be run in different modes and settings, all of them are described in the table below.

Please note that if you will run the emulator using the Flow CLI you must use flags to pass configuration values
and if you plan to run the emulator with Docker you must use the environment variables (Env) to pass configuration
Expand Down Expand Up @@ -64,7 +64,7 @@ values.
| `--storage-limit` | `FLOW_STORAGELIMITENABLED` | `true` | Enable [account storage limit](https://docs.onflow.org/cadence/language/accounts/#storage-limit) |
| `--storage-per-flow` | `FLOW_STORAGEMBPERFLOW` | | Specify size of the storage in MB for each FLOW in account balance. Default value from the flow-go |
| `--min-account-balance` | `FLOW_MINIMUMACCOUNTBALANCE` | | Specify minimum balance the account must have. Default value from the flow-go |
| `--transaction-fees` | `FLOW_TRANSACTIONFEESENABLED` | `false` | Enable variable transaction fees and execution effort metering <br> as decribed in [Variable Transaction Fees: Execution Effort](https://github.com/onflow/flow/pull/753) FLIP |
| `--transaction-fees` | `FLOW_TRANSACTIONFEESENABLED` | `false` | Enable variable transaction fees and execution effort metering <br> as described in [Variable Transaction Fees: Execution Effort](https://github.com/onflow/flow/pull/753) FLIP |
| `--transaction-max-gas-limit` | `FLOW_TRANSACTIONMAXGASLIMIT` | `9999` | Maximum [gas limit for transactions](https://docs.onflow.org/flow-go-sdk/building-transactions/#gas-limit) |
| `--script-gas-limit` | `FLOW_SCRIPTGASLIMIT` | `100000` | Specify gas limit for script execution |
| `--coverage-reporting` | `FLOW_COVERAGEREPORTING` | `false` | Enable Cadence code coverage reporting |
Expand Down
4 changes: 2 additions & 2 deletions docs/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ There is also a block explorer GUI for the emulator, that will help you speed up

## Configuration

The Flow Emulator can be run in different modes and settings, all of them are described in the table bellow.
The Flow Emulator can be run in different modes and settings, all of them are described in the table below.

Please note that if you will run the emulator using the Flow CLI you must use flags to pass configuration values
and if you plan to run the emulator with Docker you must use the environment variables (Env) to pass configuration
Expand Down Expand Up @@ -64,7 +64,7 @@ values.
| `--storage-limit` | `FLOW_STORAGELIMITENABLED` | `true` | Enable [account storage limit](https://docs.onflow.org/cadence/language/accounts/#storage-limit) |
| `--storage-per-flow` | `FLOW_STORAGEMBPERFLOW` | | Specify size of the storage in MB for each FLOW in account balance. Default value from the flow-go |
| `--min-account-balance` | `FLOW_MINIMUMACCOUNTBALANCE` | | Specify minimum balance the account must have. Default value from the flow-go |
| `--transaction-fees` | `FLOW_TRANSACTIONFEESENABLED` | `false` | Enable variable transaction fees and execution effort metering <br> as decribed in [Variable Transaction Fees: Execution Effort](https://github.com/onflow/flow/pull/753) FLIP |
| `--transaction-fees` | `FLOW_TRANSACTIONFEESENABLED` | `false` | Enable variable transaction fees and execution effort metering <br> as described in [Variable Transaction Fees: Execution Effort](https://github.com/onflow/flow/pull/753) FLIP |
| `--transaction-max-gas-limit` | `FLOW_TRANSACTIONMAXGASLIMIT` | `9999` | Maximum [gas limit for transactions](https://docs.onflow.org/flow-go-sdk/building-transactions/#gas-limit) |
| `--script-gas-limit` | `FLOW_SCRIPTGASLIMIT` | `100000` | Specify gas limit for script execution |
| `--with-contracts` | `FLOW_WITHCONTRACTS` | `false` | Deploy common contracts when emulator starts |
Expand Down
2 changes: 1 addition & 1 deletion emulator/blockchain_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ const counterScript = `
}
`

// generateAddTwoToCounterScript generates a script that increments a counter.
// GenerateAddTwoToCounterScript generates a script that increments a counter.
// If no counter exists, it is created.
func GenerateAddTwoToCounterScript(counterAddress flowsdk.Address) string {
return fmt.Sprintf(
Expand Down
2 changes: 1 addition & 1 deletion server/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ type Config struct {
SqliteURL string
// CoverageReportingEnabled enables/disables Cadence code coverage reporting.
CoverageReportingEnabled bool
// LegacyUpgradeEnabled enables/disables Cadence legacy contracts upgrades
// LegacyContractUpgradeEnabled enables/disables Cadence legacy contracts upgrades
LegacyContractUpgradeEnabled bool
// RPCHost is the address of the access node to use when using a forked network.
RPCHost string
Expand Down
2 changes: 1 addition & 1 deletion server/utils/liveness/check.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ func (c *internalCheck) CheckIn() {
c.lock.Unlock()
}

// IsLive checks if we are still live against the given the tolerance between hearbeats.
// IsLive checks if we are still live against the given the tolerance between heartbeats.
//
// If tolerance is 0, the default tolerance is used.
func (c *internalCheck) IsLive(tolerance time.Duration) bool {
Expand Down
2 changes: 1 addition & 1 deletion server/utils/liveness/collector.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ func (c *CheckCollector) ServeHTTP(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
}

// IsLive checks if we are still live against the given the tolerance between hearbeats.
// IsLive checks if we are still live against the given the tolerance between heartbeats.
//
// If tolerance is 0, the default tolerance is used.
func (c *CheckCollector) IsLive(tolerance time.Duration) bool {
Expand Down
2 changes: 1 addition & 1 deletion storage/checkpoint/checkpoint.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ import (
"github.com/onflow/flow-emulator/storage/memstore"
)

// Store is jus a memstore, but the starting state is loaded from a checkpoint folder
// Store is just a memstore, but the starting state is loaded from a checkpoint folder
// any new blocks exist in memory only and are not persisted to disk.
type Store struct {
// Store is a memstore
Expand Down
Loading