@ar.io/sdk 3.12.2 → 3.13.0-beta.1

package/lib/types/types/wayfinder.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export interface RoutingStrategy {
+    selectGateway: ({ gateways }: {
+        gateways: URL[];
+    }) => Promise<URL>;
+}
+export interface GatewaysProvider {
+    getGateways: () => Promise<URL[]>;
+}
+export type DataStream = AsyncIterable<Uint8Array> | ReadableStream<Uint8Array>;
+export interface DataVerificationStrategy {
+    /**
+     * Verifies the provided data for a given txId
+     *
+     * Depending on the implementation, the hash can be the computed data root of a transaction, the digest of the data, or some other hash of the data.
+     *
+     * The interface is intended to be vague in order to support various degrees of verification.
+     *
+     * @param data - The data to verify
+     * @param txId - The txId of the data
+     * @returns the hash of the data
+     */
+    verifyData: ({ data, txId, }: {
+        data: DataStream;
+        txId: string;
+    }) => Promise<void>;
+}
+export interface DataHashProvider {
+    /**
+     * Returns a hash for the provided txId using the specified algorithm.
+     *
+     * @param txId - The txId of the data
+     * @returns the hash of the data
+     */
+    getHash: ({ txId, }: {
+        txId: string;
+    }) => Promise<{
+        hash: string;
+        algorithm: 'sha256';
+    }>;
+}
+export interface DataRootProvider {
+    /**
+     * Returns the data root for the provided txId
+     *
+     * @param txId - The txId of the data
+     * @returns the data root of the data
+     */
+    getDataRoot: ({ txId }: {
+        txId: string;
+    }) => Promise<string>;
+}

package/lib/types/utils/hash.d.ts

@@ -1,4 +1,8 @@
-import { Readable } from 'stream';
-export declare const hashReadableToB64Url: (stream: Readable, algorithm?: string) => Promise<string>;
-export declare const hashReadableStreamToB64Url: (stream: ReadableStream, algorithm?: string) => Promise<string>;
-export declare const hashBufferToB64Url: (buffer: Buffer, algorithm?: string) => string;
+import { DataStream } from '../types/wayfinder.js';
+export declare const isAsyncIterable: <T = unknown>(x: any) => x is AsyncIterable<T>;
+export declare const isReadableStream: <T = unknown>(x: any) => x is ReadableStream<T>;
+export declare const readableStreamToAsyncIterable: (stream: ReadableStream<Uint8Array>) => AsyncIterable<Uint8Array>;
+export declare const hashDataStreamToB64Url: (stream: DataStream, algorithm?: string) => Promise<string>;
+export declare const convertDataStreamToDataRoot: ({ dataStream, }: {
+    dataStream: DataStream;
+}) => Promise<string>;

package/lib/types/version.d.ts

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export declare const version = "3.12.1";
+export declare const version = "3.13.0-alpha.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "3.12.2",
+  "version": "3.13.0-beta.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"
@@ -136,6 +136,7 @@
     "eventemitter3": "^5.0.1",
     "plimit-lit": "^3.0.1",
     "prompts": "^2.4.2",
+    "rfc4648": "^1.5.4",
     "uuid": "^11.1.0",
     "winston": "^3.13.0",
     "zod": "^3.23.8"