Skip to content

docs: clarify 1-of-N auditor signature semantics - #1404

Merged
adecaro merged 2 commits into
LFDT-Panurus:mainfrom
sid200727:docs/clarify-auditor-signatures
Mar 16, 2026
Merged

docs: clarify 1-of-N auditor signature semantics#1404
adecaro merged 2 commits into
LFDT-Panurus:mainfrom
sid200727:docs/clarify-auditor-signatures

Conversation

@sid200727

Copy link
Copy Markdown
Contributor

Summary

This PR clarifies the semantics of auditor signature validation in the token SDK.

Background

The current implementation follows a 1-of-N auditor signature policy:

  • If auditors are configured in the public parameters, at least one valid auditor signature must be present.
  • Multiple auditor public keys may be configured (e.g., during key rotation).
  • Each provided auditor signature is independently verified.
  • N-of-N semantics are not enforced.
  • All configured auditor public keys are treated as belonging to a single logical auditor entity.

The existing behavior was correct but not explicitly documented, which could lead to ambiguity when reviewing or extending the validator logic.

Changes

  • Added detailed documentation to validator_auditing.go explaining the current signature model.
  • Clarified auditor semantics in core-token.md.

Impact

This PR does not change runtime behaviour.
It only documents the existing semantics to make the intended policy explicit.

@adecaro
adecaro force-pushed the docs/clarify-auditor-signatures branch from 4118e80 to eaf3a02 Compare March 5, 2026 17:36
@adecaro
adecaro self-requested a review March 5, 2026 17:39
@adecaro adecaro self-assigned this Mar 5, 2026
@adecaro adecaro added the documentation Improvements or additions to documentation label Mar 5, 2026
@adecaro adecaro added this to the Q1/26 milestone Mar 5, 2026
@adecaro adecaro linked an issue Mar 5, 2026 that may be closed by this pull request
Comment thread token/core/common/validator_auditing.go Outdated
// single logical auditor entity.
//
// This behavior matches the semantics implemented by current token drivers.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please, remove this line so that the comments are bound to the function

@adecaro adecaro left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @sid200727 , sorry for the late review.
Thanks a lot for this clarification. It matches the current behavior.
Please, just remove the extra line and I'll merge.

@adecaro
adecaro force-pushed the docs/clarify-auditor-signatures branch from eaf3a02 to 671ce6a Compare March 9, 2026 15:35
@adecaro

adecaro commented Mar 10, 2026

Copy link
Copy Markdown
Contributor

@sid200727 , there is still an extra new line before the comments and the function name.

@adecaro
adecaro force-pushed the docs/clarify-auditor-signatures branch from 671ce6a to 0950c8e Compare March 12, 2026 15:05
@sid200727
sid200727 force-pushed the docs/clarify-auditor-signatures branch from bb1f542 to 90cffba Compare March 13, 2026 04:56
@adecaro

adecaro commented Mar 13, 2026

Copy link
Copy Markdown
Contributor

@sid200727 , I still see the extra line. Strange. What can it be?
It is the one above the declaration of the function AuditingSignaturesValidate.

@adecaro
adecaro force-pushed the docs/clarify-auditor-signatures branch 2 times, most recently from 80b99ca to f214dc5 Compare March 16, 2026 08:47
@adecaro

adecaro commented Mar 16, 2026

Copy link
Copy Markdown
Contributor

Hi @sid200727 , could you check again my comment, please?

@sid200727

Copy link
Copy Markdown
Contributor Author

Thanks for the reminder! I checked the comment again and verified that the documentation block is directly attached to the AuditingSignaturesValidate function without extra blank lines between the comment and the function.

@sid200727
sid200727 force-pushed the docs/clarify-auditor-signatures branch from f214dc5 to 82bf7dc Compare March 16, 2026 09:25
Signed-off-by: Siddhi Khandelwal <siddhi.200727@gmail.com>
Signed-off-by: Siddhi Khandelwal <siddhi.200727@gmail.com>
@adecaro
adecaro force-pushed the docs/clarify-auditor-signatures branch from 82bf7dc to f9fdb01 Compare March 16, 2026 09:29
@adecaro
adecaro self-requested a review March 16, 2026 13:03

@adecaro adecaro left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@adecaro
adecaro merged commit 82dee98 into LFDT-Panurus:main Mar 16, 2026
97 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Ambiguous requirement of auditor signatures

2 participants