@shelby-protocol/sdk 0.3.0 → 0.4.0

package/dist/core/clients/ShelbyClient.d.ts

@@ -5,9 +5,9 @@ import { BlobName } from '../layout.js';
 import { WriteBlobCommitmentsOptions, ShelbyBlobClient } from './ShelbyBlobClient.js';
 import { ShelbyClientConfig } from './ShelbyClientConfig.js';
 import { ShelbyMetadataClient } from './ShelbyMetadataClient.js';
-import { ShelbyRPCClient } from './ShelbyRPCClient.js';
-import '@shelby-protocol/clay-codes';
+import { ShelbyRPCClient, BlobOwnerAuth } from './ShelbyRPCClient.js';
 import 'zod';
+import '@shelby-protocol/clay-codes';
 import '../types/blobs.js';
 import '../operations/index.js';
 import 'graphql-request';
@@ -15,6 +15,8 @@ import '../operations/generated/sdk.js';
 import 'graphql';
 import '../networks.js';
 import '../types/storage_providers.js';
+import '../commitments.js';
+import '../rpc-responses.js';
 import '../types/payments.js';
 
 type UploadOptions = WriteBlobCommitmentsOptions;
@@ -76,11 +78,42 @@ declare class ShelbyClient {
      * ```
      */
     constructor(config: ShelbyClientConfig, provider?: ErasureCodingProvider);
+    /**
+     * Sign an authentication challenge for blob owner verification.
+     *
+     * The default implementation delegates to `ShelbyRPCClient.signChallenge`
+     * which works for standard Ed25519 accounts. Kits that use derived /
+     * abstracted accounts (Solana, Ethereum) should override this method to
+     * provide the correct public key bytes and derivation metadata.
+     */
+    protected signChallenge(account: Account, challenge: string): BlobOwnerAuth;
     /**
      * Get the erasure coding provider, creating it if necessary.
      * This allows lazy initialization for users who don't provide a provider.
      */
     private getProvider;
+    /**
+     * Build orderless transaction options (a random replay-protection nonce) for
+     * the per-blob commit transactions. batchUpload finalizes blobs
+     * concurrently, so without orderless replay protection the parallel
+     * same-account submissions collide on the sequence number ("transaction
+     * already in mempool with a different payload"). The nonce makes each commit
+     * independent regardless of the client's `orderless` config flag.
+     */
+    private orderlessCommitOptions;
+    /**
+     * Resolve the on-chain UID assigned to `blobName` from a committed register
+     * transaction. `register_blob` only publishes the uid -> name mapping via
+     * `BlobRegisteredEvent` (a pending blob is not yet in the `objects` map, so it
+     * cannot be read back by name), so the upload flow must parse it here before
+     * uploading bytes or committing.
+     */
+    private uidFromRegisterTx;
+    /**
+     * Await a blob-registration transaction, rephrasing on-chain location
+     * failures into a human-readable message.
+     */
+    private waitForRegistration;
     /**
      * The base URL for the Shelby RPC node.
      */
@@ -92,8 +125,8 @@ declare class ShelbyClient {
      *
      * Note: This method accepts only `Uint8Array` and buffers the entire blob in memory.
      * For streaming uploads of large files (e.g. >2 GiB), orchestrate the steps manually
-     * using `generateCommitments()`, `coordination.registerBlob()`, and `rpc.putBlob()`
-     * with a `ReadableStream`.
+     * using `generateCommitments()`, `coordination.registerBlob()`, `rpc.putBlobChunksets()`,
+     * and `coordination.commitObject()` with a `ReadableStream`.
      *
      * @param params.blobData - The raw data to upload as a Uint8Array.
      * @param params.signer - The account that signs and pays for the transaction.
@@ -129,8 +162,8 @@ declare class ShelbyClient {
      *
      * Note: This method accepts only `Uint8Array` and buffers each blob in memory.
      * For streaming uploads of large files, orchestrate the steps manually using
-     * `generateCommitments()`, `coordination.registerBlob()`, and `rpc.putBlob()`
-     * with a `ReadableStream`.
+     * `generateCommitments()`, `coordination.registerBlob()`, `rpc.putBlobChunksets()`,
+     * and `coordination.commitObject()` with a `ReadableStream`.
      *
      * @param params.blobs - The blobs to upload.
      * @param params.blobs.blobData - The raw data to upload as a Uint8Array.