Merge branch 'master' into feature/official-docs

.github/golangci.yml

@@ -1,9 +1,20 @@
 run:
-  timeout: 5m
+  concurrency: 8
+  timeout: 10m
+  issue-exit-code: 1
   tests: true
   skip-dirs-use-default: true
+  modules-download-mode: readonly
+  allow-parallel-runners: false
+  go: ""
+
+output:
+  uniq-by-line: false
+  path-prefix: ""
+  sort-results: true
 
 linters:
+  fast: false
   disable-all: true
   enable:
     - whitespace # Tool for detection of leading and trailing whitespace
@@ -21,12 +32,11 @@ linters:
     - gofmt # Whether the code was gofmt-ed
     - goimports # Unused imports
     - goconst # Repeated strings that could be replaced by a constant
-    #- forcetypeassert # Finds forced type assertions
     - dogsled # Checks assignments with too many blank identifiers (e.g. x, , , _, := f())
-    #- dupl # Code clone detection
     - errname # Checks that sentinel errors are prefixed with the Err and error types are suffixed with the Error
     - errorlint # errorlint is a linter for that can be used to find code that will cause problems with the error wrapping scheme introduced in Go 1.13
     - gofumpt # Stricter gofmt
+    - unused # Checks Go code for unused constants, variables, functions and types
 
 linters-settings:
   gofmt:
@@ -42,9 +52,20 @@ linters-settings:
     checks: [ "all", "-ST1022", "-ST1003" ]
   errorlint:
     asserts: false
+  gocritic:
+    enabled-tags:
+      - diagnostic
+      - experimental
+      - opinionated
+      - performance
+      - style
 
 issues:
   whole-files: true
+  max-issues-per-linter: 0
+  max-same-issues: 0
+  new: false
+  fix: false
   exclude-rules:
     - path: _test\.go
       linters:

.github/workflows/auto-author-assign.yml

@@ -15,4 +15,4 @@ jobs:
   assign-author:
     runs-on: ubuntu-latest
     steps:
-      - uses: toshimaru/auto-author-assign@v1.6.2
+      - uses: toshimaru/auto-author-assign@v2.0.1

.github/workflows/contribs.yml

@@ -0,0 +1,35 @@
+name: contribs
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    paths:
+      - "contribs/**"
+      - ".github/workflows/contribs.yml"
+      - "gnovm/**.go"
+      - "gno.land/**.go"
+      - "tm2/**.go"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  install:
+    strategy:
+      fail-fast: false
+      matrix:
+        goversion: # two latest versions
+          - "1.21.x"
+        program:
+          - "gnomd"
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v4
+        with:
+          go-version: ${{ matrix.goversion }}
+      - run: make install ${{ matrix.program }}
+        working-directory: contribs

.github/workflows/examples.yml

@@ -73,3 +73,22 @@ jobs:
       - run: go run ./gnovm/cmd/gno lint --verbose ./examples/gno.land/r/gnoland
       - run: go run ./gnovm/cmd/gno lint --verbose ./examples/gno.land/r/system
     # TODO: track coverage
+  mod-tidy:
+    strategy:
+      fail-fast: false
+      matrix:
+        go-version: [ "1.21.x" ]
+        # unittests: TODO: matrix with contracts
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/setup-go@v4
+        with:
+          go-version: ${{ matrix.go-version }}
+      - uses: actions/checkout@v4
+      - run: |
+          GNO_CMD="$(pwd)/gnovm/cmd/gno"
+          # Find all directories containing gno.mod file
+          find ./examples -name "gno.mod" -execdir go run "$GNO_CMD" mod tidy \;
+          # Check if there are changes after running gno mod tidy
+          git diff --exit-code || (echo "Some gno.mod files are not tidy, please run 'make tidy'." && exit 1)

.github/workflows/gnoland.yml

@@ -60,9 +60,7 @@ jobs:
           - _test.gnoland
           - _test.gnokey
           - _test.pkgs
-          # XXX: test broken, should be rewritten to run an inmemory localnode
-          # Re-add to makefile when fixed. Tracked here: https://github.com/gnolang/gno/issues/1222
-          #- _test.gnoweb
+          - _test.gnoweb 
     runs-on: ubuntu-latest
     timeout-minutes: 15
     steps:
@@ -78,7 +76,7 @@ jobs:
           export LOG_DIR="${{ runner.temp }}/logs/test-${{ matrix.goversion }}-gnoland"
           make ${{ matrix.args }}
       - name: Upload Test Log
-        if: always()
+        if: always() 
         uses: actions/upload-artifact@v3
         with:
           name: logs-test-gnoland-go${{ matrix.goversion }}
@@ -101,7 +99,7 @@ jobs:
         uses: codecov/codecov-action@v3
         with:
           directory: ${{ runner.temp }}/coverage
-          token: ${{ secrets.CODECOV_TOKEN }}
+          token: ${{ secrets.CODECOV_TOKEN }} 
           fail_ci_if_error: ${{ github.repository == 'gnolang/gno' }}
 
   docker-integration:

.github/workflows/gnovm.yml

@@ -67,35 +67,68 @@ jobs:
           - _test.gnolang.other
     runs-on: ubuntu-latest
     timeout-minutes: 15
+    env:
+      COVERAGE_DIR: "/tmp/coverage"
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-go@v4
         with:
           go-version: ${{ matrix.goversion }}
       - name: test
         working-directory: gnovm
+        env:
+          TXTARCOVERDIR: ${{ env.COVERAGE_DIR }}
         run: |
+          mkdir -p $COVERAGE_DIR
+
+          # Setup testing environements variables
           export GOPATH=$HOME/go
-          export GOTEST_FLAGS="-v -p 1 -timeout=30m -coverprofile=coverage.out -covermode=atomic"
+          export GOTEST_FLAGS="-v -p 1 -timeout=30m -covermode=atomic -test.gocoverdir=$COVERAGE_DIR" 
+
+          # Run target test
           make ${{ matrix.args }}
       - uses: actions/upload-artifact@v3
         if: ${{ runner.os == 'Linux' && matrix.goversion == '1.21.x' }}
         with:
           name: ${{runner.os}}-coverage-gnovm-${{ matrix.args}}-${{matrix.goversion}}
-          path: ./gnovm/coverage.out
+          path: ${{ env.COVERAGE_DIR }}
 
   upload-coverage:
     needs: test
     runs-on: ubuntu-latest
+    env:
+      COVERAGE_DATA: /tmp/coverage/coverage-raw
+      COVERAGE_OUTPUT: /tmp/coverage/coverage-out
+      COVERAGE_PROFILE: /tmp/coverage/coverage.txt
     steps:
-      - name: Download all previous coverage artifacts
+      - run: mkdir -p $COVERAGE_DATA $COVERAGE_OUTPUT
+      - name: Download all previous coverage data artifacts
         uses: actions/download-artifact@v3
         with:
-          path: ${{ runner.temp }}/coverage
+          path: ${{ env.COVERAGE_DATA }}
+      - uses: actions/setup-go@v4
+        with:
+          go-version: "1.21.x"
+      - name: Merge coverages
+        working-directory: ${{ env.COVERAGE_DATA }}
+        run: |
+          # Create coverage directory list separate by comma
+          export COVERAGE_DIRS="$(ls | tr '\n' ',' | sed s/,$//)"
+
+          # Merge all coverage data directories from previous tests
+          go tool covdata merge -v 1 -i="$COVERAGE_DIRS" -o $COVERAGE_OUTPUT
+
+          # Print coverage percent for debug purpose if needed
+          echo 'coverage results:'
+          go tool covdata percent -i=$COVERAGE_OUTPUT
+
+          # Generate coverage profile
+          go tool covdata textfmt -v 1 -i=$COVERAGE_OUTPUT -o $COVERAGE_PROFILE
+
       - name: Upload combined coverage to Codecov
         uses: codecov/codecov-action@v3
         with:
-          directory: ${{ runner.temp }}/coverage
+          files: ${{ env.COVERAGE_PROFILE }}
           token: ${{ secrets.CODECOV_TOKEN }} 
           fail_ci_if_error: ${{ github.repository == 'gnolang/gno' }}
 

.github/workflows/misc.yml

@@ -71,8 +71,9 @@ jobs:
 
       - name: Check go.mods
         run: |
-          sums="$(sha256sum go.mod misc/devdeps/go.mod)"
-          for path in . ./misc/devdeps; do
+          gomods=$(find . -type f -name go.mod)
+          sums="$(sha256sum ${gomods})"
+          for path in $(dirname $(gomods)); do
             env -C $path go mod tidy -v || exit 1
           done
           echo "$sums" | sha256sum -c

.github/workflows/tm2.yml

@@ -55,7 +55,7 @@ jobs:
           - _test.pkg.bft
           - _test.pkg.others
     runs-on: ubuntu-latest
-    timeout-minutes: 15
+    timeout-minutes: 21
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-go@v4
@@ -65,7 +65,7 @@ jobs:
         working-directory: tm2
         run: |
           export GOPATH=$HOME/go
-          export GOTEST_FLAGS="-v -p 1 -timeout=30m -coverprofile=coverage.out -covermode=atomic"
+          export GOTEST_FLAGS="-v -p 1 -timeout=20m -coverprofile=coverage.out -covermode=atomic"
           make ${{ matrix.args }}
           touch coverage.out
       - uses: actions/upload-artifact@v3

.mailmap

@@ -0,0 +1,12 @@
+# man 5 gitmailmap
+# git log --mailmap --pretty=short | grep ^Author: | sort -u
+Jae Kwon <[email protected]> Jae Kwon <[email protected]>
+Jae Kwon <[email protected]> Jae Kwon <[email protected]>
+Jae Kwon <[email protected]> jaekwon <[email protected]>
+Jae Kwon <[email protected]> Naut Jae <[email protected]>
+Thomas Bruyelle <[email protected]> Thomas Bruyelle <[email protected]>
+Thomas Bruyelle <[email protected]> Thomas Bruyelle <[email protected]>
+Miloš Živković <[email protected]> Miloš Živković <[email protected]>
+Hariom Verma <[email protected]> Hariom Verma <[email protected]>
+Giancarlos Salas <[email protected]> Giancarlos Salas <[email protected]>
+Morgan <[email protected]> Morgan <[email protected]>

CONTRIBUTING.md

@@ -80,7 +80,7 @@ There currently is an unofficial [Visual Studio Code](https://marketplace.visual
 extension (primarily developed by a core team member) for working with `*.gno`
 files.
 
-#### ViM Support
+#### ViM Support (without LSP)
 
 Add to your `.vimrc` file:
 
@@ -104,9 +104,68 @@ To use *gofumpt* instead of *gofmt*, as hinted in the comment, you may either ha
 cexpr system('go run -modfile </path/to/gno>/misc/devdeps/go.mod mvdan.cc/gofumpt -w ' . expand('%'))
 ```
 
+### ViM Support (with LSP)
+
 There is an experimental and unofficial [Gno Language Server](https://github.com/jdkato/gnols)
 developed by the community, with an installation guide for Neovim.
 
+For ViM purists, you have to install the [`vim-lsp`](https://github.com/prabirshrestha/vim-lsp)
+plugin and then register the LSP server in your `.vimrc` file:
+
+```vim
+augroup gno_autocmd
+    autocmd!
+    autocmd BufNewFile,BufRead *.gno
+        \ set filetype=gno |
+        \ set syntax=go
+augroup END
+
+if (executable('gnols'))
+    au User lsp_setup call lsp#register_server({
+        \ 'name': 'gnols',
+        \ 'cmd': ['gnols'],
+        \ 'allowlist': ['gno'],
+        \ 'config': {},
+        \ 'workspace_config': {
+        \   'root' : '/path/to/gno_repo',
+        \	'gno'  : '/path/to/gno_bin',
+        \   'precompileOnSave' : v:true,
+        \   'buildOnSave'      : v:false,
+        \ },
+        \ 'languageId': {server_info->'gno'},
+    \ })
+else
+	echomsg 'gnols binary not found: LSP disabled for Gno files'
+endif
+	
+function! s:on_lsp_buffer_enabled() abort
+    " Autocompletion
+    setlocal omnifunc=lsp#complete
+    " Format on save
+    autocmd BufWritePre <buffer> LspDocumentFormatSync
+    " Some optionnal mappings
+    nmap <buffer> <leader>i <Plug>(lsp-hover) 
+    " Following mappings are not supported yet by gnols
+    " nmap <buffer> gd <plug>(lsp-definition)     
+    " nmap <buffer> <leader>rr <plug>(lsp-rename)
+endfunction
+augroup lsp_install
+    au!
+    autocmd User lsp_buffer_enabled call s:on_lsp_buffer_enabled()
+augroup END
+```
+
+Note that unlike the previous ViM setup without LSP, here it is required by
+`vim-lsp` to have a specific `filetype=gno`. Syntax highlighting is preserved
+thanks to `syntax=go`.
+
+Inside `lsp#register_server()`, you also have to replace
+`workspace_config.root` and `workspace_config.gno` with the correct directories
+from your machine.
+
+Additionaly, it's not possible to use `gofumpt` for code formatting with
+`gnols` for now.
+
 #### Emacs Support
 
 1. Install [go-mode.el](https://github.com/dominikh/go-mode.el).

README.md

@@ -9,7 +9,7 @@
 > simulated by the Gnomes of the Greater Resistance.
 
 Gno is an interpreted and fully-deterministic implementation of the Go
-programming language, designed to build succint and composable smart contracts.
+programming language, designed to build succinct and composable smart contracts.
 The first blockchain to use it is Gno.land, a
 [Proof of Contribution](./docs/proof-of-contribution.md)-based chain, backed by
 a variation of the [Tendermint](https://docs.tendermint.com/v0.34/introduction/what-is-tendermint.html)

contribs/Makefile

@@ -0,0 +1,30 @@
+.PHONY: help
+help:
+	@echo "Available make commands:"
+	@cat Makefile | grep '^[a-z][^:]*:' | cut -d: -f1 | sort | sed 's/^/  /'
+
+.PHONY: install
+install: install.gnomd
+
+install.gnomd:; cd gnomd && go install .
+
+.PHONY: clean
+clean:
+	rm -rf build
+
+########################################
+# Dev tools
+rundep=go run -modfile ../misc/devdeps/go.mod
+
+.PHONY: fmt
+GOFMT_FLAGS ?= -w
+fmt:
+	$(rundep) mvdan.cc/gofumpt $(GOFMT_FLAGS) .
+
+########################################
+# Test suite
+GOTEST_FLAGS ?= -v -p 1 -timeout=30m
+
+.PHONY: test
+test:
+	@echo "nothing to do."