Skip to main content

Apache 2.0 reference implementation of an agent that emits an AlgoVoi settlement-attestation-v1 receipt for a Base chain transaction. End-to-end worked example demonstrating the AlgoVoi-authored substrate discipline.

Project description

algovoi-reference-agent

License: Apache 2.0 PyPI

Apache 2.0 reference implementation of an agent that emits an AlgoVoi settlement-attestation-v1 receipt for a Base chain transaction. End-to-end worked example demonstrating the AlgoVoi-authored substrate discipline.

What this is

A minimal open-source agent that:

  1. Performs a Base chain transaction (live RPC or deterministic stub)
  2. Emits a settlement-attestation-v1 receipt under urn:x402:canonicalisation:jcs-rfc8785-v1
  3. Derives an action_ref = SHA-256(JCS(preimage)) per the AlgoVoi-authored discipline
  4. Self-verifies the canonical bytes against the AlgoVoi conformance corpus

The receipt format is normatively specified in IETF Internet-Draft draft-hopley-x402-settlement-attestation. The canonicalisation discipline is specified in draft-hopley-x402-canonicalisation-jcs-v1.

Quick start

pip install algovoi-reference-agent
algovoi-agent emit --chain base --amount 0.001

Output: a JSON settlement-attestation-v1 receipt to stdout, the derived action_ref, and a local self-verification result.

Pipeline

Agent action (Base txn, live or stub)
      |
      v
algovoi-substrate (JCS canonicalisation, action_ref derivation)
      |
      v
algovoi-settlement-attestation (receipt format)
      |
      v
{ canonical_bytes, action_ref, receipt_json }
      |
      v (downstream: any consumer)
   Reputation systems, audit chains, third-party verifiers, or any
   party consuming the AlgoVoi-format receipt under Apache 2.0.

Conformance

This reference agent validates against chopmob-cloud/algovoi-jcs-conformance-vectors on every receipt emission. Byte-for-byte agreement against the settlement_attestation_v1 vector set is required.

Composed libraries

Package Purpose Registry
algovoi-substrate JCS canonicalisation, action_ref derivation PyPI / npm
algovoi-settlement-attestation Settlement attestation receipt format PyPI / npm
algovoi-audit-verifier Local conformance verification PyPI / npm

All Apache 2.0, AlgoVoi sole authorship.

Adopters Registry

If you ship a derived agent that emits AlgoVoi-format receipts, you are welcome to list your project at docs.algovoi.co.uk/adopters. The registry is the AlgoVoi-controlled attestation route. Submissions are validated byte-deterministically against the public conformance corpus.

Examples

See examples/:

  • 01_emit_settlement_attestation.py: minimal emit example
  • 02_verify_receipt.py: verify a received receipt locally
  • 03_end_to_end_pipeline.py: agent runs txn, emits receipt, self-verifies

Substrate authorship

The receipt format and canonicalisation discipline this agent emits are sole AlgoVoi authorship, anchored on the IETF Independent Submission stream. The reference implementation libraries are published under AlgoVoi authorship on PyPI and npm. The conformance corpus is maintained at chopmob-cloud/algovoi-jcs-conformance-vectors.

License

Apache 2.0. See LICENSE and NOTICE.

Apache 2.0 grants permission to USE, MODIFY, and DISTRIBUTE this reference code. It does not grant permission to republish the normative receipt format, the canonicalisation discipline, or the settlement-attestation-v1 schema under a different authorship.

-- AlgoVoi (chopmob-cloud) https://docs.algovoi.co.uk/acquisition

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

algovoi_reference_agent-0.1.0.tar.gz (17.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

algovoi_reference_agent-0.1.0-py3-none-any.whl (16.1 kB view details)

Uploaded Python 3

File details

Details for the file algovoi_reference_agent-0.1.0.tar.gz.

File metadata

  • Download URL: algovoi_reference_agent-0.1.0.tar.gz
  • Upload date:
  • Size: 17.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for algovoi_reference_agent-0.1.0.tar.gz
Algorithm Hash digest
SHA256 bfab8c9b5cd4052714f567a43b89d9de31475e659033c46d511f79d509e22297
MD5 a714c788cb473f2d03d55d113cdff888
BLAKE2b-256 17cd0b0d46fe4b20b962bf4ae433d5b3e034c316d887fcecf8c62694bd25998f

See more details on using hashes here.

File details

Details for the file algovoi_reference_agent-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for algovoi_reference_agent-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6eff491447443751aebed8471d8e995f50ce1bc8387c86568bed09f31e4c491d
MD5 c09fd891be60a3213ce29a0524341ccf
BLAKE2b-256 da886c172dbc98af0c03cf3849e08dc7d255208bfb88d35370c04df4dc5dd185

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page