feat: Local CAS now uses IPFS-compatible CIDs

The local CAS now uses CIDs that are compatible with IPFS, assuming that the IPFS node is running under default settings and that the data is less than 256KB. A new flag was added to choose between v1 or v0 CIDs. The IPFS client will also use this format now. v1 CIDs are the default. Signed-off-by: Derek Trider <[email protected]>
trustbloc · May 20, 2021 · 8ee9c32 · 8ee9c32
1 parent 4fd4d92
commit 8ee9c32
Show file tree

Hide file tree

Showing 20 changed files with 1,014 additions and 85 deletions.
diff --git a/cmd/orb-server/go.sum b/cmd/orb-server/go.sum
diff --git a/cmd/orb-server/startcmd/params.go b/cmd/orb-server/startcmd/params.go
@@ -94,6 +94,11 @@ const (
 	ipfsURLEnvKey        = "IPFS_URL"
 	ipfsURLFlagUsage     = "The URL of the IPFS Content Addressable Storage(CAS). " + commonEnvVarUsageText + ipfsURLEnvKey
 
+	cidVersionFlagName  = "cid-version"
+	cidVersionEnvKey    = "CID_VERSION"
+	cidVersionFlagUsage = "The version of the CID format to use for generating CIDs. " +
+		"Supported options: 0, 1. If not set, defaults to 1." + commonEnvVarUsageText + cidVersionEnvKey
+
 	batchWriterTimeoutFlagName      = "batch-writer-timeout"
 	batchWriterTimeoutFlagShorthand = "b"
 	batchWriterTimeoutEnvKey        = "BATCH_WRITER_TIMEOUT"
@@ -221,6 +226,7 @@ type orbParameters struct {
 	batchWriterTimeout        time.Duration
 	casType                   string
 	ipfsURL                   string
+	useV0CIDs                 bool
 	dbParameters              *dbParameters
 	logLevel                  string
 	methodContext             []string
@@ -303,6 +309,19 @@ func getOrbParameters(cmd *cobra.Command) (*orbParameters, error) {
 		return nil, err
 	}
 
+	cidVersionString, err := cmdutils.GetUserSetVarFromString(cmd, cidVersionFlagName, cidVersionEnvKey, true)
+	if err != nil {
+		return nil, err
+	}
+
+	var useV0CIDs bool
+
+	if cidVersionString == "0" {
+		useV0CIDs = true
+	} else if cidVersionString != "1" && cidVersionString != "" { // default to v1 if no version specified
+		return nil, fmt.Errorf("invalid CID version specified. Must be either 0 or 1")
+	}
+
 	batchWriterTimeoutStr, err := cmdutils.GetUserSetVarFromString(cmd, batchWriterTimeoutFlagName, batchWriterTimeoutEnvKey, true)
 	if err != nil {
 		return nil, err
@@ -442,6 +461,7 @@ func getOrbParameters(cmd *cobra.Command) (*orbParameters, error) {
 		allowedOrigins:            allowedOrigins,
 		casType:                   casType,
 		ipfsURL:                   ipfsURL,
+		useV0CIDs:                 useV0CIDs,
 		batchWriterTimeout:        batchWriterTimeout,
 		anchorCredentialParams:    anchorCredentialParams,
 		dbParameters:              dbParams,
@@ -629,6 +649,7 @@ func createFlags(startCmd *cobra.Command) {
 	startCmd.Flags().StringP(httpSignaturesEnabledFlagName, httpSignaturesEnabledShorthand, "", httpSignaturesEnabledUsage)
 	startCmd.Flags().StringP(casTypeFlagName, casTypeFlagShorthand, "", casTypeFlagUsage)
 	startCmd.Flags().StringP(ipfsURLFlagName, ipfsURLFlagShorthand, "", ipfsURLFlagUsage)
+	startCmd.Flags().String(cidVersionFlagName, "1", cidVersionFlagUsage)
 	startCmd.Flags().StringP(didNamespaceFlagName, didNamespaceFlagShorthand, "", didNamespaceFlagUsage)
 	startCmd.Flags().StringArrayP(didAliasesFlagName, didAliasesFlagShorthand, []string{}, didAliasesFlagUsage)
 	startCmd.Flags().StringArrayP(allowedOriginsFlagName, allowedOriginsFlagShorthand, []string{}, allowedOriginsFlagUsage)

diff --git a/cmd/orb-server/startcmd/params_test.go b/cmd/orb-server/startcmd/params_test.go
@@ -423,6 +423,34 @@ func TestStartCmdWithBlankEnvVar(t *testing.T) {
 	})
 }
 
+func TestStartCmdWithInvalidCIDVersion(t *testing.T) {
+	startCmd := GetStartCmd()
+
+	args := []string{
+		"--" + hostURLFlagName, "localhost:8247",
+		"--" + externalEndpointFlagName, "orb.example.com",
+		"--" + ipfsURLFlagName, "localhost:8081",
+		"--" + casTypeFlagName, "ipfs",
+		"--" + vctURLFlagName, "localhost:8081",
+		"--" + cidVersionFlagName, "-1",
+		"--" + batchWriterTimeoutFlagName, "700",
+		"--" + maxWitnessDelayFlagName, "600",
+		"--" + signWithLocalWitnessFlagName, "false",
+		"--" + startupDelayFlagName, "1",
+		"--" + didNamespaceFlagName, "namespace", "--" + databaseTypeFlagName, databaseTypeMemOption,
+		"--" + kmsSecretsDatabaseTypeFlagName, databaseTypeMemOption,
+		"--" + anchorCredentialSignatureSuiteFlagName, "suite",
+		"--" + anchorCredentialDomainFlagName, "domain.com",
+		"--" + anchorCredentialIssuerFlagName, "issuer.com",
+		"--" + anchorCredentialURLFlagName, "peer.com",
+		"--" + LogLevelFlagName, log.ParseString(log.ERROR),
+	}
+	startCmd.SetArgs(args)
+
+	err := startCmd.Execute()
+	require.EqualError(t, err, "invalid CID version specified. Must be either 0 or 1")
+}
+
 func TestStartCmdCreateKMSFailure(t *testing.T) {
 	t.Run("KMS fails (DB)", func(t *testing.T) {
 		startCmd := GetStartCmd()
@@ -521,6 +549,7 @@ func TestStartCmdValidArgs(t *testing.T) {
 		"--" + hostURLFlagName, "localhost:8247",
 		"--" + externalEndpointFlagName, "orb.example.com",
 		"--" + ipfsURLFlagName, "localhost:8081",
+		"--" + cidVersionFlagName, "0",
 		"--" + batchWriterTimeoutFlagName, "700",
 		"--" + maxWitnessDelayFlagName, "600",
 		"--" + signWithLocalWitnessFlagName, "false",

diff --git a/cmd/orb-server/startcmd/start.go b/cmd/orb-server/startcmd/start.go
@@ -286,12 +286,12 @@ func startOrbServices(parameters *orbParameters) error {
 
 	switch parameters.casType {
 	case "ipfs":
-		coreCasClient = ipfscas.New(parameters.ipfsURL)
+		coreCasClient = ipfscas.New(parameters.ipfsURL, parameters.useV0CIDs)
 		anchorCasWriter = orbcaswriter.New(coreCasClient, "ipfs")
 	case "local":
 		var err error
 
-		coreCasClient, err = casstore.New(storeProviders.provider)
+		coreCasClient, err = casstore.New(storeProviders.provider, parameters.useV0CIDs)
 		if err != nil {
 			return err
 		}
@@ -325,7 +325,7 @@ func startOrbServices(parameters *orbParameters) error {
 
 	var ipfsReader *ipfscas.Client
 	if parameters.ipfsURL != "" {
-		ipfsReader = ipfscas.New(parameters.ipfsURL)
+		ipfsReader = ipfscas.New(parameters.ipfsURL, false)
 	}
 
 	casResolver := resolver.New(coreCasClient, ipfsReader, httpClient)

diff --git a/go.mod b/go.mod
@@ -20,6 +20,8 @@ require (
 	github.com/igor-pavlenko/httpsignatures-go v0.0.21
 	github.com/ipfs/go-cid v0.0.7
 	github.com/ipfs/go-ipfs-api v0.2.0
+	github.com/ipfs/go-merkledag v0.2.3
+	github.com/ipfs/go-unixfs v0.2.6
 	github.com/mr-tron/base58 v1.2.0
 	github.com/multiformats/go-multihash v0.0.14
 	github.com/ory/dockertest/v3 v3.6.3