From 1ec9b9ce9ee7277af6f3ce12115a5be0e9ed1f5c Mon Sep 17 00:00:00 2001 From: Cayo Puigdefabregas Date: Thu, 6 Jun 2024 10:36:42 +0200 Subject: [PATCH] update READMES --- README.md | 8 ++++++++ README_es.md | 9 +++++++++ 2 files changed, 17 insertions(+) diff --git a/README.md b/README.md index bcace63..29c7774 100644 --- a/README.md +++ b/README.md @@ -144,3 +144,11 @@ This document is an example and in production it must be adapted to contain the did = generate_did(key, url) definitive_url, document = gen_did_document(did, key) ``` + +# Differences with didkit from spruceId: +Although there is didkit support, there are some small differences in behavior. + +## Namespaces: +In didkit it is necessary to define in the context every name, (key) used in the credential or else both the signature and the verification will fail. +In pyvckit if a name, (key) is used but is not defined in the context, then that signature or verification will filter out that part of the credential and ignore it as if it did not exist. +The signature will be made by deleting that undefined part. diff --git a/README_es.md b/README_es.md index dd6f9dc..e442cab 100644 --- a/README_es.md +++ b/README_es.md @@ -144,3 +144,12 @@ Este documento es un ejemplo y en producción hay que adaptarlo para contener la did = generate_did(key, url) definitive_url, document = gen_did_document(did, key) ``` + +# Diferencias con didkit de spruceId: +Aunque hay compatibilidad con didkit, hay algunas pequeñas diferencias en el comportamiento. + +## Espacios de nombres: +En didkit es necesario definir en el contexto todo nombre, (clave) usada en la credencial o si no fallará tanto la firma como la verificación. +En pyvckit si un nombre, (clave) se usa pero no esta definido en el contexto, entonces esa firma o verificación filtrará esa parte de la credencial y la omitirá como si no existiera. +La firma se hará borrando esa parte no definida. +