@shelby-protocol/sdk 0.3.1 → 0.4.1

package/dist/gen/rpc_server_pb.d.ts

@@ -0,0 +1,295 @@
+import { GenFile, GenMessage } from '@bufbuild/protobuf/codegenv2';
+import { Message } from '@bufbuild/protobuf';
+
+/**
+ * Describes the file rpc_server.proto.
+ */
+declare const file_rpc_server: GenFile;
+/**
+ * @generated from message cav.Payment
+ */
+type Payment = Message<"cav.Payment"> & {
+    /**
+     * This is the BCS-serialized SenderBuiltMicropayment, which is a WithdrawApproval struct and a signature.
+     *
+     * @generated from field: bytes payment = 1;
+     */
+    payment: Uint8Array;
+};
+/**
+ * Describes the message cav.Payment.
+ * Use `create(PaymentSchema)` to create a new message.
+ */
+declare const PaymentSchema: GenMessage<Payment>;
+/**
+ * @generated from message cav.ProofNode
+ */
+type ProofNode = Message<"cav.ProofNode"> & {
+    /**
+     * @generated from field: bytes hash = 1;
+     */
+    hash: Uint8Array;
+};
+/**
+ * Describes the message cav.ProofNode.
+ * Use `create(ProofNodeSchema)` to create a new message.
+ */
+declare const ProofNodeSchema: GenMessage<ProofNode>;
+/**
+ * The Proof message contains the path from the chunk up to the blob root.
+ *
+ * @generated from message cav.Proof
+ */
+type Proof = Message<"cav.Proof"> & {
+    /**
+     * @generated from field: repeated cav.ProofNode proof_nodes = 1;
+     */
+    proofNodes: ProofNode[];
+};
+/**
+ * Describes the message cav.Proof.
+ * Use `create(ProofSchema)` to create a new message.
+ */
+declare const ProofSchema: GenMessage<Proof>;
+/**
+ * ChunkKey identifies a single chunk within a blob. The blob is identified by
+ * its on-chain UID; the chunkset/chunk indices locate the chunk inside it.
+ *
+ * @generated from message cav.ChunkKey
+ */
+type ChunkKey = Message<"cav.ChunkKey"> & {
+    /**
+     * @generated from field: uint64 blob_uid = 1;
+     */
+    blobUid: bigint;
+    /**
+     * @generated from field: uint32 chunkset_idx = 2;
+     */
+    chunksetIdx: number;
+    /**
+     * @generated from field: uint32 chunk_idx = 3;
+     */
+    chunkIdx: number;
+};
+/**
+ * Describes the message cav.ChunkKey.
+ * Use `create(ChunkKeySchema)` to create a new message.
+ */
+declare const ChunkKeySchema: GenMessage<ChunkKey>;
+/**
+ * @generated from message cav.ReadRequest
+ */
+type ReadRequest = Message<"cav.ReadRequest"> & {
+    /**
+     * @generated from field: cav.ChunkKey identifier = 1;
+     */
+    identifier?: ChunkKey;
+    /**
+     * @generated from field: cav.Payment payment = 2;
+     */
+    payment?: Payment;
+};
+/**
+ * Describes the message cav.ReadRequest.
+ * Use `create(ReadRequestSchema)` to create a new message.
+ */
+declare const ReadRequestSchema: GenMessage<ReadRequest>;
+/**
+ * Used to perform a clay-code repair operation. An SP receives this request
+ * when another SP's rebuild tile needs helper data to reconstruct a missing chunk.
+ *
+ * @generated from message cav.ClayHelperDataReadRequest
+ */
+type ClayHelperDataReadRequest = Message<"cav.ClayHelperDataReadRequest"> & {
+    /**
+     * The chunk to READ from this peer (helper chunk). Same semantics as ReadRequest.
+     *
+     * @generated from field: cav.ChunkKey identifier = 1;
+     */
+    identifier?: ChunkKey;
+    /**
+     * The chunk index being recovered (target). Same chunkset as identifier.
+     *
+     * @generated from field: uint32 target_chunk_idx = 2;
+     */
+    targetChunkIdx: number;
+    /**
+     * Bitmask of all d helper chunk indices participating in this repair.
+     * Used to compute the clay plan deterministically on both sides.
+     *
+     * @generated from field: uint64 helper_set_mask = 3;
+     */
+    helperSetMask: bigint;
+};
+/**
+ * Describes the message cav.ClayHelperDataReadRequest.
+ * Use `create(ClayHelperDataReadRequestSchema)` to create a new message.
+ */
+declare const ClayHelperDataReadRequestSchema: GenMessage<ClayHelperDataReadRequest>;
+/**
+ * @generated from message cav.WriteRequest
+ */
+type WriteRequest = Message<"cav.WriteRequest"> & {
+    /**
+     * @generated from field: cav.ChunkKey identifier = 1;
+     */
+    identifier?: ChunkKey;
+    /**
+     * @generated from field: bytes body = 2;
+     */
+    body: Uint8Array;
+    /**
+     * This is the proof that the bytes are legitimate, i.e.
+     * this is an inclusion proof up to the Blob's merkle root published on the chain.
+     *
+     * @generated from field: cav.Proof proof = 3;
+     */
+    proof?: Proof;
+};
+/**
+ * Describes the message cav.WriteRequest.
+ * Use `create(WriteRequestSchema)` to create a new message.
+ */
+declare const WriteRequestSchema: GenMessage<WriteRequest>;
+/**
+ * @generated from message cav.Request
+ */
+type Request = Message<"cav.Request"> & {
+    /**
+     * @generated from oneof cav.Request.request
+     */
+    request: {
+        /**
+         * @generated from field: cav.ReadRequest read_req = 1;
+         */
+        value: ReadRequest;
+        case: "readReq";
+    } | {
+        /**
+         * @generated from field: cav.WriteRequest write_req = 2;
+         */
+        value: WriteRequest;
+        case: "writeReq";
+    } | {
+        /**
+         * @generated from field: cav.ClayHelperDataReadRequest helper_read_req = 5;
+         */
+        value: ClayHelperDataReadRequest;
+        case: "helperReadReq";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+    /**
+     * @generated from field: uint64 request_id = 3;
+     */
+    requestId: bigint;
+    /**
+     * @generated from field: bytes signature = 4;
+     */
+    signature: Uint8Array;
+};
+/**
+ * Describes the message cav.Request.
+ * Use `create(RequestSchema)` to create a new message.
+ */
+declare const RequestSchema: GenMessage<Request>;
+/**
+ * @generated from message cav.ReadResponse
+ */
+type ReadResponse = Message<"cav.ReadResponse"> & {
+    /**
+     * @generated from field: bytes body = 1;
+     */
+    body: Uint8Array;
+    /**
+     * @generated from field: cav.Proof proof = 2;
+     */
+    proof?: Proof;
+    /**
+     * For clay helper reads: hash of the full helper chunk computed before clay
+     * filtering.  Empty for regular reads.  The receiver needs this because clay
+     * filtering sends only a partial slice from which the full hash cannot be
+     * recomputed.
+     *
+     * @generated from field: bytes helper_chunk_root_hash = 3;
+     */
+    helperChunkRootHash: Uint8Array;
+};
+/**
+ * Describes the message cav.ReadResponse.
+ * Use `create(ReadResponseSchema)` to create a new message.
+ */
+declare const ReadResponseSchema: GenMessage<ReadResponse>;
+/**
+ * @generated from message cav.WriteResponse
+ */
+type WriteResponse = Message<"cav.WriteResponse"> & {
+    /**
+     * field 1 (signed_hash) removed; numbering preserved for wire compatibility.
+     * BLS signature over bcs(BlobAckInfo{blob_uid}).
+     * Present only when all chunksets for the blob have been received.
+     *
+     * @generated from field: bytes blob_ack_signature = 2;
+     */
+    blobAckSignature: Uint8Array;
+    /**
+     * When the blob is not yet complete, lists the chunkset indices the SP still
+     * needs. Empty when blob_ack_signature is present.
+     *
+     * @generated from field: repeated uint32 missing_chunkset_indices = 3;
+     */
+    missingChunksetIndices: number[];
+};
+/**
+ * Describes the message cav.WriteResponse.
+ * Use `create(WriteResponseSchema)` to create a new message.
+ */
+declare const WriteResponseSchema: GenMessage<WriteResponse>;
+/**
+ * @generated from message cav.Response
+ */
+type Response = Message<"cav.Response"> & {
+    /**
+     * @generated from field: uint64 request_id = 1;
+     */
+    requestId: bigint;
+    /**
+     * @generated from field: uint64 error_code = 2;
+     */
+    errorCode: bigint;
+    /**
+     * The `response` field may not be sent - if the error code indicates something
+     * was not successful, then `response` should be empty
+     * You could argue that makes the `error_code` field redundant (you can tell if
+     * something was successful based on the existence of the `response` value), but
+     * leaving it provides some way of differentiating, e.g., failure due to failed
+     * disk vs. failure due to insufficient payment received - if all you know is
+     * that `response` was empty, you don't know which of those failure modes applied
+     *
+     * @generated from oneof cav.Response.response
+     */
+    response: {
+        /**
+         * @generated from field: cav.ReadResponse read_resp = 3;
+         */
+        value: ReadResponse;
+        case: "readResp";
+    } | {
+        /**
+         * @generated from field: cav.WriteResponse write_resp = 4;
+         */
+        value: WriteResponse;
+        case: "writeResp";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * Describes the message cav.Response.
+ * Use `create(ResponseSchema)` to create a new message.
+ */
+declare const ResponseSchema: GenMessage<Response>;
+
+export { type ChunkKey, ChunkKeySchema, type ClayHelperDataReadRequest, ClayHelperDataReadRequestSchema, type Payment, PaymentSchema, type Proof, type ProofNode, ProofNodeSchema, ProofSchema, type ReadRequest, ReadRequestSchema, type ReadResponse, ReadResponseSchema, type Request, RequestSchema, type Response, ResponseSchema, type WriteRequest, WriteRequestSchema, type WriteResponse, WriteResponseSchema, file_rpc_server };

package/dist/gen/rpc_server_pb.mjs

@@ -0,0 +1,28 @@
+// src/gen/rpc_server_pb.ts
+import { fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2";
+var file_rpc_server = /* @__PURE__ */ fileDesc("ChBycGNfc2VydmVyLnByb3RvEgNjYXYiGgoHUGF5bWVudBIPCgdwYXltZW50GAEgASgMIhkKCVByb29mTm9kZRIMCgRoYXNoGAEgASgMIiwKBVByb29mEiMKC3Byb29mX25vZGVzGAEgAygLMg4uY2F2LlByb29mTm9kZSJFCghDaHVua0tleRIQCghibG9iX3VpZBgBIAEoBBIUCgxjaHVua3NldF9pZHgYAiABKA0SEQoJY2h1bmtfaWR4GAMgASgNIk8KC1JlYWRSZXF1ZXN0EiEKCmlkZW50aWZpZXIYASABKAsyDS5jYXYuQ2h1bmtLZXkSHQoHcGF5bWVudBgCIAEoCzIMLmNhdi5QYXltZW50InEKGUNsYXlIZWxwZXJEYXRhUmVhZFJlcXVlc3QSIQoKaWRlbnRpZmllchgBIAEoCzINLmNhdi5DaHVua0tleRIYChB0YXJnZXRfY2h1bmtfaWR4GAIgASgNEhcKD2hlbHBlcl9zZXRfbWFzaxgDIAEoBCJgCgxXcml0ZVJlcXVlc3QSIQoKaWRlbnRpZmllchgBIAEoCzINLmNhdi5DaHVua0tleRIMCgRib2R5GAIgASgMEhkKBXByb29mGAMgASgLMgouY2F2LlByb29mSgQIBBAFIsQBCgdSZXF1ZXN0EiQKCHJlYWRfcmVxGAEgASgLMhAuY2F2LlJlYWRSZXF1ZXN0SAASJgoJd3JpdGVfcmVxGAIgASgLMhEuY2F2LldyaXRlUmVxdWVzdEgAEjkKD2hlbHBlcl9yZWFkX3JlcRgFIAEoCzIeLmNhdi5DbGF5SGVscGVyRGF0YVJlYWRSZXF1ZXN0SAASEgoKcmVxdWVzdF9pZBgDIAEoBBIRCglzaWduYXR1cmUYBCABKAxCCQoHcmVxdWVzdCJXCgxSZWFkUmVzcG9uc2USDAoEYm9keRgBIAEoDBIZCgVwcm9vZhgCIAEoCzIKLmNhdi5Qcm9vZhIeChZoZWxwZXJfY2h1bmtfcm9vdF9oYXNoGAMgASgMIk0KDVdyaXRlUmVzcG9uc2USGgoSYmxvYl9hY2tfc2lnbmF0dXJlGAIgASgMEiAKGG1pc3NpbmdfY2h1bmtzZXRfaW5kaWNlcxgDIAMoDSKWAQoIUmVzcG9uc2USEgoKcmVxdWVzdF9pZBgBIAEoBBISCgplcnJvcl9jb2RlGAIgASgEEiYKCXJlYWRfcmVzcBgDIAEoCzIRLmNhdi5SZWFkUmVzcG9uc2VIABIoCgp3cml0ZV9yZXNwGAQgASgLMhIuY2F2LldyaXRlUmVzcG9uc2VIAEIKCghyZXNwb25zZUoECAUQBmIGcHJvdG8z");
+var PaymentSchema = /* @__PURE__ */ messageDesc(file_rpc_server, 0);
+var ProofNodeSchema = /* @__PURE__ */ messageDesc(file_rpc_server, 1);
+var ProofSchema = /* @__PURE__ */ messageDesc(file_rpc_server, 2);
+var ChunkKeySchema = /* @__PURE__ */ messageDesc(file_rpc_server, 3);
+var ReadRequestSchema = /* @__PURE__ */ messageDesc(file_rpc_server, 4);
+var ClayHelperDataReadRequestSchema = /* @__PURE__ */ messageDesc(file_rpc_server, 5);
+var WriteRequestSchema = /* @__PURE__ */ messageDesc(file_rpc_server, 6);
+var RequestSchema = /* @__PURE__ */ messageDesc(file_rpc_server, 7);
+var ReadResponseSchema = /* @__PURE__ */ messageDesc(file_rpc_server, 8);
+var WriteResponseSchema = /* @__PURE__ */ messageDesc(file_rpc_server, 9);
+var ResponseSchema = /* @__PURE__ */ messageDesc(file_rpc_server, 10);
+export {
+  ChunkKeySchema,
+  ClayHelperDataReadRequestSchema,
+  PaymentSchema,
+  ProofNodeSchema,
+  ProofSchema,
+  ReadRequestSchema,
+  ReadResponseSchema,
+  RequestSchema,
+  ResponseSchema,
+  WriteRequestSchema,
+  WriteResponseSchema,
+  file_rpc_server
+};

package/dist/node/clients/ShelbyNodeClient.d.ts

@@ -16,6 +16,7 @@ import 'graphql-request';
 import '../../core/operations/generated/sdk.js';
 import 'graphql';
 import '../../core/clients/ShelbyRPCClient.js';
+import '../../core/commitments.js';
 import '../../core/rpc-responses.js';
 import '../../core/types/payments.js';