sui_getNormalizedMoveStruct - Sui

Example code for the sui_getNormalizedMoveStruct JSON-RPC method. Complete guide on how to use sui_getNormalizedMoveStruct JSON-RPC in GetBlock Web3 documentation.

The sui_getNormalizedMoveStruct method returns a structured representation of a Move struct on the SUI network. This provides complete struct metadata including abilities, type parameters, and field definitions.

Parameters

Parameter

Type

Required

Description

package

ObjectID

Yes

Package object ID

module_name

string

Yes

Module name

struct_name

string

Yes

Struct name

Request Example

cURL

curl -X POST https://go.getblock.io/<ACCESS-TOKEN>/ \
-H "Content-Type: application/json" \
-d '{
  "jsonrpc": "2.0",
  "id": "getblock.io",
  "method": "sui_getNormalizedMoveStruct",
  "params": [
    "0xc95b9e341bc3aba1654bdbad707dcd773bd6309363447ef3fe58a960de92aa93",
    "module",
    "StructName"
  ]
}'

request.js

const axios = require('axios');

const payload = {
  jsonrpc: '2.0',
  id: 'getblock.io',
  method: 'sui_getNormalizedMoveStruct',
  params: [
    '0xc95b9e341bc3aba1654bdbad707dcd773bd6309363447ef3fe58a960de92aa93',
    'module',
    'StructName'
  ]
};

axios.post('https://go.getblock.io/<ACCESS-TOKEN>/', payload)
.then(response => console.log(response.data));

request.py

import requests

payload = {
    "jsonrpc": "2.0",
    "id": "getblock.io",
    "method": "sui_getNormalizedMoveStruct",
    "params": [
        "0xc95b9e341bc3aba1654bdbad707dcd773bd6309363447ef3fe58a960de92aa93",
        "module",
        "StructName"
    ]
}

response = requests.post("https://go.getblock.io/<ACCESS-TOKEN>/", json=payload)
print(response.json())

main.rs

use reqwest::Client;
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let payload = json!({
        "jsonrpc": "2.0",
        "id": "getblock.io",
        "method": "sui_getNormalizedMoveStruct",
        "params": ["0xc95b9e341bc3aba1654bdbad707dcd773bd6309363447ef3fe58a960de92aa93", "module", "StructName"]
    });
    let response = client.post("https://go.getblock.io/<ACCESS-TOKEN>/")
        .json(&payload).send().await?;
    println!("{}", response.text().await?);
    Ok(())
}

Response Example

{
  "jsonrpc": "2.0",
  "result": {
    "abilities": {
      "abilities": ["copy", "drop", "store", "key"]
    },
    "typeParameters": [],
    "fields": [
      {
        "name": "id",
        "type": { "Struct": { "address": "0x2", "module": "object", "name": "UID" } }
      },
      {
        "name": "balance",
        "type": "U64"
      }
    ]
  },
  "id": "getblock.io"
}

Response Parameters

Parameter

Type

Description

abilities

object

Struct abilities (copy, drop, store, key)

typeParameters

array

Generic type parameters

fields

array

Array of field definitions

Use Cases

Understand object structure
Generate type definitions
Build deserialization logic
Document data types

Error Handling

Error Code

Description

-32602

Invalid params

-32603

Internal error

StructNotFound

Struct not found

SDK Integration

typescript.ts

import { SuiClient } from '@mysten/sui/client';

const client = new SuiClient({ url: 'https://go.getblock.io/<ACCESS-TOKEN>/' });
const struct = await client.getNormalizedMoveStruct({
  package: '0xc95b9e341bc3aba1654bdbad707dcd773bd6309363447ef3fe58a960de92aa93',
  module: 'module',
  struct: 'StructName'
});
console.log(struct);

main.rs

use sui_sdk::SuiClientBuilder;

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let sui = SuiClientBuilder::default().build("https://go.getblock.io/<ACCESS-TOKEN>/").await?;
    let s = sui.read_api().get_normalized_move_struct(
        "0xc95b9e341bc3aba1654bdbad707dcd773bd6309363447ef3fe58a960de92aa93".parse()?,
        "module",
        "StructName"
    ).await?;
    println!("{:?}", s);
    Ok(())
}

Previoussui_getProtocolConfig - Sui Nextsui_getObject - Sui

Last updated 1 day ago

Was this helpful?