@0xobelisk/sui-client NPM

Dubhe Client SDK

Dubhe is a client-agnostic SDK that supports various platforms including browsers, Node.js, and the COCOS game engine. It provides a simple interface to interact with your Sui Move contracts.

Getting Started

Prerequisites

Before using the SDK, make sure you have:

Created and deployed your contract using the Dubhe CLI
Obtained the packageId after deployment

Data Model Setup

First, define your contract's configuration using DubheConfig:

import { DubheConfig } from '@0xobelisk/sui-common';

export const dubheConfig = {
  name: 'counter',
  description: 'counter',
  systems: ['counter'],
  schemas: {
    counter: {
      structure: {
        value: 'StorageValue<u32>',
      },
    },
  },
} as DubheConfig;

Generate the contract code using CLI:

dubhe schemagen --config-path dubhe.config.ts

Initializing the Client

There are two ways to initialize the Dubhe client:

Using dynamic metadata loading:

import { loadMetadata, Dubhe, NetworkType } from '@0xobelisk/sui-client';

const network = 'devnet' as NetworkType;
const packageId = 'YOUR_PACKAGE_ID';

const metadata = await loadMetadata(network, packageId);
const dubhe = new Dubhe({
  networkType: network,
  packageId: packageId,
  metadata: metadata,
  secretKey: privkey,
});

Using pre-saved metadata (recommended for better performance):

import metadata from './metadata.json';

const dubhe = new Dubhe({
  networkType: network,
  packageId: packageId,
  metadata: metadata,
  secretKey: privkey,
});

Executing Transactions

To call contract methods:

import { Transaction } from '@0xobelisk/sui-client';

// Create transaction
const tx = new Transaction();
const params = [
  /* your parameters */
];

// Execute transaction
const response = await dubhe.tx.counter_system.inc(tx, params);

// For wallet integration
await dubhe.tx.counter_system.inc(tx, params, undefined, true);
const response = await dubhe.signAndSendTxn(tx);

Querying Data

To query contract state:

const tx = new Transaction();
const params = [
  /* your parameters */
];
const result = await dubhe.query.counter_system.get(tx, params);

// For BCS encoded results
const decodedData = dubhe.view(result);

BCS Data Decoding

The SDK provides a view() method to decode BCS-encoded return values from contract queries.

Supported Types

Basic types (u8, u16, u32, u64, u128, u256)
Boolean
String
Vector
Struct
Option
Custom objects

Example with Complex Types

// Example contract return type
struct GameState {
    score: u64,
    player_name: String,
    is_active: bool,
    items: vector<Item>
}

// Query and decode
const tx = new Transaction();
const result = await dubhe.query.game_system.get_state(tx, params);
const decodedState = dubhe.view(result);

Known Limitations

⚠️ Important Note:

The current implementation cannot automatically decode enum types due to limitations in Sui metadata.
Some complex nested structures might require additional handling.

Entity Key Generation

Dubhe provides three methods for generating entity keys:

// From object ID
const objectKey = await dubhe.entity_key_from_object(objectId);

// From string data
const bytesKey = await dubhe.entity_key_from_bytes('hello');

// From number
const numberKey = await dubhe.entity_key_from_u256(123);

Query Owned Objects

To query objects owned by a specific address:

const owner =
  '0xfa99b5b0463fcfb7d0203c701a76da5eda21a96190eb1368ab36a437cc89195e';
const ownedObjects = await dubhe.getOwnedObjects(owner);

Best Practices

Use pre-saved metadata for better performance in production
Implement proper error handling for BCS decoding
Consider the limitations of enum type handling when designing your contract return types