diff --git a/.github/ISSUE_TEMPLATE/okapi-change.md b/.github/ISSUE_TEMPLATE/okapi-change.md index d847410e..439467dc 100644 --- a/.github/ISSUE_TEMPLATE/okapi-change.md +++ b/.github/ISSUE_TEMPLATE/okapi-change.md @@ -1,6 +1,6 @@ --- name: Okapi Change -about: Changes to the Okapi language bindings +about: Changes to the Okapi language bindings, eg a new function to wrap. title: '' labels: '' assignees: fundthmcalculus @@ -13,7 +13,7 @@ Languages: - [ ] .NET - [ ] Go - [ ] Java -- [ ] Node +- [ ] Dart - [ ] Python - [ ] Ruby - [ ] Swift diff --git a/.github/workflows/build-dart.yml b/.github/workflows/build-dart.yml index d85cde13..deefc823 100644 --- a/.github/workflows/build-dart.yml +++ b/.github/workflows/build-dart.yml @@ -52,8 +52,8 @@ jobs: - name: Build, Test, Pack run: | - python ../devops/build_sdks.py --language=python - dart test ./lib/test/test-okapi.dart + python ../devops/build_sdks.py --language=dart + dart test ./test/test-okapi.dart shell: pwsh working-directory: dart env: diff --git a/.github/workflows/release-dart.yml b/.github/workflows/release-dart.yml new file mode 100644 index 00000000..313c7384 --- /dev/null +++ b/.github/workflows/release-dart.yml @@ -0,0 +1,54 @@ +name: Dart (release) + +on: + workflow_dispatch: + inputs: + packageVersion: + description: 'Version to build' + required: true + default: '' + workflow_run: + workflows: ["Release Platform Libraries"] + branches: ["main", "v?.*"] + types: + - completed + +jobs: + release-dart: + name: Release Dart Package + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Set up Dart + uses: dart-lang/setup-dart@v1 + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: 3.9 + - uses: trinsic-id/set-version@v0.1 + id: setversion + with: + githubToken: ${{ secrets.API_GITHUB_TOKEN }} + overrideVersion: ${{ github.event.inputs.packageVersion }} + - name: release-downloader + uses: robinraju/release-downloader@v1.3 + with: + repository: trinsic-id/okapi + latest: true + token: ${{ secrets.API_GITHUB_TOKEN }} + fileName: "libs.zip" + + - name: Install Dart dependencies + run: dart pub get + shell: pwsh + working-directory: dart + + - name: Build, Test, Pack + run: | + python ../devops/build_sdks.py --language=dart + dart pub publish --dry-run + shell: pwsh + working-directory: dart + env: + API_GITHUB_TOKEN: ${{ secrets.API_GITHUB_TOKEN }} + LD_LIBRARY_PATH: "${{ github.workspace }}/libs" diff --git a/dart/CHANGELOG.md b/dart/CHANGELOG.md index effe43c8..6928fc4f 100644 --- a/dart/CHANGELOG.md +++ b/dart/CHANGELOG.md @@ -1,3 +1,3 @@ -## 1.0.0 +## 0.1.0 -- Initial version. +- Default number of local development, similar to the native okapi binaries diff --git a/dart/LICENSE b/dart/LICENSE new file mode 100644 index 00000000..261eeb9e --- /dev/null +++ b/dart/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/dart/pubspec.lock b/dart/pubspec.lock index 53612625..8ab33360 100644 --- a/dart/pubspec.lock +++ b/dart/pubspec.lock @@ -7,21 +7,21 @@ packages: name: _fe_analyzer_shared url: "https://pub.dartlang.org" source: hosted - version: "39.0.0" + version: "40.0.0" analyzer: dependency: transitive description: name: analyzer url: "https://pub.dartlang.org" source: hosted - version: "4.0.0" + version: "4.1.0" args: dependency: transitive description: name: args url: "https://pub.dartlang.org" source: hosted - version: "2.3.0" + version: "2.3.1" async: dependency: transitive description: @@ -36,13 +36,6 @@ packages: url: "https://pub.dartlang.org" source: hosted version: "2.1.0" - charcode: - dependency: transitive - description: - name: charcode - url: "https://pub.dartlang.org" - source: hosted - version: "1.3.1" collection: dependency: transitive description: @@ -63,7 +56,7 @@ packages: name: coverage url: "https://pub.dartlang.org" source: hosted - version: "1.2.0" + version: "1.3.2" crypto: dependency: transitive description: @@ -84,7 +77,7 @@ packages: name: ffi url: "https://pub.dartlang.org" source: hosted - version: "1.1.2" + version: "1.2.1" file: dependency: transitive description: @@ -93,19 +86,19 @@ packages: source: hosted version: "6.1.2" fixnum: - dependency: transitive + dependency: "direct main" description: name: fixnum url: "https://pub.dartlang.org" source: hosted - version: "1.0.0" + version: "1.0.1" frontend_server_client: dependency: transitive description: name: frontend_server_client url: "https://pub.dartlang.org" source: hosted - version: "2.1.2" + version: "2.1.3" glob: dependency: transitive description: @@ -126,7 +119,7 @@ packages: name: http_parser url: "https://pub.dartlang.org" source: hosted - version: "4.0.0" + version: "4.0.1" io: dependency: transitive description: @@ -140,7 +133,7 @@ packages: name: js url: "https://pub.dartlang.org" source: hosted - version: "0.6.3" + version: "0.6.4" lints: dependency: "direct dev" description: @@ -168,7 +161,7 @@ packages: name: meta url: "https://pub.dartlang.org" source: hosted - version: "1.7.0" + version: "1.8.0" mime: dependency: transitive description: @@ -196,7 +189,7 @@ packages: name: path url: "https://pub.dartlang.org" source: hosted - version: "1.8.1" + version: "1.8.2" pool: dependency: transitive description: @@ -224,7 +217,7 @@ packages: name: shelf url: "https://pub.dartlang.org" source: hosted - version: "1.2.0" + version: "1.3.0" shelf_packages_handler: dependency: transitive description: @@ -287,7 +280,7 @@ packages: name: string_scanner url: "https://pub.dartlang.org" source: hosted - version: "1.1.0" + version: "1.1.1" term_glyph: dependency: transitive description: @@ -322,14 +315,14 @@ packages: name: typed_data url: "https://pub.dartlang.org" source: hosted - version: "1.3.0" + version: "1.3.1" vm_service: dependency: transitive description: name: vm_service url: "https://pub.dartlang.org" source: hosted - version: "8.2.2" + version: "8.3.0" watcher: dependency: transitive description: @@ -357,6 +350,6 @@ packages: name: yaml url: "https://pub.dartlang.org" source: hosted - version: "3.1.0" + version: "3.1.1" sdks: - dart: ">=2.15.1 <3.0.0" + dart: ">=2.16.0 <3.0.0" diff --git a/dart/pubspec.yaml b/dart/pubspec.yaml index f128f617..bd049cf1 100644 --- a/dart/pubspec.yaml +++ b/dart/pubspec.yaml @@ -1,6 +1,6 @@ name: okapi_dart description: Dart language bindings for okapi -version: 0.1.0 +version: "1.5.0" homepage: 'https://github.com/trinsic-id/okapi/' environment: @@ -8,9 +8,10 @@ environment: dependencies: - ffi: any + ffi: ^1.1.2 protobuf: ^2.0.0 - path: any + path: ^1.8.1 + fixnum: ^1.0.1 dev_dependencies: lints: any diff --git a/dart/lib/test/test-okapi.dart b/dart/test/test-okapi.dart similarity index 99% rename from dart/lib/test/test-okapi.dart rename to dart/test/test-okapi.dart index 437bcab7..97d616c9 100644 --- a/dart/lib/test/test-okapi.dart +++ b/dart/test/test-okapi.dart @@ -9,10 +9,9 @@ import 'package:okapi_dart/proto/okapi/hashing/v1/hashing.pb.dart'; import 'package:okapi_dart/proto/okapi/keys/v1/keys.pb.dart'; import 'package:okapi_dart/proto/okapi/proofs/v1/proofs.pb.dart'; import 'package:okapi_dart/proto/okapi/security/v1/security.pb.dart'; +import 'package:okapi_dart/okapi.dart'; import 'package:test/test.dart'; -import '../okapi.dart'; - void main() { test('Dart bitness', () { var size = sizeOf() * 8; diff --git a/devops/build_sdks.py b/devops/build_sdks.py index f5ef1a75..2ffefa87 100644 --- a/devops/build_sdks.py +++ b/devops/build_sdks.py @@ -186,6 +186,15 @@ def build_golang(args) -> None: copy_okapi_libs(golang_dir, "windows-gnu") +def build_dart(args) -> None: + # Copy in Okapi libraries to the $GOLANG_LD_PATH directory + dart_dir = get_language_dir('dart') + update_line( + join(dart_dir, "pubspec.yaml"), + {"version:": f'version: "{get_package_versions(args)}"'}, + ) + + def get_package_versions(args) -> str: return (args.package_version or get_github_version()).lstrip("v") @@ -309,6 +318,8 @@ def main(): continue_on_error(build_ruby, args) if build_all or "golang" in langs_to_build: continue_on_error(build_golang, args) + if build_all or "dart" in langs_to_build: + continue_on_error(build_dart, args) if build_all or "docs" in langs_to_build: continue_on_error(build_java_docs, args) continue_on_error(build_go_docs, args) diff --git a/docs/reference/go/okapi.md b/docs/reference/go/okapi.md index e651082b..cda6f871 100644 --- a/docs/reference/go/okapi.md +++ b/docs/reference/go/okapi.md @@ -2,19 +2,23 @@ ## Types +### type [ByteBuffer](/native.go#L16) + +`type ByteBuffer struct { ... }` + ### type [DidCommer](/didcomm.go#L8) `type DidCommer interface { ... }` DidCommer implements the DIDComm Messaging protocol -### type [DidError](/native.go#L27) +### type [DidError](/native.go#L31) `type DidError struct { ... }` DidError indicates a DID protocol error -#### func (*DidError) [Error](/native.go#L33) +#### func (*DidError) [Error](/native.go#L37) `func (d *DidError) Error() string` @@ -24,6 +28,10 @@ DidError indicates a DID protocol error DidKeyer is the interface that groups the did:key functions +### type [ExternError](/native.go#L21) + +`type ExternError struct { ... }` + ### type [Hasher](/hashing.go#L8) `type Hasher interface { ... }` @@ -36,13 +44,13 @@ Hasher implements Blake3 and Sha2 hash functions LdProofer implements Linked-Data Proofs -### type [NativeError](/native.go#L17) +### type [NativeError](/native.go#L11) `type NativeError struct { ... }` NativeError indicates a native protocol error -#### func (NativeError) [Error](/native.go#L22) +#### func (NativeError) [Error](/native.go#L26) `func (o NativeError) Error() string` diff --git a/docs/reference/go/okapiproto.md b/docs/reference/go/okapiproto.md index f83b209a..b1a1eedf 100644 --- a/docs/reference/go/okapiproto.md +++ b/docs/reference/go/okapiproto.md @@ -1677,6 +1677,78 @@ Deprecated: Use VerifyOberonProofResponse.ProtoReflect.Descriptor instead. `func (x *VerifyOberonProofResponse) String() string` +### type [VerifyOberonTokenRequest](/security.pb.go#L691) + +`type VerifyOberonTokenRequest struct { ... }` + +Verify that an oberon token comes from the desired issuer + +#### func (*VerifyOberonTokenRequest) [Descriptor](/security.pb.go#L729) + +`func (*VerifyOberonTokenRequest) Descriptor() ([]byte, []int)` + +Deprecated: Use VerifyOberonTokenRequest.ProtoReflect.Descriptor instead. + +#### func (*VerifyOberonTokenRequest) [GetData](/security.pb.go#L747) + +`func (x *VerifyOberonTokenRequest) GetData() []byte` + +#### func (*VerifyOberonTokenRequest) [GetPk](/security.pb.go#L740) + +`func (x *VerifyOberonTokenRequest) GetPk() []byte` + +#### func (*VerifyOberonTokenRequest) [GetToken](/security.pb.go#L733) + +`func (x *VerifyOberonTokenRequest) GetToken() []byte` + +#### func (*VerifyOberonTokenRequest) [ProtoMessage](/security.pb.go#L714) + +`func (*VerifyOberonTokenRequest) ProtoMessage()` + +#### func (*VerifyOberonTokenRequest) [ProtoReflect](/security.pb.go#L716) + +`func (x *VerifyOberonTokenRequest) ProtoReflect() protoreflect.Message` + +#### func (*VerifyOberonTokenRequest) [Reset](/security.pb.go#L701) + +`func (x *VerifyOberonTokenRequest) Reset()` + +#### func (*VerifyOberonTokenRequest) [String](/security.pb.go#L710) + +`func (x *VerifyOberonTokenRequest) String() string` + +### type [VerifyOberonTokenResponse](/security.pb.go#L755) + +`type VerifyOberonTokenResponse struct { ... }` + +Contains the verification result for the oberon token + +#### func (*VerifyOberonTokenResponse) [Descriptor](/security.pb.go#L791) + +`func (*VerifyOberonTokenResponse) Descriptor() ([]byte, []int)` + +Deprecated: Use VerifyOberonTokenResponse.ProtoReflect.Descriptor instead. + +#### func (*VerifyOberonTokenResponse) [GetValid](/security.pb.go#L795) + +`func (x *VerifyOberonTokenResponse) GetValid() bool` + +#### func (*VerifyOberonTokenResponse) [ProtoMessage](/security.pb.go#L776) + +`func (*VerifyOberonTokenResponse) ProtoMessage()` + +#### func (*VerifyOberonTokenResponse) [ProtoReflect](/security.pb.go#L778) + +`func (x *VerifyOberonTokenResponse) ProtoReflect() protoreflect.Message` + +#### func (*VerifyOberonTokenResponse) [Reset](/security.pb.go#L763) + +`func (x *VerifyOberonTokenResponse) Reset()` + +#### func (*VerifyOberonTokenResponse) [String](/security.pb.go#L772) + +`func (x *VerifyOberonTokenResponse) String() string` + ### type [VerifyProofRequest](/proofs.pb.go#L189) `type VerifyProofRequest struct { ... }` diff --git a/java/build.gradle b/java/build.gradle index bf2e0284..f350f278 100644 --- a/java/build.gradle +++ b/java/build.gradle @@ -12,7 +12,7 @@ plugins { def jarDomainId = "id" def jarGroupId = "trinsic" def jarArtifactId = "okapi" -def jarVersion = "1.2.0" +def jarVersion = "1.5.0" publishing { repositories { diff --git a/python/setup.cfg b/python/setup.cfg index e134910f..03f9b43b 100644 --- a/python/setup.cfg +++ b/python/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = trinsic-okapi -version = 1.4.0 +version = 1.5.0 author = Scott Phillips author_email = scott.phillips@trinsic.id description = Trinsic okapi SDK bindings diff --git a/ruby/lib/version.rb b/ruby/lib/version.rb index 8726737c..1111111c 100644 --- a/ruby/lib/version.rb +++ b/ruby/lib/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Okapi - VERSION = '1.4.0' + VERSION = '1.5.0' end