Add a VM with Contract support

.github/workflows/hypersdk-ci.yml

@@ -182,3 +182,89 @@ jobs:
  with:
  vm-name: morpheusvm
  github-token: ${{ secrets.GITHUB_TOKEN }}
+
+ # VMWithContracts
+ vmwithcontracts-lint:
+ needs: [ hypersdk-tests ]
+ if: ${{ needs.hypersdk-tests.outputs.only_programs_changed != 'true' }}
+ runs-on: ubuntu-latest
+ timeout-minutes: 10
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+ - name: Set up Go
+ uses: ./.github/actions/install-go
+ with:
+ cache-dependency-path: |
+ go.sum
+ examples/vmwithcontracts/go.sum
+ - name: Run static analysis tests
+ working-directory: ./examples/vmwithcontracts
+ shell: bash
+ run: scripts/lint.sh
+ - name: Build vm, cli
+ working-directory: ./examples/vmwithcontracts
+ shell: bash
+ run: scripts/build.sh
+
+ # vmwithcontracts-unit-tests:
+ # needs: [ hypersdk-tests ]
+ # if: ${{ needs.hypersdk-tests.outputs.only_programs_changed != 'true' }}
+ # runs-on: ubuntu-20.04-32
+ # timeout-minutes: 10
+ # steps:
+ # - name: Checkout
+ # uses: actions/checkout@v4
+ # - name: Set up Go
+ # uses: ./.github/actions/install-go
+ # with:
+ # cache-dependency-path: |
+ # go.sum
+ # examples/vmwithcontracts/go.sum
+ # - name: Run unit tests
+ # working-directory: ./examples/vmwithcontracts
+ # shell: bash
+ # run: scripts/tests.unit.sh
+ # - name: Run integration tests
+ # working-directory: ./examples/vmwithcontracts
+ # shell: bash
+ # run: scripts/tests.integration.sh
+ # 
+ # vmwithcontracts-e2e-tests:
+ # needs: [ vmwithcontracts-lint, vmwithcontracts-unit-tests ]
+ # runs-on: ubuntu-20.04-32
+ # timeout-minutes: 25
+ # steps:
+ # - name: Checkout
+ # uses: actions/checkout@v4
+ # - name: Set up Go
+ # uses: ./.github/actions/install-go
+ # with:
+ # cache-dependency-path: |
+ # go.sum
+ # examples/vmwithcontracts/go.sum
+ # - name: Run e2e tests
+ # working-directory: ./examples/vmwithcontracts
+ # shell: bash
+ # run: scripts/run.sh
+ # env:
+ # MODE: 'test'
+ # - name: Upload tmpnet network dir
+ # uses: ava-labs/avalanchego/.github/actions/upload-tmpnet-artifact@v1-actions
+ # if: always()
+ # with:
+ # name: vmwithcontracts-e2e-tmpnet-data
+ # 
+ # vmwithcontracts-release:
+ # needs: [ vmwithcontracts-e2e-tests ]
+ # # We build with 20.04 to maintain max compatibility: https://github.com/golang/go/issues/57328
+ # runs-on: ubuntu-20.04-32
+ # permissions:
+ # contents: write
+ # steps:
+ # - name: Checkout
+ # uses: actions/checkout@v4
+ # - uses: ./.github/actions/vm-release
+ # with:
+ # vm-name: vmwithcontracts
+ # github-token: ${{ secrets.GITHUB_TOKEN }}

api/dependencies.go

@@ -14,6 +14,7 @@ import (
  "github.com/ava-labs/hypersdk/chain"
  "github.com/ava-labs/hypersdk/fees"
  "github.com/ava-labs/hypersdk/genesis"
+ "github.com/ava-labs/hypersdk/state"
 )
 
 type VM interface {
@@ -36,4 +37,5 @@ type VM interface {
  ) (map[ids.NodeID]*validators.GetValidatorOutput, map[string]struct{})
  GetVerifyAuth() bool
  ReadState(ctx context.Context, keys [][]byte) ([][]byte, []error)
+ ImmutableState(ctx context.Context) (state.Immutable, error)
 }

cli/prompt/prompt.go

@@ -4,6 +4,7 @@
 package prompt
 
 import (
+ "encoding/hex"
  "errors"
  "fmt"
  "strconv"
@@ -29,6 +30,24 @@ var (
  ErrInsufficientAccounts = errors.New("insufficient accounts")
 )
 
+func Bytes(label string) ([]byte, error) {
+ promptText := promptui.Prompt{
+ Label: label,
+ Validate: func(input string) error {
+ if len(input) == 0 {
+ return ErrInputEmpty
+ }
+ _, err := hex.DecodeString(input)
+ return err
+ },
+ }
+ hexString, err := promptText.Run()
+ if err != nil {
+ return nil, err
+ }
+ return hex.DecodeString(hexString)
+}
+
 func Address(label string, parseAddress func(string) (codec.Address, error)) (codec.Address, error) {
  promptText := promptui.Prompt{
  Label: label,

examples/vmwithcontracts/.golangci.yml

@@ -0,0 +1,113 @@
+# Copyright (C) 2023, Ava Labs, Inc. All rights reserved.
+# See the file LICENSE for licensing terms.
+
+# https://golangci-lint.run/usage/configuration/
+run:
+ timeout: 10m
+ # skip auto-generated files.
+ skip-files:
+ - ".*\\.pb\\.go$"
+ - ".*mock.*"
+
+issues:
+ # Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
+ max-same-issues: 0
+
+linters:
+ # please, do not use `enable-all`: it's deprecated and will be removed soon.
+ # inverted configuration with `enable-all` and `disable` is not scalable during updates of golangci-lint
+ disable-all: true
+ enable:
+ - asciicheck
+ - depguard
+ - errcheck
+ - errorlint
+ - exportloopref
+ - goconst
+ - gocritic
+ - gofmt
+ - gofumpt
+ - goimports
+ - revive
+ - gosec
+ - gosimple
+ - govet
+ - ineffassign
+ - misspell
+ - nakedret
+ - nolintlint
+ - prealloc
+ - stylecheck
+ - unconvert
+ - unparam
+ - unused
+ - unconvert
+ - whitespace
+ - staticcheck
+ - bodyclose
+ - goprintffuncname
+ - typecheck
+ - noctx
+
+linters-settings:
+ errorlint:
+ # Check for plain type assertions and type switches.
+ asserts: false
+ # Check for plain error comparisons.
+ comparison: false
+ revive:
+ rules:
+ # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#bool-literal-in-expr
+ - name: bool-literal-in-expr
+ disabled: false
+ # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#early-return
+ - name: early-return
+ disabled: false
+ # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#empty-lines
+ - name: empty-lines
+ disabled: false
+ # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#struct-tag
+ - name: struct-tag
+ disabled: false
+ # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unexported-naming
+ - name: unexported-naming
+ disabled: false
+ # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unhandled-error
+ - name: unhandled-error
+ disabled: false
+ arguments:
+ - "fmt.Fprint"
+ - "fmt.Fprintf"
+ - "fmt.Print"
+ - "fmt.Printf"
+ - "fmt.Println"
+ - "rand.Read"
+ - "sb.WriteString"
+ # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-parameter
+ - name: unused-parameter
+ disabled: false
+ # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-receiver
+ - name: unused-receiver
+ disabled: false
+ # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#useless-break
+ - name: useless-break
+ disabled: false
+ staticcheck:
+ # https://staticcheck.io/docs/options#checks
+ checks:
+ - "all"
+ - "-SA6002" # argument should be pointer-like to avoid allocation, for sync.Pool
+ - "-SA1019" # deprecated packages e.g., golang.org/x/crypto/ripemd160
+ # https://golangci-lint.run/usage/linters#gosec
+ gosec:
+ excludes:
+ - G107 # https://securego.io/docs/rules/g107.html
+ depguard:
+ rules:
+ packages:
+ deny:
+ - pkg: "github.com/stretchr/testify/assert"
+ desc: github.com/stretchr/testify/require should be used instead.
+ - pkg: "io/ioutil"
+ desc: io/ioutil is deprecated. Use package io or os instead.
+ include-go-root: true

examples/vmwithcontracts/.goreleaser.yml

@@ -0,0 +1,75 @@
+# Copyright (C) 2023, Ava Labs, Inc. All rights reserved.
+# See the file LICENSE for licensing terms.
+
+# ref. https://goreleaser.com/customization/build/
+builds:
+ - id: vmwithcontracts-cli
+ main: ./cmd/vmwithcontracts-cli
+ binary: vmwithcontracts-cli
+ flags:
+ - -v
+ goos:
+ - linux
+ - darwin
+ goarch:
+ - amd64
+ - arm64
+ env:
+ - CGO_ENABLED=1
+ - CGO_CFLAGS=-O -D__BLST_PORTABLE__ # Set the CGO flags to use the portable version of BLST
+ overrides:
+ - goos: linux
+ goarch: arm64
+ env:
+ - CC=aarch64-linux-gnu-gcc
+ - goos: darwin
+ goarch: arm64
+ env:
+ - CC=oa64-clang
+ - goos: darwin
+ goarch: amd64
+ goamd64: v1
+ env:
+ - CC=o64-clang
+ - id: vmwithcontracts
+ main: ./cmd/vmwithcontracts
+ binary: vmwithcontracts
+ flags:
+ - -v
+ goos:
+ - linux
+ - darwin
+ goarch:
+ - amd64
+ - arm64
+ env:
+ - CGO_ENABLED=1
+ - CGO_CFLAGS=-O -D__BLST_PORTABLE__ # Set the CGO flags to use the portable version of BLST
+ overrides:
+ - goos: linux
+ goarch: arm64
+ env:
+ - CC=aarch64-linux-gnu-gcc
+ - goos: darwin
+ goarch: arm64
+ env:
+ - CC=oa64-clang
+ - goos: darwin
+ goarch: amd64
+ goamd64: v1
+ env:
+ - CC=o64-clang
+
+checksum:
+ name_template: "vmwithcontracts_checksums.txt"
+
+archives:
+ - id: default
+ name_template: 'vmwithcontracts_{{ .Version }}_{{ .Os }}_{{ .Arch }}'
+
+release:
+ make_latest: false # Should be done manually
+ mode: 'keep-existing' # Should not override releases
+ github:
+ owner: ava-labs
+ name: hypersdk

examples/vmwithcontracts/LICENSE

@@ -0,0 +1,66 @@
+Copyright (C) 2023, Ava Labs, Inc. All rights reserved.
+
+Ecosystem License
+Version: 1.1
+
+Subject to the terms herein, Ava Labs, Inc. (**“Ava Labs”**) hereby grants you
+a limited, royalty-free, worldwide, non-sublicensable, non-transferable,
+non-exclusive license to use, copy, modify, create derivative works based on,
+and redistribute the Software, in source code, binary, or any other form,
+including any modifications or derivative works of the Software (collectively,
+**“Licensed Software”**), in each case subject to this Ecosystem License
+(**“License”**).
+
+This License applies to all copies, modifications, derivative works, and any
+other form or usage of the Licensed Software. You will include and display
+this License, without modification, with all uses of the Licensed Software,
+regardless of form.
+
+You will use the Licensed Software solely (i) in connection with the Avalanche
+Public Blockchain platform, having a NetworkID of 1 (Mainnet) or 5 (Fuji), and
+associated blockchains, comprised exclusively of the Avalanche X-Chain,
+C-Chain, P-Chain and any subnets linked to the P-Chain (“Avalanche Authorized
+Platform”) or (ii) for non-production, testing or research purposes within the
+Avalanche ecosystem, in each case, without any commercial application
+(“Non-Commercial Use”); provided that this License does not permit use of the
+Licensed Software in connection with (a) any forks of the Avalanche Authorized
+Platform or (b) in any manner not operationally connected to the Avalanche
+Authorized Platform other than, for the avoidance of doubt, the limited
+exception for Non-Commercial Use. Ava Labs may publicly announce changes or
+additions to the Avalanche Authorized Platform, which may expand or modify
+usage of the Licensed Software. Upon such announcement, the Avalanche
+Authorized Platform will be deemed to be the then-current iteration of such
+platform.
+
+You hereby acknowledge and agree to the terms set forth at
+www.avalabs.org/important-notice.
+
+If you use the Licensed Software in violation of this License, this License
+will automatically terminate and Ava Labs reserves all rights to seek any
+remedy for such violation.
+
+Except for uses explicitly permitted in this License, Ava Labs retains all
+rights in the Licensed Software, including without limitation the ability to
+modify it.
+
+Except as required or explicitly permitted by this License, you will not use
+any Ava Labs names, logos, or trademarks without Ava Labs’ prior written
+consent.
+
+You may use this License for software other than the “Licensed Software”
+specified above, as long as the only change to this License is the definition
+of the term “Licensed Software.”
+
+The Licensed Software may reference third party components. You acknowledge
+and agree that these third party components may be governed by a separate
+license or terms and that you will comply with them.
+
+**TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE LICENSED SOFTWARE IS PROVIDED
+ON AN “AS IS” BASIS, AND AVA LABS EXPRESSLY DISCLAIMS AND EXCLUDES ALL
+REPRESENTATIONS, WARRANTIES AND OTHER TERMS AND CONDITIONS, WHETHER EXPRESS OR
+IMPLIED, INCLUDING WITHOUT LIMITATION BY OPERATION OF LAW OR BY CUSTOM,
+STATUTE OR OTHERWISE, AND INCLUDING, BUT NOT LIMITED TO, ANY IMPLIED WARRANTY,
+TERM, OR CONDITION OF NON-INFRINGEMENT, MERCHANTABILITY, TITLE, OR FITNESS FOR
+PARTICULAR PURPOSE. YOU USE THE LICENSED SOFTWARE AT YOUR OWN RISK. AVA LABS
+EXPRESSLY DISCLAIMS ALL LIABILITY (INCLUDING FOR ALL DIRECT, CONSEQUENTIAL OR
+OTHER DAMAGES OR LOSSES) RELATED TO ANY USE OF THE LICENSED SOFTWARE.**