Add support for TS-SDK + Explorer

.changeset/clean-goats-dress.md

@@ -0,0 +1,5 @@
+---
+"@mysten/sui.js": minor
+---
+
+Update schema for `SuiSystemState` and `DelegatedStake`

apps/explorer/src/components/top-validators-card/TopValidatorsCard.tsx

@@ -21,9 +21,9 @@ const NUMBER_OF_VALIDATORS = 10;
 export function processValidators(set: Validator[]) {
     return set.map((av) => ({
         name: av.metadata.name,
-        address: av.metadata.sui_address,
-        stake: av.staking_pool.sui_balance,
-        logo: av.metadata.image_url,
+        address: av.metadata.suiAddress,
+        stake: av.stakingPool.suiBalance,
+        logo: av.metadata.imageUrl,
     }));
 }
 
@@ -94,7 +94,7 @@ export function TopValidatorsCard({ limit, showIcon }: TopValidatorsCardProps) {
         () =>
             data
                 ? validatorsTable(
-                      data.validators.active_validators,
+                      data.validators.activeValidators,
                       limit,
                       showIcon
                   )

apps/explorer/src/components/validator/ValidatorMeta.tsx

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { ArrowUpRight12 } from '@mysten/icons';
-import { toB64, type Validator } from '@mysten/sui.js';
+import { type Validator } from '@mysten/sui.js';
 
 import { StakeButton } from './StakeButton';
 
@@ -17,14 +17,12 @@ type ValidatorMetaProps = {
 };
 
 export function ValidatorMeta({ validatorData }: ValidatorMetaProps) {
-    const validatorPublicKey = toB64(
-        new Uint8Array(validatorData.metadata.protocol_pubkey_bytes)
-    );
+    const validatorPublicKey = validatorData.metadata.protocolPubkeyBytes;
 
     const validatorName = validatorData.metadata.name;
-    const logo = validatorData.metadata.image_url;
+    const logo = validatorData.metadata.imageUrl;
     const description = validatorData.metadata.description;
-    const projectUrl = validatorData.metadata.project_url;
+    const projectUrl = validatorData.metadata.projectUrl;
 
     return (
         <>
@@ -69,7 +67,7 @@ export function ValidatorMeta({ validatorData }: ValidatorMetaProps) {
                     </DescriptionItem>
                     <DescriptionItem title="Address">
                         <AddressLink
-                            address={validatorData.metadata.sui_address}
+                            address={validatorData.metadata.suiAddress}
                             noTruncate
                         />
                     </DescriptionItem>

apps/explorer/src/components/validator/ValidatorStats.tsx

@@ -33,9 +33,9 @@ export function ValidatorStats({
         () => calculateAPY(validatorData, +epoch),
         [validatorData, epoch]
     );
-    const totalStake = +validatorData.staking_pool.sui_balance;
-    const commission = +validatorData.commission_rate / 100;
-    const rewardsPoolBalance = +validatorData.staking_pool.rewards_pool;
+    const totalStake = +validatorData.stakingPool.suiBalance;
+    const commission = +validatorData.commissionRate / 100;
+    const rewardsPoolBalance = +validatorData.stakingPool.rewardsPool;
 
     return (
         <div className="flex flex-col items-stretch gap-5 md:flex-row">

apps/explorer/src/components/validator/calculateAPY.ts

@@ -8,13 +8,13 @@ import { roundFloat } from '~/utils/roundFloat';
 const APY_DECIMALS = 4;
 
 export function calculateAPY(validator: Validator, epoch: number) {
-    const { sui_balance, starting_epoch, pool_token_balance } =
-        validator.staking_pool;
+    const { suiBalance, startingEpoch, poolTokenBalance } =
+        validator.stakingPool;
 
-    const num_epochs_participated = +epoch - +starting_epoch;
+    const num_epochs_participated = +epoch - +startingEpoch;
     const apy =
         Math.pow(
-            1 + (+sui_balance - +pool_token_balance) / +pool_token_balance,
+            1 + (+suiBalance - +poolTokenBalance) / +poolTokenBalance,
             365 / num_epochs_participated
         ) - 1;
 

apps/explorer/src/pages/validator/ValidatorDetails.tsx

@@ -20,14 +20,13 @@ function ValidatorDetails() {
     const validatorData = useMemo(() => {
         if (!data) return null;
         return (
-            data.validators.active_validators.find(
-                (av) => av.metadata.sui_address === id
+            data.validators.activeValidators.find(
+                (av) => av.metadata.suiAddress === id
             ) || null
         );
     }, [id, data]);
 
-    const numberOfValidators =
-        data?.validators.active_validators.length ?? null;
+    const numberOfValidators = data?.validators.activeValidators.length ?? null;
 
     const { data: validatorEvents, isLoading: validatorsEventsLoading } =
         useGetValidatorsEvents({

apps/explorer/src/pages/validators/Validators.tsx

@@ -35,24 +35,24 @@ function validatorsTableData(
     return {
         data: validators.map((validator) => {
             const validatorName = validator.metadata.name;
-            const totalStake = validator.staking_pool.sui_balance;
-            const img = validator.metadata.image_url;
+            const totalStake = validator.stakingPool.suiBalance;
+            const img = validator.metadata.imageUrl;
 
             const event = getValidatorMoveEvent(
                 validatorsEvents,
-                validator.metadata.sui_address
+                validator.metadata.suiAddress
             );
 
             return {
                 name: {
                     name: validatorName,
-                    logo: validator.metadata.image_url,
+                    logo: validator.metadata.imageUrl,
                 },
                 stake: totalStake,
                 apy: calculateAPY(validator, epoch),
-                commission: +validator.commission_rate / 100,
+                commission: +validator.commissionRate / 100,
                 img: img,
-                address: validator.metadata.sui_address,
+                address: validator.metadata.suiAddress,
                 lastReward: event?.fields.stake_rewards || 0,
             };
         }),
@@ -158,7 +158,7 @@ function ValidatorPageResult() {
     const { data, isLoading, isSuccess, isError } = useGetSystemObject();
 
     const numberOfValidators = useMemo(
-        () => data?.validators.active_validators.length || null,
+        () => data?.validators.activeValidators.length || null,
         [data]
     );
 
@@ -173,17 +173,17 @@ function ValidatorPageResult() {
 
     const totalStaked = useMemo(() => {
         if (!data) return 0;
-        const validators = data.validators.active_validators;
+        const validators = data.validators.activeValidators;
 
         return validators.reduce(
-            (acc, cur) => acc + +cur.staking_pool.sui_balance,
+            (acc, cur) => acc + +cur.stakingPool.suiBalance,
             0
         );
     }, [data]);
 
     const averageAPY = useMemo(() => {
         if (!data) return 0;
-        const validators = data.validators.active_validators;
+        const validators = data.validators.activeValidators;
 
         const validatorsApy = validators.map((av) =>
             calculateAPY(av, +data.epoch)
@@ -212,7 +212,7 @@ function ValidatorPageResult() {
     const validatorsTable = useMemo(() => {
         if (!data || !validatorEvents) return null;
 
-        const validators = data.validators.active_validators;
+        const validators = data.validators.activeValidators;
 
         return validatorsTableData(
             validators,

crates/sui-json-rpc/src/unit_tests/rpc_server_tests.rs

@@ -13,12 +13,12 @@ use sui_config::SUI_KEYSTORE_FILENAME;
 use sui_framework_build::compiled_package::BuildConfig;
 use sui_json::SuiJsonValue;
 
+use sui_json_rpc_types::SuiObjectInfo;
 use sui_json_rpc_types::{
-    Balance, CoinPage, DelegatedStake, DelegationStatus, SuiObjectResponse, SuiCoinMetadata,
-    SuiEvent, SuiExecutionStatus, SuiObjectInfo, SuiTBlsSignObjectCommitmentType,
+    Balance, CoinPage, DelegatedStake, DelegationStatus, SuiCoinMetadata, SuiEvent,
+    SuiExecutionStatus, SuiObjectDataOptions, SuiObjectResponse, SuiTBlsSignObjectCommitmentType,
     SuiTransactionResponse, TransactionBytes,
 };
-use sui_json_rpc_types::{SuiObjectDataOptions, SuiObjectInfo};
 use sui_keys::keystore::{AccountKeystore, FileBasedKeystore, Keystore};
 use sui_types::balance::Supply;
 use sui_types::base_types::ObjectID;

crates/sui-sdk/src/apis.rs

@@ -14,10 +14,9 @@ use std::time::{Duration, Instant};
 use sui_json_rpc::api::GovernanceReadApiClient;
 use sui_json_rpc_types::{
     Balance, Checkpoint, CheckpointId, Coin, CoinPage, DelegatedStake, DryRunTransactionResponse,
-    DynamicFieldPage, EventPage, GetRawObjectDataResponse, SuiCoinMetadata, SuiEventEnvelope,
-    SuiEventFilter, SuiMoveNormalizedModule, SuiObjectDataOptions, SuiObjectInfo,
-    SuiObjectResponse, SuiPastObjectResponse, SuiSystemStateRpc, SuiTransactionResponse,
-    TransactionsPage,
+    DynamicFieldPage, EventPage, SuiCoinMetadata, SuiEventEnvelope, SuiEventFilter,
+    SuiMoveNormalizedModule, SuiObjectDataOptions, SuiObjectInfo, SuiObjectResponse,
+    SuiPastObjectResponse, SuiSystemStateRpc, SuiTransactionResponse, TransactionsPage,
 };
 use sui_types::balance::Supply;
 use sui_types::base_types::{

sdk/typescript/src/types/dynamic_fields.ts

@@ -26,7 +26,8 @@ export const DynamicFieldName = object({
 export type DynamicFieldName = Infer<typeof DynamicFieldName>;
 
 export const DynamicFieldInfo = object({
-  name: union([DynamicFieldName, string()]),
+  name: DynamicFieldName,
+  bcsName: string(),
   type: DynamicFieldType,
   objectType: string(),
   objectId: ObjectId,