@ardrive/turbo-sdk 1.0.0-alpha.2 → 1.0.0-alpha.21

package/lib/README.md

@@ -1,114 +0,0 @@
-# @ardriveapp/turbo-sdk 🚀
-
-Welcome to the `@ardrive/turbo-sdk`! This SDK provides functionalities for interacting with the Turbo Upload and Payment Services. It is available in both NodeJS and Web environments.
-
-## Table of Contents
-
-- [Installation](#installation)
-- [Usage](#usage):
-
-  - [NodeJS Environments](#nodejs)
-    - [CommonJS](#commonjs)
-    - [ESM](#esm)
-  - [Web Environments](#web)
-    - [Bundlers (Webpack, Rollup, ESbuild, etc.)](#bundlers-webpack-rollup-esbuild-etc)
-    - [Browser](#browser)
-  - [Typescript](#typescript)
-  - [Examples](./examples)
-
-- [Contributions](#contributions)
-
-## Installation
-
-```shell
-npm install @ardrive/turbo-sdk
-```
-
-or
-
-```shell
-yarn add @ardrive/turbo-sdk
-```
-
-## Usage
-
-The SDK is available in both CommonJS and ESM formats and is compatible with bundlers such as Webpack, Rollup, and ESbuild.
-
-### Web
-
-#### Bundlers (Webpack, Rollup, ESbuild, etc.)
-
-```javascript
-import { TurboFactory } from '@ardrive/turbo-sdk/web';
-
-const turbo = TurboFactory.unauthenticated({});
-const rates = await turbo.getFiatRates();
-```
-
-#### Browser
-
-```html
-<script src="https://cdn.jsdelivr.net/npm/@ardrive/turbo-sdk"></script>
-<script>
-  const turbo = TurboFactory.unauthenticated({});
-  const rates = await turbo.getFiatRates();
-</script>
-```
-
-### NodeJS
-
-#### CommonJS
-
-```javascript
-const { TurboFactory } = require('@ardrive/turbo-sdk/node');
-
-const turbo = TurboFactory.unauthenticated({});
-const rates = await turbo.getFiatRates();
-```
-
-### ESM
-
-```javascript
-import { TurboFactory } from '@ardrive/turbo-sdk/node';
-
-const turbo = TurboFactory.unauthenticated({});
-const rates = await turbo.getFiatRates();
-```
-
-### Typescript
-
-The SDK provides TypeScript typings. When you import the SDK in a TypeScript project:
-
-```typescript
-import Ardrive from '@ardrive/turbo-sdk/web';
-
-// or '@ardrive/turbo-sdk/node' for Node.js projects
-```
-
-The provided typings (`./lib/types/index.d.ts`) will be automatically recognized, offering type checking and autocompletion benefits.
-
-## APIs (WIP)
-
-### TurboFactory
-
-- `public()`
-- `private()`
-
-### TurboUnauthenticatedClient
-
-- `getFiatRates()`
-- `getFiatToAR()`
-- `getSupportedCountries()`
-- `getSupportedCurrencies()`
-- `getWincForFiat()`
-- `getUploadCosts()`
-- `uploadSignedDataItem()`
-
-### TurboAuthenticatedClient
-
-- `getBalance()`
-- `uploadFile()`
-
-## Contributions
-
-If you encounter any issues or have feature requests, please file an issue on our GitHub repository. Contributions, pull requests, and feedback are welcome and encouraged.

package/lib/common/http.js

@@ -1,45 +0,0 @@
-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());
-    });
-};
-import { createAxiosInstance } from '../utils/axiosClient.js';
-import { FailedRequestError } from '../utils/errors.js';
-export class TurboHTTPService {
-    constructor({ url, retryConfig, }) {
-        this.axios = createAxiosInstance({
-            axiosConfig: {
-                baseURL: url,
-            },
-            retryConfig,
-        });
-    }
-    get({ endpoint, signal, allowedStatuses = [200, 202], headers, }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { status, statusText, data } = yield this.axios.get(endpoint, {
-                headers,
-                signal,
-            });
-            if (!allowedStatuses.includes(status)) {
-                throw new FailedRequestError(status, statusText);
-            }
-            return data;
-        });
-    }
-    post({ endpoint, signal, allowedStatuses = [200, 202], headers, data, }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { status, statusText, data: response, } = yield this.axios.post(endpoint, data, {
-                headers,
-                signal,
-            });
-            if (!allowedStatuses.includes(status)) {
-                throw new FailedRequestError(status, statusText);
-            }
-            return response;
-        });
-    }
-}

package/lib/common/payment.js

@@ -1,81 +0,0 @@
-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());
-    });
-};
-import { TurboHTTPService } from './http.js';
-export class TurboUnauthenticatedPaymentService {
-    constructor({ url = 'https://payment.ardrive.dev', retryConfig, }) {
-        this.httpService = new TurboHTTPService({
-            url: `${url}/v1`,
-            retryConfig,
-        });
-    }
-    getFiatRates() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.httpService.get({
-                endpoint: '/rates',
-            });
-        });
-    }
-    getFiatToAR({ currency, }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.httpService.get({
-                endpoint: `/rates/${currency}`,
-            });
-        });
-    }
-    getSupportedCountries() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.httpService.get({
-                endpoint: '/countries',
-            });
-        });
-    }
-    getSupportedCurrencies() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.httpService.get({
-                endpoint: '/currencies',
-            });
-        });
-    }
-    getUploadCosts({ bytes, }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const fetchPricePromises = bytes.map((byteCount) => this.httpService.get({
-                endpoint: `/price/bytes/${byteCount}`,
-            }));
-            const wincCostsForBytes = yield Promise.all(fetchPricePromises);
-            return wincCostsForBytes;
-        });
-    }
-    getWincForFiat({ amount, currency }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.httpService.get({
-                endpoint: `/price/${currency}/${amount}`,
-            });
-        });
-    }
-}
-// NOTE: to avoid redundancy, we use inheritance here - but generally prefer composition over inheritance
-export class TurboAuthenticatedPaymentService extends TurboUnauthenticatedPaymentService {
-    constructor({ url = 'https://payment.ardrive.dev', retryConfig, signer, }) {
-        super({ url, retryConfig });
-        this.signer = signer;
-    }
-    getBalance() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const headers = yield this.signer.generateSignedRequestHeaders();
-            const balance = yield this.httpService.get({
-                endpoint: '/balance',
-                headers,
-                allowedStatuses: [200, 404],
-            });
-            // 404's don't return a balance, so default to 0
-            return balance.winc ? balance : { winc: '0' };
-        });
-    }
-}

package/lib/common/turbo.js

@@ -1,100 +0,0 @@
-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());
-    });
-};
-import { TurboUnauthenticatedPaymentService } from './payment.js';
-import { TurboUnauthenticatedUploadService } from './upload.js';
-export class TurboUnauthenticatedClient {
-    constructor({ uploadService = new TurboUnauthenticatedUploadService({}), paymentService = new TurboUnauthenticatedPaymentService({}), }) {
-        this.paymentService = paymentService;
-        this.uploadService = uploadService;
-    }
-    /**
-     * Returns the supported fiat currency conversion rate for 1AR based on current market prices.
-     */
-    getFiatToAR({ currency, }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.paymentService.getFiatToAR({ currency });
-        });
-    }
-    /**
-     * Returns the latest conversion rates to purchase 1GiB of data for all supported currencies, including all adjustments and fees.
-     *
-     * Note: this does not take into account varying adjustments and promotions for different sizes of data. If you want to calculate the total
-     * cost in 'winc' for a given number of bytes, use getUploadCosts.
-     */
-    getFiatRates() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.paymentService.getFiatRates();
-        });
-    }
-    /**
-     * Returns a comprehensive list of supported countries that can purchase credits through the Turbo Payment Service.
-     */
-    getSupportedCountries() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.paymentService.getSupportedCountries();
-        });
-    }
-    /**
-     * Returns a list of all supported fiat currencies.
-     */
-    getSupportedCurrencies() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.paymentService.getSupportedCurrencies();
-        });
-    }
-    /**
-     * Determines the price in 'winc' to upload one data item of a specific size in bytes, including all Turbo cost adjustments and fees.
-     */
-    getUploadCosts({ bytes, }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.paymentService.getUploadCosts({ bytes });
-        });
-    }
-    /**
-     * Determines the amount of 'winc' that would be returned for a given currency and amount, including all Turbo cost adjustments and fees.
-     */
-    getWincForFiat({ amount, currency, }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.paymentService.getWincForFiat({ amount, currency });
-        });
-    }
-    /**
-     * Uploads a signed data item to the Turbo Upload Service.
-     */
-    uploadSignedDataItem({ dataItemStreamFactory, signal, }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.uploadService.uploadSignedDataItem({
-                dataItemStreamFactory,
-                signal,
-            });
-        });
-    }
-}
-export class TurboAuthenticatedClient extends TurboUnauthenticatedClient {
-    constructor({ paymentService, uploadService, }) {
-        super({ paymentService, uploadService });
-    }
-    /**
-     * Returns the current balance of the user's wallet in 'winc'.
-     */
-    getBalance() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.paymentService.getBalance();
-        });
-    }
-    /**
-     * Signs and uploads raw data to the Turbo Upload Service.
-     */
-    uploadFile({ fileStreamFactory, signal, }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.uploadService.uploadFile({ fileStreamFactory, signal });
-        });
-    }
-}

package/lib/common/upload.js

@@ -1,54 +0,0 @@
-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());
-    });
-};
-import { TurboHTTPService } from './http.js';
-export class TurboUnauthenticatedUploadService {
-    constructor({ url = 'https://upload.ardrive.dev', retryConfig, }) {
-        this.httpService = new TurboHTTPService({
-            url: `${url}/v1`,
-            retryConfig,
-        });
-    }
-    uploadSignedDataItem({ dataItemStreamFactory, signal, }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            // TODO: add p-limit constraint or replace with separate upload class
-            return this.httpService.post({
-                endpoint: `/tx`,
-                signal,
-                data: dataItemStreamFactory(),
-                headers: {
-                    'content-type': 'application/octet-stream',
-                },
-            });
-        });
-    }
-}
-// NOTE: to avoid redundancy, we use inheritance here - but generally prefer composition over inheritance
-export class TurboAuthenticatedUploadService extends TurboUnauthenticatedUploadService {
-    constructor({ url = 'https://upload.ardrive.dev', retryConfig, signer, }) {
-        super({ url, retryConfig });
-        this.signer = signer;
-    }
-    uploadFile({ fileStreamFactory, signal, }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const signedDataItem = yield this.signer.signDataItem({
-                fileStreamFactory,
-            });
-            // TODO: add p-limit constraint or replace with separate upload class
-            return this.httpService.post({
-                endpoint: `/tx`,
-                signal,
-                data: signedDataItem,
-                headers: {
-                    'content-type': 'application/octet-stream',
-                },
-            });
-        });
-    }
-}

package/lib/package.json

@@ -1,105 +0,0 @@
-{
-  "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 ]",
-    "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"
-  }
-}

package/lib/types/index.d.ts

@@ -1,18 +0,0 @@
-/**
- * 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 './arweave.js';
-export * from './turbo.js';

package/lib/types/index.js

@@ -1,18 +0,0 @@
-/**
- * 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 './arweave.js';
-export * from './turbo.js';

package/lib/utils/readableStream.js

@@ -1,24 +0,0 @@
-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/signer.js

@@ -1,61 +0,0 @@
-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)),
-            };
-        });
-    }
-}