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.

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

fix: adjust the repo name to evmos-utils #29

Merged
merged 3 commits into from
Dec 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 14 additions & 13 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,34 +39,35 @@ Ref: https://keepachangelog.com/en/1.0.0/

### Features

- [#26](https://github.com/MalteHerrmann/upgrade-local-node-go/pull/26) Enable just depositing with the binary
- [#26](https://github.com/MalteHerrmann/evmos-utils/pull/26) Enable just depositing with the binary

### Improvements

- [#27](https://github.com/MalteHerrmann/upgrade-local-node-go/pull/27) Add MIT license
- [#28](https://github.com/MalteHerrmann/upgrade-local-node-go/pull/28) Use [Cobra CLI](https://github.com/spf13/cobra) package
- [#27](https://github.com/MalteHerrmann/evmos-utils/pull/27) Add MIT license
- [#28](https://github.com/MalteHerrmann/evmos-utils/pull/28) Use [Cobra CLI](https://github.com/spf13/cobra) package
- [#29](https://github.com/MalteHerrmann/evmos-utils/pull/29) Adjust repository name from `upgrade-local-node-go` to `evmos-utils`

## [v0.3.0](https://github.com/MalteHerrmann/upgrade-local-node-go/releases/tag/v0.3.0) - 2023-08-30
## [v0.3.0](https://github.com/MalteHerrmann/evmos-utils/releases/tag/v0.3.0) - 2023-08-30

### Features

- [#14](https://github.com/MalteHerrmann/upgrade-local-node-go/pull/14) Enable just voting with the binary
- [#14](https://github.com/MalteHerrmann/evmos-utils/pull/14) Enable just voting with the binary

### Improvements

- [#7](https://github.com/MalteHerrmann/upgrade-local-node-go/pull/7) Add linters plus corresponding refactors
- [#6](https://github.com/MalteHerrmann/upgrade-local-node-go/pull/6) Restructuring and refactoring
- [#4](https://github.com/MalteHerrmann/upgrade-local-node-go/pull/4) Add GH actions and Makefile for testing
- [#3](https://github.com/MalteHerrmann/upgrade-local-node-go/pull/3) Use broadcast mode `sync` instead of `block`
- [#2](https://github.com/MalteHerrmann/upgrade-local-node-go/pull/2) Only vote if account has delegations
- [#7](https://github.com/MalteHerrmann/evmos-utils/pull/7) Add linters plus corresponding refactors
- [#6](https://github.com/MalteHerrmann/evmos-utils/pull/6) Restructuring and refactoring
- [#4](https://github.com/MalteHerrmann/evmos-utils/pull/4) Add GH actions and Makefile for testing
- [#3](https://github.com/MalteHerrmann/evmos-utils/pull/3) Use broadcast mode `sync` instead of `block`
- [#2](https://github.com/MalteHerrmann/evmos-utils/pull/2) Only vote if account has delegations

## [v0.2.0](https://github.com/MalteHerrmann/upgrade-local-node-go/releases/tag/v0.2.0) - 2023-08-09
## [v0.2.0](https://github.com/MalteHerrmann/evmos-utils/releases/tag/v0.2.0) - 2023-08-09

### Improvements

- [#1](https://github.com/MalteHerrmann/upgrade-local-node-go/pull/1) Adaptively gets keys and current proposal ID from the local node
- [#1](https://github.com/MalteHerrmann/evmos-utils/pull/1) Adaptively gets keys and current proposal ID from the local node

## [v0.1.0](https://github.com/MalteHerrmann/upgrade-local-node-go/releases/tag/v0.1.0) - 2023-08-01
## [v0.1.0](https://github.com/MalteHerrmann/evmos-utils/releases/tag/v0.1.0) - 2023-08-01

### Features

Expand Down
31 changes: 23 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Evmos Dev Utils
# Evmos Utils

This tool contains several utility functionalities that are useful during
development of the Evmos blockchain.
Expand All @@ -12,25 +12,29 @@ started by calling the `local_node.sh` script from the Evmos main repository.
## Installation

In order to install the tool, clone the source and install locally.
Note, that using `go install github.com/MalteHerrmann/upgrade-local-node-go@latest`

Note, that using `go install github.com/MalteHerrmann/evmos-utils@latest`
does not work because of the replace directives in `go.mod`,
which are necessary for the Evmos dependencies.

```bash
git clone https://github.com/MalteHerrmann/upgrade-local-node-go.git
cd upgrade-local-node-go
git clone https://github.com/MalteHerrmann/evmos-utils.git
cd evmos-utils
make install
```

## Features

### Upgrade Local Node
The tool is based on [Cobra CLI](https://github.com/spf13/cobra) so you can use
`--help` to get a list of all available commands and flags.

### Upgrade a Local Node

The tool creates and submits a software upgrade proposal to a running local Evmos node,
The tool creates and submits a software upgrade proposal to a locally running Evmos node,
and votes on the proposal. To do so, run:

```bash
upgrade-local-node-go [TARGET_VERSION]
evmos-utils upgrade [TARGET_VERSION]
```

The target version must be specified in the format `vX.Y.Z(-rc*)`, e.g. `v13.0.0-rc2`.
Expand All @@ -42,5 +46,16 @@ to validators. This can either target the most recent proposal, or a specific on
passing an ID to the command.

```bash
upgrade-local-node-go vote [PROPOSAL_ID]
evmos-utils vote [PROPOSAL_ID]
```

### Deposit for Proposal

The tool can make a deposit for a proposal.
It returns the minimum deposit necessary from the governance parameters of the running local node
and places the deposit on behalf of the first account in the test keyring.

```bash
evmos-utils deposit [PROPOSAL_ID]
```

4 changes: 2 additions & 2 deletions cmd/deposit.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ package cmd
import (
"log"

"github.com/MalteHerrmann/upgrade-local-node-go/gov"
"github.com/MalteHerrmann/upgrade-local-node-go/utils"
"github.com/MalteHerrmann/evmos-utils/gov"
"github.com/MalteHerrmann/evmos-utils/utils"
"github.com/spf13/cobra"
)

Expand Down
4 changes: 2 additions & 2 deletions cmd/upgrade.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ import (
"log"
"regexp"

"github.com/MalteHerrmann/upgrade-local-node-go/gov"
"github.com/MalteHerrmann/upgrade-local-node-go/utils"
"github.com/MalteHerrmann/evmos-utils/gov"
"github.com/MalteHerrmann/evmos-utils/utils"
"github.com/pkg/errors"
"github.com/spf13/cobra"
)
Expand Down
4 changes: 2 additions & 2 deletions cmd/vote.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ package cmd
import (
"log"

"github.com/MalteHerrmann/upgrade-local-node-go/gov"
"github.com/MalteHerrmann/upgrade-local-node-go/utils"
"github.com/MalteHerrmann/evmos-utils/gov"
"github.com/MalteHerrmann/evmos-utils/utils"
"github.com/spf13/cobra"
)

Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/MalteHerrmann/upgrade-local-node-go
module github.com/MalteHerrmann/evmos-utils

go 1.21

Expand Down
2 changes: 1 addition & 1 deletion gov/deposit.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"regexp"
"strconv"

"github.com/MalteHerrmann/upgrade-local-node-go/utils"
"github.com/MalteHerrmann/evmos-utils/utils"
sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/pkg/errors"
)
Expand Down Expand Up @@ -63,7 +63,7 @@
// ParseMinDepositFromResponse parses the minimum deposit from the given output of the governance
// parameters query.
//
// FIXME: It wasn't possible to unmarshal the JSON output of the query because of a missing unit in the max_deposit_period

Check failure on line 66 in gov/deposit.go

View workflow job for this annotation

GitHub Actions / lint

gov/deposit.go:66: Line contains TODO/BUG/FIXME: "FIXME: It wasn't possible to unmarshal t..." (godox)
// parameter. This should rather be done using GRPC.
func ParseMinDepositFromResponse(out string) (sdk.Coins, error) {
depositPatternRaw := `min_deposit":\[{"denom":"(\w+)","amount":"(\d+)`
Expand Down
2 changes: 1 addition & 1 deletion gov/deposit_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package gov_test
import (
"testing"

"github.com/MalteHerrmann/upgrade-local-node-go/gov"
"github.com/MalteHerrmann/evmos-utils/gov"
sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/stretchr/testify/require"
)
Expand Down
2 changes: 1 addition & 1 deletion gov/proposal.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"strconv"
"strings"

"github.com/MalteHerrmann/upgrade-local-node-go/utils"
"github.com/MalteHerrmann/evmos-utils/utils"
sdk "github.com/cosmos/cosmos-sdk/types"
govv1types "github.com/cosmos/cosmos-sdk/x/gov/types/v1"
"github.com/pkg/errors"
Expand Down
2 changes: 1 addition & 1 deletion gov/proposal_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package gov_test
import (
"testing"

"github.com/MalteHerrmann/upgrade-local-node-go/gov"
"github.com/MalteHerrmann/evmos-utils/gov"
sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/stretchr/testify/require"
)
Expand Down
2 changes: 1 addition & 1 deletion gov/utils.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import (
"fmt"
"strconv"

"github.com/MalteHerrmann/upgrade-local-node-go/utils"
"github.com/MalteHerrmann/evmos-utils/utils"
"github.com/pkg/errors"
)

Expand Down
2 changes: 1 addition & 1 deletion gov/vote.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import (
"strconv"
"strings"

"github.com/MalteHerrmann/upgrade-local-node-go/utils"
"github.com/MalteHerrmann/evmos-utils/utils"
"github.com/pkg/errors"
)

Expand Down
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package main

import (
"github.com/MalteHerrmann/upgrade-local-node-go/cmd"
"github.com/MalteHerrmann/evmos-utils/cmd"
)

func main() {
Expand Down
2 changes: 1 addition & 1 deletion utils/delegations_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package utils_test
import (
"testing"

"github.com/MalteHerrmann/upgrade-local-node-go/utils"
"github.com/MalteHerrmann/evmos-utils/utils"
"github.com/stretchr/testify/require"
)

Expand Down
2 changes: 1 addition & 1 deletion utils/keys_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package utils_test
import (
"testing"

"github.com/MalteHerrmann/upgrade-local-node-go/utils"
"github.com/MalteHerrmann/evmos-utils/utils"
"github.com/stretchr/testify/require"
)

Expand Down
2 changes: 1 addition & 1 deletion utils/utils_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package utils_test
import (
"testing"

"github.com/MalteHerrmann/upgrade-local-node-go/utils"
"github.com/MalteHerrmann/evmos-utils/utils"
sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/stretchr/testify/require"
)
Expand Down
Loading