vochain fork: refactor ZkCircuits handling

* circuit/config: rename `dev` -> `v0.0.1` and add voceremony as `v1.0.0` * circuit/config: rename `tag` concept into `version` * circuit/config: now ZkCircuitConfig has Version field, drop app.circuitConfigTag * TransactionHandler: unexport zkCircuit field, expose over ZkCircuit methods that implement sync.Mutex * api: /chain/info now returns circuitVersion (instead of misspelt cicuitConfigurationTag) * apiclient: small fix, LoadZkCircuit once on NewHTTPclient instead of every Vote * testsuite: mount zkCircuits cache dir in test container as well * vochain/app.go: SetZkCircuit during beginBlock * add config/forks.go * circuit: add DownloadZkCircuits funcs * DownloadZkCircuitsForChainID * DownloadDefaultZkCircuit NewBaseApplication now calls circuit.DownloadDefaultZkCircuit instead of transactionHandler.LoadZkCircuit and newTendermint now calls circuit.DownloadZkCircuitsForChainID
vocdoni · Nov 28, 2023 · 451e07a · 451e07a
1 parent b597656
commit 451e07a
Show file tree

Hide file tree

Showing 16 changed files with 182 additions and 108 deletions.
diff --git a/api/api_types.go b/api/api_types.go
@@ -200,20 +200,20 @@ type GenericTransactionWithInfo struct {
 }
 
 type ChainInfo struct {
-	ID                      string    `json:"chainId" example:"azeno"`
-	BlockTime               [5]uint64 `json:"blockTime" example:"12000,11580,11000,11100,11100"`
-	ElectionCount           uint64    `json:"electionCount" example:"120"`
-	OrganizationCount       uint64    `json:"organizationCount" example:"20"`
-	GenesisTime             time.Time `json:"genesisTime"  format:"date-time" example:"2022-11-17T18:00:57.379551614Z"`
-	Height                  uint32    `json:"height" example:"5467"`
-	Syncing                 bool      `json:"syncing" example:"true"`
-	Timestamp               int64     `json:"blockTimestamp" swaggertype:"string" format:"date-time" example:"2022-11-17T18:00:57.379551614Z"`
-	TransactionCount        uint64    `json:"transactionCount" example:"554"`
-	ValidatorCount          uint32    `json:"validatorCount" example:"5"`
-	VoteCount               uint64    `json:"voteCount" example:"432"`
-	CircuitConfigurationTag string    `json:"cicuitConfigurationTag" example:"dev"`
-	MaxCensusSize           uint64    `json:"maxCensusSize" example:"50000"`
-	NetworkCapacity         uint64    `json:"networkCapacity" example:"2000"`
+	ID                string    `json:"chainId" example:"azeno"`
+	BlockTime         [5]uint64 `json:"blockTime" example:"12000,11580,11000,11100,11100"`
+	ElectionCount     uint64    `json:"electionCount" example:"120"`
+	OrganizationCount uint64    `json:"organizationCount" example:"20"`
+	GenesisTime       time.Time `json:"genesisTime"  format:"date-time" example:"2022-11-17T18:00:57.379551614Z"`
+	Height            uint32    `json:"height" example:"5467"`
+	Syncing           bool      `json:"syncing" example:"true"`
+	Timestamp         int64     `json:"blockTimestamp" swaggertype:"string" format:"date-time" example:"2022-11-17T18:00:57.379551614Z"`
+	TransactionCount  uint64    `json:"transactionCount" example:"554"`
+	ValidatorCount    uint32    `json:"validatorCount" example:"5"`
+	VoteCount         uint64    `json:"voteCount" example:"432"`
+	CircuitVersion    string    `json:"circuitVersion" example:"v1.0.0"`
+	MaxCensusSize     uint64    `json:"maxCensusSize" example:"50000"`
+	NetworkCapacity   uint64    `json:"networkCapacity" example:"2000"`
 }
 
 type Account struct {

diff --git a/api/censuses.go b/api/censuses.go
@@ -210,9 +210,9 @@ func (a *API) censusCreateHandler(msg *apirest.APIdata, ctx *httprouter.HTTPCont
 	}
 
 	// get census max levels from vochain app if available
-	maxLevels := circuit.CircuitsConfigurations[circuit.DefaultCircuitConfigurationTag].Levels
-	if a.vocapp != nil {
-		maxLevels = a.vocapp.TransactionHandler.ZkCircuit.Config.Levels
+	maxLevels := circuit.CircuitsConfigurations[circuit.DefaultZkCircuitVersion].Levels
+	if a.vocapp != nil && a.vocapp.TransactionHandler != nil {
+		maxLevels = a.vocapp.TransactionHandler.ZkCircuit().Config.Levels
 	}
 
 	censusID := util.RandomBytes(32)

diff --git a/api/chain.go b/api/chain.go
@@ -8,7 +8,6 @@ import (
 	"time"
 
 	tmtypes "github.com/cometbft/cometbft/types"
-	"go.vocdoni.io/dvote/crypto/zk/circuit"
 	"go.vocdoni.io/dvote/httprouter"
 	"go.vocdoni.io/dvote/httprouter/apirest"
 	"go.vocdoni.io/dvote/types"
@@ -301,20 +300,20 @@ func (a *API) chainInfoHandler(_ *apirest.APIdata, ctx *httprouter.HTTPContext)
 	}
 
 	data, err := json.Marshal(&ChainInfo{
-		ID:                      a.vocapp.ChainID(),
-		BlockTime:               *a.vocinfo.BlockTimes(),
-		ElectionCount:           a.indexer.CountTotalProcesses(),
-		OrganizationCount:       a.indexer.CountTotalEntities(),
-		Height:                  a.vocapp.Height(),
-		Syncing:                 a.vocapp.IsSynchronizing(),
-		TransactionCount:        transactionCount,
-		ValidatorCount:          uint32(len(validators)),
-		Timestamp:               a.vocapp.Timestamp(),
-		VoteCount:               voteCount,
-		GenesisTime:             a.vocapp.Genesis().GenesisTime,
-		CircuitConfigurationTag: a.vocapp.CircuitConfigurationTag(),
-		MaxCensusSize:           maxCensusSize,
-		NetworkCapacity:         networkCapacity,
+		ID:                a.vocapp.ChainID(),
+		BlockTime:         *a.vocinfo.BlockTimes(),
+		ElectionCount:     a.indexer.CountTotalProcesses(),
+		OrganizationCount: a.indexer.CountTotalEntities(),
+		Height:            a.vocapp.Height(),
+		Syncing:           a.vocapp.IsSynchronizing(),
+		TransactionCount:  transactionCount,
+		ValidatorCount:    uint32(len(validators)),
+		Timestamp:         a.vocapp.Timestamp(),
+		VoteCount:         voteCount,
+		GenesisTime:       a.vocapp.Genesis().GenesisTime,
+		CircuitVersion:    a.vocapp.TransactionHandler.ZkCircuitVersion(),
+		MaxCensusSize:     maxCensusSize,
+		NetworkCapacity:   networkCapacity,
 	})
 	if err != nil {
 		return err
@@ -332,10 +331,8 @@ func (a *API) chainInfoHandler(_ *apirest.APIdata, ctx *httprouter.HTTPContext)
 //	@Success		200	{object}	circuit.ZkCircuitConfig
 //	@Router			/chain/info/circuit [get]
 func (a *API) chainCircuitInfoHandler(_ *apirest.APIdata, ctx *httprouter.HTTPContext) error {
-	// Get current circuit tag
-	circuitConfig := circuit.GetCircuitConfiguration(a.vocapp.CircuitConfigurationTag())
-	// Encode the circuit configuration to JSON
-	data, err := json.Marshal(circuitConfig)
+	// Encode the current circuit configuration to JSON
+	data, err := json.Marshal(a.vocapp.TransactionHandler.ZkCircuit().Config)
 	if err != nil {
 		return err
 	}

diff --git a/apiclient/client.go b/apiclient/client.go
@@ -41,7 +41,7 @@ type HTTPclient struct {
 	addr    *url.URL
 	account *ethereum.SignKeys
 	chainID string
-	circuit *circuit.ZkCircuitConfig
+	circuit *circuit.ZkCircuit
 	retries int
 }
 
@@ -72,8 +72,11 @@ func NewHTTPclient(addr *url.URL, bearerToken *uuid.UUID) (*HTTPclient, error) {
 		return nil, fmt.Errorf("cannot get chain ID from API server")
 	}
 	c.chainID = info.ID
-	// Get the default circuit config
-	c.circuit = circuit.GetCircuitConfiguration(info.CircuitConfigurationTag)
+
+	c.circuit, err = circuit.LoadZkCircuitVersion(info.CircuitVersion)
+	if err != nil {
+		return nil, fmt.Errorf("error loading circuit: %w", err)
+	}
 	return c, nil
 }
 

diff --git a/apiclient/vote.go b/apiclient/vote.go
@@ -1,7 +1,6 @@
 package apiclient
 
 import (
-	"context"
 	"encoding/hex"
 	"encoding/json"
 	"fmt"
@@ -102,14 +101,9 @@ func (cl *HTTPclient) Vote(v *VoteData) (types.HexBytes, error) {
 		if err != nil {
 			return nil, fmt.Errorf("error encoding inputs: %w", err)
 		}
-		// load the correct circuit from the ApiClient configuration
-		currentCircuit, err := circuit.LoadZkCircuit(context.Background(), c.circuit)
-		if err != nil {
-			return nil, fmt.Errorf("error loading circuit: %w", err)
-		}
 		// instance the prover with the circuit config loaded and generate the
 		// proof for the calculated inputs
-		proof, err := prover.Prove(currentCircuit.ProvingKey, currentCircuit.Wasm, inputs)
+		proof, err := prover.Prove(c.circuit.ProvingKey, c.circuit.Wasm, inputs)
 		if err != nil {
 			return nil, fmt.Errorf("could not generate anonymous proof: %w", err)
 		}

diff --git a/config/forks.go b/config/forks.go
@@ -0,0 +1,27 @@
+package config
+
+// ForksCfg allows applying softforks at specified heights
+type ForksCfg struct {
+	VoceremonyForkBlock uint32
+}
+
+// Forks is a map of chainIDs
+var Forks = map[string]*ForksCfg{
+	"vocdoni/DEV/29": {
+		VoceremonyForkBlock: 180000, // estimated 2023-11-30T23:45:29.095375169Z
+	},
+	"vocdoni/STAGE/9": {
+		VoceremonyForkBlock: 190000, // estimated 2023-12-04T11:25:38.643517797Z
+	},
+	"vocdoni/LTS/1.2": {
+		VoceremonyForkBlock: 350000, // estimated 2023-12-06T05:59:27.529386884Z
+	},
+}
+
+// ForksForChainID returns the ForksCfg of chainID, if found, or an empty ForksCfg otherwise
+func ForksForChainID(chainID string) *ForksCfg {
+	if cfg, found := Forks[chainID]; found {
+		return cfg
+	}
+	return &ForksCfg{}
+}
diff --git a/crypto/zk/circuit/circuit.go b/crypto/zk/circuit/circuit.go
@@ -12,10 +12,11 @@ import (
 	"path/filepath"
 	"time"
 
+	"go.vocdoni.io/dvote/config"
 	"go.vocdoni.io/dvote/log"
 )
 
-var downloadCircuitsTimeout = time.Minute * 5
+const downloadCircuitsTimeout = time.Minute * 5
 
 // BaseDir is where the artifact cache is expected to be found.
 // If the artifacts are not found there, they will be downloaded and stored.
@@ -40,11 +41,31 @@ type ZkCircuit struct {
 	Config          *ZkCircuitConfig
 }
 
-// LoadZkCircuitByTag gets the circuit configuration associated to the provided
-// tag or gets the default one and load its artifacts to prepare the circuit to
-// be used.
-func LoadZkCircuitByTag(configTag string) (*ZkCircuit, error) {
-	circuitConf := GetCircuitConfiguration(configTag)
+// DownloadDefaultZkCircuit ensures the default circuit is cached locally
+func DownloadDefaultZkCircuit() error {
+	_, err := LoadZkCircuitVersion(DefaultZkCircuitVersion)
+	if err != nil {
+		return fmt.Errorf("could not load zk verification keys: %w", err)
+	}
+	return nil
+}
+
+// DownloadZkCircuitsForChainID ensures all circuits needed for chainID are cached locally
+func DownloadZkCircuitsForChainID(chainID string) error {
+	if config.ForksForChainID(chainID).VoceremonyForkBlock > 0 {
+		_, err := LoadZkCircuitVersion(PreVoceremonyForkZkCircuitVersion)
+		if err != nil {
+			return fmt.Errorf("could not load zk verification keys: %w", err)
+		}
+	}
+	return DownloadDefaultZkCircuit()
+}
+
+// LoadZkCircuitVersion load the circuit artifacts based on the version provided.
+// First, tries to load the artifacts from local storage, if they are not
+// available, tries to download from their remote location.
+func LoadZkCircuitVersion(version string) (*ZkCircuit, error) {
+	circuitConf := GetCircuitConfiguration(version)
 	ctx, cancel := context.WithTimeout(context.Background(), downloadCircuitsTimeout)
 	defer cancel()
 	return LoadZkCircuit(ctx, circuitConf)
@@ -85,7 +106,7 @@ func LoadZkCircuit(ctx context.Context, config *ZkCircuitConfig) (*ZkCircuit, er
 // operations fails, returns an error.
 func (circuit *ZkCircuit) LoadLocal() error {
 	var err error
-	log.Debugw("loading circuit locally...", "BaseDir", BaseDir)
+	log.Debugw("loading circuit locally...", "BaseDir", BaseDir, "version", circuit.Config.Version)
 	files := map[string][]byte{
 		circuit.Config.ProvingKeyFilename:      nil,
 		circuit.Config.VerificationKeyFilename: nil,
@@ -112,7 +133,7 @@ func (circuit *ZkCircuit) LoadLocal() error {
 // remote location. If any of the downloads fails, returns an error.
 func (circuit *ZkCircuit) LoadRemote(ctx context.Context) error {
 	log.Debugw("circuit not downloaded yet, downloading...",
-		"BaseDir", BaseDir)
+		"BaseDir", BaseDir, "version", circuit.Config.Version)
 	baseUri, err := url.Parse(circuit.Config.URI)
 	if err != nil {
 		return err

diff --git a/crypto/zk/circuit/config.go b/crypto/zk/circuit/config.go
@@ -10,14 +10,10 @@ import (
 	"go.vocdoni.io/dvote/util"
 )
 
-// DefaultCircuitConfigurationTag constant contains the tag value that points
-// to the default ZkSnark circuit configuration. It ensures that at least one
-// circuit configuration is available so the configuration referred by this tag
-// must be defined.
-const DefaultCircuitConfigurationTag = "dev"
-
 // ZkCircuitConfig defines the configuration of the files to be downloaded
 type ZkCircuitConfig struct {
+	// Version of the published circuit
+	Version string
 	// URI defines the URI from where to download the files
 	URI string `json:"uri"`
 	// CircuitPath defines the path from where the files are downloaded.
@@ -75,12 +71,19 @@ func (conf *ZkCircuitConfig) SupportsCensusSize(maxCensusSize uint64) bool {
 	return conf.MaxCensusSize().Cmp(new(big.Int).SetUint64(maxCensusSize)) > 0
 }
 
+// DefaultZkCircuitVersion is the circuit version used by default
+const DefaultZkCircuitVersion = "v1.0.0"
+
+// PreVoceremonyForkZkCircuitVersion is the circuit version used before VoceremonyForkBlock
+const PreVoceremonyForkZkCircuitVersion = "v0.0.1"
+
 // CircuitsConfigurations stores the relation between the different vochain nets
 // and the associated circuit configuration. Any circuit configuration must have
 // the remote and local location of the circuits artifacts and their metadata
 // such as artifacts hash or the number of parameters.
 var CircuitsConfigurations = map[string]*ZkCircuitConfig{
-	"dev": {
+	"v0.0.1": {
+		Version: "v0.0.1",
 		URI: "https://raw.githubusercontent.com/vocdoni/" +
 			"zk-franchise-proof-circuit/master",
 		CircuitPath:             "artifacts/zkCensus/dev/160",
@@ -92,29 +95,29 @@ var CircuitsConfigurations = map[string]*ZkCircuitConfig{
 		WasmHash:                hexToBytes("0x80a73567f6a4655d4332301efcff4bc5711bb48176d1c71fdb1e48df222ac139"),
 		WasmFilename:            "circuit.wasm",
 	},
-	"prod": {
-		URI: "https://raw.githubusercontent.com/vocdoni/" +
-			"zk-franchise-proof-circuit/master",
-		CircuitPath:             "artifacts/zkCensus/dev/160",
+	"v1.0.0": {
+		Version:                 "v1.0.0",
+		URI:                     "https://raw.githubusercontent.com/altergui/zk-voceremony",
+		CircuitPath:             "ceremony/vocdoni-zkcensus-ceremony/results",
 		Levels:                  160, // ZkCircuit number of levels
-		ProvingKeyHash:          hexToBytes("0xe359b256e5e3c78acaccf8dab5dc4bea99a2f07b2a05e935b5ca658c714dea4a"),
-		ProvingKeyFilename:      "proving_key.zkey",
-		VerificationKeyHash:     hexToBytes("0x235e55571812f8e324e73e37e53829db0c4ac8f68469b9b953876127c97b425f"),
-		VerificationKeyFilename: "verification_key.json",
-		WasmHash:                hexToBytes("0x80a73567f6a4655d4332301efcff4bc5711bb48176d1c71fdb1e48df222ac139"),
-		WasmFilename:            "circuit.wasm",
+		ProvingKeyHash:          hexToBytes("0x94f4062db3e43175ac1136f285551d547a177e37b0616a41900a38ed5ec3d478"),
+		ProvingKeyFilename:      "census_proving_key.zkey",
+		VerificationKeyHash:     hexToBytes("0x2a47ff7e511926290fedfa406886944eeb0a3df9021ca26333c0c124c89aa7b0"),
+		VerificationKeyFilename: "census_verification_key.json",
+		WasmHash:                hexToBytes("0xc98133cf4d84ced677549e0d848739f4e80ddf78af678cbc8b95377247a92773"),
+		WasmFilename:            "census.wasm",
 	},
 }
 
 // GetCircuitConfiguration returns the circuit configuration associated with the
 // provided tag or gets the default one.
-func GetCircuitConfiguration(configTag string) *ZkCircuitConfig {
+func GetCircuitConfiguration(version string) *ZkCircuitConfig {
 	// check if the provided config tag exists and return it if it does
-	if conf, ok := CircuitsConfigurations[configTag]; ok {
+	if conf, ok := CircuitsConfigurations[version]; ok {
 		return conf
 	}
 	// if not, return default configuration
-	return CircuitsConfigurations[DefaultCircuitConfigurationTag]
+	return CircuitsConfigurations[DefaultZkCircuitVersion]
 }
 
 // hexToBytes parses a hex string and returns the byte array from it. Warning,

diff --git a/dockerfiles/testsuite/docker-compose.yml b/dockerfiles/testsuite/docker-compose.yml
@@ -101,6 +101,7 @@ services:
     networks:
       - blockchain
     volumes:
+      - /tmp/.vochain-zkCircuits/:/root/.cache/vocdoni/zkCircuits/
       - gocoverage-test:/app/run/gocoverage
     environment:
       - GOCOVERDIR=/app/run/gocoverage