ZK-643: General bindings crate #76

kroist · 2025-01-06T14:10:40Z

This pull request introduces a new crate, shielder_bindings, which provides WebAssembly (WASM) and mobile bindings (uniffi-rs) for the Shielder cryptographic operations.

Key changes include:

New Crate Setup:

[crates/shielder_bindings/Cargo.toml]: Added new crate shielder_bindings which is mostly a copy of shielder-wasm crate, but currently only with poseidon hash and private-key-to-scalar conversion.

Build and Configuration:

[crates/shielder_bindings/Makefile]: Added separate makefile targets for building WASM packages and iOS bindings.
[crates/shielder_bindings/Cargo.toml]: Added feature flags for binding generation options:
- build-wasm - webassembly
- multithreading-wasm - optional multithreaded webassembly
- build-uniffi - mobile bindings through uniffi

Documentation:

[crates/shielder_bindings/README.md]: Added README with an overview, build instructions for WebAssembly and iOS, and prerequisites.

github-actions · 2025-01-06T14:18:01Z

Transaction Name	Main	Current	Difference (%)
NewAccountNative	2000347	2000263	-0.00420%
DepositNative	1827930	1827942	+0.00066%
WithdrawNative	1898102	1898090	-0.00063%

pmikolajczyk41

few small comments, but no blockers; feel free to resolve them on your own

good job with taking care of two completely different compilation targets!

pmikolajczyk41 · 2025-01-07T09:00:37Z

crates/shielder_bindings/Cargo.toml

@@ -0,0 +1,60 @@
+[package]
+name = "shielder_bindings"


all other crates in this repo (and crate directories) use dash instead of underscore; if you don't mind - please rename

unfortunately uniffi breaks if we use dash :D

pmikolajczyk41 · 2025-01-07T09:01:23Z

crates/shielder_bindings/Cargo.toml

+edition.workspace = true
+authors = ["Cardinal", "Piotr Roslaniec <[email protected]>"]
+homepage.workspace = true
+license = "Apache-2.0"


licence can be inherited as well

pmikolajczyk41 · 2025-01-07T09:01:51Z

crates/shielder_bindings/Cargo.toml

+rand = { workspace = true, features = ["small_rng"] }
+rand_chacha = { workspace = true }
+rand_core = { workspace = true }


unused deps

pmikolajczyk41 · 2025-01-07T09:01:59Z

crates/shielder_bindings/Cargo.toml

+rand_chacha = { workspace = true }
+rand_core = { workspace = true }
+rayon = { workspace = true, optional = true }
+sha2 = { workspace = true }


pmikolajczyk41 · 2025-01-07T09:02:11Z

crates/shielder_bindings/Cargo.toml

+wasm-bindgen = { workspace = true, optional = true }
+
+[build-dependencies]
+rand = { workspace = true, features = ["small_rng"] }


pmikolajczyk41 · 2025-01-07T09:08:30Z

crates/shielder_bindings/package.template.json

+  "description": "WASM bindings for Shielder cryptography. Intended for use in web applications.",
+  "license": "Apache-2.0",
+  "author": "Cardinal",
+  "contributors": [


should we expand this section?

If you mean to expand it with our names, it seems to me that "author: Cardinal" covers us sufficiently, and we can leave "contributors" just for any external contributors, otherwise we'd need to start putting our names everywhere.

pmikolajczyk41 · 2025-01-07T09:10:08Z

crates/shielder_bindings/src/conversions.rs

+use wasm_bindgen::prelude::wasm_bindgen;
+
+#[cfg_attr(feature = "build-wasm", wasm_bindgen)]
+pub fn private_key_to_f(hex: &str) -> Vec<u8> {


if you don't want to remove the source of this copy-paste (from shielder-wasm) in this PR, pls add at least deprecation

pmikolajczyk41 · 2025-01-07T09:11:40Z

crates/shielder_bindings/src/lib.rs

+#![cfg_attr(not(feature = "build-uniffi"), no_std)]
+
+#[cfg(feature = "build-uniffi")]
+uniffi::setup_scaffolding!();
+
+#[cfg(feature = "multithreading-wasm")]
+pub use wasm_bindgen_rayon::init_thread_pool;
+
+extern crate alloc;


I think we should include building this crate with different feature flags in our CI (probably by just calling Makefile targets)

Really want to do this later, when the critical part is written and working

pmikolajczyk41 · 2025-01-07T09:12:41Z

crates/shielder_bindings/Makefile

+else
+	SED_CMD := sed -i
+endif
+


you might add help target as we do in other Makefiles

pmikolajczyk41 · 2025-01-07T09:19:34Z

crates/shielder_bindings/README.md

+- Rust toolchain (see rust-toolchain.toml)
+- wasm-pack (for WebAssembly builds)
+- Rust target: aarch64-apple-ios-sim (for iOS simulator builds)
+


something more, because when I do make ios I get error: failed to get iphonesimulator SDK path: No such file or directory (os error 2)

guspiel

Cool:)

guspiel · 2025-01-07T13:16:39Z

crates/shielder_bindings/package.template.json

@@ -0,0 +1,19 @@
+{
+  "name": "shielder-wasm",


leftover name?

guspiel · 2025-01-07T13:17:40Z

crates/shielder_bindings/package.template.json

+{
+  "name": "shielder-wasm",
+  "version": "0.0.1",
+  "description": "WASM bindings for Shielder cryptography. Intended for use in web applications.",


maybe "zkOS cryptography" here in the description?

guspiel · 2025-01-07T13:30:56Z

crates/shielder_bindings/package.template.json

+  "description": "WASM bindings for Shielder cryptography. Intended for use in web applications.",
+  "license": "Apache-2.0",
+  "author": "Cardinal",
+  "contributors": [


If you mean to expand it with our names, it seems to me that "author: Cardinal" covers us sufficiently, and we can leave "contributors" just for any external contributors, otherwise we'd need to start putting our names everywhere.

guspiel · 2025-01-07T13:32:05Z

crates/shielder_bindings/Cargo.toml

+[package]
+name = "shielder_bindings"
+version = "0.1.0"
+description = "WASM and mobile bindings for the shielder-circuits"


nit: I think language sounds better if you remove "the" from the description, because shielder-circuits is a crate name

guspiel · 2025-01-07T13:48:30Z

crates/shielder_bindings/src/hash.rs

@@ -0,0 +1,35 @@
+use alloc::vec::Vec;


Could you name this module differently? This is not just hashing. Perhaps "primitives" (seen this in Poseidon repo)? This term seems to cover both important constants and the hash function.

guspiel · 2025-01-07T13:52:16Z

crates/shielder_bindings/src/hash.rs

+
+#[cfg_attr(feature = "build-wasm", wasm_bindgen)]
+#[cfg_attr(feature = "build-uniffi", uniffi::export)]
+pub fn arity() -> u32 {


Usage looks cool:) Nice that we have one interface for both binding libraries.

kroist added 3 commits January 6, 2025 12:50

move WASM to new shielder_bindings crate

351bcd6

add uniffi bindings and set up compilation

619ffeb

use multithreading for uniffi, optional multithreading for wasm

76e7cc7

upd description

026658e

pmikolajczyk41 self-requested a review January 7, 2025 08:48

pmikolajczyk41 approved these changes Jan 7, 2025

View reviewed changes

pmikolajczyk41 mentioned this pull request Jan 7, 2025

ZK-559: Add shielder-sdk-crypto package #77

Merged

guspiel approved these changes Jan 7, 2025

View reviewed changes

upd

77684b6

kroist merged commit 2bb3528 into main Jan 7, 2025
14 checks passed

kroist deleted the general-bindings-crate branch January 7, 2025 16:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ZK-643: General bindings crate #76

ZK-643: General bindings crate #76

kroist commented Jan 6, 2025 •

edited

Loading

github-actions bot commented Jan 6, 2025 •

edited

Loading

pmikolajczyk41 left a comment

pmikolajczyk41 Jan 7, 2025

kroist Jan 7, 2025

pmikolajczyk41 Jan 7, 2025

pmikolajczyk41 Jan 7, 2025

pmikolajczyk41 Jan 7, 2025

pmikolajczyk41 Jan 7, 2025

pmikolajczyk41 Jan 7, 2025

guspiel Jan 7, 2025

pmikolajczyk41 Jan 7, 2025

pmikolajczyk41 Jan 7, 2025

kroist Jan 7, 2025

pmikolajczyk41 Jan 7, 2025

pmikolajczyk41 Jan 7, 2025

guspiel left a comment

guspiel Jan 7, 2025

guspiel Jan 7, 2025

guspiel Jan 7, 2025

guspiel Jan 7, 2025

guspiel Jan 7, 2025

guspiel Jan 7, 2025

ZK-643: General bindings crate #76

ZK-643: General bindings crate #76

Conversation

kroist commented Jan 6, 2025 • edited Loading

New Crate Setup:

Build and Configuration:

Documentation:

github-actions bot commented Jan 6, 2025 • edited Loading

pmikolajczyk41 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

guspiel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kroist commented Jan 6, 2025 •

edited

Loading

github-actions bot commented Jan 6, 2025 •

edited

Loading