Skip to content

Align Python receipt verifier with TypeScript parity for receipt_id semantics #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
GsCommand wants to merge 1 commit into from
Closed

Align Python receipt verifier with TypeScript parity for receipt_id semantics #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions python-sdk/commandlayer/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ class VerifyOptions(TypedDict, total=False):
class VerifyChecks(TypedDict):
hash_matches: bool
signature_valid: bool
receipt_id_present: bool
receipt_id_matches: bool
alg_matches: bool
canonical_matches: bool
Expand Down
5 changes: 4 additions & 1 deletion python-sdk/commandlayer/verify.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,7 @@ def verify_receipt(receipt: CanonicalReceipt | CommandResponse, public_key: str
metadata = target.get("metadata") if isinstance(target, dict) else None
receipt_id_value = metadata.get("receipt_id") if isinstance(metadata, dict) else None
receipt_id = receipt_id_value if isinstance(receipt_id_value, str) else None
receipt_id_present = receipt_id is not None
receipt_id_matches = not receipt_id or not claimed_hash or receipt_id == claimed_hash

pubkey: bytes | None = None
Expand Down Expand Up @@ -239,10 +240,11 @@ def verify_receipt(receipt: CanonicalReceipt | CommandResponse, public_key: str
signature_error = str(err)

return {
"ok": alg_matches and canonical_matches and hash_matches and receipt_id_matches and signature_valid,
"ok": alg_matches and canonical_matches and hash_matches and signature_valid,
"checks": {
"hash_matches": hash_matches,
"signature_valid": signature_valid,
"receipt_id_present": receipt_id_present,
"receipt_id_matches": receipt_id_matches,
"alg_matches": alg_matches,
"canonical_matches": canonical_matches,
Expand Down Expand Up @@ -272,6 +274,7 @@ def verify_receipt(receipt: CanonicalReceipt | CommandResponse, public_key: str
"checks": {
"hash_matches": False,
"signature_valid": False,
"receipt_id_present": isinstance(metadata, dict) and isinstance(metadata.get("receipt_id"), str),
"receipt_id_matches": False,
"alg_matches": False,
"canonical_matches": False,
Expand Down
1 change: 1 addition & 0 deletions typescript-sdk/scripts/unit-tests.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ await assertRejects(

const receipt = {
status: "success",
verb: "summarize",
result: { summary: "test" },
metadata: {
proof: {
Expand Down
16 changes: 11 additions & 5 deletions typescript-sdk/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@ const VERBS = [

export type Verb = (typeof VERBS)[number];
export type ReceiptStatus = "success" | "error" | string;
export type ReceiptProtocolMetadata = {
verb?: string;
version?: string;
[k: string]: unknown;
};

export type ReceiptProof = {
alg: typeof CANONICAL_ALG;
Expand Down Expand Up @@ -76,12 +81,12 @@ export type RuntimeMetadata = {
[k: string]: unknown;
};

export type CommandResponse<TResult = unknown, TError = unknown> = {
receipt: CanonicalReceipt<TResult, TError>;
export type CommandResponse<TResult = unknown> = {
receipt: CanonicalReceipt<TResult>;
runtime_metadata?: RuntimeMetadata;
};

export type LegacyBlendedReceipt<TResult = unknown, TError = unknown> = CanonicalReceipt<TResult, TError> & {
export type LegacyBlendedReceipt<TResult = unknown> = CanonicalReceipt<TResult> & {
trace?: RuntimeMetadata;
};

Expand Down Expand Up @@ -295,7 +300,7 @@ function extractReceipt(subject: CanonicalReceipt | CommandResponse | LegacyBlen

export function extractReceiptVerb(subject: CanonicalReceipt | CommandResponse | LegacyBlendedReceipt): string | null {
const receipt = extractReceipt(subject);
return isRecord(receipt.x402) && typeof receipt.x402.verb === "string" ? receipt.x402.verb : null;
return getReceiptVerb(receipt);
}

export function normalizeCommandResponse<T = unknown>(payload: unknown): CommandResponse<T> {
Expand Down Expand Up @@ -349,6 +354,7 @@ export async function verifyReceipt(receiptLike: CanonicalReceipt | CommandRespo
const { hash_sha256: recomputedHash } = recomputeReceiptHashSha256(receipt);
const hashMatches = claimedHash === recomputedHash;
const receiptId = typeof receipt.metadata?.receipt_id === "string" ? receipt.metadata.receipt_id : null;
const receiptIdPresent = typeof receipt.metadata?.receipt_id === "string";
const receiptIdMatches = !receiptId || !claimedHash ? true : receiptId === claimedHash;

let pubkey: Uint8Array | null = null;
Expand Down Expand Up @@ -396,7 +402,7 @@ export async function verifyReceipt(receiptLike: CanonicalReceipt | CommandRespo
},
values: {
verb: getReceiptVerb(receipt),
signer_id,
signer_id: signerId,
alg,
canonical,
claimed_hash: claimedHash,
Expand Down
Loading