Skip to content

update api to be compat with js-sdk #4

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

Open
predatorx7 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update api to be compat with js-sdk #4

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
29 changes: 29 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Changelog

All notable changes to this project will be documented in this file.

## [2.0.0] - 2026-03-09

### Added
- **1-to-1 JavaScript SDK Parity**: `ReclaimProofRequest` now directly mirrors the capabilities and documentation of `@reclaimprotocol/js-sdk`.
- Complete set of callback URL endpoints parameters including `cancelCallbackUrl` and `cancelRedirectUrl`.
- Modal customization parameters via `set_modal_options` and `close_modal`.
- Claim creation type overrides via `set_claim_creation_type`.
- `set_json_context` alongside legacy `add_context`.
- Lifecycle methods `start_session`, `get_session_id`, `get_cancel_callback_url`, `get_json_proof_response`.
- Explicit `method` and `body` payload parameters added to `set_redirect_url` and `set_cancel_redirect_url`.
- Expanded JSON serialization compatibility preserving parity across TypeScript/Python JSON payloads using `to_json_string` and `from_json_string`.
- Implemented robust global signature validation checking the global test attestors pool automatically by fetching from the backend API.
- Fully mirrored JS documentation strings for all SDK functions enabling identical developer experience and rich IDE typing hinting.

### Changed
- Refactored `verify_proof` to rely on global dynamic attestors validation instead of solely local signature matching.
- **Breaking**: `Context` object schema unified with JS SDK handling (defaults to `"sample context"`).
- **Breaking**: Default export serialization variables matching structural expectations of the JavaScript backend payload processors.

### Deprecated
- `add_context(address, message)` has been deprecated in favor of `set_context(address, message)` which behaves equivalently. It will be removed in a future version.
- `set_callback_url(url)` has been marked as deprecated in favor of `set_app_callback_url`.

### Fixed
- Fixed URL constructor formatting omissions resulting in mismatched request template structures matching the iOS/Android apps constraints.
2 changes: 1 addition & 1 deletion LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2024 Reclaim Protocol
Copyright (c) 2024-2026 Reclaim Protocol

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
20 changes: 20 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
.PHONY: install test build deploy clean

install:
pip install -e .
pip install build twine

test:
cd tests/js_compat && npm install
python3 -m unittest discover tests

build: clean
python3 -m build

deploy: test build
python3 -m twine upload dist/*

clean:
rm -rf build/
rm -rf dist/
rm -rf src/*.egg-info/
Loading