sidetree 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b65f50d961dcfc15f1440ae26225fad38a7b42f43874764005b9d01cc624bb3a
-  data.tar.gz: dbe04b5d7072da5b1cbec36b90089d29cb69e6077cc60a501045d0eddff38d92
+  metadata.gz: 1d0ba773b3e271c87bc94baf8de2cffdf3a877ab036706a1c33a856c7415a015
+  data.tar.gz: c33c29278762606a4be6aeaa1baab07840bb53fe247a1c579d5674134ffb0c67
 SHA512:
-  metadata.gz: e7aa774c61569b33aa98de41aa6ab265c58107346704aaebf673e45bc464f250f1073ea70994ae1a884cbd92964dc7e84b1841e2cbfc917601157a2eea1a7854
-  data.tar.gz: a68ccd2615046db978b08dcffa585611f2ed44ee59a765e0c53614074892ad83e5f733df493bc8f06a15a4b264c777c52867f486562e13918b5cf4fff236c758
+  metadata.gz: 53ff99ea81549069663f34023c53ec690f428db60b035f494ce9aaa0379b7ec54032b9963adf6ed8fbf55f3bb5ac03de2f4559b7cd615ec04a907030854238e3
+  data.tar.gz: 89dca27ab2ae6e1e028aecd1e3928a12e2ea0c6e517392c715de5eeb3e54fb2a3bdb027afb8a709cb9ac559e62c08e5ca66ff6af498967bc362a9ce740e115e6

data/.github/workflows/main.yml

@@ -7,7 +7,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        ruby: [2.7, 3.0, 3.1]
+        ruby: [2.7, 3.0, 3.1, 3.2]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2

data/.ruby-version

@@ -1 +1 @@
-ruby-3.1.0
+ruby-3.2.0

data/README.md

@@ -1,8 +1,7 @@
-# [WIP]Sidetree for Ruby
+# Sidetree for Ruby [![Build Status](https://github.com/azuchi/sidetreerb/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/azuchi/sidetreerb/actions/workflows/main.yml) [![Gem Version](https://badge.fury.io/rb/sidetree.svg)](https://badge.fury.io/rb/sidetree) [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sidetree`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is an experimental library that implements the [Sidetree protocol](https://identity.foundation/sidetree/spec/) in Ruby.
+If you use this library, please test to see if it works properly with [reference implementation](https://github.com/decentralized-identity/sidetree).
 
 ## Installation
 
@@ -22,7 +21,242 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Environment
+
+Currently, this library support mainnet and testnet.
+If you want to run with testnet, configure the network with the following code.
+
+```ruby
+Sidetree::Params.network = Sidetree::Params::Network::TESTNET
+```
+### Create new DID
+
+```ruby
+# Generate recovery key
+recovery_key = Sidetree::Key.generate
+
+# Generate update key
+update_key = Sidetree::Key.generate
+
+# Generate signing key
+signing_key = Sidetree::Key.generate(id: "signing-key")
+
+# Create DID Document from signing key
+document = Sidetree::Model::Document.new(public_keys: [signing_key])
+
+# Create DID
+did =
+  Sidetree::DID.create(
+    document,
+    update_key,
+    recovery_key
+  )
+=> "did:sidetree:test:EiAw8oTzWzmPyTANALvzeHkCc6-uQ7XxnohqphrwC_jhNg:eyJkZWx0YSI6eyJwYXRjaGVzIjpbeyJhY3Rpb24iOiJyZXBsYWNlIiwiZG9jdW1lbnQiOnsicHVibGljS2V5cyI6W3siaWQiOiJzaWduaW5nLWtleSIsInB1YmxpY0tleUp3ayI6eyJjcnYiOiJzZWNwMjU2azEiLCJrdHkiOiJFQyIsIngiOiJJQ3BuZXVJZ2ZqZW5UZzhhMmVCeEd1RkVjV1lwZkFTcDRXdHVmbmdGd3owIiwieSI6IlNPbUxzSzhIWlU0bmY5YWZCQmF0SlJUSjVWeGZSMlVRZ1hFVV8xTXVyTzgifSwicHVycG9zZXMiOltdLCJ0eXBlIjoiRWNkc2FTZWNwMjU2azFWZXJpZmljYXRpb25LZXkyMDE5In1dLCJzZXJ2aWNlcyI6W119fV0sInVwZGF0ZUNvbW1pdG1lbnQiOiJFaUExQ1l4NWE5NTlPRGRicThrMG1WUDJwZmVEY0RXaHd3TXhWamNDS2tZOXF3In0sInN1ZmZpeERhdGEiOnsiZGVsdGFIYXNoIjoiRWlDWklRdjlyeVVDR2dLbjMtSjNfTV9ZN0k1VTIyZlpldFRaSTFxSjZqdnVEQSIsInJlY292ZXJ5Q29tbWl0bWVudCI6IkVpQ2dPTGRPb0F5a3A4SzBrMlNwMmlzRUtNOFpmRnBVSWhVcnRLbUEydEcxcWcifX0"
+```
+
+### DID operation
+
+#### Create Operation
+
+```ruby
+# Generate Create Operation
+create_op = did.create_op
+
+# Generate Chunk File from create operation
+chunk_file =  Sidetree::Model::ChunkFile.create_from_ops(create_ops: [create_op])
+
+# Write chunk file to IPFS
+# Initialize IPFS client(If the parameter is omitted, the default is to access http://localhost:5001/api/v0.)
+ipfs = Sidetree::CAS::IPFS.new
+
+chunk_file_uri = ipfs.write(chunk_file.to_compress)
+
+# Generate Provisional Index File and write to IPFS
+provisional_index_file = Sidetree::Model::ProvisionalIndexFile.new(chunks: [Sidetree::Model::Chunk.new(chunk_file_uri)])
+provisional_index_file_uri = ipfs.write(provisional_index_file.to_compress)
+
+# Generate Core Index File and write to IPFS
+core_index_file = Sidetree::Model::CoreIndexFile.new(
+  create_ops: [create_op],
+  provisional_index_file_uri: provisional_index_file_uri
+)
+core_index_file_uri = ipfs.write(core_index_file.to_compress)
+
+# Generate Anchor String to anchoring to Bitcoin
+anchor_str = Sidetree::Util::AnchoredDataSerializer.serialize(1, core_index_file_uri)
+```
+
+#### Update Operation
+
+```ruby
+# DID suffix to be updated
+did_suffix = "EiBRrmEha_Q30GieEwLB-XM8CZd_b49dQ7znhaBxfAHTsQ"
+
+# Current update key
+update_key = Sidetree::Key.new(private_key: <private key>)
+
+# Generate new signing key
+new_signing_key = Sidetree::Key.generate(id: "signing-key")
+
+# Create replace DID Document
+document = Sidetree::Model::Document.new(public_keys: [new_signing_key])
+
+# Generate next update key
+next_update_key = Sidetree::Key.generate
+
+# Generate update delta object
+delta =
+  Sidetree::Model::Delta.new(
+    [document.to_replace_patch],
+    next_update_key.to_commitment
+  )
+
+# Generate jws and sign with update key
+claim = { updateKey: update_key.to_jwk.normalize, deltaHash: delta.to_hash }
+jws = Sidetree::Util::JWS.sign(claim, update_key)
+
+# Generate Provisional Proof File and write to IPFS
+provisional_proof = Sidetree::Model::ProvisionalProofFile.new([jws])
+provisional_proof_uri = ipfs.write(provisional_proof.to_compress)
+
+# Create update operation
+update_op =
+  Sidetree::OP::Update.new(did_suffix, delta, jws, update_key.to_reveal_value)
+
+# Generate Chunk File and write to IPFS
+chunk_file =
+  Sidetree::Model::ChunkFile.create_from_ops(update_ops: [update_op])
+chunk_file_uri = ipfs.write(chunk_file.to_compress)
+
+# Generate Provisional Index File and write to IPFS
+provisional_index_file =
+  Sidetree::Model::ProvisionalIndexFile.new(
+    proof_file_uri: provisional_proof_uri,
+    chunks: [Sidetree::Model::Chunk.new(chunk_file_uri)],
+    operations: [update_op]
+  )
+provisional_index_file_uri = ipfs.write(provisional_index_file.to_compress)
+
+# Generate Core Index File and write to IPFS
+core_index_file =
+  Sidetree::Model::CoreIndexFile.new(
+    provisional_index_file_uri: provisional_index_file_uri
+  )
+core_index_file_uri = ipfs.write(core_index_file.to_compress)
+
+anchor_str =
+  Sidetree::Util::AnchoredDataSerializer.serialize(1, core_index_file_uri)
+```
+
+#### Recover Operation
+
+```ruby
+did_suffix = "EiBRrmEha_Q30GieEwLB-XM8CZd_b49dQ7znhaBxfAHTsQ"
+
+# Current recovery key
+recovery_key = Sidetree::Key.new(private_key: <private key>)
+
+# Generate new recovery key
+new_recovery_key = Sidetree::Key.generate
+
+# Generate new update key
+new_update_key = Sidetree::Key.generate
+
+# Generate new signing key
+new_signing_key = Sidetree::Key.generate(id: "signing-key")
+
+# Generate replace DID Document
+document = Sidetree::Model::Document.new(public_keys: [new_signing_key])
+delta =
+  Sidetree::Model::Delta.new(
+    [document.to_replace_patch],
+    new_update_key.to_commitment
+  )
+
+# Generate jws and sign with recovery key
+claim = {
+  recoveryKey: recovery_key.to_jwk.normalize,
+  recoveryCommitment: new_recovery_key.to_commitment,
+  deltaHash: delta.to_hash
+}
+jws = Sidetree::Util::JWS.sign(claim, recovery_key)
+
+# Generate Core Proof File from jws
+core_proof_file = Sidetree::Model::CoreProofFile.new(recover_proofs: [jws])
+core_proof_file_uri = ipfs.write(core_proof_file.to_compress)
+
+# Create recover operation
+recover_op =
+  Sidetree::OP::Recover.new(
+    did_suffix,
+    delta,
+    jws,
+    recovery_key.to_reveal_value
+  )
+
+# Generate Chunk File and write to IPFS
+chunk_file =
+  Sidetree::Model::ChunkFile.create_from_ops(recover_ops: [recover_op])
+chunk_file_uri = ipfs.write(chunk_file.to_compress)
+
+# Generate Provisional Index File and write to IPFS
+provisional_index_file =
+  Sidetree::Model::ProvisionalIndexFile.new(
+    chunks: [Sidetree::Model::Chunk.new(chunk_file_uri)]
+  )
+provisional_index_file_uri = ipfs.write(provisional_index_file.to_compress)
+
+# Generate Core Index File and write to IPFS
+core_index_file =
+  Sidetree::Model::CoreIndexFile.new(
+    provisional_index_file_uri: provisional_index_file_uri,
+    core_proof_file_uri: core_proof_file_uri,
+    recover_ops: [recover_op]
+  )
+core_index_file_uri = ipfs.write(core_index_file.to_compress)
+
+anchor_str =
+  Sidetree::Util::AnchoredDataSerializer.serialize(1, core_index_file_uri)
+```
+
+#### Deactivate operation
+
+```ruby
+# Current recovery key
+recovery_key = Sidetree::Key.new(private_key: <private key>)
+
+# Generate jws and sign with recovery key
+claim = {
+  didSuffix: did_suffix,
+  recoveryKey: recovery_key.to_jwk.normalize
+}
+jws = Sidetree::Util::JWS.sign(claim, recovery_key)
+
+# Generate Core Proof File and write to IPFS
+core_proof_file = Sidetree::Model::CoreProofFile.new(deactivate_proofs: [jws])
+core_proof_file_uri = ipfs.write(core_proof_file.to_compress)
+
+# Create Deactivate Operation
+deactivate_op =
+  Sidetree::OP::Deactivate.new(
+    did_suffix,
+    jws,
+    recovery_key.to_reveal_value
+  )
+
+# Generate Core Index File and write to IPFS
+core_index_file =
+  Sidetree::Model::CoreIndexFile.new(
+    core_proof_file_uri: core_proof_file_uri,
+    deactivate_ops: [deactivate_op]
+  )
+core_index_file_uri = ipfs.write(core_index_file.to_compress)
+
+anchor_str =
+  Sidetree::Util::AnchoredDataSerializer.serialize(1, core_index_file_uri)
+```
+
+The pseudocode above all anchor a single operation, but you can be combined into a batch(i.e. to single anchor string).
 
 ## Development
 

data/lib/sidetree/model/core_proof_file.rb

@@ -5,7 +5,7 @@ module Sidetree
       attr_reader :recover_proofs
       attr_reader :deactivate_proofs
 
-      def initialize(recover_proofs, deactivate_proofs)
+      def initialize(recover_proofs: [], deactivate_proofs: [])
         @recover_proofs = recover_proofs
         @deactivate_proofs = deactivate_proofs
       end
@@ -78,7 +78,10 @@ module Sidetree
           if recover_proofs.length + deactivate_proofs.length == 0
             raise Sidetree::Error, "Core proof file has no proof"
           end
-          CoreProofFile.new(recover_proofs, deactivate_proofs)
+          CoreProofFile.new(
+            recover_proofs: recover_proofs,
+            deactivate_proofs: deactivate_proofs
+          )
         rescue JSON::ParserError
           raise Sidetree::Error, "Core proof file is not json"
         end

data/lib/sidetree/version.rb

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

data/sidetree.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   spec.add_dependency 'ecdsa', '~> 1.2.0'
-  spec.add_dependency 'json-jwt', '~> 1.13.0'
+  spec.add_dependency 'json-jwt', '~> 1.16.3'
   spec.add_dependency 'json-canonicalization', '~> 0.3.0'
   spec.add_dependency 'multihashes', '~> 0.2.0'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidetree
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - azuchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-19 00:00:00.000000000 Z
+date: 2023-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ecdsa
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: 1.16.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: 1.16.3
 - !ruby/object:Gem::Dependency
   name: json-canonicalization
   requirement: !ruby/object:Gem::Requirement
@@ -184,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Ruby implementation for Sidetree protocol.