diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..7cae95d --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,57 @@ +# +# Copyright Gen Digital Inc. All Rights Reserved. +# +# SPDX-License-Identifier: Apache-2.0 +# + +name: Build + +env: + GO_VERSION: 1.21 + +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +jobs: + Checks: + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - uses: actions/checkout@v2 + - name: Set up Go + uses: actions/setup-go@v2 + with: + go-version: ${{ env.GO_VERSION }} + - name: Run checks + run: | + make checks + + unitTest: + name: Unit test + runs-on: ${{ matrix.os }} + timeout-minutes: 15 + strategy: + matrix: + os: [ubuntu-latest] + steps: + - name: Setup Go 1.21 + uses: actions/setup-go@v2 + with: + go-version: 1.21 + id: go + + - uses: actions/checkout@v2 + + - name: Run unit test + timeout-minutes: 15 + run: make unit-test + + - name: Upload coverage to Codecov + timeout-minutes: 10 + if: matrix.os == 'ubuntu-latest' && github.repository == 'trustbloc/sidetree-svc-go' + uses: codecov/codecov-action@v1.3.1 + with: + file: ./coverage.txt diff --git a/.github/workflows/sonar.yml b/.github/workflows/sonar.yml new file mode 100644 index 0000000..7bed961 --- /dev/null +++ b/.github/workflows/sonar.yml @@ -0,0 +1,32 @@ +# +# Copyright Gen Digital Inc. All Rights Reserved. +# +# SPDX-License-Identifier: Apache-2.0 +# + +name: Sonar +on: + workflow_run: + workflows: [Build] + types: [requested] +jobs: + sonarcloud: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + # Disabling shallow clone is recommended for improving relevancy of reporting + fetch-depth: 0 + - name: SonarCloud Scan + uses: sonarsource/sonarcloud-github-action@master + with: + args: > + -Dsonar.organization=trustbloc + -Dsonar.projectKey=trustbloc_sidetree-svc-go + -Dsonar.scm.revision=${{ github.event.workflow_run.head_sha }} + -Dsonar.pullrequest.key=${{ github.event.workflow_run.pull_requests[0].number }} + -Dsonar.pullrequest.branch=${{ github.event.workflow_run.pull_requests[0].head.ref }} + -Dsonar.pullrequest.base=${{ github.event.workflow_run.pull_requests[0].base.ref }} + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e28541e --- /dev/null +++ b/.gitignore @@ -0,0 +1,27 @@ +# +# Copyright SecureKey Technologies Inc. All Rights Reserved. +# +# SPDX-License-Identifier: Apache-2.0 +# + +# Binaries for programs and plugins +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Test binary, build with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# IDE generated files +.idea/ + +# OS generated files +.DS_Store + +coverage.txt +.build diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..885f7eb --- /dev/null +++ b/Makefile @@ -0,0 +1,34 @@ +# +# Copyright Gen Digital Inc. All Rights Reserved. +# +# SPDX-License-Identifier: Apache-2.0 +# + +# +# Supported Targets: +# +# all (default) : runs code checks and unit tests +# checks: runs code checks (license, spelling, lint) +# unit-test: runs unit tests + + +GO_CMD ?= go +export GO111MODULE=on + +checks: license lint + +license: + @scripts/check_license.sh + +lint: + @scripts/check_lint.sh + +unit-test: + @scripts/unit.sh + +.PHONY: clean +clean: + rm -rf .build + +all: clean checks unit-test + diff --git a/README.md b/README.md index 0eb4761..c7fbcb1 100644 --- a/README.md +++ b/README.md @@ -1 +1,31 @@ -# sidetree-svc-go +# sidetree-core-go + +This library implements components of a service conforming to the [Sidetree Protocol](https://github.com/decentralized-identity/sidetree/blob/master/docs/protocol.md>). + +Below are the main components: + +## Batch Writer +The batch writer batches multiple document operations(create, update, delete, recover) in a single batch file. Batch files are stored in a distributed content-addressable storage (DCAS or CAS). A reference to the operation batch is then anchored on a blockchain as a Sidetree transaction. + +## Operation Processor +All document processing is deferred to resolution time. Resolution of the given ID to its document is done by iterating over all operations in blockchain-time order (starts with ‘create’). Each operation is checked for validity before applying a JSON patch to document. + +## Document Handler +The document handler performs document operation processing and document resolution. It supports both DID documents and generic documents. + +### Operation Processing +Upon successful validation against a configured validator, an operation will be added to the batch. + +### Resolution +Document resolution is based on ID or initial state values. + +- DID: The latest document is returned if found. + +- Long Form DID: Can be requested in the following format: +did:METHOD::Base64url(JCS({suffix-data, delta})) + +## Contributing +Thank you for your interest in contributing. Please see our [community contribution guidelines](https://github.com/trustbloc/community/blob/main/CONTRIBUTING.md) for more information. + +## License +Apache License, Version 2.0 (Apache-2.0). See the [LICENSE](LICENSE) file. diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..fda7c91 --- /dev/null +++ b/go.mod @@ -0,0 +1,7 @@ +// Copyright Gen Digital Inc. All Rights Reserved. +// +// SPDX-License-Identifier: Apache-2.0 + +module github.com/trustbloc/sidetree-svc-go + +go 1.21 diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..e69de29 diff --git a/pkg/placeholder.go b/pkg/placeholder.go new file mode 100644 index 0000000..eac86aa --- /dev/null +++ b/pkg/placeholder.go @@ -0,0 +1,7 @@ +/* + * Copyright Gen Digital Inc. All Rights Reserved. + * + * SPDX-License-Identifier: Apache-2.0 + */ + +package pkg diff --git a/scripts/check_license.sh b/scripts/check_license.sh new file mode 100755 index 0000000..7eaf590 --- /dev/null +++ b/scripts/check_license.sh @@ -0,0 +1,66 @@ +#!/bin/bash +# +# Copyright IBM Corp, Gen Digital Inc. All Rights Reserved. +# +# SPDX-License-Identifier: Apache-2.0 +# + +echo "Running check_license.sh" + +function filterExcludedFiles { + CHECK=`echo "$CHECK" | grep -v .png$ | grep -v .xml$ | grep -v .rst$ | grep -v ^.git/ \ + | grep -v .pem$ | grep -v .block$ | grep -v .tx$ | grep -v ^LICENSE$ | grep -v _sk$ \ + | grep -v .key$ | grep -v .crt$ | grep -v \\.gen.go$ | grep -v \\.json$ | grep -v Gopkg.lock$ \ + | grep -v .md$ | grep -v ^vendor/ | grep -v ^build/ | grep -v .pb.go$ | grep -v ci.properties$ \ + | grep -v go.sum$ |sort -u` +} + +CHECK=$(git diff --name-only --diff-filter=ACMRTUXB HEAD) +REMOTE_REF=$(git log -1 --pretty=format:"%d" | grep '[(].*\/' | wc -l) + +# If CHECK is empty then there is no working directory changes: fallback to last two commits. +# Else if REMOTE_REF=0 then working copy commits are even with remote: only use the working copy changes. +# Otherwise assume that the change is amending the previous commit: use both last two commit and working copy changes. +if [[ -z "${CHECK}" ]] || [[ "${REMOTE_REF}" -eq 0 ]]; then + if [[ ! -z "${CHECK}" ]]; then + echo "Examining last commit and working directory changes" + CHECK+=$'\n' + else + echo "Examining last commit changes" + fi + + LAST_COMMITS=($(git log -2 --pretty=format:"%h")) + CHECK+=$(git diff-tree --no-commit-id --name-only --diff-filter=ACMRTUXB -r ${LAST_COMMITS[1]} ${LAST_COMMITS[0]}) +else + echo "Examining working directory changes" +fi + +filterExcludedFiles + +if [[ -z "$CHECK" ]]; then + echo "All files are excluded from having license headers" + exit 0 +fi + +missing=`echo "$CHECK" | xargs ls -d 2>/dev/null | xargs grep -L "SPDX-License-Identifier"` +if [[ -z "$missing" ]]; then + echo "All files have SPDX-License-Identifier headers" + exit 0 +fi +echo "The following files are missing SPDX-License-Identifier headers:" +echo "$missing" +echo +echo "Please replace the Apache license header comment text with:" +echo "SPDX-License-Identifier: Apache-2.0" + +echo +echo "Checking committed files for traditional Apache License headers ..." +missing=`echo "$missing" | xargs ls -d 2>/dev/null | xargs grep -L "http://www.apache.org/licenses/LICENSE-2.0"` +if [[ -z "$missing" ]]; then + echo "All remaining files have Apache 2.0 headers" + exit 0 +fi +echo "The following files are missing traditional Apache 2.0 headers:" +echo "$missing" +echo "Fatal Error - All files must have a license header" +exit 1 \ No newline at end of file diff --git a/scripts/check_lint.sh b/scripts/check_lint.sh new file mode 100755 index 0000000..c6f36ac --- /dev/null +++ b/scripts/check_lint.sh @@ -0,0 +1,15 @@ +#!/bin/bash +# +# Copyright Gen Digital Inc. All Rights Reserved. +# +# SPDX-License-Identifier: Apache-2.0 +# + +set -e + +echo "Running $0" + +DOCKER_CMD=docker +GOLANGCI_LINT_IMAGE="golangci/golangci-lint:v1.53.3" + +${DOCKER_CMD} run --rm -e GOPROXY=${GOPROXY} -v $(pwd):/opt/workspace -w /opt/workspace ${GOLANGCI_LINT_IMAGE} golangci-lint run --max-same-issues 20 --build-tags testing \ No newline at end of file diff --git a/scripts/unit.sh b/scripts/unit.sh new file mode 100755 index 0000000..809bed8 --- /dev/null +++ b/scripts/unit.sh @@ -0,0 +1,15 @@ +#!/bin/bash +# +# Copyright Gen Digital Inc. All Rights Reserved. +# +# SPDX-License-Identifier: Apache-2.0 +# + +set -e + +# Packages to exclude +PKGS=`go list github.com/trustbloc/sidetree-svc-go/pkg/... 2> /dev/null | \ + grep -v /mocks | \ + grep -v /api/` +echo "Running pkg unit tests..." +go test -count=1 -cover $PKGS -p 1 -timeout=10m -race -coverprofile=coverage.txt -covermode=atomic -tags testing