Skip to content
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.

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

chore: Update web-client API and remove off/on chain references #685

Merged
merged 4 commits into from
Jan 23, 2025

Conversation

igamigo
Copy link
Collaborator

@igamigo igamigo commented Jan 22, 2025

Also makes the idxdb store only compile for WASM targets

@igamigo igamigo requested a review from dagarcia7 January 22, 2025 17:24
@igamigo igamigo force-pushed the igamigo-note-scripts-wasm branch from 4bbd530 to cdc5137 Compare January 22, 2025 17:27
@igamigo igamigo changed the title feat: Re-export standard note creation functions on web-client chore: Update web-client API and remove off/on chain references Jan 22, 2025
@igamigo igamigo force-pushed the igamigo-note-scripts-wasm branch from c7be47e to 7357286 Compare January 22, 2025 17:35
@igamigo igamigo linked an issue Jan 22, 2025 that may be closed by this pull request
@@ -20,6 +20,9 @@ use crate::{
transactions::{TransactionRecord, TransactionStoreUpdate},
};

#[cfg(not(target_arch = "wasm32"))]
compile_error!("The `idxdb` feature is only supported when targeting wasm32.");
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💯

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the changes in here are fine, but since I haven't paid too much attention to the docs lately, I was looking at TypeDoc to see if we can just automatically generate documentation for the SDK calls from the Typescript typings. We can even add any additional context we want as rust docs on the web client calls and it should show up in the typings .d.ts file and ultimately in the auto-generated docs. Doesn't have to be in this PR, but something to think about for a near future issue.

Copy link
Collaborator

@SantiagoPittella SantiagoPittella left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@igamigo igamigo merged commit 8d55ed4 into next Jan 23, 2025
15 checks passed
@igamigo igamigo deleted the igamigo-note-scripts-wasm branch January 23, 2025 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Smaller improvements to web-client
3 participants