Skip to content

docs(course_access): complete save_user_profile docstring with Returns section #239

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
Divine-designs wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(course_access): complete save_user_profile docstring with Returns section #239

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
28 changes: 18 additions & 10 deletions contracts/course/course_access/src/functions/save_profile.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,26 @@ const SAVE_USER_PROFILE_EVENT: Symbol = symbol_short!("saveUsPrl");

/// Save a minimal on-chain user profile.
///
/// Stores only the user's address and an off-chain reference ID.
/// All PII (name, email, profession, goals, country) is stored off-chain.
/// Stores only the user's address and an off-chain reference ID under
/// `DataKey::UserProfile(user)` in persistent storage and emits a
/// `saveUsPrl` event with `(user, off_chain_ref_id)`. All PII (name,
/// email, profession, goals, country) lives off-chain and is keyed by
/// `off_chain_ref_id`.
///
/// # Arguments
/// * `env` - Soroban environment
/// * `off_chain_ref_id` - UUID/hash mapping to the user's full record in the off-chain DB
/// * `user` - The user's blockchain address
pub fn save_user_profile(
env: Env,
off_chain_ref_id: String,
user: Address,
) {
///
/// * `env` - The Soroban environment for storage and event access.
/// * `off_chain_ref_id` - UUID or hash mapping to the user's full record
/// in the off-chain database. Must be non-empty.
/// * `user` - The user's blockchain address that the profile belongs to.
///
/// # Returns
///
/// * `()` - The function returns the unit type on success. On failure
/// (empty `off_chain_ref_id`) it does not return — `handle_error`
/// raises `Error::OffChainRefIdRequired`, which halts contract
/// execution with the corresponding error code.
pub fn save_user_profile(env: Env, off_chain_ref_id: String, user: Address) {
// Validate required field
if off_chain_ref_id.is_empty() {
handle_error(&env, Error::OffChainRefIdRequired)
Expand Down
Loading