* Improve SDK rustdoc and add ARCHITECTURE.md files
- Rewrite lib.rs module docs with quick-start example and module overview
- Add stream example and include_str! ARCHITECTURE.md to mixnet module
- Add ARCHITECTURE.md for mixnet, client_pool, and stream modules
- Add rustdoc to MixnetClientBuilder, MixnetClientSender, MixnetMessageSender
- Add cancel safety and drop behavior annotations to async methods
- Add TcpProxy deprecation notice pointing to stream module
* Fix rustdoc errors and add stepwise comments to remaining examples
Rustdoc fixes:
- Add missing .unwrap() on connect_new example
- Replace broken turbofish intra-doc link in MixnetClientBuilder
- Fix NymProxyServer::new args in tcp_proxy example
- Wrap BandwidthImporter example in scoped block to fix borrow-then-move
- Change misleading "5-hop routing" to "multi-hop routing"
- Fix copy-paste "forget me" in send_remember_me error message
- Fix wrong cargo run command in stream_simple_read_write
- Fix DecayWrapper description
* Cut down doc comment length
* Trimmed down SDK ARCHITECTURE files
* Slim Rust SDK docs and rename opener to dialer
- Merge tour page into SDK landing page, delete tour.mdx
- Trim all three tutorials: cut boilerplate, duplicated code, and misplaced content
- Make FFI page evergreen with Go and C++ snippets, link to repo examples
- Rename "opener" to "dialer" in stream docs, source ARCHITECTURE.md, and rustdoc
- Add reply-to-open arrow in stream mermaid diagram
- Replace remaining Unicode dashes in mermaid flowchart
* - elevate streams in rustdoc: examples on lib.rs, MixnetClient, open_stream, listener
- add stream quick reference to mixnet ARCHITECTURE.md
- add stream types to key types list in ARCHITECTURE.md
- add docs.rs links for AsyncRead/AsyncWrite and stream submodule
- tcp_proxy: replace bold deprecation with warning box
* - replace individual example doc pages with GitHub-linked tables
- add step-by-step inline comments to all SDK example source files
- add doc comments to examples missing them (simple, surb_reply, builder, etc.)
- expand mixnet tutorial with persistent identity and split_sender sections
- add tcpproxy tutorial
- rename "API Reference" to "TypeDoc Reference" in TS SDK sidebar
- rename "Misc" to "Extras" in developer sidebar, move VPN CLI up
- remove echo server from tools
- update message-queue callout to reference actual modules
- fix mixnet/examples redirect collision
* Add missing mut to example code
* Update ARCHITECTURE.md with LP Framing + stream examples with sequencing
* Update doc comment in utils.rs
* Standardise commenting style across Rust SDK examples
* Fix inline doc examples and trim re-export boilerplate
* Update sdk/rust/nym-sdk/examples/bandwidth.rs
Co-authored-by: Simon Wicky <simon@nymtech.net>
* Fix review comments
---------
Co-authored-by: Simon Wicky <simon@nymtech.net>
add offline ecash library
minor changes in coconut benchmarks
add ecash smart contract
change contract traits from coconut to ecash
first wave of andrew's suggestion
first wave of andrew's suggestion
second wave of andrew's suggestion for ecash lib
andrew's suggestion for ecash contract
licensing commit
safety comments for most unwraps
more unwrap handling
change chrono crate for time
latest cargo lock
error revamp
small visibility fix
small fix
remove indexedmap from contract + some tweaks
add cw2 version in ecash contract
remove envryption key from contract
change types from coconut to ecash types
adapt api model for credential issuance
adapt issued credential storage on API
add signatures cache on API
change API routes for new blind signing
modify issued_credential table
add issuance logic client-side
credential and signature storage client side
utils for credential issuance
first wave of fix
some of andrew's suggestions
remove encryption key from deposit
freepass issuance client side
freepass issuance API side
andrew's suggested fixes
other suggested fix
adapt change from PR below
allow offline verification flag
credential spending models
credential spending models for client
credential preperation for the client
credential preperation for the client
credential storage for spending on client
bloom filter for API
spent credential storage on validators
API route for spending online and offline ecash
API routes in the client lib
credential storage on gateway
ecash verifier to replace coconut verifier
accept credentials on gateway
bandwidth expiration for gateways
client ask for more bandwidth if it runs out
credential import
adapt nym validator rewarder and sdk
fix tests api tests and add constants
cargo fmt and lock and small test fix
cargo fmt and lock and small test fix
cargo lock
move stuff where they belong in ecash and static parameters
move some constants, error handling and phase out time crate
error revamp part 2
secret key by ref instead of clone
change l in wallet and v visibility
rework payinfo
rework monster tuples
fix expiration date signature cloning
minor fixes
final bits and bobs fixes
final bits and bobs fixes
rename l accessor to tickets_spent
wave of fixes
second wave of fixes
change hash domain value
removed benchmark flag
remove useless stringification in storage
nuke Bandwidth voucher
change timestamps to offsetdatetime
key name change
post-rebase fixes
update nym-connect 'time' dep due to broken semver
upload ecash contract to the build server
make wasm zknym-lib compile
but it won't work properly just yet
make wasm zknym-lib compile
but it won't work properly just yet
fix typo in ecash contract deps
make sure to use 0.1.0 sphinx packet
optimise pairings in 'check_vk_pairing'
derive serde for ecash types
simplified g1 tuple byte conversion
further optimise the pairing
unified signature type + renamed nym-api coconut module to ecash
using bincode serialiser for more complex binary types
using multimiller loop instead of rayon for verifying coin indices signatures
batching signature verification wherever possible
feature-locked rayon
clippy
refactor ecash contract a bit + introduce deposit storage
reworked find_proposal_id
various minor fixed
add offline_zk_nyms to nym-node everywhere
add missing #query
change test value to fit new serialization
optimised deposits storage
removed duplicate decompression code
using deposit_id instead of transaction hash
removed freepasses
split up ecash handling
unified shared state
fixed deposit_id parsing
log recovered deposit id
removed online verification
add detailed build info to ecash contract
fixed deserialisation of deposit amount received from nyxd queries
changed deposit to only persist attached pubkey
first iteration of split of verification and redemption
basic tool for setting up new network
expanded the tool with the option to bypass DKG
rename + init network without DKG
setting up locally running apis
ecash key migration
more local functionalities
wip fixing sql schemas
gateway immediately submitting redemption proposal
and getting it passed if valid
most of the gateway logic for split redemption with error recovery
fixed gateway not persisting ecash signers
simplify creation of compatible client
create properly serialised ecash key from the beginning
rebuild missing tickets and proposals on startup
stop ticket issuance during DKG transition
fixing build issues
split out ecash storage on nym-api side
master-verification-key route
caching all the signatures and keys
implemented aggregated routes for nym-apis
swagger UI for ecash endpoints
added explicit annotation for index and expiration signatures
revamped client ticketbook storage
save all recovery information in the same underlying storage
wrapper for bloomfilter
being more aggressive with marking tickets as used
ensure client has correct signatures before making deposit
fix deserialisation of AggregatedExpirationDateSignatureResponse + add ticketbook table
split nym-api ecash routes handlers into multiple files
fixed deserialisation of encoded expiration date
add tt_gamma1 to challenge and change naming for paper consistency
rotating double spending bloomfilter
nym-api test fixes + make sure to insert initial BF params
fixed ecash benchmark code
updated contract schema
updated CI to not upload gateway/mixnode binaries
ticket bandwidth revocation
added default deserialisation for zk nym config
post-rebase fixes
* clients: make surb storage more flexible
- in the rust-sdk we make the surb storage generic and pluggable, with
the fs_backend the default.
- make it possible to disable fs_backend at runtime
* Add comment
* changelog: add note
* client-core: tidy up some minor things
mfahampshire