@ardrive/turbo-sdk 1.0.0-alpha.1

package/lib/utils/errors.js

@@ -0,0 +1,28 @@
+/**
+ * Copyright (C) 2022-2023 Permanent Data Solutions, Inc. All Rights Reserved.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+export class UnauthenticatedRequestError extends Error {
+    constructor() {
+        super('Failed authentication. JWK is required.');
+        this.name = 'UnauthenticatedRequestError';
+    }
+}
+export class FailedRequestError extends Error {
+    constructor(status, message) {
+        super(`Failed request: ${status}: ${message}`);
+        this.name = 'FailedRequestError';
+    }
+}

package/lib/utils/readableStream.d.ts

@@ -0,0 +1,22 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+/**
+ * Copyright (C) 2022-2023 Permanent Data Solutions, Inc. All Rights Reserved.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+import { ReadableStream } from 'node:stream/web';
+export declare function readableStreamToBuffer({ stream, }: {
+    stream: ReadableStream;
+}): Promise<Buffer>;

package/lib/utils/readableStream.js

@@ -0,0 +1,24 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+export function readableStreamToBuffer({ stream, }) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const reader = stream.getReader();
+        const chunks = [];
+        let done = false;
+        while (!done) {
+            const { done: streamDone, value } = yield reader.read();
+            done = streamDone;
+            if (!done) {
+                chunks.push(value);
+            }
+        }
+        return Buffer.concat(chunks);
+    });
+}

package/lib/web/factory.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright (C) 2022-2023 Permanent Data Solutions, Inc. All Rights Reserved.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+import { TurboBaseFactory } from '../common/factory.js';
+import { TurboAuthenticatedClient } from '../common/index.js';
+import { TurboPrivateConfiguration } from '../types/index.js';
+export declare class TurboFactory extends TurboBaseFactory {
+    static authenticated({ privateKey, paymentServiceConfig, uploadServiceConfig, }: TurboPrivateConfiguration): TurboAuthenticatedClient;
+}

package/lib/web/factory.js

@@ -0,0 +1,30 @@
+/**
+ * Copyright (C) 2022-2023 Permanent Data Solutions, Inc. All Rights Reserved.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+import { TurboBaseFactory } from '../common/factory.js';
+import { TurboAuthenticatedClient, TurboAuthenticatedPaymentService, TurboAuthenticatedUploadService, } from '../common/index.js';
+import { TurboWebArweaveSigner } from './signer.js';
+export class TurboFactory extends TurboBaseFactory {
+    static authenticated({ privateKey, paymentServiceConfig = {}, uploadServiceConfig = {}, }) {
+        const signer = new TurboWebArweaveSigner({ privateKey });
+        const paymentService = new TurboAuthenticatedPaymentService(Object.assign(Object.assign({}, paymentServiceConfig), { signer }));
+        const uploadService = new TurboAuthenticatedUploadService(Object.assign(Object.assign({}, uploadServiceConfig), { signer }));
+        return new TurboAuthenticatedClient({
+            uploadService,
+            paymentService,
+        });
+    }
+}

package/lib/web/index.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Copyright (C) 2022-2023 Permanent Data Solutions, Inc. All Rights Reserved.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+export * from './factory.js';
+export * from './signer.js';
+export * from '../common/index.js';

package/lib/web/index.js

@@ -0,0 +1,19 @@
+/**
+ * Copyright (C) 2022-2023 Permanent Data Solutions, Inc. All Rights Reserved.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+export * from './factory.js';
+export * from './signer.js';
+export * from '../common/index.js';

package/lib/web/signer.d.ts

@@ -0,0 +1,37 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+/**
+ * Copyright (C) 2022-2023 Permanent Data Solutions, Inc. All Rights Reserved.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+import { ArweaveSigner } from 'arbundles/web';
+import { ReadableStream } from 'node:stream/web';
+import { JWKInterface } from '../types/arweave.js';
+import { TurboWalletSigner } from '../types/turbo.js';
+export declare class TurboWebArweaveSigner implements TurboWalletSigner {
+    protected privateKey: JWKInterface;
+    protected signer: ArweaveSigner;
+    constructor({ privateKey }: {
+        privateKey: JWKInterface;
+    });
+    signDataItem({ fileStreamFactory, }: {
+        fileStreamFactory: () => ReadableStream;
+    }): Promise<Buffer>;
+    generateSignedRequestHeaders(): Promise<{
+        'x-public-key': string;
+        'x-nonce': string;
+        'x-signature': string;
+    }>;
+}

package/lib/web/signer.js

@@ -0,0 +1,61 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+/**
+ * Copyright (C) 2022-2023 Permanent Data Solutions, Inc. All Rights Reserved.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+import { ArweaveSigner, createData } from 'arbundles/web';
+import Arweave from 'arweave/web/index.js';
+import { randomBytes } from 'node:crypto';
+import { toB64Url } from '../utils/base64.js';
+import { readableStreamToBuffer } from '../utils/readableStream.js';
+export class TurboWebArweaveSigner {
+    constructor({ privateKey }) {
+        this.privateKey = privateKey;
+        this.signer = new ArweaveSigner(this.privateKey);
+    }
+    signDataItem({ fileStreamFactory, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // TODO: converts the readable stream to a buffer bc incrementally signing ReadableStreams is not trivial
+            const buffer = yield readableStreamToBuffer({
+                stream: fileStreamFactory(),
+                // TODO: add payload size to get performance improvements
+            });
+            const signedDataItem = createData(buffer, this.signer);
+            yield signedDataItem.sign(this.signer);
+            return signedDataItem.getRaw();
+        });
+    }
+    // NOTE: this might be better in a parent class or elsewhere - easy enough to leave in here now and does require specific environment version of crypto
+    generateSignedRequestHeaders() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const nonce = randomBytes(16).toString('hex');
+            const buffer = Buffer.from(nonce);
+            const signature = yield Arweave.default.crypto.sign(this.privateKey, buffer);
+            return {
+                'x-public-key': this.privateKey.n,
+                'x-nonce': nonce,
+                'x-signature': toB64Url(Buffer.from(signature)),
+            };
+        });
+    }
+}

package/package.json

@@ -0,0 +1,106 @@
+{
+  "name": "@ardrive/turbo-sdk",
+  "version": "1.0.0-alpha.1",
+  "main": "./lib/node/index.js",
+  "types": "./lib/types/index.d.ts",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ardriveapp/turbo-sdk.git"
+  },
+  "files": [
+    "lib",
+    "bundles",
+    "LICENSE",
+    "README.md"
+  ],
+  "author": {
+    "name": "Permanent Data Solutions Inc",
+    "email": "info@ardrive.io",
+    "website": "https://ardrive.io"
+  },
+  "exports": {
+    ".": {
+      "import": "./lib/node/index.js",
+      "require": "./lib/node/index.js",
+      "types": "./lib/types/index.d.ts",
+      "browser": "./bundles/web.bundle.min.js"
+    },
+    "./node": {
+      "import": "./lib/node/index.js",
+      "require": "./lib/node/index.js",
+      "types": "./lib/types/index.d.ts"
+    },
+    "./web": {
+      "import": "./lib/web/index.js",
+      "require": "./lib/web/index.js",
+      "types": "./lib/types/index.d.ts",
+      "browser": "./bundles/web.bundle.min.js"
+    }
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "license": "AGPL-3.0-or-later",
+  "scripts": {
+    "build:web": "node bundle.cjs",
+    "build:esm": "yarn tsc -p tsconfig.node.json && yarn tsc -p tsconfig.web.json && cp package.json README.md LICENSE.md ./lib",
+    "build": "yarn clean && yarn build:web && yarn build:esm",
+    "clean": "rimraf [ lib coverage bundles ]",
+    "postinstall": "husky install",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
+    "format": "prettier --check .",
+    "format:fix": "prettier --write .",
+    "test": "c8 mocha --config .mocharc --exit",
+    "test:web": "c8 mocha --config .mocharc --exclude tests/**/*.node.test.ts --exit",
+    "test:node": "c8 mocha --config .mocharc --exclude tests/**/*.web.test.ts --exit",
+    "prepare": "husky install",
+    "example:mjs": "yarn build:esm && node examples/node/index.mjs",
+    "example:cjs": "yarn build:esm && node examples/node/index.cjs",
+    "example:web": "yarn build:web && cp -r bundles/* examples/web && http-server --port 8080 --host -o examples/web"
+  },
+  "dependencies": {
+    "arbundles": "^0.9.9",
+    "arweave": "^1.14.4",
+    "axios": "^1.4.0",
+    "retry-axios": "^3.0.0",
+    "winston": "^3.10.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^17.1.2",
+    "@commitlint/config-conventional": "^17.1.0",
+    "@esbuild-plugins/node-modules-polyfill": "^0.2.2",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@trivago/prettier-plugin-sort-imports": "^4.2.0",
+    "@types/chai": "^4.3.5",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^20.4.8",
+    "@types/sinon": "^10.0.15",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
+    "@typescript-eslint/parser": "^6.4.0",
+    "c8": "^8.0.1",
+    "chai": "^4.3.7",
+    "esbuild": "^0.19.2",
+    "eslint": "^8.47.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-config-standard-with-typescript": "^37.0.0",
+    "eslint-plugin-header": "^3.1.1",
+    "eslint-plugin-import": "^2.28.0",
+    "eslint-plugin-mocha": "^10.1.0",
+    "eslint-plugin-n": "^16.0.1",
+    "eslint-plugin-prettier": "^5.0.0",
+    "eslint-plugin-promise": "^6.1.1",
+    "http-server": "^14.1.1",
+    "husky": "^8.0.3",
+    "mocha": "^10.2.0",
+    "node-stdlib-browser": "^1.2.0",
+    "prettier": "^3.0.2",
+    "rimraf": "^5.0.1",
+    "semantic-release": "^21.0.7",
+    "sinon": "^15.2.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.1.6"
+  }
+}