Skip to content

Commit f664540

Browse files
author
MalteHerrmann
committed
fix linters
1 parent 294054f commit f664540

File tree

27 files changed

+206
-128
lines changed

27 files changed

+206
-128
lines changed

docs/develop/api/ethereum-json-rpc/methods.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ Find below a list of JSON-RPC methods supported on Evmos, sorted by namespaces.
88

99
## Curl Examples Explained
1010

11-
The curl options below might return a response where the node complains about the content type, this is because the `--data` option sets the content type to `application/x-www-form-urlencoded`. If your node does complain, manually set the header by placing `-H "Content-Type: application/json"` at the start of the call.
11+
The curl options below might return a response where the node complains about the content type,
12+
this is because the `--data` option sets the content type to `application/x-www-form-urlencoded`.
13+
If your node does complain, manually set the header
14+
by placing `-H "Content-Type: application/json"` at the start of the call.
1215

1316
The examples also do not include the URL/IP & port combination which must be the last argument given to curl e.x. `127.0.0.1:8545`
1417

@@ -277,7 +280,8 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_protocolVersion","params":[]
277280

278281
### `eth_syncing`
279282

280-
The sync status object may need to be different depending on the details of Tendermint's sync protocol. However, the 'synced' result is simply a boolean, and can easily be derived from Tendermint's internal sync state.
283+
The sync status object may need to be different depending on the details of Tendermint's sync protocol.
284+
However, the 'synced' result is simply a boolean, and can easily be derived from Tendermint's internal sync state.
281285

282286
```json
283287
// Request
@@ -468,15 +472,18 @@ Sends transaction from given account to a given account.
468472

469473
`to`: `DATA`, 20 Bytes - (optional when creating new contract) The address the transaction is directed to.
470474

471-
`gas`: QUANTITY - (optional, default: 90000) Integer of the gas provided for the transaction execution. It will return unused gas.
475+
`gas`: QUANTITY - (optional, default: 90000) Integer of the gas provided for the transaction execution.
476+
It will return unused gas.
472477

473478
`gasPrice`: QUANTITY - (optional, default: To-Be-Determined) Integer of the gasPrice used for each paid gas
474479

475480
`value`: QUANTITY - value sent with this transaction
476481

477-
`data`: `DATA` - The compiled code of a contract OR the hash of the invoked method signature and encoded parameters. For details see Ethereum Contract ABI
482+
`data`: `DATA` - The compiled code of a contract OR the hash of the invoked method signature and encoded parameters.
483+
For details see Ethereum Contract ABI.
478484

479-
`nonce`: QUANTITY - (optional) Integer of a nonce. This allows to overwrite your own pending transactions that use the same nonce.
485+
`nonce`: QUANTITY - (optional) Integer of a nonce.
486+
This allows to overwrite your own pending transactions that use the same nonce.
480487

481488
```json
482489
// Request
@@ -515,13 +522,15 @@ Executes a new message call immediately without creating a transaction on the bl
515522

516523
`to`: `DATA`, 20 Bytes - The address the transaction is directed to.
517524

518-
`gas`: QUANTITY - gas provided for the transaction execution. eth_call consumes zero gas, but this parameter may be needed by some executions.
525+
`gas`: QUANTITY - gas provided for the transaction execution.
526+
eth_call consumes zero gas, but this parameter may be needed by some executions.
519527

520528
`gasPrice`: QUANTITY - gasPrice used for each paid gas
521529

522530
`value`: QUANTITY - value sent with this transaction
523531

524-
`data`: `DATA` - (optional) Hash of the method signature and encoded parameters. For details see Ethereum Contract ABI in the Solidity documentation
532+
`data`: `DATA` - (optional) Hash of the method signature and encoded parameters.
533+
For details see Ethereum Contract ABI in the Solidity documentation
525534

526535
- Block number or Block Hash ([EIP-1898](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1898.md))
527536

@@ -911,7 +920,9 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"personal_lockAccount","params":[
911920
**Private**: Requires authentication.
912921
:::
913922

914-
Generates a new private key and stores it in the key store directory. The key file is encrypted with the given passphrase. Returns the address of the new account.
923+
Generates a new private key and stores it in the key store directory.
924+
The key file is encrypted with the given passphrase.
925+
It returns the address of the new account.
915926

916927
#### Parameters
917928

@@ -1184,11 +1195,13 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"miner_setExtra","params":["data"
11841195
**Private**: Requires authentication.
11851196
:::
11861197

1187-
Sets the minimal gas price used to accept transactions. Any transaction below this limit is excluded from the validator block proposal process.
1198+
Sets the minimal gas price used to accept transactions.
1199+
Any transaction below this limit is excluded from the validator block proposal process.
11881200

11891201
This method requires a `node` restart after being called because it changes the configuration file.
11901202

1191-
Make sure your `evmosd start` call is not using the flag `minimum-gas-prices` because this value will be used instead of the one set on the configuration file.
1203+
Make sure your `evmosd start` call is not using the flag `minimum-gas-prices`,
1204+
because this value will be used instead of the one set on the configuration file.
11921205

11931206
#### Parameters
11941207

docs/develop/api/tendermint-rpc.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,11 @@ More on Events:
4343

4444
### Subscribing to Events via Websocket
4545

46-
Tendermint Core provides a [Websocket](https://docs.tendermint.com/v0.34/tendermint-core/subscription.html) connection to subscribe or unsubscribe to Tendermint `Events`. To start a connection with the Tendermint websocket you need to define the address with the `--rpc.laddr` flag when starting the node (default `tcp://127.0.0.1:26657`):
46+
Tendermint Core provides a [Websocket](https://docs.tendermint.com/v0.34/tendermint-core/subscription.html) connection
47+
to subscribe or unsubscribe to Tendermint `Events`.
48+
To start a connection with the Tendermint websocket you need to
49+
define the address with the `--rpc.laddr` flag when starting the node
50+
(default `tcp://127.0.0.1:26657`):
4751

4852
```bash
4953
evmosd start --rpc.laddr="tcp://127.0.0.1:26657"
@@ -98,7 +102,8 @@ The main events you can subscribe to are:
98102
- `ValidatorSetUpdates`: Contains validator set updates for the block.
99103
100104
:::tip
101-
👉 The list of events types and values for each Cosmos SDK module can be found in the [Modules Specification](./../../../../protocol/modules/) section.
105+
👉 The list of events types and values for each Cosmos SDK module
106+
can be found in the [Modules Specification](./../../../../protocol/modules/) section.
102107
Check the `Events` page to obtain the event list of each supported module on Evmos.
103108
:::
104109

docs/develop/graphs-indexers/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ find all transactions that include a specific token. This type of indexing can g
99
of decentralized applications and make it easier for users to access and analyze the data stored on the blockchain.
1010

1111
## List of Graph Indexers
12+
1213
### Mainnet
1314

1415
| Service | Description | Support | Links & Features |

docs/develop/oracles/index.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,15 @@ This enables smart contracts to respond to real-world events, trigger automated
4747

4848
In this diagram:
4949

50-
* External Data Source refers to a source of data outside the blockchain network, such as a stock market, weather service, or other external API.
51-
* Oracle Service is a third-party service that acts as a bridge between the external data source and the smart contract. It retrieves the data from the external source and provides it to the smart contract.
52-
* Smart Contract is a self-executing contract that is deployed on the blockchain network. It uses the data provided by the oracle to perform certain actions, such as releasing funds or triggering events.
50+
* External Data Source refers to a source of data outside the blockchain network,
51+
such as a stock market, weather service, or other external API.
52+
* Oracle Service is a third-party service that acts as a bridge between the external data source and the smart contract.
53+
It retrieves the data from the external source and provides it to the smart contract.
54+
* Smart Contract is a self-executing contract that is deployed on the blockchain network.
55+
It uses the data provided by the oracle to perform certain actions, such as releasing funds or triggering events.
5356
* API Call refers to the request made by the smart contract to the oracle service, asking for the required external data.
54-
* Retrieve External Data refers to the process of retrieving the requested data from the external data source via the API call.
55-
* Use External Data refers to the process of using the retrieved data in the smart contract to perform actions, such as condition checking and state changes.
57+
* Retrieve External Data refers to the process of retrieving the requested data
58+
from the external data source via the API call.
59+
* Use External Data refers to the process of using the retrieved data in the smart contract to perform actions,
60+
such as condition checking and state changes.
5661
* Return Result refers to the process of returning the result of the action performed in the smart contract back to the oracle.

docs/develop/smart-contracts/evm-extensions/ibc-transfer.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ sidebar_position: 5
66

77
## Solidity Interface & ABI
88

9-
`ICS20.sol` - previously known as `IBCTransfer.sol` - is an interface through which Solidity contracts can interact with the IBC protocol on Evmos chain.
9+
`ICS20.sol` - previously known as `IBCTransfer.sol` -
10+
is an interface through which Solidity contracts can interact with the IBC protocol on Evmos chain.
1011
This is convenient for developers as they don’t need to know the implementation details behind the `transfer` module in [IBC-go](https://ibc.cosmos.network/).
1112
Instead, they can perform IBC transfers using the Ethereum interface they are familiar with.
1213
An example of a simple implementation can be found in the [evmos/extensions repo](https://github.com/evmos/extensions/tree/main/examples/simple-ibc-transfer).

docs/develop/smart-contracts/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ implementation, such as hashing, elliptic curve cryptography, and modular expone
3939

4040
By adding custom EVM extensions to Ethereum's basic feature set,
4141
Evmos allows developers to use previously unavailable functionality in smart contracts, like staking and governance operations.
42-
This will allow more complex smart contracts to be built on Evmos and further improves the interoperability between Cosmos and Ethereum.
42+
This will allow more complex smart contracts to be built on Evmos
43+
and further improves the interoperability between Cosmos and Ethereum.
4344
It also is a key feature to achieve Evmos' vision of being the definitive dApp
4445
chain, where any dApp can be deployed once and users can interact with
4546
a wide range of different blockchains natively.

docs/develop/tools/tools-plugins.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,37 @@ sidebar_position: 4
66

77
## Smart Contract Development Tools
88

9-
- [Remix](https://remix.ethereum.org/#optimize=false&runs=200&evmVersion=null&version=soljson-v0.8.17+commit.8df45f5f.js) is a free, browser-based Integrated Development Environment (IDE) for writing, testing, and deploying smart contracts on the Ethereum blockchain. It is designed to make it easier for developers to get started with building decentralized applications (dapps) by providing a simple and user-friendly interface for writing and deploying smart contracts. With Remix, you can write, test, and deploy smart contracts written in Solidity. It also includes debugging tools and a simulation environment for testing contracts before deploying them to the blockchain. The tool provides plugins as well.
10-
- [Truffle Suite](https://trufflesuite.com/docs/) contains a suite of comprehensive tools to streamline the process of building and testing smart contracts, and deploying them to any EVM network, like EVMOS network in Javascript/Typescript. The suite contains [Truffle](https://trufflesuite.com/docs/truffle/) to make compiling, testing, debugging, and deploying smart contract development. [Ganache](https://trufflesuite.com/docs/ganache/) provides easy and fast local blockchain development environment with UI and CLI functionalities. [Drizzle](https://trufflesuite.com/docs/drizzle/) packs frontend libraries that enables standard-compliant wallet connection, account, and contract state management through React components.
11-
- [Foundry](https://getfoundry.sh/) is RUST toolkit that enables fast, portable, and modular application development for Ethereum and EVM-compatible chains.
12-
- [Hardhat](https://hardhat.org/) is a JS/TS library that allow comprehensive testing, development, and deploying smart contracts. Hardhat contains many [plugins](https://hardhat.org/hardhat-runner/plugins) to aid further developments.
9+
- [Remix](https://remix.ethereum.org/#optimize=false&runs=200&evmVersion=null&version=soljson-v0.8.17+commit.8df45f5f.js)
10+
is a free, browser-based Integrated Development Environment (IDE)
11+
for writing, testing, and deploying smart contracts on the Ethereum blockchain.
12+
It is designed to make it easier for developers to get started with building decentralized applications (dapps)
13+
by providing a simple and user-friendly interface for writing and deploying smart contracts.
14+
With Remix, you can write, test, and deploy smart contracts written in Solidity.
15+
It also includes debugging tools and a simulation environment
16+
for testing contracts before deploying them to the blockchain.
17+
The tool provides plugins as well.
18+
- [Truffle Suite](https://trufflesuite.com/docs/) contains a suite of comprehensive tools
19+
to streamline the process of building and testing smart contracts,
20+
and deploying them to any EVM network, like EVMOS network in Javascript/Typescript.
21+
The suite contains [Truffle](https://trufflesuite.com/docs/truffle/)
22+
to make compiling, testing, debugging, and deploying smart contract development.
23+
[Ganache](https://trufflesuite.com/docs/ganache/) provides easy and fast local blockchain development environment
24+
with UI and CLI functionalities.
25+
[Drizzle](https://trufflesuite.com/docs/drizzle/) packs frontend libraries
26+
that enables standard-compliant wallet connection, account,
27+
and contract state management through React components.
28+
- [Foundry](https://getfoundry.sh/) is RUST toolkit that enables fast, portable,
29+
and modular application development for Ethereum and EVM-compatible chains.
30+
- [Hardhat](https://hardhat.org/) is a JS/TS library that allow comprehensive testing, development, and deploying smart contracts.
31+
Hardhat contains many [plugins](https://hardhat.org/hardhat-runner/plugins) to aid further developments.
1332

1433
## Open Sourced Contracts
1534

16-
- [OpenZeppelin](https://www.openzeppelin.com/contracts) contains battle-tested libraries of smart contracts for Ethereum-compatible chains and includes the most used ERC standards.
35+
- [OpenZeppelin](https://www.openzeppelin.com/contracts) contains battle-tested libraries of smart contracts
36+
for Ethereum-compatible chains and includes the most used ERC standards.
1737

1838
## IDE
1939

20-
- [Truffle for VSCode](https://trufflesuite.com/docs/vscode-ext/) is a Visual Studio Code extension that simplifies how you create, build, debug, and deploy smart contracts on Ethereum and EVM-compatible blockchains.
40+
- [Truffle for VSCode](https://trufflesuite.com/docs/vscode-ext/) is a Visual Studio Code extension
41+
that simplifies how you create, build, debug,
42+
and deploy smart contracts on Ethereum and EVM-compatible blockchains.

docs/protocol/concepts/accounts.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ Creating a mnemonic phrase gives you control of many accounts,
2929
all accessible with that same phrase.
3030

3131
Cosmos blockchains, like Evmos, support creating accounts with mnemonic phrases,
32-
otherwise known as [hierarchical deterministic key generation](https://github.com/confio/cosmos-hd-key-derivation-spec) (HD keys).
32+
otherwise known as
33+
[hierarchical deterministic key generation](https://github.com/confio/cosmos-hd-key-derivation-spec) (HD keys).
3334
This allows the user to create accounts on multiple blockchains
3435
without having to manage multiple secrets.
3536

@@ -117,7 +118,8 @@ There are 3 main types of HRP for the `Addresses`/`PubKeys` available by default
117118

118119
### Address formats for clients
119120

120-
`EthAccount` can be represented in both [Bech32](https://en.bitcoin.it/wiki/Bech32) (`evmos1...`) and hex (`0x...`) formats for Ethereum's Web3 tooling compatibility.
121+
`EthAccount` can be represented in both [Bech32](https://en.bitcoin.it/wiki/Bech32) (`evmos1...`)
122+
and hex (`0x...`) formats for Ethereum's Web3 tooling compatibility.
121123

122124
The Bech32 format is the default format for Cosmos-SDK queries and transactions through CLI and REST
123125
clients. The hex format on the other hand, is the Ethereum `common.Address` representation of a
@@ -213,7 +215,9 @@ curl -X GET "http://localhost:10337/cosmos/auth/v1beta1/accounts/evmos14au322k9m
213215

214216
### JSON-RPC
215217

216-
To retrieve the Ethereum hex address using Web3, use the JSON-RPC [`eth_accounts`](./../../develop/api/ethereum-json-rpc/methods#eth-accounts) or [`personal_listAccounts`](./../../develop/api/ethereum-json-rpc/methods#personal-listAccounts) endpoints:
218+
To retrieve the Ethereum hex address using Web3,
219+
use the JSON-RPC [`eth_accounts`](./../../develop/api/ethereum-json-rpc/methods#eth-accounts)
220+
or [`personal_listAccounts`](./../../develop/api/ethereum-json-rpc/methods#personal-listAccounts) endpoints:
217221

218222
```bash
219223
# query against a local node

docs/protocol/concepts/encoding.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,14 @@ support Amino in the EVM module, but it is supported for all other Cosmos SDK mo
5757

5858
### RLP
5959

60-
Recursive Length Prefix ([RLP](https://eth.wiki/en/fundamentals/rlp)), is an encoding/decoding algorithm that serializes a message and
60+
Recursive Length Prefix ([RLP](https://eth.wiki/en/fundamentals/rlp)),
61+
is an encoding/decoding algorithm that serializes a message and
6162
allows for quick reconstruction of encoded data. Evmos uses RLP to encode/decode Ethereum
6263
messages for JSON-RPC handling to conform messages to the proper Ethereum format. This allows
6364
messages to be encoded and decoded in the exact format as Ethereum's.
6465

65-
The `x/evm` transactions (`MsgEthereumTx`) encoding is performed by casting the message to a go-ethereum's `Transaction` and then marshaling the transaction data using RLP:
66+
The `x/evm` transactions (`MsgEthereumTx`) encoding is performed by casting the message to a go-ethereum's `Transaction`
67+
and then marshaling the transaction data using RLP:
6668

6769
```go
6870
// TxEncoder overwrites sdk.TxEncoder to support MsgEthereumTx

docs/protocol/concepts/keyring.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar_position: 7
77
Create, import, export and delete keys using the CLI keyring.
88

99
The keyring holds the private/public keypairs used to interact with the node. For instance, a validator key needs to be
10-
set up before running the node, so that blocks can be correctly signed. The private key can be stored in different
10+
set up before running the node, so that blocks can be correctly signed. The private key can be stored in different
1111
locations, called ["backends"](#keyring-backends), such as a file or the operating system's own key storage.
1212

1313
:::tip
@@ -38,14 +38,14 @@ MY_VALIDATOR_ADDRESS=$(evmosd keys show dev0 -a)
3838
```
3939

4040
This command generates a new 24-word mnemonic phrase, persists it to the relevant backend, and outputs information about
41-
the keypair. If this keypair will be used to hold value-bearing tokens, be sure to write down the mnemonic phrase
41+
the keypair. If this keypair will be used to hold value-bearing tokens, be sure to write down the mnemonic phrase
4242
somewhere safe!
4343

44-
By default, the keyring generates a `eth_secp256k1` key. The keyring also supports `ed25519` keys, which may be created
44+
By default, the keyring generates a `eth_secp256k1` key. The keyring also supports `ed25519` keys, which may be created
4545
by passing the `--algo` flag. A keyring can of course hold both types of keys simultaneously.
4646

4747
:::tip
48-
**Note**: The Ethereum address associated with a public key can be derived by taking the full Ethereum public key of type
48+
**Note**: The Ethereum address associated with a public key can be derived by taking the full Ethereum public key of type
4949
`eth_secp256k1`, computing the `Keccak-256` hash, and truncating the first twelve bytes.
5050
:::
5151

0 commit comments

Comments
 (0)