sidetree 0.1.0 → 0.1.3

data/lib/sidetree/validator.rb

@@ -5,7 +5,7 @@ module Sidetree
     # @param [Hash] delta delta object.
     # @return [Sidetree::Error]
     def validate_delta!(delta)
-      raise Error, 'Delta does not defined.' unless delta
+      raise Error, "Delta does not defined." unless delta
       delta_size = delta.to_json_c14n.bytesize
       if delta_size > Sidetree::Params::MAX_DELTA_SIZE
         raise Error,
@@ -13,7 +13,7 @@ module Sidetree
       end
 
       if delta.instance_of?(Array)
-        raise Error, 'Delta object cannot be an array.'
+        raise Error, "Delta object cannot be an array."
       end
       delta.keys.each do |k|
         unless %w[patches updateCommitment].include?(k.to_s)
@@ -22,11 +22,11 @@ module Sidetree
       end
 
       unless delta[:patches].instance_of?(Array)
-        raise Error, 'Patches object in delta must be an array.'
+        raise Error, "Patches object in delta must be an array."
       end
       delta[:patches].each { |p| validate_patch!(p) }
 
-      validate_encoded_multi_hash!(delta[:updateCommitment], 'updateCommitment')
+      validate_encoded_multi_hash!(delta[:updateCommitment], "updateCommitment")
     end
 
     # @param [Hash] patch patch object.
@@ -49,7 +49,7 @@ module Sidetree
     end
 
     def validate_document!(document)
-      raise Error, 'Document object missing in patch object' unless document
+      raise Error, "Document object missing in patch object" unless document
       document.keys.each do |k|
         unless %w[publicKeys services].include?(k.to_s)
           raise Error, "Property '#{k}' is not allowed in document object."
@@ -61,7 +61,7 @@ module Sidetree
 
     def validate_add_public_keys_patch!(patch)
       unless patch.keys.length == 2
-        raise Error, 'Patch missing or unknown property.'
+        raise Error, "Patch missing or unknown property."
       end
       validate_public_keys!(patch[:publicKeys])
     end
@@ -73,7 +73,7 @@ module Sidetree
         end
       end
       unless patch[:ids].instance_of?(Array)
-        raise Error, 'Patch public key ids not an array.'
+        raise Error, "Patch public key ids not an array."
       end
 
       patch[:ids].each { |id| validate_id!(id) }
@@ -81,10 +81,10 @@ module Sidetree
 
     def validate_add_services_patch!(patch)
       unless patch.keys.length == 2
-        raise Error, 'Patch missing or unknown property.'
+        raise Error, "Patch missing or unknown property."
       end
       unless patch[:services].instance_of?(Array)
-        raise Error, 'Patch services not an array.'
+        raise Error, "Patch services not an array."
       end
       validate_services!(patch[:services])
     end
@@ -96,7 +96,7 @@ module Sidetree
         end
       end
       unless patch[:ids].instance_of?(Array)
-        raise Error, 'Patch service ids not an array.'
+        raise Error, "Patch service ids not an array."
       end
 
       patch[:ids].each { |id| validate_id!(id) }
@@ -104,7 +104,7 @@ module Sidetree
 
     def validate_public_keys!(public_keys)
       unless public_keys.instance_of?(Array)
-        raise Error, 'publicKeys must be an array.'
+        raise Error, "publicKeys must be an array."
       end
       pubkey_ids = []
       public_keys.each do |public_key|
@@ -114,7 +114,7 @@ module Sidetree
           end
         end
         if public_key[:publicKeyJwk].instance_of?(Array)
-          raise Error, 'publicKeyJwk object cannot be an array.'
+          raise Error, "publicKeyJwk object cannot be an array."
         end
         if public_key[:type] && !public_key[:type].is_a?(String)
           raise Error, "Public key type #{public_key[:type]} is incorrect."
@@ -123,16 +123,16 @@ module Sidetree
         validate_id!(public_key[:id])
 
         if pubkey_ids.include?(public_key[:id])
-          raise Error, 'Public key id is duplicated.'
+          raise Error, "Public key id is duplicated."
         end
         pubkey_ids << public_key[:id]
 
         if public_key[:purposes]
           unless public_key[:purposes].instance_of?(Array)
-            raise Error, 'purposes must be an array.'
+            raise Error, "purposes must be an array."
           end
           unless public_key[:purposes].count == public_key[:purposes].uniq.count
-            raise Error, 'purpose is duplicated.'
+            raise Error, "purpose is duplicated."
           end
           public_key[:purposes].each do |purpose|
             unless OP::PublicKeyPurpose.values.include?(purpose)
@@ -145,34 +145,33 @@ module Sidetree
 
     def validate_services!(services)
       unless services.instance_of?(Array)
-        raise Error, 'services must be an array.'
+        raise Error, "services must be an array."
       end
 
       service_ids = []
       services.each do |service|
         unless service.keys.length == 3
-          raise Error, 'Service has missing or unknown property.'
+          raise Error, "Service has missing or unknown property."
         end
 
         validate_id!(service[:id])
 
         if service_ids.include?(service[:id])
-          raise Error, 'Service id has to be unique.'
+          raise Error, "Service id has to be unique."
         end
         service_ids << service[:id]
 
         unless service[:type].is_a?(String)
           raise Error, "Service type #{service[:type]} is incorrect."
         end
-        raise Error, 'Service type too long.' if service[:type].length > 30
+        raise Error, "Service type too long." if service[:type].length > 30
 
         endpoint = service[:serviceEndpoint]
         if endpoint.instance_of?(String)
           validate_uri!(endpoint)
         elsif endpoint.instance_of?(Hash)
-
         else
-          raise Error, 'ServiceEndpoint must be string or object.'
+          raise Error, "ServiceEndpoint must be string or object."
         end
       end
     end
@@ -196,10 +195,10 @@ module Sidetree
     end
 
     def validate_id!(id)
-      raise Error, 'id does not string.' unless id.instance_of?(String)
-      raise Error, 'id is too long.' if id.length > 50
+      raise Error, "id does not string." unless id.instance_of?(String)
+      raise Error, "id is too long." if id.length > 50
       unless valid_base64_encoding?(id)
-        raise Error, 'id does not use base64url character set.'
+        raise Error, "id does not use base64url character set."
       end
     end
 
@@ -216,9 +215,21 @@ module Sidetree
       end
     end
 
+    # Verify that the Multihash of +content+ matches that of +multihash+.
+    # @param [String] content content to be hashed
+    # @param [String] multihash Hash value to be checked
+    # @param [String] target Name of the target object to include in the error message
+    # @raise [Sidetree::Error]
+    def validate_canonicalize_object_hash!(content, multihash, target)
+      unless Sidetree.to_hash(content) == multihash
+        raise Sidetree::Error,
+              "Canonicalized #{target} object hash does not match expected hash '#{multihash}'"
+      end
+    end
+
     def validate_did_type!(type)
       return unless type
-      raise Error, 'DID type must be a string.' unless type.instance_of?(String)
+      raise Error, "DID type must be a string." unless type.instance_of?(String)
       if type.length > 4
         raise Error,
               "DID type string '#{type}' cannot be longer than 4 characters."
@@ -231,20 +242,31 @@ module Sidetree
 
     def validate_suffix_data!(suffix)
       if suffix.instance_of?(Array)
-        raise Error, 'Suffix data can not be an array.'
+        raise Error, "Suffix data can not be an array."
       end
       suffix.keys.each do |k|
         unless %w[deltaHash recoveryCommitment type].include?(k.to_s)
           raise Error, "Property '#{k}' is not allowed in publicKeys object."
         end
       end
-      validate_encoded_multi_hash!(suffix[:deltaHash], 'delta hash')
+      validate_encoded_multi_hash!(suffix[:deltaHash], "delta hash")
       validate_encoded_multi_hash!(
         suffix[:recoveryCommitment],
-        'recovery commitment'
+        "recovery commitment"
       )
-      validate_encoded_multi_hash!(suffix[:deltaHash], 'delta hash')
+      validate_encoded_multi_hash!(suffix[:deltaHash], "delta hash")
       validate_did_type!(suffix[:type])
     end
+
+    def validate_cas_file_uri!(uri, target)
+      unless uri.is_a?(String)
+        raise Sidetree::Error,
+              "Input #{target} CAS file URI '#{uri}' needs to be of string type"
+      end
+      if uri.bytesize > Sidetree::Params::MAX_CAS_URI_LENGTH
+        raise Sidetree::Error,
+              "Input #{target} CAS file URI byte size cannot exceed #{Sidetree::Params::MAX_CAS_URI_LENGTH}"
+      end
+    end
   end
 end

data/lib/sidetree/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sidetree
-  VERSION = '0.1.0'
+  VERSION = "0.1.3"
 end

data/lib/sidetree.rb

@@ -1,37 +1,54 @@
 # frozen_string_literal: true
 
-require_relative 'sidetree/version'
-require 'ecdsa'
-require 'json/jwt'
-require 'base64'
-require 'json'
-require 'json/canonicalization'
-require 'uri'
-require 'multihashes'
+require_relative "sidetree/version"
+require "ecdsa"
+require "json/jwt"
+require "base64"
+require "json"
+require "json/canonicalization"
+require "uri"
+require "multihashes"
 
 module Sidetree
   class Error < StandardError
   end
 
-  autoload :Key, 'sidetree/key'
-  autoload :DID, 'sidetree/did'
-  autoload :Model, 'sidetree/model'
-  autoload :OP, 'sidetree/op'
-  autoload :Validator, 'sidetree/validator'
+  autoload :Util, "sidetree/util"
+  autoload :Key, "sidetree/key"
+  autoload :DID, "sidetree/did"
+  autoload :Model, "sidetree/model"
+  autoload :OP, "sidetree/op"
+  autoload :Validator, "sidetree/validator"
+  autoload :CAS, "sidetree/cas"
 
   module Params
     # Algorithm for generating hashes of protocol-related values. 0x12 = sha2-256
     HASH_ALGORITHM = [0x12]
-    HASH_ALGORITH_STRING = 'sha2-256'
+    HASH_ALGORITH_STRING = "sha2-256"
 
     # Maximum canonicalized operation delta buffer size.
     MAX_DELTA_SIZE = 1000
-
+    # Maximum compressed chunk file size. 10MB.
+    MAX_CHUNK_FILE_SIZE = 10_000_000
+    # Maximum compressed Provisional Index File size. 1 MB (zipped)
+    MAX_PROVISIONAL_INDEX_FILE_SIZE = 1_000_000
+    # Maximum compressed Proof File size. 2.5 MB (zipped)
+    MAX_PROOF_FILE_SIZE = 2_500_000
+    # Maximum compressed Core Index File size. 1 MB (zipped)
+    MAX_CORE_INDEX_FILE_SIZE = 1_000_000
+    # Maximum writer lock ID size
+    MAX_WRITER_LOCK_ID_SIZE = 200
+    # Maximum length of CAS URIs. 100 bytes
+    MAX_CAS_URI_LENGTH = 100
+    # Maximum number of operations per batch. 10000 ops.
+    MAX_OPERATION_COUNT = 10_000
+    # Default public key type
+    DEFAULT_PUBKEY_TYPE = "EcdsaSecp256k1VerificationKey2019"
     # Default DID method
-    DEFAULT_METHOD = 'sidetree'
+    DEFAULT_METHOD = "sidetree"
 
     # Supported did methods.
-    METHODS = { default: DEFAULT_METHOD, ion: 'ion' }
+    METHODS = { default: DEFAULT_METHOD, ion: "ion" }
 
     @network = nil
 
@@ -48,8 +65,8 @@ module Sidetree
     end
 
     module Network
-      MAINNET = 'mainnet'
-      TESTNET = 'test'
+      MAINNET = "mainnet"
+      TESTNET = "test"
     end
   end
 

data/sidetree.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description = 'Ruby implementation for Sidetree protocol.'
   spec.homepage = 'https://github.com/azuchi/sidetreerb'
   spec.license = 'MIT'
-  spec.required_ruby_version = '>= 2.6.0'
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
@@ -35,10 +35,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'json-jwt', '~> 1.13.0'
   spec.add_dependency 'json-canonicalization', '~> 0.3.0'
   spec.add_dependency 'multihashes', '~> 0.2.0'
-  spec.add_runtime_dependency 'thor'
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'prettier'
+  spec.add_development_dependency 'prettier', '~> 3.2.0'
+  spec.add_development_dependency 'webmock', '~> 3.14.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidetree
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - azuchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-24 00:00:00.000000000 Z
+date: 2022-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ecdsa
@@ -67,52 +67,51 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.2.0
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '3.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: prettier
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
-  name: prettier
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.14.0
 description: Ruby implementation for Sidetree protocol.
 email:
 - azuchi@chaintope.com
-executables:
-- ion
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -130,18 +129,36 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- exe/ion
 - lib/sidetree.rb
+- lib/sidetree/cas.rb
+- lib/sidetree/cas/fetch_result.rb
+- lib/sidetree/cas/ipfs.rb
 - lib/sidetree/did.rb
 - lib/sidetree/key.rb
 - lib/sidetree/model.rb
+- lib/sidetree/model/cas_file_base.rb
+- lib/sidetree/model/chunk.rb
+- lib/sidetree/model/chunk_file.rb
+- lib/sidetree/model/core_index_file.rb
+- lib/sidetree/model/core_proof_file.rb
 - lib/sidetree/model/delta.rb
 - lib/sidetree/model/document.rb
+- lib/sidetree/model/provisional_index_file.rb
+- lib/sidetree/model/provisional_proof_file.rb
 - lib/sidetree/model/service.rb
 - lib/sidetree/model/suffix.rb
 - lib/sidetree/op.rb
 - lib/sidetree/op/base.rb
 - lib/sidetree/op/create.rb
+- lib/sidetree/op/deactivate.rb
+- lib/sidetree/op/recover.rb
+- lib/sidetree/op/updatable.rb
+- lib/sidetree/op/update.rb
+- lib/sidetree/util.rb
+- lib/sidetree/util/anchored_data_serializer.rb
+- lib/sidetree/util/compressor.rb
+- lib/sidetree/util/jwk.rb
+- lib/sidetree/util/jws.rb
 - lib/sidetree/validator.rb
 - lib/sidetree/version.rb
 - sidetree.gemspec
@@ -160,7 +177,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/exe/ion

@@ -1,34 +0,0 @@
-#!/usr/bin/env ruby
-require 'thor'
-require 'sidetree'
-
-class ION < Thor
-  class << self
-    def exit_on_failure?
-      true
-    end
-  end
-
-  desc 'create', 'Create ION DID.'
-  def create
-    recovery_key = Sidetree::Key.generate
-    update_key = Sidetree::Key.generate
-    signing_key = Sidetree::Key.generate(id: 'signing-key')
-    document = Sidetree::Model::Document.new(public_keys: [signing_key])
-    did = Sidetree::DID.create(document, update_key, recovery_key, method: Sidetree::Params::METHODS[:ion])
-
-    puts "DID: #{did.short_form}"
-    puts
-    puts "Recovery key: #{recovery_key.encoded_private_key}"
-    puts "Update key: #{update_key.encoded_private_key}"
-    puts "Signing key: #{signing_key.encoded_private_key}"
-    puts
-
-    puts "Long-Form DID: #{did.to_s}"
-    op = did.create_op
-    puts "DID suffix data: #{op.suffix.to_h.to_json}"
-    puts "Document delta: #{op.delta.to_h.to_json}"
-  end
-end
-
-ION.start(ARGV)