@shelby-protocol/sdk 0.2.0 → 0.2.2

package/dist/browser/index.d.ts

@@ -23,7 +23,7 @@ export { BlobActivity, BlobActivityType, BlobEncoding, BlobMetadata, ClayEncodin
 export { ChannelInfo, SenderBuiltMicropayment, StaleChannelStateError } from '../core/types/payments.js';
 export { PlacementGroupInfo, PlacementGroupSlot, PlacementGroupSlotStatus } from '../core/types/placement_groups.js';
 export { ActiveStateDetails, FrozenStateDetails, StorageProviderInfo, StorageProviderStateDetails, WaitlistedStateDetails } from '../core/types/storage_providers.js';
-export { buildRequestUrl, concatHashes, getBlobNameSuffix, readInChunks, zeroPadBytes } from '../core/utils.js';
+export { buildRequestUrl, concatHashes, getBlobNameSuffix, normalizeAddress, readInChunks, zeroPadBytes } from '../core/utils.js';
 export { Bigint_Comparison_Exp, Blob_Activities, Blob_Activities_Aggregate, Blob_Activities_Aggregate_Fields, Blob_Activities_Aggregate_FieldsCountArgs, Blob_Activities_Avg_Fields, Blob_Activities_Bool_Exp, Blob_Activities_Max_Fields, Blob_Activities_Min_Fields, Blob_Activities_Order_By, Blob_Activities_Select_Column, Blob_Activities_Stddev_Fields, Blob_Activities_Stddev_Pop_Fields, Blob_Activities_Stddev_Samp_Fields, Blob_Activities_Stream_Cursor_Input, Blob_Activities_Stream_Cursor_Value_Input, Blob_Activities_Sum_Fields, Blob_Activities_Var_Pop_Fields, Blob_Activities_Var_Samp_Fields, Blob_Activities_Variance_Fields, Blobs, BlobsPlacement_Group_SlotsArgs, BlobsPlacement_Group_Slots_AggregateArgs, Blobs_Aggregate, Blobs_Aggregate_Fields, Blobs_Aggregate_FieldsCountArgs, Blobs_Avg_Fields, Blobs_Bool_Exp, Blobs_Max_Fields, Blobs_Min_Fields, Blobs_Order_By, Blobs_Select_Column, Blobs_Stddev_Fields, Blobs_Stddev_Pop_Fields, Blobs_Stddev_Samp_Fields, Blobs_Stream_Cursor_Input, Blobs_Stream_Cursor_Value_Input, Blobs_Sum_Fields, Blobs_Var_Pop_Fields, Blobs_Var_Samp_Fields, Blobs_Variance_Fields, Cursor_Ordering, Exact, GetBlobActivitiesCountDocument, GetBlobActivitiesCountQuery, GetBlobActivitiesCountQueryVariables, GetBlobActivitiesDocument, GetBlobActivitiesQuery, GetBlobActivitiesQueryVariables, GetBlobsCountDocument, GetBlobsCountQuery, GetBlobsCountQueryVariables, GetBlobsDocument, GetBlobsQuery, GetBlobsQueryVariables, GetPlacementGroupSlotsCountDocument, GetPlacementGroupSlotsCountQuery, GetPlacementGroupSlotsCountQueryVariables, GetPlacementGroupSlotsDocument, GetPlacementGroupSlotsQuery, GetPlacementGroupSlotsQueryVariables, GetProcessorStatusDocument, GetProcessorStatusQuery, GetProcessorStatusQueryVariables, Incremental, InputMaybe, Int_Comparison_Exp, MakeEmpty, MakeMaybe, MakeOptional, Maybe, Numeric_Comparison_Exp, Order_By, Placement_Group_Slots, Placement_Group_Slots_Aggregate, Placement_Group_Slots_Aggregate_Bool_Exp, Placement_Group_Slots_Aggregate_Bool_Exp_Count, Placement_Group_Slots_Aggregate_Fields, Placement_Group_Slots_Aggregate_FieldsCountArgs, Placement_Group_Slots_Aggregate_Order_By, Placement_Group_Slots_Avg_Fields, Placement_Group_Slots_Avg_Order_By, Placement_Group_Slots_Bool_Exp, Placement_Group_Slots_Max_Fields, Placement_Group_Slots_Max_Order_By, Placement_Group_Slots_Min_Fields, Placement_Group_Slots_Min_Order_By, Placement_Group_Slots_Order_By, Placement_Group_Slots_Select_Column, Placement_Group_Slots_Stddev_Fields, Placement_Group_Slots_Stddev_Order_By, Placement_Group_Slots_Stddev_Pop_Fields, Placement_Group_Slots_Stddev_Pop_Order_By, Placement_Group_Slots_Stddev_Samp_Fields, Placement_Group_Slots_Stddev_Samp_Order_By, Placement_Group_Slots_Stream_Cursor_Input, Placement_Group_Slots_Stream_Cursor_Value_Input, Placement_Group_Slots_Sum_Fields, Placement_Group_Slots_Sum_Order_By, Placement_Group_Slots_Var_Pop_Fields, Placement_Group_Slots_Var_Pop_Order_By, Placement_Group_Slots_Var_Samp_Fields, Placement_Group_Slots_Var_Samp_Order_By, Placement_Group_Slots_Variance_Fields, Placement_Group_Slots_Variance_Order_By, Processor_Status, Processor_Status_Bool_Exp, Processor_Status_Order_By, Processor_Status_Select_Column, Processor_Status_Stream_Cursor_Input, Processor_Status_Stream_Cursor_Value_Input, Query_Root, Query_RootBlob_ActivitiesArgs, Query_RootBlob_Activities_AggregateArgs, Query_RootBlob_Activities_By_PkArgs, Query_RootBlobsArgs, Query_RootBlobs_AggregateArgs, Query_RootBlobs_By_PkArgs, Query_RootPlacement_Group_SlotsArgs, Query_RootPlacement_Group_Slots_AggregateArgs, Query_RootPlacement_Group_Slots_By_PkArgs, Query_RootProcessor_StatusArgs, Scalars, Sdk, SdkFunctionWrapper, String_Comparison_Exp, Subscription_Root, Subscription_RootBlob_ActivitiesArgs, Subscription_RootBlob_Activities_AggregateArgs, Subscription_RootBlob_Activities_By_PkArgs, Subscription_RootBlob_Activities_StreamArgs, Subscription_RootBlobsArgs, Subscription_RootBlobs_AggregateArgs, Subscription_RootBlobs_By_PkArgs, Subscription_RootBlobs_StreamArgs, Subscription_RootPlacement_Group_SlotsArgs, Subscription_RootPlacement_Group_Slots_AggregateArgs, Subscription_RootPlacement_Group_Slots_By_PkArgs, Subscription_RootPlacement_Group_Slots_StreamArgs, Subscription_RootProcessor_StatusArgs, Subscription_RootProcessor_Status_StreamArgs, Timestamp_Comparison_Exp, getSdk } from '../core/operations/generated/sdk.js';
 import '@aptos-labs/ts-sdk';
 import 'zod';

package/dist/browser/index.mjs

@@ -2,49 +2,36 @@ import "../chunk-EM67QTMR.mjs";
 import "../chunk-WTICJPDB.mjs";
 import {
   ShelbyClient
-} from "../chunk-7PN65RDX.mjs";
+} from "../chunk-ONOOCOQ5.mjs";
 import {
   MissingTransactionSubmitterError,
   ShelbyBlobClient
-} from "../chunk-SRV4YWFH.mjs";
-import "../chunk-XNEIWM4O.mjs";
-import {
-  createDefaultErasureCodingProvider,
-  defaultErasureCodingConfig,
-  erasureCodingConfig16Total10Data13Helper,
-  erasureCodingConfig4Total2Data3Helper
-} from "../chunk-HPPMI7DC.mjs";
-import {
-  ClayErasureCodingProvider
-} from "../chunk-OGKZ575S.mjs";
-import {
-  ReedSolomonErasureCodingProvider
-} from "../chunk-NHWWORCH.mjs";
+} from "../chunk-PESSW3FK.mjs";
 import "../chunk-Z7RFCADT.mjs";
 import {
   ShelbyMetadataClient
-} from "../chunk-MV6FNYAU.mjs";
+} from "../chunk-H53O23I7.mjs";
 import {
   ShelbyMicropaymentChannelClient
-} from "../chunk-E5QCRTBU.mjs";
+} from "../chunk-H5YZHUSJ.mjs";
 import "../chunk-QQ57OGQ2.mjs";
 import "../chunk-ZHXCVRZX.mjs";
 import "../chunk-AD2G3QYD.mjs";
 import "../chunk-MQUVYMNQ.mjs";
 import {
   ShelbyPlacementGroupClient
-} from "../chunk-W37FZSMA.mjs";
+} from "../chunk-57RQAVKL.mjs";
 import {
   ShelbyRPCClient
-} from "../chunk-PJVWGMVI.mjs";
+} from "../chunk-E5PP7BZJ.mjs";
 import {
   SenderBuiltMicropayment,
   StaleChannelStateError
-} from "../chunk-4MG4XGY4.mjs";
+} from "../chunk-TVLV7C74.mjs";
 import {
   createShelbyIndexerClient,
   getShelbyIndexerClient
-} from "../chunk-CGYJLKBU.mjs";
+} from "../chunk-EZPZAUIV.mjs";
 import {
   Blob_Activities_Select_Column,
   Blobs_Select_Column,
@@ -62,6 +49,23 @@ import {
   getSdk
 } from "../chunk-KJ24NKPH.mjs";
 import "../chunk-AABBONAF.mjs";
+import "../chunk-XNEIWM4O.mjs";
+import {
+  createDefaultErasureCodingProvider,
+  defaultErasureCodingConfig,
+  erasureCodingConfig16Total10Data13Helper,
+  erasureCodingConfig4Total2Data3Helper
+} from "../chunk-HPPMI7DC.mjs";
+import {
+  ClayErasureCodingProvider
+} from "../chunk-OGKZ575S.mjs";
+import {
+  ReedSolomonErasureCodingProvider
+} from "../chunk-NHWWORCH.mjs";
+import {
+  BlobNameSchema,
+  ChunkKey
+} from "../chunk-Z4FZ7W6L.mjs";
 import {
   isShelbyNetwork,
   shelbyNetworks
@@ -85,7 +89,7 @@ import {
 } from "../chunk-C6RQ3AEU.mjs";
 import {
   createBlobKey
-} from "../chunk-OTBLZL2S.mjs";
+} from "../chunk-3NRBHSMQ.mjs";
 import {
   BlobCommitmentsSchema,
   COMMITMENT_SCHEMA_VERSION,
@@ -93,14 +97,15 @@ import {
   expectedTotalChunksets,
   generateCommitments,
   generateMerkleRoot
-} from "../chunk-2WEX3K7C.mjs";
+} from "../chunk-BXEVML7N.mjs";
 import {
   buildRequestUrl,
   concatHashes,
   getBlobNameSuffix,
+  normalizeAddress,
   readInChunks,
   zeroPadBytes
-} from "../chunk-4JZO2D7T.mjs";
+} from "../chunk-UEZNZBJO.mjs";
 import {
   CHUNK_SIZE_PARAMS,
   ChunkSizeScheme,
@@ -131,7 +136,7 @@ import {
   SHELBY_DEPLOYER,
   TOKEN_DEPLOYER,
   TOKEN_OBJECT_ADDRESS
-} from "../chunk-4ZOFT75Q.mjs";
+} from "../chunk-7OV5ZYW6.mjs";
 import {
   ShelbyErrorCodes,
   isAccessDeniedError,
@@ -139,10 +144,6 @@ import {
   isBlobExpiredError,
   isBlobNotFoundError
 } from "../chunk-CQ6QPIZK.mjs";
-import {
-  BlobNameSchema,
-  ChunkKey
-} from "../chunk-Z4FZ7W6L.mjs";
 import "../chunk-7P6ASYW6.mjs";
 export {
   BlobCommitmentsSchema,
@@ -229,6 +230,7 @@ export {
   isBlobExpiredError,
   isBlobNotFoundError,
   isShelbyNetwork,
+  normalizeAddress,
   readInChunks,
   shelbyNetworks,
   zeroPadBytes

package/dist/chunk-3NRBHSMQ.mjs

@@ -0,0 +1,12 @@
+import {
+  normalizeAddress
+} from "./chunk-UEZNZBJO.mjs";
+
+// src/core/blobs.ts
+var createBlobKey = (params) => {
+  return `@${normalizeAddress(params.account).toStringLongWithoutPrefix()}/${params.blobName}`;
+};
+
+export {
+  createBlobKey
+};

package/dist/{chunk-W37FZSMA.mjs → chunk-57RQAVKL.mjs}

@@ -1,6 +1,6 @@
 import {
   getShelbyIndexerClient
-} from "./chunk-CGYJLKBU.mjs";
+} from "./chunk-EZPZAUIV.mjs";
 
 // src/core/clients/ShelbyPlacementGroupClient.ts
 var ShelbyPlacementGroupClient = class {

package/dist/{chunk-4ZOFT75Q.mjs → chunk-7OV5ZYW6.mjs}

@@ -29,8 +29,8 @@ var NetworkToGasStationBaseUrl = {
   [Network.LOCAL]: void 0,
   [Network.CUSTOM]: void 0
 };
-var SHELBY_DEPLOYER = "0xc63d6a5efb0080a6029403131715bd4971e1149f7cc099aac69bb0069b3ddbf5";
-var MICROPAYMENTS_DEPLOYER = "0xb42ac038b6dae86f6171e28e297aab9555ce09909445ec579e4ffe6b8d4d63bf";
+var SHELBY_DEPLOYER = "0x85fdb9a176ab8ef1d9d9c1b60d60b3924f0800ac1de1cc2085fb0b8bb4988e6a";
+var MICROPAYMENTS_DEPLOYER = "0x1ae7275148bf6ef742b658fd9cbcc2e094201606f4a7bc707bab0201da8043ee";
 var TOKEN_DEPLOYER = "0x33009e852be7f93762dd0bf303383c2cb2c5cab7a30d8238ca5f9f177ae75124";
 var TOKEN_OBJECT_ADDRESS = "0x249f5c642a63885ff88a5113b3ba0079840af5a1357706f8c7f3bfc5dd12511f";
 var SHELBYUSD_TOKEN_ADDRESS = TOKEN_OBJECT_ADDRESS;

package/dist/{chunk-2WEX3K7C.mjs → chunk-BXEVML7N.mjs}

@@ -2,7 +2,7 @@ import {
   concatHashes,
   readInChunks,
   zeroPadBytes
-} from "./chunk-4JZO2D7T.mjs";
+} from "./chunk-UEZNZBJO.mjs";
 import {
   DEFAULT_CHUNKSET_SIZE_BYTES
 } from "./chunk-JTXYKO3U.mjs";

package/dist/{chunk-PJVWGMVI.mjs → chunk-E5PP7BZJ.mjs}

@@ -1,9 +1,12 @@
 import {
   StaleChannelStateError
-} from "./chunk-4MG4XGY4.mjs";
+} from "./chunk-TVLV7C74.mjs";
 import {
   getShelbyIndexerClient
-} from "./chunk-CGYJLKBU.mjs";
+} from "./chunk-EZPZAUIV.mjs";
+import {
+  BlobNameSchema
+} from "./chunk-Z4FZ7W6L.mjs";
 import {
   sleep
 } from "./chunk-I6NG5GNL.mjs";
@@ -13,17 +16,14 @@ import {
 } from "./chunk-IE6LYVIA.mjs";
 import {
   buildRequestUrl,
+  normalizeAddress,
   readInChunks
-} from "./chunk-4JZO2D7T.mjs";
+} from "./chunk-UEZNZBJO.mjs";
 import {
   NetworkToShelbyRPCBaseUrl
-} from "./chunk-4ZOFT75Q.mjs";
-import {
-  BlobNameSchema
-} from "./chunk-Z4FZ7W6L.mjs";
+} from "./chunk-7OV5ZYW6.mjs";
 
 // src/core/clients/ShelbyRPCClient.ts
-import { AccountAddress } from "@aptos-labs/ts-sdk";
 var MICROPAYMENT_HEADER = "X-Shelby-Micropayment";
 function encodeURIComponentKeepSlashes(str) {
   return encodeURIComponent(str).replace(/%2F/g, "/");
@@ -399,7 +399,7 @@ var ShelbyRPCClient = class {
       }
     });
     return {
-      account: AccountAddress.from(params.account),
+      account: normalizeAddress(params.account),
       name: params.blobName,
       readable: validatingStream,
       contentLength: expectedContentLength

package/dist/{chunk-CGYJLKBU.mjs → chunk-EZPZAUIV.mjs}

@@ -6,7 +6,7 @@ import {
 } from "./chunk-AABBONAF.mjs";
 import {
   NetworkToShelbyBlobIndexerBaseUrl
-} from "./chunk-4ZOFT75Q.mjs";
+} from "./chunk-7OV5ZYW6.mjs";
 
 // src/core/operations/index.ts
 import { Network } from "@aptos-labs/ts-sdk";

package/dist/{chunk-ZEDD2MPU.mjs → chunk-FMPOGFDW.mjs}

@@ -1,6 +1,6 @@
 import {
   ShelbyClient
-} from "./chunk-7PN65RDX.mjs";
+} from "./chunk-ONOOCOQ5.mjs";
 
 // src/node/clients/ShelbyNodeClient.ts
 var ShelbyNodeClient = class extends ShelbyClient {

package/dist/{chunk-MV6FNYAU.mjs → chunk-H53O23I7.mjs}

@@ -1,9 +1,12 @@
 import {
   getAptosConfig
 } from "./chunk-AABBONAF.mjs";
+import {
+  normalizeAddress
+} from "./chunk-UEZNZBJO.mjs";
 import {
   SHELBY_DEPLOYER
-} from "./chunk-4ZOFT75Q.mjs";
+} from "./chunk-7OV5ZYW6.mjs";
 
 // src/core/clients/ShelbyMetadataClient.ts
 import {
@@ -74,11 +77,11 @@ var ShelbyMetadataClient = class {
       });
       const metadata = rawMetadata[0];
       return metadata.map((provider) => ({
-        address: AccountAddress.fromString(provider.address),
+        address: normalizeAddress(provider.address),
         ipAddress: provider.ip_address,
         port: provider.port,
         blsPublicKey: Hex.fromHexInput(provider.bls_public_key).toUint8Array(),
-        failureDomain: provider.failure_domain,
+        availabilityZone: provider.availability_zone,
         state: parseStorageProviderState(provider.state)
       }));
     } catch (error) {
@@ -115,7 +118,7 @@ var ShelbyMetadataClient = class {
         }
       });
       const metadata = addressMetadataArray[0];
-      return metadata.map((pg) => AccountAddress.fromString(pg));
+      return metadata.map((pg) => normalizeAddress(pg));
     } catch (error) {
       if (error instanceof Error && // Depending on the network, the error message may show up differently.
       (error.message?.includes("sub_status: Some(404)") || error.message?.includes("E_PLACEMENT_GROUP_NOT_FOUND"))) {
@@ -150,7 +153,7 @@ var ShelbyMetadataClient = class {
         }
       });
       const metadata = addressMetadataArray[0];
-      return metadata.map((slice) => AccountAddress.fromString(slice));
+      return metadata.map((slice) => normalizeAddress(slice));
     } catch (error) {
       if (error instanceof Error && // Depending on the network, the error message may show up differently.
       (error.message?.includes("sub_status: Some(404)") || error.message?.includes("E_SLICE_NOT_FOUND"))) {
@@ -160,37 +163,113 @@ var ShelbyMetadataClient = class {
     }
   }
   /**
-   * Retrieves the storage providers assigned to a slice, through a placement group.
+   * Gets the placement group address for a slice.
+   *
+   * @param sliceAddress - The address of the slice account.
+   * @returns The placement group address as a string.
+   */
+  async getPlacementGroupAddressForSlice(sliceAddress) {
+    const sliceMetadata = await this.aptos.view({
+      payload: {
+        function: `${this.deployer.toString()}::slice::get_slice_info`,
+        functionArguments: [sliceAddress.toString()]
+      }
+    });
+    return sliceMetadata[0].placement_group_assignments[0].placement_group_address;
+  }
+  /**
+   * Retrieves the designated storage providers for a slice.
+   *
+   * Designated SPs are those appointed to store data for their slots:
+   * - Active: Currently serving data
+   * - Receiving: Receiving data during slot transfer
+   * - Repairing: Repairing data after crash or failed transfer
+   * - Reconstructing: Reconstructing data if the repair fails
    *
    * @param params.account - The address of the slice account.
-   * @returns The list of storage providers for the slice, or an empty array if none exist.
+   * @returns An array where result[i] is the designated SP for slot i, or null if no SP is designated.
    *
    * @example
    * ```typescript
-   * const pgInfo = await client.getStorageProvidersForSlice();
+   * const providers = await client.getDesignatedStorageProvidersForSlice({ account: sliceAddress });
    * ```
    */
-  async getStorageProvidersForSlice(params) {
-    const sliceMetadata = await this.aptos.view({
+  async getDesignatedStorageProvidersForSlice(params) {
+    const placementGroupAddress = await this.getPlacementGroupAddressForSlice(
+      params.account
+    );
+    const rawMetadata = await this.aptos.view({
       payload: {
-        function: `${this.deployer.toString()}::slice::get_slice_info`,
-        functionArguments: [params.account.toString()]
+        function: `${this.deployer.toString()}::placement_group::get_designated_storage_providers`,
+        functionArguments: [placementGroupAddress]
       }
     });
-    const placementGroupAddress = sliceMetadata[0].placement_group_assignments[0].placement_group_address;
+    const providers = rawMetadata[0];
+    return providers.map(
+      (opt) => opt.vec.length > 0 ? normalizeAddress(opt.vec[0]) : null
+    );
+  }
+  /**
+   * Retrieves the active storage providers for a slice.
+   *
+   * Active SPs have a complete copy of the data for the slot, and are not in any data transfer/repair/reconstruction phase.
+   * Active SP can be audited for the data it contains.
+   * Each slot has at most one active SP.
+   *
+   * @param params.account - The address of the slice account.
+   * @returns An array where result[i] is the active SP for slot i, or null if no SP is active.
+   *
+   * @example
+   * ```typescript
+   * const providers = await client.getActiveStorageProvidersForSlice({ account: sliceAddress });
+   * ```
+   */
+  async getActiveStorageProvidersForSlice(params) {
+    const placementGroupAddress = await this.getPlacementGroupAddressForSlice(
+      params.account
+    );
     const rawMetadata = await this.aptos.view({
       payload: {
-        function: `${this.deployer.toString()}::placement_group::get_placement_group_info`,
+        function: `${this.deployer.toString()}::placement_group::get_active_storage_providers`,
         functionArguments: [placementGroupAddress]
       }
     });
-    const members = rawMetadata[0].members;
-    const keys = members.flatMap((m) => {
-      const active = m.active?.vec.map((a) => a.address) ?? [];
-      const others = m.others?.data.map((o) => o.key) ?? [];
-      return [...active, ...others];
+    const providers = rawMetadata[0];
+    return providers.map(
+      (opt) => opt.vec.length > 0 ? normalizeAddress(opt.vec[0]) : null
+    );
+  }
+  /**
+   * Retrieves the serving storage providers for a slice.
+   *
+   * Serving SPs are those that can respond to read requests. The serving logic is:
+   * - If an Active SP exists for a slot: Only the Active SP is serving
+   * - If no Active SP (transition in progress): Both Designated and Vacating SPs serve
+   *
+   * Each slot may have multiple serving SPs during transitions.
+   *
+   * @param params.account - The address of the slice account.
+   * @returns An array where result[i] contains the serving SPs for slot i.
+   *
+   * @example
+   * ```typescript
+   * const providers = await client.getServingStorageProvidersForSlice({ account: sliceAddress });
+   * ```
+   */
+  async getServingStorageProvidersForSlice(params) {
+    const placementGroupAddress = await this.getPlacementGroupAddressForSlice(
+      params.account
+    );
+    const rawMetadata = await this.aptos.view({
+      payload: {
+        function: `${this.deployer.toString()}::placement_group::get_serving_storage_providers`,
+        functionArguments: [placementGroupAddress]
+      }
     });
-    return keys.map((k) => AccountAddress.fromString(k));
+    const providers = rawMetadata[0];
+    return providers.map(
+      (slotProviders) => slotProviders.map((addr) => normalizeAddress(addr))
+    );
   }
 };