Merge pull request #623 from 0xPolygonID/feature/support-custom-networks

feat: Support custom networks

Author: vmidyllic

.env-api.sample

@@ -11,3 +11,4 @@ ISSUER_API_IDENTITY_BLOCKCHAIN=polygon
 ISSUER_API_IDENTITY_NETWORK=mumbai
 ISSUER_API_UI_KEY_TYPE=BJJ
 ISSUER_API_ENVIRONMENT=local
+ISSUER_CUSTOM_DID_METHODS='[{"blockchain":"linea","network":"testnet","networkFlag":"0b01000001","chainID":59140}]'

README.md

@@ -175,6 +175,12 @@ In order to make the UI work, we will need configure some env variables in the `
     ISSUER_API_UI_SERVER_URL={PUBLICLY_ACCESSIBLE_URL_POINTING_TO_ISSUER_API_UI_SERVER_PORT}
     ```
 
+    > **_NOTE:_**  It is possible to register custom did methods. This field accepts an array of objects in JSON format.</br>
+    > Example:
+        ```
+        ISSUER_CUSTOM_DID_METHODS='[{"blockchain":"linea","network":"testnet","networkFlag":"0b01000001","chainID":59140}]'
+        ```
+
 2. Generate Issuer DID:
 
     ```bash

cmd/issuer_initializer/main.go

@@ -47,6 +47,8 @@ func main() {
 
 	log.Config(cfg.Log.Level, cfg.Log.Mode, os.Stdout)
 
+	services.RegisterCustomDIDMethods(cfg.CustomDIDMethods)
+
 	if err := cfg.Sanitize(ctx); err != nil {
 		log.Error(ctx, "there are errors in the configuration that prevent server to start", "err", err)
 		return

cmd/platform/main.go

@@ -53,6 +53,8 @@ func main() {
 		return
 	}
 
+	services.RegisterCustomDIDMethods(cfg.CustomDIDMethods)
+
 	log.Config(cfg.Log.Level, cfg.Log.Mode, os.Stdout)
 
 	if err := cfg.Sanitize(ctx); err != nil {

cmd/platform_ui/main.go

@@ -67,6 +67,8 @@ func main() {
 		return
 	}
 
+	services.RegisterCustomDIDMethods(cfg.CustomDIDMethods)
+
 	storage, err := db.NewStorage(cfg.Database.URL)
 	if err != nil {
 		log.Error(ctx, "cannot connect to database", "err", err)

go.sum

@@ -355,6 +355,8 @@ github.com/gofrs/flock v0.8.1 h1:+gYjHKf32LDeiEEFhQaotPbLuUXjY5ZqxKgXy7n59aw=
 github.com/gofrs/flock v0.8.1/go.mod h1:F1TvTiK9OcQqauNUHlbJvyl9Qa1QvF/gOUDKA14jxHU=
 github.com/gofrs/uuid v4.0.0+incompatible h1:1SD/1F5pU8p29ybwgQSwpQk+mwdRrXCYuPhW6m+TnJw=
 github.com/gofrs/uuid v4.0.0+incompatible/go.mod h1:b2aQJv3Z4Fp6yNu3cdSllBxTCLRxnplIgP/c0N/04lM=
+github.com/gofrs/uuid/v5 v5.0.0 h1:p544++a97kEL+svbcFbCQVM9KFu0Yo25UoISXGNNH9M=
+github.com/gofrs/uuid/v5 v5.0.0/go.mod h1:CDOjlDMVAtN56jqyRUZh58JT31Tiw7/oQyEXZV+9bD8=
 github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ=
 github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q=
 github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q=
@@ -559,12 +561,8 @@ github.com/iden3/go-schema-processor v1.3.1 h1:LJfFInfYGMOp0bTKKC17R8q4XI+VtqhFL
 github.com/iden3/go-schema-processor v1.3.1/go.mod h1:NwJ1nuGdRlCFaN1/V6mS0AOAdvpLcGf4KKq0mluLG7U=
 github.com/iden3/go-schema-processor/v2 v2.2.0 h1:sYPqLs72pEWXIfF0/MOv9AFm3+IGutRM3yClWRrjheg=
 github.com/iden3/go-schema-processor/v2 v2.2.0/go.mod h1:Ovsrk0839NZgHtoW4hVLAmHoOsHAQZuVNUXd7sIOkLQ=
-github.com/iden3/go-schema-processor/v2 v2.3.1 h1:cjsfUZNgyPoHQDEES4vuVod948QC9l35QkoEIat0ghc=
-github.com/iden3/go-schema-processor/v2 v2.3.1/go.mod h1:BcHVDZyn8q8vUlL+XpOo7hpwXmEjxzO8ao1LkvFsM+k=
 github.com/iden3/iden3comm/v2 v2.1.0 h1:op2X3y/H9khizcdoYKf3iRAQFt/l5dsip47sJu1kv7Q=
 github.com/iden3/iden3comm/v2 v2.1.0/go.mod h1:G+ufR/M28O3PKMVrkUqCuoYfjiEkGFWvf8oF2BmFC6c=
-github.com/iden3/iden3comm/v2 v2.2.0 h1:cftP0uP8+/1+9r/Fin1FDbSDZuqIoXZv+EITw3/bS5Q=
-github.com/iden3/iden3comm/v2 v2.2.0/go.mod h1:IBdraWsFyChVTArxaE2zr4ALhw7eetJFpEukj2qimeg=
 github.com/iden3/merkletree-proof v0.0.4 h1:o1XXws6zb7+BBDQYXlo0GPUH+jUY3+GxkT88U1C4Sb8=
 github.com/iden3/merkletree-proof v0.0.4/go.mod h1:D49CVDG/tshMiZuDCxWjGJoNplRg9y9XIlg9/eMSYOc=
 github.com/imdario/mergo v0.3.16 h1:wwQJbIsHYGMUyLSPrEq1CT16AhnhNJQ51+4fdHUnCl4=

internal/config/config.go

@@ -2,13 +2,15 @@ package config
 
 import (
 	"context"
+	"encoding/json"
 	"errors"
 	"fmt"
 	"net/url"
 	"os"
 	"path/filepath"
 	"regexp"
 	"runtime"
+	"strconv"
 	"strings"
 	"time"
 
@@ -46,7 +48,8 @@ type Configuration struct {
 	IPFS                         IPFS          `mapstructure:"IPFS"`
 	VaultUserPassAuthEnabled     bool
 	VaultUserPassAuthPassword    string
-	CredentialStatus             CredentialStatus `mapstructure:"CredentialStatus"`
+	CredentialStatus             CredentialStatus   `mapstructure:"CredentialStatus"`
+	CustomDIDMethods             []CustomDIDMethods `mapstructure:"-"`
 }
 
 // Database has the database configuration
@@ -90,6 +93,43 @@ type Ethereum struct {
 	TransferAccountKeyPath    string        `tip:"Transfer account key path"`
 }
 
+// CustomDIDMethods struct
+// Example: ISSUER_CUSTOM_DID_METHODS='[{"blockchain":"linea","network":"testnet","networkFlag":"0b01000001","chainID":59140}]'
+type CustomDIDMethods struct {
+	Blockchain  string `tip:"Identity blockchain for custom network"`
+	Network     string `tip:"Identity network for custom network"`
+	NetworkFlag byte   `tip:"Identity network flag for custom network"`
+	ChainID     int    `tip:"Chain id for custom network"`
+}
+
+// UnmarshalJSON implements the Unmarshal interface for CustomNetwork
+func (cn *CustomDIDMethods) UnmarshalJSON(data []byte) error {
+	aux := struct {
+		Blockchain  string `json:"blockchain"`
+		Network     string `json:"network"`
+		NetworkFlag string `json:"networkFlag"`
+		ChainID     int    `json:"chainId"`
+	}{}
+
+	if err := json.Unmarshal(data, &aux); err != nil {
+		return err
+	}
+	if len(aux.NetworkFlag) != 10 || aux.NetworkFlag[:2] != "0b" {
+		return errors.New("invalid NetworkFlag format")
+	}
+	flag, err := strconv.ParseUint(aux.NetworkFlag[2:], 2, 8)
+	if err != nil {
+		return err
+	}
+
+	cn.Blockchain = aux.Blockchain
+	cn.Network = aux.Network
+	cn.NetworkFlag = byte(flag)
+	cn.ChainID = aux.ChainID
+
+	return nil
+}
+
 // Prover struct
 type Prover struct {
 	ServerURL       string
@@ -344,6 +384,17 @@ func Load(fileName string) (*Configuration, error) {
 	if err := viper.Unmarshal(config); err != nil {
 		log.Error(ctx, "error unmarshalling configuration", "err", err)
 	}
+
+	jsonStr := viper.GetString("CUSTOM_DID_METHODS")
+	var customDIDMethods []CustomDIDMethods
+	if jsonStr != "" {
+		if err := json.Unmarshal([]byte(jsonStr), &customDIDMethods); err != nil {
+			log.Error(ctx, "error unmarshalling custom networks", "err", err)
+			return nil, err
+		}
+	}
+	config.CustomDIDMethods = customDIDMethods
+
 	checkEnvVars(ctx, config)
 	return config, nil
 }
@@ -452,6 +503,8 @@ func bindEnv() {
 	_ = viper.BindEnv("APIUI.IdentityNetwork", "ISSUER_API_IDENTITY_NETWORK")
 	_ = viper.BindEnv("APIUI.KeyType", "ISSUER_API_UI_KEY_TYPE")
 
+	_ = viper.BindEnv("ISSUER_CUSTOM_DID_METHODS")
+
 	viper.AutomaticEnv()
 }
 

internal/core/services/did_registrator.go

@@ -0,0 +1,19 @@
+package services
+
+import (
+	core "github.com/iden3/go-iden3-core/v2"
+	"github.com/polygonid/sh-id-platform/internal/config"
+)
+
+// RegisterCustomDIDMethods registers custom DID methods
+func RegisterCustomDIDMethods(customdDids []config.CustomDIDMethods) {
+	for _, cdid := range customdDids {
+		params := core.DIDMethodNetworkParams{
+			Method:      core.DIDMethodPolygonID,
+			Blockchain:  core.Blockchain(cdid.Blockchain),
+			Network:     core.NetworkID(cdid.Network),
+			NetworkFlag: cdid.NetworkFlag,
+		}
+		core.RegisterDIDMethodNetwork(params, core.WithChainID(cdid.ChainID))
+	}
+}