From 530929370518fa899bca353f24ea189d1e54fda8 Mon Sep 17 00:00:00 2001 From: Moe Jangda Date: Mon, 24 Jun 2024 10:54:52 -0500 Subject: [PATCH 1/4] housekeeping --- CHANGELOG.md | 2 +- CODEOWNERS | 25 ++++++++++++++++++++++++- README.md | 41 +++-------------------------------------- 3 files changed, 28 insertions(+), 40 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index effe43c..a0712a7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,3 @@ -## 1.0.0 +## 0.1.0 - Initial version. diff --git a/CODEOWNERS b/CODEOWNERS index 17a1c89..8ac0343 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -1 +1,24 @@ -* @mistermoe @ethan-tbd @kirahsapong @wesbillman @diehuxx +# This CODEOWNERS file denotes the project leads +# and encodes their responsibilities for code review. + +# Instructions: At a minimum, replace the '@GITHUB_USER_NAME_GOES_HERE' +# here with at least one project lead. + +# Lines starting with '#' are comments. +# Each line is a file pattern followed by one or more owners. +# The format is described: https://github.blog/2017-07-06-introducing-code-owners/ + +# These owners will be the default owners for everything in the repo. +* @ethan-tbd @mistermoe @wesbillman + + +# ----------------------------------------------- +# BELOW THIS LINE ARE TEMPLATES, UNUSED +# ----------------------------------------------- +# Order is important. The last matching pattern has the most precedence. +# So if a pull request only touches javascript files, only these owners +# will be requested to review. +# *.js @octocat @github/js + +# You can also use email addresses if you prefer. +# docs/* docs@example.com \ No newline at end of file diff --git a/README.md b/README.md index 8b55e73..a2062a1 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,4 @@ - - -TODO: Put a short description of the package here that helps potential users -know whether this package might be useful for them. - -## Features - -TODO: List what your package can do. Maybe include images, gifs, or videos. - -## Getting started - -TODO: List prerequisites and provide or point to information on how to -start using the package. - -## Usage - -TODO: Include short and useful examples for package users. Add longer examples -to `/example` folder. - -```dart -const like = 'sample'; -``` - -## Additional information - -TODO: Tell users more about the package: where to find more information, how to -contribute to the package, how to file issues, what response they can expect -from the package authors, and more. +> [!WARNING] +> 🚧 WIP 👷 \ No newline at end of file From b4a61345d2a2bac2ec37290dd4a6dc59540f0f4e Mon Sep 17 00:00:00 2001 From: Moe Jangda Date: Mon, 24 Jun 2024 11:05:41 -0500 Subject: [PATCH 2/4] pull `web5` up from `packages/web5` --- .gitignore | 18 +++++++++- Justfile | 34 ++++++++----------- ...ysis_options.yaml => analysis_options.yaml | 0 {packages/web5/lib => lib}/src/crypto.dart | 0 .../lib => lib}/src/crypto/algorithm_id.dart | 0 .../web5/lib => lib}/src/crypto/crypto.dart | 0 .../web5/lib => lib}/src/crypto/ecdsa.dart | 0 .../web5/lib => lib}/src/crypto/ed25519.dart | 0 .../web5/lib => lib}/src/crypto/eddsa.dart | 0 .../src/crypto/in_memory_key_manager.dart | 0 .../web5/lib => lib}/src/crypto/jwk.dart | 0 .../lib => lib}/src/crypto/key_manager.dart | 0 .../lib => lib}/src/crypto/secp256k1.dart | 0 {packages/web5/lib => lib}/src/dids.dart | 0 .../web5/lib => lib}/src/dids/bearer_did.dart | 0 {packages/web5/lib => lib}/src/dids/did.dart | 0 .../web5/lib => lib}/src/dids/did_core.dart | 0 .../did_core/did_dereference_metadata.dart | 0 .../did_core/did_dereference_options.dart | 0 .../dids/did_core/did_dereference_result.dart | 0 .../src/dids/did_core/did_document.dart | 0 .../dids/did_core/did_document_metadata.dart | 0 .../did_core/did_resolution_metadata.dart | 0 .../dids/did_core/did_resolution_result.dart | 0 .../src/dids/did_core/did_resource.dart | 0 .../src/dids/did_core/did_service.dart | 0 .../did_core/did_verification_method.dart | 0 .../did_verification_relationship.dart | 0 .../web5/lib => lib}/src/dids/did_dht.dart | 0 .../src/dids/did_dht/bencoder.dart | 0 .../lib => lib}/src/dids/did_dht/bep44.dart | 0 .../src/dids/did_dht/converters.dart | 0 .../converters/did_document_converter.dart | 0 .../did_dht/converters/service_converter.dart | 0 .../dids/did_dht/converters/vm_converter.dart | 0 .../lib => lib}/src/dids/did_dht/did_dht.dart | 0 .../src/dids/did_dht/dns_packet.dart | 0 .../src/dids/did_dht/dns_packet/answer.dart | 0 .../src/dids/did_dht/dns_packet/codec.dart | 0 .../src/dids/did_dht/dns_packet/consts.dart | 0 .../src/dids/did_dht/dns_packet/header.dart | 0 .../src/dids/did_dht/dns_packet/name.dart | 0 .../src/dids/did_dht/dns_packet/opcode.dart | 0 .../src/dids/did_dht/dns_packet/opt_data.dart | 0 .../src/dids/did_dht/dns_packet/packet.dart | 0 .../src/dids/did_dht/dns_packet/question.dart | 0 .../src/dids/did_dht/dns_packet/rcode.dart | 0 .../src/dids/did_dht/dns_packet/rdata.dart | 0 .../dids/did_dht/dns_packet/rdata_codecs.dart | 0 .../dids/did_dht/dns_packet/record_class.dart | 0 .../dids/did_dht/dns_packet/record_type.dart | 0 .../src/dids/did_dht/dns_packet/txt_data.dart | 0 .../src/dids/did_dht/registered_types.dart | 0 .../src/dids/did_dht/root_record.dart | 0 .../lib => lib}/src/dids/did_jwk/did_jwk.dart | 0 .../src/dids/did_method_resolver.dart | 0 .../lib => lib}/src/dids/did_resolver.dart | 0 .../lib => lib}/src/dids/did_web/did_web.dart | 0 .../lib => lib}/src/dids/portable_did.dart | 0 {packages/web5/lib => lib}/src/encoders.dart | 0 .../lib => lib}/src/encoders/base64url.dart | 0 .../web5/lib => lib}/src/encoders/zbase.dart | 0 .../web5/lib => lib}/src/extensions.dart | 0 .../lib => lib}/src/extensions/bigint.dart | 0 .../web5/lib => lib}/src/extensions/json.dart | 0 {packages/web5/lib => lib}/src/jws.dart | 0 .../web5/lib => lib}/src/jws/decoded_jws.dart | 0 {packages/web5/lib => lib}/src/jws/jws.dart | 0 .../web5/lib => lib}/src/jws/jws_header.dart | 0 {packages/web5/lib => lib}/src/jwt.dart | 0 .../web5/lib => lib}/src/jwt/decoded_jwt.dart | 0 {packages/web5/lib => lib}/src/jwt/jwt.dart | 0 .../web5/lib => lib}/src/jwt/jwt_claims.dart | 0 .../web5/lib => lib}/src/jwt/jwt_encoded.dart | 0 .../web5/lib => lib}/src/jwt/jwt_header.dart | 0 {packages/web5/lib => lib}/src/pexv2.dart | 0 .../src/pexv2/presentation_definition.dart | 0 {packages/web5/lib => lib}/src/vc.dart | 0 {packages/web5/lib => lib}/src/vc/vc.dart | 0 {packages/web5/lib => lib}/src/vc/vc_jwt.dart | 0 {packages/web5/lib => lib}/web5.dart | 0 packages/web5/.gitignore | 17 ---------- packages/web5/pubspec.yaml => pubspec.yaml | 0 .../test => test}/crypto/crypto_test.dart | 0 .../test => test}/crypto/secp256k1_test.dart | 2 +- .../dids/did_core/did_document_test.dart | 0 .../dids/did_dht/bencoder_test.dart | 0 .../dids/did_dht/bep44_test.dart | 0 .../did_document_converter_test.dart | 0 .../converters/service_converter_test.dart | 0 .../did_dht/converters/vm_converter_test.dart | 0 .../dids/did_dht/did_dht_test.dart | 0 .../dids/did_dht/dns_packet/answer_test.dart | 0 .../dids/did_dht/dns_packet/header_test.dart | 0 .../dids/did_dht/dns_packet/name_test.dart | 0 .../dids/did_dht/dns_packet/packet_test.dart | 0 .../did_dht/dns_packet/txt_data_test.dart | 0 .../dids/did_dht/dns_packet/vector.dart | 0 .../web5/test => test}/dids/did_jwk_test.dart | 0 .../test => test}/dids/did_resolver_test.dart | 0 .../web5/test => test}/dids/did_web_test.dart | 0 .../web5/test => test}/helpers/mocks.dart | 0 .../helpers/test_vector_helpers.dart | 2 +- .../web5/test => test}/jws/jws_test.dart | 0 .../web5/test => test}/jwt/jwt_test.dart | 0 .../pexv2/presentation_definition_test.dart | 0 .../web5/test => test}/vc/vc_jwt_test.dart | 0 {packages/web5/test => test}/vc/vc_test.dart | 0 108 files changed, 33 insertions(+), 40 deletions(-) rename packages/web5/analysis_options.yaml => analysis_options.yaml (100%) rename {packages/web5/lib => lib}/src/crypto.dart (100%) rename {packages/web5/lib => lib}/src/crypto/algorithm_id.dart (100%) rename {packages/web5/lib => lib}/src/crypto/crypto.dart (100%) rename {packages/web5/lib => lib}/src/crypto/ecdsa.dart (100%) rename {packages/web5/lib => lib}/src/crypto/ed25519.dart (100%) rename {packages/web5/lib => lib}/src/crypto/eddsa.dart (100%) rename {packages/web5/lib => lib}/src/crypto/in_memory_key_manager.dart (100%) rename {packages/web5/lib => lib}/src/crypto/jwk.dart (100%) rename {packages/web5/lib => lib}/src/crypto/key_manager.dart (100%) rename {packages/web5/lib => lib}/src/crypto/secp256k1.dart (100%) rename {packages/web5/lib => lib}/src/dids.dart (100%) rename {packages/web5/lib => lib}/src/dids/bearer_did.dart (100%) rename {packages/web5/lib => lib}/src/dids/did.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_core.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_core/did_dereference_metadata.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_core/did_dereference_options.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_core/did_dereference_result.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_core/did_document.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_core/did_document_metadata.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_core/did_resolution_metadata.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_core/did_resolution_result.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_core/did_resource.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_core/did_service.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_core/did_verification_method.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_core/did_verification_relationship.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/bencoder.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/bep44.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/converters.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/converters/did_document_converter.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/converters/service_converter.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/converters/vm_converter.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/did_dht.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/dns_packet.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/dns_packet/answer.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/dns_packet/codec.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/dns_packet/consts.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/dns_packet/header.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/dns_packet/name.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/dns_packet/opcode.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/dns_packet/opt_data.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/dns_packet/packet.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/dns_packet/question.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/dns_packet/rcode.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/dns_packet/rdata.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/dns_packet/rdata_codecs.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/dns_packet/record_class.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/dns_packet/record_type.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/dns_packet/txt_data.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/registered_types.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_dht/root_record.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_jwk/did_jwk.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_method_resolver.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_resolver.dart (100%) rename {packages/web5/lib => lib}/src/dids/did_web/did_web.dart (100%) rename {packages/web5/lib => lib}/src/dids/portable_did.dart (100%) rename {packages/web5/lib => lib}/src/encoders.dart (100%) rename {packages/web5/lib => lib}/src/encoders/base64url.dart (100%) rename {packages/web5/lib => lib}/src/encoders/zbase.dart (100%) rename {packages/web5/lib => lib}/src/extensions.dart (100%) rename {packages/web5/lib => lib}/src/extensions/bigint.dart (100%) rename {packages/web5/lib => lib}/src/extensions/json.dart (100%) rename {packages/web5/lib => lib}/src/jws.dart (100%) rename {packages/web5/lib => lib}/src/jws/decoded_jws.dart (100%) rename {packages/web5/lib => lib}/src/jws/jws.dart (100%) rename {packages/web5/lib => lib}/src/jws/jws_header.dart (100%) rename {packages/web5/lib => lib}/src/jwt.dart (100%) rename {packages/web5/lib => lib}/src/jwt/decoded_jwt.dart (100%) rename {packages/web5/lib => lib}/src/jwt/jwt.dart (100%) rename {packages/web5/lib => lib}/src/jwt/jwt_claims.dart (100%) rename {packages/web5/lib => lib}/src/jwt/jwt_encoded.dart (100%) rename {packages/web5/lib => lib}/src/jwt/jwt_header.dart (100%) rename {packages/web5/lib => lib}/src/pexv2.dart (100%) rename {packages/web5/lib => lib}/src/pexv2/presentation_definition.dart (100%) rename {packages/web5/lib => lib}/src/vc.dart (100%) rename {packages/web5/lib => lib}/src/vc/vc.dart (100%) rename {packages/web5/lib => lib}/src/vc/vc_jwt.dart (100%) rename {packages/web5/lib => lib}/web5.dart (100%) delete mode 100644 packages/web5/.gitignore rename packages/web5/pubspec.yaml => pubspec.yaml (100%) rename {packages/web5/test => test}/crypto/crypto_test.dart (100%) rename {packages/web5/test => test}/crypto/secp256k1_test.dart (97%) rename {packages/web5/test => test}/dids/did_core/did_document_test.dart (100%) rename {packages/web5/test => test}/dids/did_dht/bencoder_test.dart (100%) rename {packages/web5/test => test}/dids/did_dht/bep44_test.dart (100%) rename {packages/web5/test => test}/dids/did_dht/converters/did_document_converter_test.dart (100%) rename {packages/web5/test => test}/dids/did_dht/converters/service_converter_test.dart (100%) rename {packages/web5/test => test}/dids/did_dht/converters/vm_converter_test.dart (100%) rename {packages/web5/test => test}/dids/did_dht/did_dht_test.dart (100%) rename {packages/web5/test => test}/dids/did_dht/dns_packet/answer_test.dart (100%) rename {packages/web5/test => test}/dids/did_dht/dns_packet/header_test.dart (100%) rename {packages/web5/test => test}/dids/did_dht/dns_packet/name_test.dart (100%) rename {packages/web5/test => test}/dids/did_dht/dns_packet/packet_test.dart (100%) rename {packages/web5/test => test}/dids/did_dht/dns_packet/txt_data_test.dart (100%) rename {packages/web5/test => test}/dids/did_dht/dns_packet/vector.dart (100%) rename {packages/web5/test => test}/dids/did_jwk_test.dart (100%) rename {packages/web5/test => test}/dids/did_resolver_test.dart (100%) rename {packages/web5/test => test}/dids/did_web_test.dart (100%) rename {packages/web5/test => test}/helpers/mocks.dart (100%) rename {packages/web5/test => test}/helpers/test_vector_helpers.dart (86%) rename {packages/web5/test => test}/jws/jws_test.dart (100%) rename {packages/web5/test => test}/jwt/jwt_test.dart (100%) rename {packages/web5/test => test}/pexv2/presentation_definition_test.dart (100%) rename {packages/web5/test => test}/vc/vc_jwt_test.dart (100%) rename {packages/web5/test => test}/vc/vc_test.dart (100%) diff --git a/.gitignore b/.gitignore index e43b0f9..f5e5134 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,17 @@ -.DS_Store +# https://dart.dev/guides/libraries/private-files +# Created by `dart pub` +.dart_tool/ + +# Avoid committing pubspec.lock for library packages; see +# https://dart.dev/guides/libraries/private-files#pubspeclock. +pubspec.lock + +# Flutter/Dart/Pub related +**/doc/api/ +**/ios/Flutter/.last_build_id +.dart_tool/ +.flutter-plugins +.flutter-plugins-dependencies +.pub-cache/ +.pub/ +/build/ diff --git a/Justfile b/Justfile index ff5ed06..2a5c364 100644 --- a/Justfile +++ b/Justfile @@ -1,29 +1,23 @@ +_help: + @just -l + get: #!/bin/bash + set -euo pipefail + echo "Getting dependencies for packages" - for dir in packages/*; do \ - if [ -d $dir ]; then \ - echo "Getting dependencies in $dir"; \ - (cd $dir && flutter pub get || dart pub get); \ - fi \ - done + dart pub get -test: test-vectors +test: #!/bin/bash - for dir in packages/*; do \ - if [ -d $dir ]; then \ - echo "Running tests in $dir"; \ - (cd $dir && flutter test || dart test); \ - fi \ - done + set -euo pipefail + + git submodule init + git submodule update + dart test analyze: #!/bin/bash - for dir in packages/*; do \ - if [ -d $dir ]; then \ - (cd $dir && flutter analyze || dart analyze); \ - fi \ - done + set -euo pipefail -test-vectors: - @git submodule update --init --recursive + dart analyze diff --git a/packages/web5/analysis_options.yaml b/analysis_options.yaml similarity index 100% rename from packages/web5/analysis_options.yaml rename to analysis_options.yaml diff --git a/packages/web5/lib/src/crypto.dart b/lib/src/crypto.dart similarity index 100% rename from packages/web5/lib/src/crypto.dart rename to lib/src/crypto.dart diff --git a/packages/web5/lib/src/crypto/algorithm_id.dart b/lib/src/crypto/algorithm_id.dart similarity index 100% rename from packages/web5/lib/src/crypto/algorithm_id.dart rename to lib/src/crypto/algorithm_id.dart diff --git a/packages/web5/lib/src/crypto/crypto.dart b/lib/src/crypto/crypto.dart similarity index 100% rename from packages/web5/lib/src/crypto/crypto.dart rename to lib/src/crypto/crypto.dart diff --git a/packages/web5/lib/src/crypto/ecdsa.dart b/lib/src/crypto/ecdsa.dart similarity index 100% rename from packages/web5/lib/src/crypto/ecdsa.dart rename to lib/src/crypto/ecdsa.dart diff --git a/packages/web5/lib/src/crypto/ed25519.dart b/lib/src/crypto/ed25519.dart similarity index 100% rename from packages/web5/lib/src/crypto/ed25519.dart rename to lib/src/crypto/ed25519.dart diff --git a/packages/web5/lib/src/crypto/eddsa.dart b/lib/src/crypto/eddsa.dart similarity index 100% rename from packages/web5/lib/src/crypto/eddsa.dart rename to lib/src/crypto/eddsa.dart diff --git a/packages/web5/lib/src/crypto/in_memory_key_manager.dart b/lib/src/crypto/in_memory_key_manager.dart similarity index 100% rename from packages/web5/lib/src/crypto/in_memory_key_manager.dart rename to lib/src/crypto/in_memory_key_manager.dart diff --git a/packages/web5/lib/src/crypto/jwk.dart b/lib/src/crypto/jwk.dart similarity index 100% rename from packages/web5/lib/src/crypto/jwk.dart rename to lib/src/crypto/jwk.dart diff --git a/packages/web5/lib/src/crypto/key_manager.dart b/lib/src/crypto/key_manager.dart similarity index 100% rename from packages/web5/lib/src/crypto/key_manager.dart rename to lib/src/crypto/key_manager.dart diff --git a/packages/web5/lib/src/crypto/secp256k1.dart b/lib/src/crypto/secp256k1.dart similarity index 100% rename from packages/web5/lib/src/crypto/secp256k1.dart rename to lib/src/crypto/secp256k1.dart diff --git a/packages/web5/lib/src/dids.dart b/lib/src/dids.dart similarity index 100% rename from packages/web5/lib/src/dids.dart rename to lib/src/dids.dart diff --git a/packages/web5/lib/src/dids/bearer_did.dart b/lib/src/dids/bearer_did.dart similarity index 100% rename from packages/web5/lib/src/dids/bearer_did.dart rename to lib/src/dids/bearer_did.dart diff --git a/packages/web5/lib/src/dids/did.dart b/lib/src/dids/did.dart similarity index 100% rename from packages/web5/lib/src/dids/did.dart rename to lib/src/dids/did.dart diff --git a/packages/web5/lib/src/dids/did_core.dart b/lib/src/dids/did_core.dart similarity index 100% rename from packages/web5/lib/src/dids/did_core.dart rename to lib/src/dids/did_core.dart diff --git a/packages/web5/lib/src/dids/did_core/did_dereference_metadata.dart b/lib/src/dids/did_core/did_dereference_metadata.dart similarity index 100% rename from packages/web5/lib/src/dids/did_core/did_dereference_metadata.dart rename to lib/src/dids/did_core/did_dereference_metadata.dart diff --git a/packages/web5/lib/src/dids/did_core/did_dereference_options.dart b/lib/src/dids/did_core/did_dereference_options.dart similarity index 100% rename from packages/web5/lib/src/dids/did_core/did_dereference_options.dart rename to lib/src/dids/did_core/did_dereference_options.dart diff --git a/packages/web5/lib/src/dids/did_core/did_dereference_result.dart b/lib/src/dids/did_core/did_dereference_result.dart similarity index 100% rename from packages/web5/lib/src/dids/did_core/did_dereference_result.dart rename to lib/src/dids/did_core/did_dereference_result.dart diff --git a/packages/web5/lib/src/dids/did_core/did_document.dart b/lib/src/dids/did_core/did_document.dart similarity index 100% rename from packages/web5/lib/src/dids/did_core/did_document.dart rename to lib/src/dids/did_core/did_document.dart diff --git a/packages/web5/lib/src/dids/did_core/did_document_metadata.dart b/lib/src/dids/did_core/did_document_metadata.dart similarity index 100% rename from packages/web5/lib/src/dids/did_core/did_document_metadata.dart rename to lib/src/dids/did_core/did_document_metadata.dart diff --git a/packages/web5/lib/src/dids/did_core/did_resolution_metadata.dart b/lib/src/dids/did_core/did_resolution_metadata.dart similarity index 100% rename from packages/web5/lib/src/dids/did_core/did_resolution_metadata.dart rename to lib/src/dids/did_core/did_resolution_metadata.dart diff --git a/packages/web5/lib/src/dids/did_core/did_resolution_result.dart b/lib/src/dids/did_core/did_resolution_result.dart similarity index 100% rename from packages/web5/lib/src/dids/did_core/did_resolution_result.dart rename to lib/src/dids/did_core/did_resolution_result.dart diff --git a/packages/web5/lib/src/dids/did_core/did_resource.dart b/lib/src/dids/did_core/did_resource.dart similarity index 100% rename from packages/web5/lib/src/dids/did_core/did_resource.dart rename to lib/src/dids/did_core/did_resource.dart diff --git a/packages/web5/lib/src/dids/did_core/did_service.dart b/lib/src/dids/did_core/did_service.dart similarity index 100% rename from packages/web5/lib/src/dids/did_core/did_service.dart rename to lib/src/dids/did_core/did_service.dart diff --git a/packages/web5/lib/src/dids/did_core/did_verification_method.dart b/lib/src/dids/did_core/did_verification_method.dart similarity index 100% rename from packages/web5/lib/src/dids/did_core/did_verification_method.dart rename to lib/src/dids/did_core/did_verification_method.dart diff --git a/packages/web5/lib/src/dids/did_core/did_verification_relationship.dart b/lib/src/dids/did_core/did_verification_relationship.dart similarity index 100% rename from packages/web5/lib/src/dids/did_core/did_verification_relationship.dart rename to lib/src/dids/did_core/did_verification_relationship.dart diff --git a/packages/web5/lib/src/dids/did_dht.dart b/lib/src/dids/did_dht.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht.dart rename to lib/src/dids/did_dht.dart diff --git a/packages/web5/lib/src/dids/did_dht/bencoder.dart b/lib/src/dids/did_dht/bencoder.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/bencoder.dart rename to lib/src/dids/did_dht/bencoder.dart diff --git a/packages/web5/lib/src/dids/did_dht/bep44.dart b/lib/src/dids/did_dht/bep44.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/bep44.dart rename to lib/src/dids/did_dht/bep44.dart diff --git a/packages/web5/lib/src/dids/did_dht/converters.dart b/lib/src/dids/did_dht/converters.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/converters.dart rename to lib/src/dids/did_dht/converters.dart diff --git a/packages/web5/lib/src/dids/did_dht/converters/did_document_converter.dart b/lib/src/dids/did_dht/converters/did_document_converter.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/converters/did_document_converter.dart rename to lib/src/dids/did_dht/converters/did_document_converter.dart diff --git a/packages/web5/lib/src/dids/did_dht/converters/service_converter.dart b/lib/src/dids/did_dht/converters/service_converter.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/converters/service_converter.dart rename to lib/src/dids/did_dht/converters/service_converter.dart diff --git a/packages/web5/lib/src/dids/did_dht/converters/vm_converter.dart b/lib/src/dids/did_dht/converters/vm_converter.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/converters/vm_converter.dart rename to lib/src/dids/did_dht/converters/vm_converter.dart diff --git a/packages/web5/lib/src/dids/did_dht/did_dht.dart b/lib/src/dids/did_dht/did_dht.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/did_dht.dart rename to lib/src/dids/did_dht/did_dht.dart diff --git a/packages/web5/lib/src/dids/did_dht/dns_packet.dart b/lib/src/dids/did_dht/dns_packet.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/dns_packet.dart rename to lib/src/dids/did_dht/dns_packet.dart diff --git a/packages/web5/lib/src/dids/did_dht/dns_packet/answer.dart b/lib/src/dids/did_dht/dns_packet/answer.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/dns_packet/answer.dart rename to lib/src/dids/did_dht/dns_packet/answer.dart diff --git a/packages/web5/lib/src/dids/did_dht/dns_packet/codec.dart b/lib/src/dids/did_dht/dns_packet/codec.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/dns_packet/codec.dart rename to lib/src/dids/did_dht/dns_packet/codec.dart diff --git a/packages/web5/lib/src/dids/did_dht/dns_packet/consts.dart b/lib/src/dids/did_dht/dns_packet/consts.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/dns_packet/consts.dart rename to lib/src/dids/did_dht/dns_packet/consts.dart diff --git a/packages/web5/lib/src/dids/did_dht/dns_packet/header.dart b/lib/src/dids/did_dht/dns_packet/header.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/dns_packet/header.dart rename to lib/src/dids/did_dht/dns_packet/header.dart diff --git a/packages/web5/lib/src/dids/did_dht/dns_packet/name.dart b/lib/src/dids/did_dht/dns_packet/name.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/dns_packet/name.dart rename to lib/src/dids/did_dht/dns_packet/name.dart diff --git a/packages/web5/lib/src/dids/did_dht/dns_packet/opcode.dart b/lib/src/dids/did_dht/dns_packet/opcode.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/dns_packet/opcode.dart rename to lib/src/dids/did_dht/dns_packet/opcode.dart diff --git a/packages/web5/lib/src/dids/did_dht/dns_packet/opt_data.dart b/lib/src/dids/did_dht/dns_packet/opt_data.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/dns_packet/opt_data.dart rename to lib/src/dids/did_dht/dns_packet/opt_data.dart diff --git a/packages/web5/lib/src/dids/did_dht/dns_packet/packet.dart b/lib/src/dids/did_dht/dns_packet/packet.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/dns_packet/packet.dart rename to lib/src/dids/did_dht/dns_packet/packet.dart diff --git a/packages/web5/lib/src/dids/did_dht/dns_packet/question.dart b/lib/src/dids/did_dht/dns_packet/question.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/dns_packet/question.dart rename to lib/src/dids/did_dht/dns_packet/question.dart diff --git a/packages/web5/lib/src/dids/did_dht/dns_packet/rcode.dart b/lib/src/dids/did_dht/dns_packet/rcode.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/dns_packet/rcode.dart rename to lib/src/dids/did_dht/dns_packet/rcode.dart diff --git a/packages/web5/lib/src/dids/did_dht/dns_packet/rdata.dart b/lib/src/dids/did_dht/dns_packet/rdata.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/dns_packet/rdata.dart rename to lib/src/dids/did_dht/dns_packet/rdata.dart diff --git a/packages/web5/lib/src/dids/did_dht/dns_packet/rdata_codecs.dart b/lib/src/dids/did_dht/dns_packet/rdata_codecs.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/dns_packet/rdata_codecs.dart rename to lib/src/dids/did_dht/dns_packet/rdata_codecs.dart diff --git a/packages/web5/lib/src/dids/did_dht/dns_packet/record_class.dart b/lib/src/dids/did_dht/dns_packet/record_class.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/dns_packet/record_class.dart rename to lib/src/dids/did_dht/dns_packet/record_class.dart diff --git a/packages/web5/lib/src/dids/did_dht/dns_packet/record_type.dart b/lib/src/dids/did_dht/dns_packet/record_type.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/dns_packet/record_type.dart rename to lib/src/dids/did_dht/dns_packet/record_type.dart diff --git a/packages/web5/lib/src/dids/did_dht/dns_packet/txt_data.dart b/lib/src/dids/did_dht/dns_packet/txt_data.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/dns_packet/txt_data.dart rename to lib/src/dids/did_dht/dns_packet/txt_data.dart diff --git a/packages/web5/lib/src/dids/did_dht/registered_types.dart b/lib/src/dids/did_dht/registered_types.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/registered_types.dart rename to lib/src/dids/did_dht/registered_types.dart diff --git a/packages/web5/lib/src/dids/did_dht/root_record.dart b/lib/src/dids/did_dht/root_record.dart similarity index 100% rename from packages/web5/lib/src/dids/did_dht/root_record.dart rename to lib/src/dids/did_dht/root_record.dart diff --git a/packages/web5/lib/src/dids/did_jwk/did_jwk.dart b/lib/src/dids/did_jwk/did_jwk.dart similarity index 100% rename from packages/web5/lib/src/dids/did_jwk/did_jwk.dart rename to lib/src/dids/did_jwk/did_jwk.dart diff --git a/packages/web5/lib/src/dids/did_method_resolver.dart b/lib/src/dids/did_method_resolver.dart similarity index 100% rename from packages/web5/lib/src/dids/did_method_resolver.dart rename to lib/src/dids/did_method_resolver.dart diff --git a/packages/web5/lib/src/dids/did_resolver.dart b/lib/src/dids/did_resolver.dart similarity index 100% rename from packages/web5/lib/src/dids/did_resolver.dart rename to lib/src/dids/did_resolver.dart diff --git a/packages/web5/lib/src/dids/did_web/did_web.dart b/lib/src/dids/did_web/did_web.dart similarity index 100% rename from packages/web5/lib/src/dids/did_web/did_web.dart rename to lib/src/dids/did_web/did_web.dart diff --git a/packages/web5/lib/src/dids/portable_did.dart b/lib/src/dids/portable_did.dart similarity index 100% rename from packages/web5/lib/src/dids/portable_did.dart rename to lib/src/dids/portable_did.dart diff --git a/packages/web5/lib/src/encoders.dart b/lib/src/encoders.dart similarity index 100% rename from packages/web5/lib/src/encoders.dart rename to lib/src/encoders.dart diff --git a/packages/web5/lib/src/encoders/base64url.dart b/lib/src/encoders/base64url.dart similarity index 100% rename from packages/web5/lib/src/encoders/base64url.dart rename to lib/src/encoders/base64url.dart diff --git a/packages/web5/lib/src/encoders/zbase.dart b/lib/src/encoders/zbase.dart similarity index 100% rename from packages/web5/lib/src/encoders/zbase.dart rename to lib/src/encoders/zbase.dart diff --git a/packages/web5/lib/src/extensions.dart b/lib/src/extensions.dart similarity index 100% rename from packages/web5/lib/src/extensions.dart rename to lib/src/extensions.dart diff --git a/packages/web5/lib/src/extensions/bigint.dart b/lib/src/extensions/bigint.dart similarity index 100% rename from packages/web5/lib/src/extensions/bigint.dart rename to lib/src/extensions/bigint.dart diff --git a/packages/web5/lib/src/extensions/json.dart b/lib/src/extensions/json.dart similarity index 100% rename from packages/web5/lib/src/extensions/json.dart rename to lib/src/extensions/json.dart diff --git a/packages/web5/lib/src/jws.dart b/lib/src/jws.dart similarity index 100% rename from packages/web5/lib/src/jws.dart rename to lib/src/jws.dart diff --git a/packages/web5/lib/src/jws/decoded_jws.dart b/lib/src/jws/decoded_jws.dart similarity index 100% rename from packages/web5/lib/src/jws/decoded_jws.dart rename to lib/src/jws/decoded_jws.dart diff --git a/packages/web5/lib/src/jws/jws.dart b/lib/src/jws/jws.dart similarity index 100% rename from packages/web5/lib/src/jws/jws.dart rename to lib/src/jws/jws.dart diff --git a/packages/web5/lib/src/jws/jws_header.dart b/lib/src/jws/jws_header.dart similarity index 100% rename from packages/web5/lib/src/jws/jws_header.dart rename to lib/src/jws/jws_header.dart diff --git a/packages/web5/lib/src/jwt.dart b/lib/src/jwt.dart similarity index 100% rename from packages/web5/lib/src/jwt.dart rename to lib/src/jwt.dart diff --git a/packages/web5/lib/src/jwt/decoded_jwt.dart b/lib/src/jwt/decoded_jwt.dart similarity index 100% rename from packages/web5/lib/src/jwt/decoded_jwt.dart rename to lib/src/jwt/decoded_jwt.dart diff --git a/packages/web5/lib/src/jwt/jwt.dart b/lib/src/jwt/jwt.dart similarity index 100% rename from packages/web5/lib/src/jwt/jwt.dart rename to lib/src/jwt/jwt.dart diff --git a/packages/web5/lib/src/jwt/jwt_claims.dart b/lib/src/jwt/jwt_claims.dart similarity index 100% rename from packages/web5/lib/src/jwt/jwt_claims.dart rename to lib/src/jwt/jwt_claims.dart diff --git a/packages/web5/lib/src/jwt/jwt_encoded.dart b/lib/src/jwt/jwt_encoded.dart similarity index 100% rename from packages/web5/lib/src/jwt/jwt_encoded.dart rename to lib/src/jwt/jwt_encoded.dart diff --git a/packages/web5/lib/src/jwt/jwt_header.dart b/lib/src/jwt/jwt_header.dart similarity index 100% rename from packages/web5/lib/src/jwt/jwt_header.dart rename to lib/src/jwt/jwt_header.dart diff --git a/packages/web5/lib/src/pexv2.dart b/lib/src/pexv2.dart similarity index 100% rename from packages/web5/lib/src/pexv2.dart rename to lib/src/pexv2.dart diff --git a/packages/web5/lib/src/pexv2/presentation_definition.dart b/lib/src/pexv2/presentation_definition.dart similarity index 100% rename from packages/web5/lib/src/pexv2/presentation_definition.dart rename to lib/src/pexv2/presentation_definition.dart diff --git a/packages/web5/lib/src/vc.dart b/lib/src/vc.dart similarity index 100% rename from packages/web5/lib/src/vc.dart rename to lib/src/vc.dart diff --git a/packages/web5/lib/src/vc/vc.dart b/lib/src/vc/vc.dart similarity index 100% rename from packages/web5/lib/src/vc/vc.dart rename to lib/src/vc/vc.dart diff --git a/packages/web5/lib/src/vc/vc_jwt.dart b/lib/src/vc/vc_jwt.dart similarity index 100% rename from packages/web5/lib/src/vc/vc_jwt.dart rename to lib/src/vc/vc_jwt.dart diff --git a/packages/web5/lib/web5.dart b/lib/web5.dart similarity index 100% rename from packages/web5/lib/web5.dart rename to lib/web5.dart diff --git a/packages/web5/.gitignore b/packages/web5/.gitignore deleted file mode 100644 index f5e5134..0000000 --- a/packages/web5/.gitignore +++ /dev/null @@ -1,17 +0,0 @@ -# https://dart.dev/guides/libraries/private-files -# Created by `dart pub` -.dart_tool/ - -# Avoid committing pubspec.lock for library packages; see -# https://dart.dev/guides/libraries/private-files#pubspeclock. -pubspec.lock - -# Flutter/Dart/Pub related -**/doc/api/ -**/ios/Flutter/.last_build_id -.dart_tool/ -.flutter-plugins -.flutter-plugins-dependencies -.pub-cache/ -.pub/ -/build/ diff --git a/packages/web5/pubspec.yaml b/pubspec.yaml similarity index 100% rename from packages/web5/pubspec.yaml rename to pubspec.yaml diff --git a/packages/web5/test/crypto/crypto_test.dart b/test/crypto/crypto_test.dart similarity index 100% rename from packages/web5/test/crypto/crypto_test.dart rename to test/crypto/crypto_test.dart diff --git a/packages/web5/test/crypto/secp256k1_test.dart b/test/crypto/secp256k1_test.dart similarity index 97% rename from packages/web5/test/crypto/secp256k1_test.dart rename to test/crypto/secp256k1_test.dart index 0cc2a7e..0517605 100644 --- a/packages/web5/test/crypto/secp256k1_test.dart +++ b/test/crypto/secp256k1_test.dart @@ -7,7 +7,7 @@ import 'package:web5/src/crypto.dart'; import 'package:test/test.dart'; final thisDir = Directory.current.path; -final vectorDir = '$thisDir/../../web5-spec/test-vectors/crypto_es256k'; +final vectorDir = '$thisDir/web5-spec/test-vectors/crypto_es256k'; class Input { String data; diff --git a/packages/web5/test/dids/did_core/did_document_test.dart b/test/dids/did_core/did_document_test.dart similarity index 100% rename from packages/web5/test/dids/did_core/did_document_test.dart rename to test/dids/did_core/did_document_test.dart diff --git a/packages/web5/test/dids/did_dht/bencoder_test.dart b/test/dids/did_dht/bencoder_test.dart similarity index 100% rename from packages/web5/test/dids/did_dht/bencoder_test.dart rename to test/dids/did_dht/bencoder_test.dart diff --git a/packages/web5/test/dids/did_dht/bep44_test.dart b/test/dids/did_dht/bep44_test.dart similarity index 100% rename from packages/web5/test/dids/did_dht/bep44_test.dart rename to test/dids/did_dht/bep44_test.dart diff --git a/packages/web5/test/dids/did_dht/converters/did_document_converter_test.dart b/test/dids/did_dht/converters/did_document_converter_test.dart similarity index 100% rename from packages/web5/test/dids/did_dht/converters/did_document_converter_test.dart rename to test/dids/did_dht/converters/did_document_converter_test.dart diff --git a/packages/web5/test/dids/did_dht/converters/service_converter_test.dart b/test/dids/did_dht/converters/service_converter_test.dart similarity index 100% rename from packages/web5/test/dids/did_dht/converters/service_converter_test.dart rename to test/dids/did_dht/converters/service_converter_test.dart diff --git a/packages/web5/test/dids/did_dht/converters/vm_converter_test.dart b/test/dids/did_dht/converters/vm_converter_test.dart similarity index 100% rename from packages/web5/test/dids/did_dht/converters/vm_converter_test.dart rename to test/dids/did_dht/converters/vm_converter_test.dart diff --git a/packages/web5/test/dids/did_dht/did_dht_test.dart b/test/dids/did_dht/did_dht_test.dart similarity index 100% rename from packages/web5/test/dids/did_dht/did_dht_test.dart rename to test/dids/did_dht/did_dht_test.dart diff --git a/packages/web5/test/dids/did_dht/dns_packet/answer_test.dart b/test/dids/did_dht/dns_packet/answer_test.dart similarity index 100% rename from packages/web5/test/dids/did_dht/dns_packet/answer_test.dart rename to test/dids/did_dht/dns_packet/answer_test.dart diff --git a/packages/web5/test/dids/did_dht/dns_packet/header_test.dart b/test/dids/did_dht/dns_packet/header_test.dart similarity index 100% rename from packages/web5/test/dids/did_dht/dns_packet/header_test.dart rename to test/dids/did_dht/dns_packet/header_test.dart diff --git a/packages/web5/test/dids/did_dht/dns_packet/name_test.dart b/test/dids/did_dht/dns_packet/name_test.dart similarity index 100% rename from packages/web5/test/dids/did_dht/dns_packet/name_test.dart rename to test/dids/did_dht/dns_packet/name_test.dart diff --git a/packages/web5/test/dids/did_dht/dns_packet/packet_test.dart b/test/dids/did_dht/dns_packet/packet_test.dart similarity index 100% rename from packages/web5/test/dids/did_dht/dns_packet/packet_test.dart rename to test/dids/did_dht/dns_packet/packet_test.dart diff --git a/packages/web5/test/dids/did_dht/dns_packet/txt_data_test.dart b/test/dids/did_dht/dns_packet/txt_data_test.dart similarity index 100% rename from packages/web5/test/dids/did_dht/dns_packet/txt_data_test.dart rename to test/dids/did_dht/dns_packet/txt_data_test.dart diff --git a/packages/web5/test/dids/did_dht/dns_packet/vector.dart b/test/dids/did_dht/dns_packet/vector.dart similarity index 100% rename from packages/web5/test/dids/did_dht/dns_packet/vector.dart rename to test/dids/did_dht/dns_packet/vector.dart diff --git a/packages/web5/test/dids/did_jwk_test.dart b/test/dids/did_jwk_test.dart similarity index 100% rename from packages/web5/test/dids/did_jwk_test.dart rename to test/dids/did_jwk_test.dart diff --git a/packages/web5/test/dids/did_resolver_test.dart b/test/dids/did_resolver_test.dart similarity index 100% rename from packages/web5/test/dids/did_resolver_test.dart rename to test/dids/did_resolver_test.dart diff --git a/packages/web5/test/dids/did_web_test.dart b/test/dids/did_web_test.dart similarity index 100% rename from packages/web5/test/dids/did_web_test.dart rename to test/dids/did_web_test.dart diff --git a/packages/web5/test/helpers/mocks.dart b/test/helpers/mocks.dart similarity index 100% rename from packages/web5/test/helpers/mocks.dart rename to test/helpers/mocks.dart diff --git a/packages/web5/test/helpers/test_vector_helpers.dart b/test/helpers/test_vector_helpers.dart similarity index 86% rename from packages/web5/test/helpers/test_vector_helpers.dart rename to test/helpers/test_vector_helpers.dart index eeb5499..97d4d97 100644 --- a/packages/web5/test/helpers/test_vector_helpers.dart +++ b/test/helpers/test_vector_helpers.dart @@ -2,7 +2,7 @@ import 'dart:convert'; import 'dart:io'; final thisDir = Directory.current.path; -final vectorDir = '$thisDir/../../web5-spec/test-vectors/'; +final vectorDir = '$thisDir/web5-spec/test-vectors/'; Map getJsonVectors(String vectorSubPath) { final vectorPath = '$vectorDir$vectorSubPath'; diff --git a/packages/web5/test/jws/jws_test.dart b/test/jws/jws_test.dart similarity index 100% rename from packages/web5/test/jws/jws_test.dart rename to test/jws/jws_test.dart diff --git a/packages/web5/test/jwt/jwt_test.dart b/test/jwt/jwt_test.dart similarity index 100% rename from packages/web5/test/jwt/jwt_test.dart rename to test/jwt/jwt_test.dart diff --git a/packages/web5/test/pexv2/presentation_definition_test.dart b/test/pexv2/presentation_definition_test.dart similarity index 100% rename from packages/web5/test/pexv2/presentation_definition_test.dart rename to test/pexv2/presentation_definition_test.dart diff --git a/packages/web5/test/vc/vc_jwt_test.dart b/test/vc/vc_jwt_test.dart similarity index 100% rename from packages/web5/test/vc/vc_jwt_test.dart rename to test/vc/vc_jwt_test.dart diff --git a/packages/web5/test/vc/vc_test.dart b/test/vc/vc_test.dart similarity index 100% rename from packages/web5/test/vc/vc_test.dart rename to test/vc/vc_test.dart From c63549939e9e3b8d7ca6752d799030ecb79d1a3f Mon Sep 17 00:00:00 2001 From: Moe Jangda Date: Mon, 24 Jun 2024 11:20:49 -0500 Subject: [PATCH 3/4] add `.pubignore` --- .pubignore | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 .pubignore diff --git a/.pubignore b/.pubignore new file mode 100644 index 0000000..7b3b7bd --- /dev/null +++ b/.pubignore @@ -0,0 +1,3 @@ +bin +web5-spec +Justfile \ No newline at end of file From e3e0c798c66f1f316522bf12d5540c6a30a9775b Mon Sep 17 00:00:00 2001 From: Moe Jangda Date: Mon, 24 Jun 2024 11:34:56 -0500 Subject: [PATCH 4/4] add `CODE_OF_CONDUCT.md` and add hipster badges to `README` --- CODE_OF_CONDUCT.md | 136 +++++++++++++++++++++++++++++++++++++++++++++ README.md | 3 + 2 files changed, 139 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..0c3c1a4 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,136 @@ + +# TBD Code of Conduct + +TBD builds infrastructure for the next wave of innovation in financial services — which we believe will be decentralized, permissionless, and non-custodial. This means opening the global economy to everyone. We extend the same principles of inclusion to our developer ecosystem. We are excited to build with you. So we will ensure our community is truly open, transparent and inclusive. Because of the global nature of our project, diversity and inclusivity is paramount to our success. We not only welcome diverse perspectives, we **need** them! + +The code of conduct below reflects the expectations for ourselves and for our community. + + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, physical appearance, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful and welcoming of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +The TBD Open Source Governance Committee (GC) is responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +The GC has the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event, or any space where the project is listed as part of your profile. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the TBD Open Source Governance Committee (GC) at +`tbd-open-source-governance@squareup.com`. +All complaints will be reviewed and investigated promptly and fairly. + +The GC is obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +The GC will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from the GC, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media and forums. + +Although this list cannot be exhaustive, we explicitly honor diversity in age, culture, ethnicity, gender identity or expression, language, national origin, political beliefs, profession, race, religion, sexual orientation, socioeconomic status, and technical ability. We will not tolerate discrimination based on any of the protected characteristics above, including participants with disabilities. + +Violating these terms may lead to a temporary or permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations \ No newline at end of file diff --git a/README.md b/README.md index a2062a1..2289cc3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ Dart SDK for [Web5](https://github.com/TBD54566975/web5-spec?tab=readme-ov-file#web5-sdk-features) + +![GitHub License](https://img.shields.io/github/license/tbd54566975/web5-dart) ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/tbd54566975/web5-dart/ci.yaml) ![Pub Version](https://img.shields.io/pub/v/typeid?link=https%3A%2F%2Fpub.dev%2Fpackages%2Fweb5) ![Pub Publisher](https://img.shields.io/pub/publisher/web5) ![Pub Points](https://img.shields.io/pub/points/web5) + > [!WARNING] > 🚧 WIP 👷 \ No newline at end of file