Juno is in **maintenance** and not actively developed anymore. # SDK The following functions are provided to help you work with document and asset data inside your Satellite. They are part of the tools available when writing serverless functions in Rust and support common tasks such as interacting with the datastore, storage, and custom hook logic. **πŸ“¦ Crate:** The SDK is provided by the [junobuild-satellite](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/index.html) crate. To use them, add this to your Cargo.toml: ``` [dependencies]junobuild-satellite = "*" ``` You have to follow the pace of the Juno release to ensure compatibility. Refer to the [maintenance guide](/docs/build/functions/development/rust.md#upgrade) for instructions. --- ## Datastore The following functions can be used to manage documents within the Datastore from your serverless functions. --- ### set\_doc\_store Sets a document in a collection’s of the datastore. Use this to insert or update document data. ``` pub fn set_doc_store( caller: UserId, collection: CollectionKey, key: Key, value: SetDoc,) -> Result, String> ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.set_doc_store.html) --- ### get\_doc\_store Retrieves a document from a collection. ``` pub fn get_doc_store( caller: UserId, collection: CollectionKey, key: Key,) -> Result, String> ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.get_doc_store.html) --- ### list\_docs\_store Lists documents in a collection based on filter criteria. ``` pub fn list_docs_store( caller: Principal, collection: CollectionKey, filter: &ListParams,) -> Result, String> ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.list_docs_store.html) --- ### count\_docs\_store Counts documents in a collection based on filter criteria. ``` pub fn count_docs_store( caller: Principal, collection: CollectionKey, filter: &ListParams,) -> Result ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.count_docs_store.html) --- ### count\_collection\_docs\_store Counts all documents in a collection. ``` pub fn count_collection_docs_store( collection: &CollectionKey) -> Result ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.count_collection_docs_store.html) --- ### delete\_doc\_store Deletes a document from a collection. ``` pub fn delete_doc_store( caller: UserId, collection: CollectionKey, key: Key, value: DelDoc,) -> Result>, String> ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.delete_doc_store.html) --- ### delete\_docs\_store Deletes all documents in a collection. ``` pub fn delete_docs_store( collection: &CollectionKey) -> Result<(), String> ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.delete_docs_store.html) --- ### delete\_filtered\_docs\_store Deletes documents matching filter criteria. ``` pub fn delete_filtered_docs_store( caller: Principal, collection: CollectionKey, filter: &ListParams,) -> Result>>, String> ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.delete_filtered_docs_store.html) --- ## Storage The following functions can be used to manage assets within the Storage from your serverless functions. --- ### set\_asset\_handler Sets an asset in the store for the identity encoding (no compression applied). ``` pub fn set_asset_handler( key: &AssetKey, content: &Blob, headers: &[HeaderField],) -> Result<(), String> ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.set_asset_handler.html) --- ### get\_asset\_store Retrieves an asset from a collection. ``` pub fn get_asset_store( caller: Principal, collection: &CollectionKey, full_path: FullPath,) -> Result, String> ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.get_asset_store.html) --- ### list\_assets\_store Lists assets in a collection, excluding their content. ``` pub fn list_assets_store( caller: Principal, collection: &CollectionKey, filters: &ListParams,) -> Result, String> ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.list_assets_store.html) --- ### count\_assets\_store Counts assets in a collection matching the filter criteria. ``` pub fn count_assets_store( caller: Principal, collection: &CollectionKey, filters: &ListParams,) -> Result ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.count_assets_store.html) --- ### count\_collection\_assets\_store Counts all assets in a collection. ``` pub fn count_collection_assets_store( collection: &CollectionKey,) -> Result ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.count_collection_assets_store.html) --- ### delete\_asset\_store Deletes an asset from a collection. ``` pub fn delete_asset_store( caller: Principal, collection: &CollectionKey, full_path: FullPath,) -> Result, String> ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.delete_asset_store.html) --- ### delete\_assets\_store Deletes all assets in a collection. ``` pub fn delete_assets_store( collection: &CollectionKey,) -> Result<(), String> ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.delete_assets_store.html) --- ### delete\_filtered\_assets\_store Deletes assets matching filter criteria. ``` pub fn delete_filtered_assets_store( caller: Principal, collection: CollectionKey, filters: &ListParams,) -> Result>, String> ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.delete_filtered_assets_store.html) --- ### set\_asset\_token\_store Set or update an access token for an asset. ``` pub fn set_asset_token_store( caller: Principal, collection: &CollectionKey, full_path: &FullPath, token: &AssetAccessToken,) -> Result, String> ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.set_asset_token_store.html) --- ### get\_content\_chunks\_store Retrieves content chunks of an asset. Particularly useful when stable memory is used. ``` pub fn get_content_chunks_store( encoding: &AssetEncoding, chunk_index: usize, memory: &Memory,) -> Option ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.get_content_chunks_store.html) --- ## Access Keys The following functions allow you to inspect and assert the access keys of your Satellite. --- ### get\_access\_keys Retrieves all access keys of the Satellite. ``` pub fn get_access_keys() -> AccessKeys ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.get_access_keys.html) --- ### get\_admin\_access\_keys Retrieves only the admin access\_keys of the Satellite. ``` pub fn get_admin_access_keys() -> AccessKeys ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.get_admin_access_keys.html) --- ### is\_valid\_access\_key Checks if a principal is a non-expired access key regardless of scope (admin, write, or submit). ``` pub fn is_valid_access_key( id: Principal, access_keys: &AccessKeys,) -> bool ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.is_valid_access_key.html) --- ### is\_write\_access\_key Checks if a principal is a non-expired access key with admin or write scope. ``` pub fn is_write_access_key( id: Principal, access_keys: &AccessKeys,) -> bool ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.is_write_access_key.html) --- ### is\_admin\_controller Checks if a principal is an admin access key and a controller known by the Internet Computer. ``` pub fn is_admin_controller( id: Principal, access_keys: &AccessKeys,) -> bool ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.is_admin_controller.html) --- ## Guards The following guard functions can be used to validate the caller in your custom serverless functions. --- ### caller\_is\_admin Guards that the caller is an admin access key of this satellite. Admin access keys have full management privileges and never expire. ``` pub fn caller_is_admin() -> Result<(), String> ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.caller_is_admin.html) --- ### caller\_has\_write\_permission Guards that the caller has write permission. Admin and editor access keys pass; submitter access keys do not. ``` pub fn caller_has_write_permission() -> Result<(), String> ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.caller_has_write_permission.html) --- ### caller\_is\_access\_key Guards that the caller is any recognized access key of this satellite. Accepts admin, editor, and submitter access keys alike. ``` pub fn caller_is_access_key() -> Result<(), String> ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.caller_is_access_key.html) --- ## Others The SDK also provides various Satellite-specific functions --- ### random Generates a random `i32`. **Caution:** The generator is seeded once after upgrade of the Satellite. This makes it unsuitable for use cases requiring unpredictable randomness, like lotteries. ``` pub fn random() -> Result ``` πŸ“¦ See full definition on [docs.rs](https://docs.rs/junobuild-satellite/latest/junobuild_satellite/fn.random.html)