Merge pull request #49 from regen-network/ryan/add-amino-fixes

fix: gov and group amino and snapshot hashes
regen-network · Dec 16, 2022 · 3c9dcb9 · 3c9dcb9
2 parents f71df80 + 8985cf8
commit 3c9dcb9
Show file tree

Hide file tree

Showing 60 changed files with 540 additions and 194 deletions.
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -25,7 +25,7 @@ jobs:
         uses: actions/checkout@v3
       - uses: actions/setup-go@v3
         with:
-          go-version: 1.18
+          go-version: 1.19
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
         uses: github/codeql-action/init@v2

diff --git a/.github/workflows/cosmovisor-release.yml b/.github/workflows/cosmovisor-release.yml
@@ -13,7 +13,7 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-go@v3
         with:
-          go-version: 1.18
+          go-version: 1.19
       # get 'v*.*.*' part from 'cosmovisor/v*.*.*' and save to $GITHUB_ENV
       - name: Set env
         run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/cosmovisor/}" >> $GITHUB_ENV

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -15,7 +15,7 @@ jobs:
       - name: Install Go
         uses: actions/setup-go@v3
         with:
-          go-version: 1.18
+          go-version: 1.19
       - name: Unshallow
         run: git fetch --prune --unshallow
       - name: Create release

diff --git a/.github/workflows/sims.yml b/.github/workflows/sims.yml
@@ -22,7 +22,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-go@v3
         with:
-          go-version: 1.18
+          go-version: 1.19
       - name: Display go version
         run: go version
       - run: make build
@@ -51,7 +51,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-go@v3
         with:
-          go-version: 1.18
+          go-version: 1.19
       - name: Display go version
         run: go version
       - uses: actions/cache@v3
@@ -70,7 +70,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-go@v3
         with:
-          go-version: 1.18
+          go-version: 1.19
       - name: Display go version
         run: go version
       - uses: actions/cache@v3
@@ -89,7 +89,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-go@v3
         with:
-          go-version: 1.18
+          go-version: 1.19
       - name: Display go version
         run: go version
       - uses: actions/cache@v3

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -27,7 +27,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-go@v3
         with:
-          go-version: 1.18
+          go-version: 1.19
       - uses: technote-space/get-diff-action@v6.0.1
         id: git_diff
         with:
@@ -48,7 +48,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-go@v3
         with:
-          go-version: 1.18
+          go-version: 1.19
       - uses: technote-space/get-diff-action@v6.0.1
         id: git_diff
         with:
@@ -71,7 +71,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-go@v3
         with:
-          go-version: 1.18
+          go-version: 1.19
       - name: Create a file with all core Cosmos SDK pkgs
         run: go list ./... > pkgs.txt
       - name: Split pkgs into 4 files
@@ -105,7 +105,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-go@v3
         with:
-          go-version: 1.18
+          go-version: 1.19
       - uses: technote-space/get-diff-action@v6.0.1
         with:
           PATTERNS: |
@@ -201,7 +201,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-go@v3
         with:
-          go-version: 1.18
+          go-version: 1.19
       - uses: technote-space/get-diff-action@v6.0.1
         id: git_diff
         with:
@@ -241,7 +241,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-go@v3
         with:
-          go-version: 1.18
+          go-version: 1.19
       - name: Display go version
         run: go version
       - uses: technote-space/get-diff-action@v6.0.1

diff --git a/Dockerfile b/Dockerfile
@@ -10,7 +10,7 @@
 # > docker run -it -p 26657:26657 -p 26656:26656 -v ~/.simappcli:/root/.simapp simapp simd keys add foo
 # > docker run -it -p 26657:26657 -p 26656:26656 -v ~/.simappcli:/root/.simapp simapp simd keys list
 # TODO: demo connecting rest-server (or is this in server now?)
-FROM golang:1.18-alpine AS build-env
+FROM golang:1.19-alpine AS build-env
 
 # Install minimum necessary dependencies
 ENV PACKAGES curl make git libc-dev bash gcc linux-headers eudev-dev python3

diff --git a/README.md b/README.md
@@ -42,7 +42,7 @@ The Cosmos SDK is a framework for building blockchain applications. [Tendermint
 **WARNING**: The Cosmos SDK has mostly stabilized, but we are still making some
 breaking changes.
 
-**Note**: Requires [Go 1.18+](https://go.dev/dl)
+**Note**: Requires [Go 1.19+](https://go.dev/dl)
 
 ## Quick Start
 

diff --git a/baseapp/baseapp_test.go b/baseapp/baseapp_test.go
@@ -1792,7 +1792,7 @@ func TestSnapshotWithPruning(t *testing.T) {
 				pruningOpts:        pruningtypes.NewPruningOptions(pruningtypes.PruningNothing),
 			},
 			expectedSnapshots: []*abci.Snapshot{
-				{Height: 20, Format: 2, Chunks: 5},
+				{Height: 20, Format: snapshottypes.CurrentFormat, Chunks: 5},
 			},
 		},
 		"prune everything with snapshot": {
@@ -1804,7 +1804,7 @@ func TestSnapshotWithPruning(t *testing.T) {
 				pruningOpts:        pruningtypes.NewPruningOptions(pruningtypes.PruningEverything),
 			},
 			expectedSnapshots: []*abci.Snapshot{
-				{Height: 20, Format: 2, Chunks: 5},
+				{Height: 20, Format: snapshottypes.CurrentFormat, Chunks: 5},
 			},
 		},
 		"default pruning with snapshot": {
@@ -1816,7 +1816,7 @@ func TestSnapshotWithPruning(t *testing.T) {
 				pruningOpts:        pruningtypes.NewPruningOptions(pruningtypes.PruningDefault),
 			},
 			expectedSnapshots: []*abci.Snapshot{
-				{Height: 20, Format: 2, Chunks: 5},
+				{Height: 20, Format: snapshottypes.CurrentFormat, Chunks: 5},
 			},
 		},
 		"custom": {
@@ -1828,8 +1828,8 @@ func TestSnapshotWithPruning(t *testing.T) {
 				pruningOpts:        pruningtypes.NewCustomPruningOptions(12, 12),
 			},
 			expectedSnapshots: []*abci.Snapshot{
-				{Height: 25, Format: 2, Chunks: 6},
-				{Height: 20, Format: 2, Chunks: 5},
+				{Height: 25, Format: snapshottypes.CurrentFormat, Chunks: 6},
+				{Height: 20, Format: snapshottypes.CurrentFormat, Chunks: 5},
 			},
 		},
 		"no snapshots": {
@@ -1850,9 +1850,9 @@ func TestSnapshotWithPruning(t *testing.T) {
 				pruningOpts:        pruningtypes.NewPruningOptions(pruningtypes.PruningNothing),
 			},
 			expectedSnapshots: []*abci.Snapshot{
-				{Height: 9, Format: 2, Chunks: 2},
-				{Height: 6, Format: 2, Chunks: 2},
-				{Height: 3, Format: 2, Chunks: 1},
+				{Height: 9, Format: snapshottypes.CurrentFormat, Chunks: 2},
+				{Height: 6, Format: snapshottypes.CurrentFormat, Chunks: 2},
+				{Height: 3, Format: snapshottypes.CurrentFormat, Chunks: 1},
 			},
 		},
 	}
@@ -1928,7 +1928,7 @@ func TestLoadSnapshotChunk(t *testing.T) {
 	}{
 		"Existing snapshot": {2, snapshottypes.CurrentFormat, 1, false},
 		"Missing height":    {100, snapshottypes.CurrentFormat, 1, true},
-		"Missing format":    {2, 3, 1, true},
+		"Missing format":    {2, 4, 1, true},
 		"Missing chunk":     {2, snapshottypes.CurrentFormat, 9, true},
 		"Zero height":       {0, snapshottypes.CurrentFormat, 1, true},
 		"Zero format":       {2, 0, 1, true},

diff --git a/client/v2/go.mod b/client/v2/go.mod
@@ -1,6 +1,6 @@
 module github.com/cosmos/cosmos-sdk/client/v2
 
-go 1.18
+go 1.19
 
 require (
 	github.com/cosmos/cosmos-proto v1.0.0-alpha7

diff --git a/contrib/images/simd-dlv/Dockerfile b/contrib/images/simd-dlv/Dockerfile
@@ -1,4 +1,4 @@
-FROM golang:1.18-alpine AS build
+FROM golang:1.19-alpine AS build
 
 RUN apk add build-base git linux-headers libc-dev
 RUN go install github.com/go-delve/delve/cmd/dlv@latest

diff --git a/contrib/images/simd-env/Dockerfile b/contrib/images/simd-env/Dockerfile
@@ -1,4 +1,4 @@
-FROM golang:1.18-alpine AS build
+FROM golang:1.19-alpine AS build
 
 RUN apk add build-base git linux-headers
 

diff --git a/contrib/rosetta/rosetta-ci/Dockerfile b/contrib/rosetta/rosetta-ci/Dockerfile
@@ -1,4 +1,4 @@
-FROM golang:1.18-alpine as build
+FROM golang:1.19-alpine as build
 
 RUN apk add --no-cache tar git
 

diff --git a/contrib/rosetta/rosetta-cli/Dockerfile b/contrib/rosetta/rosetta-cli/Dockerfile
@@ -1,4 +1,4 @@
-FROM golang:1.18-alpine as build
+FROM golang:1.19-alpine as build
 
 RUN apk add git gcc libc-dev --no-cache
 

diff --git a/core/go.mod b/core/go.mod
@@ -1,6 +1,6 @@
 module cosmossdk.io/core
 
-go 1.18
+go 1.19
 
 require (
 	github.com/cosmos/cosmos-proto v1.0.0-alpha7

diff --git a/cosmovisor/go.mod b/cosmovisor/go.mod
@@ -1,6 +1,6 @@
 module github.com/cosmos/cosmos-sdk/cosmovisor
 
-go 1.18
+go 1.19
 
 require (
 	github.com/cosmos/cosmos-sdk v0.46.1

diff --git a/docs/architecture/adr-049-state-sync-hooks.md b/docs/architecture/adr-049-state-sync-hooks.md
@@ -3,10 +3,11 @@
 ## Changelog
 
 - Jan 19, 2022: Initial Draft
+- Apr 29, 2022: Safer extension snapshotter interface
 
 ## Status
 
-Draft, Under Implementation
+Implemented
 
 ## Abstract
 
@@ -107,11 +108,16 @@ func (m *Manager) RegisterExtensions(extensions ...types.ExtensionSnapshotter) e
 On top of the existing `Snapshotter` interface for the `multistore`, we add `ExtensionSnapshotter` interface for the extension snapshotters. Three more function signatures: `SnapshotFormat()`, `SupportedFormats()` and `SnapshotName()` are added to `ExtensionSnapshotter`.
 
 ```go
+// ExtensionPayloadReader read extension payloads,
+// it returns io.EOF when reached either end of stream or the extension boundaries.
+type ExtensionPayloadReader = func() ([]byte, error)
+
+// ExtensionPayloadWriter is a helper to write extension payloads to underlying stream.
+type ExtensionPayloadWriter = func([]byte) error
+
 // ExtensionSnapshotter is an extension Snapshotter that is appended to the snapshot stream.
 // ExtensionSnapshotter has an unique name and manages it's own internal formats.
 type ExtensionSnapshotter interface {
-	Snapshotter
-
 	// SnapshotName returns the name of snapshotter, it should be unique in the manager.
 	SnapshotName() string
 
@@ -120,6 +126,14 @@ type ExtensionSnapshotter interface {
 
 	// SupportedFormats returns a list of formats it can restore from.
 	SupportedFormats() []uint32
+
+	// SnapshotExtension writes extension payloads into the underlying protobuf stream.
+	SnapshotExtension(height uint64, payloadWriter ExtensionPayloadWriter) error
+
+	// RestoreExtension restores an extension state snapshot,
+	// the payload reader returns `io.EOF` when reached the extension boundaries.
+	RestoreExtension(height uint64, format uint32, payloadReader ExtensionPayloadReader) error
+
 }
 ```
 

diff --git a/docs/core/encoding.md b/docs/core/encoding.md
@@ -67,18 +67,24 @@ Note, there are length-prefixed variants of the above functionality and this is
 typically used for when the data needs to be streamed or grouped together
 (e.g. `ResponseDeliverTx.Data`)
 
-#### Authz authorizations
+#### Authz authorizations and Gov/Group proposals
 
-Since the `MsgExec` message type can contain different messages instances, it is important that developers
+Since authz's `MsgExec` and `MsgGrant` message types, as well as gov's and group's `MsgSubmitProposal`, can contain different messages instances, it is important that developers
 add the following code inside the `init` method of their module's `codec.go` file:
 
 ```go
-import authzcodec "github.com/cosmos/cosmos-sdk/x/authz/codec"
+import (
+  authzcodec "github.com/cosmos/cosmos-sdk/x/authz/codec"
+  govcodec "github.com/cosmos/cosmos-sdk/x/gov/codec"
+  groupcodec "github.com/cosmos/cosmos-sdk/x/group/codec"
+)
 
 init() {
-    // Register all Amino interfaces and concrete types on the authz Amino codec so that this can later be
-    // used to properly serialize MsgGrant and MsgExec instances
+    // Register all Amino interfaces and concrete types on the authz and gov Amino codec so that this can later be
+    // used to properly serialize MsgGrant, MsgExec and MsgSubmitProposal instances
     RegisterLegacyAminoCodec(authzcodec.Amino)
+    RegisterLegacyAminoCodec(govcodec.Amino)
+    RegisterLegacyAminoCodec(groupcodec.Amino)
 }
 ```
 

diff --git a/errors/go.mod b/errors/go.mod
@@ -1,6 +1,6 @@
 module cosmossdk.io/errors
 
-go 1.18
+go 1.19
 
 require (
 	github.com/pkg/errors v0.9.1

diff --git a/go.mod b/go.mod
@@ -1,4 +1,4 @@
-go 1.18
+go 1.19
 
 module github.com/cosmos/cosmos-sdk
 

diff --git a/math/go.mod b/math/go.mod
@@ -1,6 +1,6 @@
 module cosmossdk.io/math
 
-go 1.18
+go 1.19
 
 require github.com/stretchr/testify v1.7.0
 

diff --git a/orm/go.mod b/orm/go.mod
@@ -1,6 +1,6 @@
 module github.com/cosmos/cosmos-sdk/orm
 
-go 1.18
+go 1.19
 
 require (
 	cosmossdk.io/errors v1.0.0-beta.6