feat: retrieve_token_collections (#118)

Author: MartianGreed

Cargo.lock

@@ -9,10 +9,11 @@ crate-type = ["cdylib", "rlib", "staticlib"]
 [dependencies]
 dojo-world = { git = "https://github.com/dojoengine/dojo", rev = "4145801" }
 dojo-types = { git = "https://github.com/dojoengine/dojo", rev = "4145801" }
-torii-proto = { git = "https://github.com/dojoengine/torii", rev = "9a3f85b" }
-torii-client = { git = "https://github.com/dojoengine/torii", rev = "9a3f85b" }
-torii-grpc-client = { git = "https://github.com/dojoengine/torii", rev = "9a3f85b" }
-torii-libp2p-types = { git = "https://github.com/dojoengine/torii", rev = "9a3f85b" }
+torii-proto = { git = "https://github.com/dojoengine/torii", rev = "4231d80" }
+torii-client = { git = "https://github.com/dojoengine/torii", rev = "4231d80" }
+torii-grpc-client = { git = "https://github.com/dojoengine/torii", rev = "4231d80" }
+torii-typed-data = { git = "https://github.com/dojoengine/torii", rev = "4231d80" }
+torii-libp2p-types = { git = "https://github.com/dojoengine/torii", rev = "4231d80" }
 
 starknet = "0.13.0"
 starknet-crypto = "0.7.2"
@@ -70,4 +71,4 @@ base64 = "0.22.1"
 cbindgen = { git = "https://github.com/masnagam/cbindgen", branch = "fix-issue-43" }
 
 [patch.crates-io]
-crunchy = { git = "https://github.com/nmathewson/crunchy", branch = "cross-compilation-fix" }
+crunchy = { git = "https://github.com/nmathewson/crunchy", branch = "cross-compilation-fix" }

Cargo.toml

@@ -20,6 +20,7 @@ struct Subscription;
 struct Struct;
 struct Token;
 struct TokenBalance;
+struct TokenCollection;
 struct Provider;
 struct Account;
 struct Ty;
@@ -541,6 +542,33 @@ typedef struct ResultPageTokenBalance {
   };
 } ResultPageTokenBalance;
 
+typedef struct CArrayTokenCollection {
+  struct TokenCollection *data;
+  uintptr_t data_len;
+} CArrayTokenCollection;
+
+typedef struct PageTokenCollection {
+  struct CArrayTokenCollection items;
+  struct COptionc_char next_cursor;
+} PageTokenCollection;
+
+typedef enum ResultPageTokenCollection_Tag {
+  OkPageTokenCollection,
+  ErrPageTokenCollection,
+} ResultPageTokenCollection_Tag;
+
+typedef struct ResultPageTokenCollection {
+  ResultPageTokenCollection_Tag tag;
+  union {
+    struct {
+      struct PageTokenCollection ok;
+    };
+    struct {
+      struct Error err;
+    };
+  };
+} ResultPageTokenCollection;
+
 typedef struct IndexerUpdate {
   int64_t head;
   int64_t tps;
@@ -793,6 +821,15 @@ typedef struct CHashItemFieldElementModelMetadata {
   struct ModelMetadata value;
 } CHashItemFieldElementModelMetadata;
 
+typedef struct TokenCollection {
+  struct FieldElement contract_address;
+  const char *name;
+  const char *symbol;
+  uint8_t decimals;
+  uint32_t count;
+  const char *metadata;
+} TokenCollection;
+
 typedef struct Member {
   const char *name;
   struct Ty *ty;
@@ -1197,6 +1234,33 @@ struct ResultPageTokenBalance client_token_balances(struct ToriiClient *client,
                                                     uint32_t limit,
                                                     struct COptionc_char cursor);
 
+/**
+ * Gets token collections for given accounts and contracts
+ *
+ * # Parameters
+ * * `client` - Pointer to ToriiClient instance
+ * * `contract_addresses` - Array of contract addresses
+ * * `contract_addresses_len` - Length of contract addresses array
+ * * `account_addresses` - Array of account addresses
+ * * `account_addresses_len` - Length of account addresses array
+ * * `token_ids` - Array of token ids
+ * * `token_ids_len` - Length of token ids array
+ * * `limit` - Maximum number of token balances to return
+ * * `cursor` - Cursor to start from
+ *
+ * # Returns
+ * Result containing array of TokenBalance information or error
+ */
+struct ResultPageTokenCollection client_token_collections(struct ToriiClient *client,
+                                                          const struct FieldElement *contract_addresses,
+                                                          uintptr_t contract_addresses_len,
+                                                          const struct FieldElement *account_addresses,
+                                                          uintptr_t account_addresses_len,
+                                                          const struct U256 *token_ids,
+                                                          uintptr_t token_ids_len,
+                                                          uint32_t limit,
+                                                          struct COptionc_char cursor);
+
 /**
  * Subscribes to indexer updates
  *

dojo.h

@@ -806,6 +806,15 @@ struct TokenBalance {
   U256 token_id;
 };
 
+struct TokenCollection {
+  FieldElement contract_address;
+  const char *name;
+  const char *symbol;
+  uint8_t decimals;
+  uint32_t count;
+  const char *metadata;
+};
+
 struct IndexerUpdate {
   int64_t head;
   int64_t tps;
@@ -1234,6 +1243,31 @@ Result<Page<TokenBalance>> client_token_balances(ToriiClient *client,
                                                  uint32_t limit,
                                                  COption<const char*> cursor);
 
+/// Gets token collections for given accounts and contracts
+///
+/// # Parameters
+/// * `client` - Pointer to ToriiClient instance
+/// * `contract_addresses` - Array of contract addresses
+/// * `contract_addresses_len` - Length of contract addresses array
+/// * `account_addresses` - Array of account addresses
+/// * `account_addresses_len` - Length of account addresses array
+/// * `token_ids` - Array of token ids
+/// * `token_ids_len` - Length of token ids array
+/// * `limit` - Maximum number of token balances to return
+/// * `cursor` - Cursor to start from
+///
+/// # Returns
+/// Result containing array of TokenBalance information or error
+Result<Page<TokenCollection>> client_token_collections(ToriiClient *client,
+                                                       const FieldElement *contract_addresses,
+                                                       uintptr_t contract_addresses_len,
+                                                       const FieldElement *account_addresses,
+                                                       uintptr_t account_addresses_len,
+                                                       const U256 *token_ids,
+                                                       uintptr_t token_ids_len,
+                                                       uint32_t limit,
+                                                       COption<const char*> cursor);
+
 /// Subscribes to indexer updates
 ///
 /// # Parameters

dojo.hpp

@@ -345,6 +345,23 @@ cdef extern from *:
     PageTokenBalance ok;
     Error err;
 
+  cdef struct CArrayTokenCollection:
+    TokenCollection *data;
+    uintptr_t data_len;
+
+  cdef struct PageTokenCollection:
+    CArrayTokenCollection items;
+    COptionc_char next_cursor;
+
+  cdef enum ResultPageTokenCollection_Tag:
+    OkPageTokenCollection,
+    ErrPageTokenCollection,
+
+  cdef struct ResultPageTokenCollection:
+    ResultPageTokenCollection_Tag tag;
+    PageTokenCollection ok;
+    Error err;
+
   cdef struct IndexerUpdate:
     int64_t head;
     int64_t tps;
@@ -504,6 +521,14 @@ cdef extern from *:
     FieldElement key;
     ModelMetadata value;
 
+  cdef struct TokenCollection:
+    FieldElement contract_address;
+    const char *name;
+    const char *symbol;
+    uint8_t decimals;
+    uint32_t count;
+    const char *metadata;
+
   cdef struct Member:
     const char *name;
     Ty *ty;
@@ -852,6 +877,31 @@ cdef extern from *:
                                                uint32_t limit,
                                                COptionc_char cursor);
 
+  # Gets token collections for given accounts and contracts
+  #
+  # # Parameters
+  # * `client` - Pointer to ToriiClient instance
+  # * `contract_addresses` - Array of contract addresses
+  # * `contract_addresses_len` - Length of contract addresses array
+  # * `account_addresses` - Array of account addresses
+  # * `account_addresses_len` - Length of account addresses array
+  # * `token_ids` - Array of token ids
+  # * `token_ids_len` - Length of token ids array
+  # * `limit` - Maximum number of token balances to return
+  # * `cursor` - Cursor to start from
+  #
+  # # Returns
+  # Result containing array of TokenBalance information or error
+  ResultPageTokenCollection client_token_collections(ToriiClient *client,
+                                                     const FieldElement *contract_addresses,
+                                                     uintptr_t contract_addresses_len,
+                                                     const FieldElement *account_addresses,
+                                                     uintptr_t account_addresses_len,
+                                                     const U256 *token_ids,
+                                                     uintptr_t token_ids_len,
+                                                     uint32_t limit,
+                                                     COptionc_char cursor);
+
   # Subscribes to indexer updates
   #
   # # Parameters

dojo.pyx

@@ -52,8 +52,8 @@ use torii_libp2p_types::Message;
 use tower_http::cors::{AllowOrigin, CorsLayer};
 use types::{
     BlockId, CArray, COption, Call, Clause, Controller, Entity, Error, Event, IndexerUpdate,
-    KeysClause, Page, Policy, Query, Result, Signature, Struct, Token, TokenBalance, ToriiClient,
-    Ty, WorldMetadata,
+    KeysClause, Page, Policy, Query, Result, Signature, Struct, Token, TokenBalance,
+    TokenCollection, ToriiClient, Ty, WorldMetadata,
 };
 use url::Url;
 
@@ -1255,6 +1255,74 @@ pub unsafe extern "C" fn client_token_balances(
     Result::Ok(token_balances.into())
 }
 
+/// Gets token collections for given accounts and contracts
+///
+/// # Parameters
+/// * `client` - Pointer to ToriiClient instance
+/// * `contract_addresses` - Array of contract addresses
+/// * `contract_addresses_len` - Length of contract addresses array
+/// * `account_addresses` - Array of account addresses
+/// * `account_addresses_len` - Length of account addresses array
+/// * `token_ids` - Array of token ids
+/// * `token_ids_len` - Length of token ids array
+/// * `limit` - Maximum number of token balances to return
+/// * `cursor` - Cursor to start from
+///
+/// # Returns
+/// Result containing array of TokenBalance information or error
+#[no_mangle]
+pub unsafe extern "C" fn client_token_collections(
+    client: *mut ToriiClient,
+    contract_addresses: *const types::FieldElement,
+    contract_addresses_len: usize,
+    account_addresses: *const types::FieldElement,
+    account_addresses_len: usize,
+    token_ids: *const types::U256,
+    token_ids_len: usize,
+    limit: u32,
+    cursor: COption<*const c_char>,
+) -> Result<Page<TokenCollection>> {
+    let account_addresses = if account_addresses.is_null() || account_addresses_len == 0 {
+        Vec::new()
+    } else {
+        let addresses =
+            unsafe { std::slice::from_raw_parts(account_addresses, account_addresses_len) };
+        addresses.iter().map(|f| f.clone().into()).collect::<Vec<Felt>>()
+    };
+
+    let contract_addresses = if contract_addresses.is_null() || contract_addresses_len == 0 {
+        Vec::new()
+    } else {
+        let addresses =
+            unsafe { std::slice::from_raw_parts(contract_addresses, contract_addresses_len) };
+        addresses.iter().map(|f| f.clone().into()).collect::<Vec<Felt>>()
+    };
+
+    let token_ids = if token_ids.is_null() || token_ids_len == 0 {
+        Vec::new()
+    } else {
+        let ids = unsafe { std::slice::from_raw_parts(token_ids, token_ids_len) };
+        ids.iter().map(|f| f.clone().into()).collect::<Vec<U256>>()
+    };
+
+    let token_collections = match RUNTIME.block_on(
+        (*client).inner.token_collections(
+            account_addresses,
+            contract_addresses,
+            token_ids,
+            if limit == 0 { None } else { Some(limit) },
+            cursor
+                .map(|c| unsafe { std::ffi::CStr::from_ptr(c).to_string_lossy().into_owned() })
+                .into(),
+        ),
+    ) {
+        Ok(collections) => collections,
+        Err(e) => return Result::Err(e.into()),
+    };
+
+    Result::Ok(token_collections.into())
+}
+
 /// Subscribes to indexer updates
 ///
 /// # Parameters