Skip to content

chore(ffi): Remove rust code example in FFI doc #343

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

Merged
merged 1 commit into from
Oct 27, 2025
+10 −178
Merged

chore(ffi): Remove rust code example in FFI doc #343

Show file tree
Hide file tree
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
54 changes: 3 additions & 51 deletions bindings/go/iota_sdk_ffi/iota_sdk_ffi.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3332,7 +3332,7 @@ func uniffiCheckChecksums() {
checksum := rustCall(func(_uniffiStatus *C.RustCallStatus) C.uint16_t {
return C.uniffi_iota_sdk_ffi_checksum_method_graphqlclient_dynamic_field()
})
if checksum != 28380 {
if checksum != 12346 {
// If this happens try cleaning and rebuilding your project
panic("iota_sdk_ffi: uniffi_iota_sdk_ffi_checksum_method_graphqlclient_dynamic_field: UniFFI API checksum mismatch")
}
Expand Down Expand Up @@ -3512,7 +3512,7 @@ func uniffiCheckChecksums() {
checksum := rustCall(func(_uniffiStatus *C.RustCallStatus) C.uint16_t {
return C.uniffi_iota_sdk_ffi_checksum_method_graphqlclient_objects()
})
if checksum != 64679 {
if checksum != 14040 {
// If this happens try cleaning and rebuilding your project
panic("iota_sdk_ffi: uniffi_iota_sdk_ffi_checksum_method_graphqlclient_objects: UniFFI API checksum mismatch")
}
Expand Down Expand Up @@ -14349,18 +14349,6 @@ type GraphQlClientInterface interface {
//
// This returns `DynamicFieldOutput` which contains the name, the value
// as json, and object.
//
// # Example
// ```rust,ignore
//
// let client = iota_graphql_client::Client::new_devnet();
// let address = ObjectId::SYSTEM.into();
// let df = client.dynamic_field_with_name(address, "u64", 2u64).await.unwrap();
//
// # alternatively, pass in the bcs bytes
// let bcs = base64ct::Base64::decode_vec("AgAAAAAAAAA=").unwrap();
// let df = client.dynamic_field(address, "u64", BcsName(bcs)).await.unwrap();
// ```
DynamicField(address *Address, typeTag *TypeTag, name Value) (*DynamicFieldOutput, error)
// Get a page of dynamic fields for the provided address. Note that this
// will also fetch dynamic fields on wrapped objects.
Expand Down Expand Up @@ -14435,18 +14423,6 @@ type GraphQlClientInterface interface {
//
// Use this function together with the `ObjectFilter::owner` to get the
// objects owned by an address.
//
// # Example
//
// ```rust,ignore
// let filter = ObjectFilter {
// type_tag: None,
// owner: Some(Address::from_str("test").unwrap().into()),
// object_ids: None,
// };
//
// let owned_objects = client.objects(None, None, Some(filter), None, None).await;
// ```
Objects(filter *ObjectFilter, paginationFilter *PaginationFilter) (ObjectPage, error)
// The package corresponding to the given address (at the optionally given
// version). When no version is given, the package is loaded directly
Expand Down Expand Up @@ -14888,18 +14864,6 @@ func (_self *GraphQlClient) DryRunTxKind(txKind *TransactionKind, txMeta Transac
//
// This returns `DynamicFieldOutput` which contains the name, the value
// as json, and object.
//
// # Example
// ```rust,ignore
//
// let client = iota_graphql_client::Client::new_devnet();
// let address = ObjectId::SYSTEM.into();
// let df = client.dynamic_field_with_name(address, "u64", 2u64).await.unwrap();
//
// # alternatively, pass in the bcs bytes
// let bcs = base64ct::Base64::decode_vec("AgAAAAAAAAA=").unwrap();
// let df = client.dynamic_field(address, "u64", BcsName(bcs)).await.unwrap();
// ```
func (_self *GraphQlClient) DynamicField(address *Address, typeTag *TypeTag, name Value) (*DynamicFieldOutput, error) {
_pointer := _self.ffiObject.incrementPointer("*GraphQlClient")
defer _self.ffiObject.decrementPointer()
Expand Down Expand Up @@ -15572,18 +15536,6 @@ func (_self *GraphQlClient) ObjectBcs(objectId *ObjectId) (*[]byte, error) {
//
// Use this function together with the `ObjectFilter::owner` to get the
// objects owned by an address.
//
// # Example
//
// ```rust,ignore
// let filter = ObjectFilter {
// type_tag: None,
// owner: Some(Address::from_str("test").unwrap().into()),
// object_ids: None,
// };
//
// let owned_objects = client.objects(None, None, Some(filter), None, None).await;
// ```
func (_self *GraphQlClient) Objects(filter *ObjectFilter, paginationFilter *PaginationFilter) (ObjectPage, error) {
_pointer := _self.ffiObject.incrementPointer("*GraphQlClient")
defer _self.ffiObject.decrementPointer()
Expand Down Expand Up @@ -32970,7 +32922,7 @@ func (_ FfiDestroyerExecutionError) Destroy(value ExecutionError) {
// execution-status = success / failure
// success = %x00
// failure = %x01 execution-error (option u64)
// ```xx
// ```
type ExecutionStatus interface {
Destroy()
}
Expand Down
54 changes: 3 additions & 51 deletions bindings/kotlin/lib/iota_sdk/iota_sdk_ffi.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8412,7 +8412,7 @@ private fun uniffiCheckApiChecksums(lib: IntegrityCheckingUniffiLib) {
if (lib.uniffi_iota_sdk_ffi_checksum_method_graphqlclient_dry_run_tx_kind() != 37663.toShort()) {
throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
}
if (lib.uniffi_iota_sdk_ffi_checksum_method_graphqlclient_dynamic_field() != 28380.toShort()) {
if (lib.uniffi_iota_sdk_ffi_checksum_method_graphqlclient_dynamic_field() != 12346.toShort()) {
throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
}
if (lib.uniffi_iota_sdk_ffi_checksum_method_graphqlclient_dynamic_fields() != 14745.toShort()) {
Expand Down Expand Up @@ -8472,7 +8472,7 @@ private fun uniffiCheckApiChecksums(lib: IntegrityCheckingUniffiLib) {
if (lib.uniffi_iota_sdk_ffi_checksum_method_graphqlclient_object_bcs() != 29653.toShort()) {
throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
}
if (lib.uniffi_iota_sdk_ffi_checksum_method_graphqlclient_objects() != 64679.toShort()) {
if (lib.uniffi_iota_sdk_ffi_checksum_method_graphqlclient_objects() != 14040.toShort()) {
throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
}
if (lib.uniffi_iota_sdk_ffi_checksum_method_graphqlclient_package() != 7913.toShort()) {
Expand Down Expand Up @@ -21817,18 +21817,6 @@ public interface GraphQlClientInterface {
*
* This returns `DynamicFieldOutput` which contains the name, the value
* as json, and object.
*
* # Example
* ```rust,ignore
*
* let client = iota_graphql_client::Client::new_devnet();
* let address = ObjectId::SYSTEM.into();
* let df = client.dynamic_field_with_name(address, "u64", 2u64).await.unwrap();
*
* # alternatively, pass in the bcs bytes
* let bcs = base64ct::Base64::decode_vec("AgAAAAAAAAA=").unwrap();
* let df = client.dynamic_field(address, "u64", BcsName(bcs)).await.unwrap();
* ```
*/
suspend fun `dynamicField`(`address`: Address, `typeTag`: TypeTag, `name`: Value): DynamicFieldOutput?

Expand Down Expand Up @@ -21963,18 +21951,6 @@ public interface GraphQlClientInterface {
*
* Use this function together with the `ObjectFilter::owner` to get the
* objects owned by an address.
*
* # Example
*
* ```rust,ignore
* let filter = ObjectFilter {
* type_tag: None,
* owner: Some(Address::from_str("test").unwrap().into()),
* object_ids: None,
* };
*
* let owned_objects = client.objects(None, None, Some(filter), None, None).await;
* ```
*/
suspend fun `objects`(`filter`: ObjectFilter? = null, `paginationFilter`: PaginationFilter? = null): ObjectPage

Expand Down Expand Up @@ -22450,18 +22426,6 @@ open class GraphQlClient: Disposable, AutoCloseable, GraphQlClientInterface
*
* This returns `DynamicFieldOutput` which contains the name, the value
* as json, and object.
*
* # Example
* ```rust,ignore
*
* let client = iota_graphql_client::Client::new_devnet();
* let address = ObjectId::SYSTEM.into();
* let df = client.dynamic_field_with_name(address, "u64", 2u64).await.unwrap();
*
* # alternatively, pass in the bcs bytes
* let bcs = base64ct::Base64::decode_vec("AgAAAAAAAAA=").unwrap();
* let df = client.dynamic_field(address, "u64", BcsName(bcs)).await.unwrap();
* ```
*/
@Throws(SdkFfiException::class)
@Suppress("ASSIGNED_BUT_NEVER_ACCESSED_VARIABLE")
Expand Down Expand Up @@ -22976,18 +22940,6 @@ open class GraphQlClient: Disposable, AutoCloseable, GraphQlClientInterface
*
* Use this function together with the `ObjectFilter::owner` to get the
* objects owned by an address.
*
* # Example
*
* ```rust,ignore
* let filter = ObjectFilter {
* type_tag: None,
* owner: Some(Address::from_str("test").unwrap().into()),
* object_ids: None,
* };
*
* let owned_objects = client.objects(None, None, Some(filter), None, None).await;
* ```
*/
@Throws(SdkFfiException::class)
@Suppress("ASSIGNED_BUT_NEVER_ACCESSED_VARIABLE")
Expand Down Expand Up @@ -54540,7 +54492,7 @@ public object FfiConverterTypeExecutionError : FfiConverterRustBuffer<ExecutionE
* execution-status = success / failure
* success = %x00
* failure = %x01 execution-error (option u64)
* ```xx
* ```
*/
sealed class ExecutionStatus: Disposable {

Expand Down
54 changes: 3 additions & 51 deletions bindings/python/lib/iota_sdk_ffi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1121,7 +1121,7 @@ def _uniffi_check_api_checksums(lib):
raise InternalError("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
if lib.uniffi_iota_sdk_ffi_checksum_method_graphqlclient_dry_run_tx_kind() != 37663:
raise InternalError("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
if lib.uniffi_iota_sdk_ffi_checksum_method_graphqlclient_dynamic_field() != 28380:
if lib.uniffi_iota_sdk_ffi_checksum_method_graphqlclient_dynamic_field() != 12346:
raise InternalError("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
if lib.uniffi_iota_sdk_ffi_checksum_method_graphqlclient_dynamic_fields() != 14745:
raise InternalError("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
Expand Down Expand Up @@ -1161,7 +1161,7 @@ def _uniffi_check_api_checksums(lib):
raise InternalError("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
if lib.uniffi_iota_sdk_ffi_checksum_method_graphqlclient_object_bcs() != 29653:
raise InternalError("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
if lib.uniffi_iota_sdk_ffi_checksum_method_graphqlclient_objects() != 64679:
if lib.uniffi_iota_sdk_ffi_checksum_method_graphqlclient_objects() != 14040:
raise InternalError("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
if lib.uniffi_iota_sdk_ffi_checksum_method_graphqlclient_package() != 7913:
raise InternalError("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
Expand Down Expand Up @@ -19627,7 +19627,7 @@ class ExecutionStatus:
execution-status = success / failure
success = %x00
failure = %x01 execution-error (option u64)
```xx
```
"""

def __init__(self):
Expand Down Expand Up @@ -30272,18 +30272,6 @@ def dynamic_field(self, address: "Address",type_tag: "TypeTag",name: "Value"):

This returns `DynamicFieldOutput` which contains the name, the value
as json, and object.

# Example
```rust,ignore

let client = iota_graphql_client::Client::new_devnet();
let address = ObjectId::SYSTEM.into();
let df = client.dynamic_field_with_name(address, "u64", 2u64).await.unwrap();

# alternatively, pass in the bcs bytes
let bcs = base64ct::Base64::decode_vec("AgAAAAAAAAA=").unwrap();
let df = client.dynamic_field(address, "u64", BcsName(bcs)).await.unwrap();
```
"""

raise NotImplementedError
Expand Down Expand Up @@ -30438,18 +30426,6 @@ def objects(self, filter: "typing.Union[object, typing.Optional[ObjectFilter]]"

Use this function together with the `ObjectFilter::owner` to get the
objects owned by an address.

# Example

```rust,ignore
let filter = ObjectFilter {
type_tag: None,
owner: Some(Address::from_str("test").unwrap().into()),
object_ids: None,
};

let owned_objects = client.objects(None, None, Some(filter), None, None).await;
```
"""

raise NotImplementedError
Expand Down Expand Up @@ -30975,18 +30951,6 @@ async def dynamic_field(self, address: "Address",type_tag: "TypeTag",name: "Valu

This returns `DynamicFieldOutput` which contains the name, the value
as json, and object.

# Example
```rust,ignore

let client = iota_graphql_client::Client::new_devnet();
let address = ObjectId::SYSTEM.into();
let df = client.dynamic_field_with_name(address, "u64", 2u64).await.unwrap();

# alternatively, pass in the bcs bytes
let bcs = base64ct::Base64::decode_vec("AgAAAAAAAAA=").unwrap();
let df = client.dynamic_field(address, "u64", BcsName(bcs)).await.unwrap();
```
"""

_UniffiConverterTypeAddress.check_lower(address)
Expand Down Expand Up @@ -31613,18 +31577,6 @@ async def objects(self, filter: "typing.Union[object, typing.Optional[ObjectFilt

Use this function together with the `ObjectFilter::owner` to get the
objects owned by an address.

# Example

```rust,ignore
let filter = ObjectFilter {
type_tag: None,
owner: Some(Address::from_str("test").unwrap().into()),
object_ids: None,
};

let owned_objects = client.objects(None, None, Some(filter), None, None).await;
```
"""

if filter is _DEFAULT:
Expand Down
24 changes: 0 additions & 24 deletions crates/iota-sdk-ffi/src/graphql.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,18 +364,6 @@ impl GraphQLClient {
///
/// Use this function together with the `ObjectFilter::owner` to get the
/// objects owned by an address.
///
/// # Example
///
/// ```rust,ignore
/// let filter = ObjectFilter {
/// type_tag: None,
/// owner: Some(Address::from_str("test").unwrap().into()),
/// object_ids: None,
/// };
///
/// let owned_objects = client.objects(None, None, Some(filter), None, None).await;
/// ```
#[uniffi::method(default(pagination_filter = None, filter = None))]
pub async fn objects(
&self,
Expand Down Expand Up @@ -738,18 +726,6 @@ impl GraphQLClient {
///
/// This returns `DynamicFieldOutput` which contains the name, the value
/// as json, and object.
///
/// # Example
/// ```rust,ignore
///
/// let client = iota_graphql_client::Client::new_devnet();
/// let address = ObjectId::SYSTEM.into();
/// let df = client.dynamic_field_with_name(address, "u64", 2u64).await.unwrap();
///
/// # alternatively, pass in the bcs bytes
/// let bcs = base64ct::Base64::decode_vec("AgAAAAAAAAA=").unwrap();
/// let df = client.dynamic_field(address, "u64", BcsName(bcs)).await.unwrap();
/// ```
pub async fn dynamic_field(
&self,
address: &Address,
Expand Down
2 changes: 1 addition & 1 deletion crates/iota-sdk-ffi/src/types/execution_status.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ use crate::{
/// execution-status = success / failure
/// success = %x00
/// failure = %x01 execution-error (option u64)
/// ```xx
/// ```
#[derive(uniffi::Enum)]
pub enum ExecutionStatus {
/// The Transaction successfully executed.
Expand Down