@ardrive/turbo-sdk 1.0.0-alpha.5 → 1.0.0-alpha.7

package/lib/esm/common/turbo.d.ts

@@ -0,0 +1,73 @@
+/**
+ * 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 { Currency, TurboAbortSignal, TurboAuthenticatedClientInterface, TurboAuthenticatedPaymentServiceInterface, TurboAuthenticatedUploadServiceInterface, TurboBalanceResponse, TurboCountriesResponse, TurboCurrenciesResponse, TurboFiatToArResponse, TurboFileFactory, TurboPriceResponse, TurboPrivateClientConfiguration, TurboPublicClientConfiguration, TurboRatesResponse, TurboSignedDataItemFactory, TurboUnauthenticatedClientInterface, TurboUnauthenticatedPaymentServiceInterface, TurboUnauthenticatedUploadServiceInterface, TurboUploadDataItemResponse } from '../types/index.js';
+export declare class TurboUnauthenticatedClient implements TurboUnauthenticatedClientInterface {
+    protected readonly paymentService: TurboUnauthenticatedPaymentServiceInterface;
+    protected readonly uploadService: TurboUnauthenticatedUploadServiceInterface;
+    constructor({ uploadService, paymentService, }: TurboPublicClientConfiguration);
+    /**
+     * Returns the supported fiat currency conversion rate for 1AR based on current market prices.
+     */
+    getFiatToAR({ currency, }: {
+        currency: Currency;
+    }): Promise<TurboFiatToArResponse>;
+    /**
+     * 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(): Promise<TurboRatesResponse>;
+    /**
+     * Returns a comprehensive list of supported countries that can purchase credits through the Turbo Payment Service.
+     */
+    getSupportedCountries(): Promise<TurboCountriesResponse>;
+    /**
+     * Returns a list of all supported fiat currencies.
+     */
+    getSupportedCurrencies(): Promise<TurboCurrenciesResponse>;
+    /**
+     * 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, }: {
+        bytes: number[];
+    }): Promise<TurboPriceResponse[]>;
+    /**
+     * 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, }: {
+        amount: number;
+        currency: Currency;
+    }): Promise<Omit<TurboPriceResponse, 'adjustments'>>;
+    /**
+     * Uploads a signed data item to the Turbo Upload Service.
+     */
+    uploadSignedDataItem({ dataItemStreamFactory, signal, }: TurboSignedDataItemFactory & TurboAbortSignal): Promise<TurboUploadDataItemResponse>;
+}
+export declare class TurboAuthenticatedClient extends TurboUnauthenticatedClient implements TurboAuthenticatedClientInterface {
+    protected readonly paymentService: TurboAuthenticatedPaymentServiceInterface;
+    protected readonly uploadService: TurboAuthenticatedUploadServiceInterface;
+    constructor({ paymentService, uploadService, }: TurboPrivateClientConfiguration);
+    /**
+     * Returns the current balance of the user's wallet in 'winc'.
+     */
+    getBalance(): Promise<TurboBalanceResponse>;
+    /**
+     * Signs and uploads raw data to the Turbo Upload Service.
+     */
+    uploadFile({ fileStreamFactory, signal, }: TurboFileFactory & TurboAbortSignal): Promise<TurboUploadDataItemResponse>;
+}

package/lib/esm/common/upload.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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 { TurboAbortSignal, TurboAuthenticatedUploadServiceConfiguration, TurboAuthenticatedUploadServiceInterface, TurboFileFactory, TurboSignedDataItemFactory, TurboUnauthenticatedUploadServiceInterface, TurboUnauthenticatedUploadServiceInterfaceConfiguration, TurboUploadDataItemResponse, TurboWalletSigner } from '../types/turbo.js';
+import { TurboHTTPService } from './http.js';
+export declare class TurboUnauthenticatedUploadService implements TurboUnauthenticatedUploadServiceInterface {
+    protected httpService: TurboHTTPService;
+    constructor({ url, retryConfig, }: TurboUnauthenticatedUploadServiceInterfaceConfiguration);
+    uploadSignedDataItem({ dataItemStreamFactory, signal, }: TurboSignedDataItemFactory & TurboAbortSignal): Promise<TurboUploadDataItemResponse>;
+}
+export declare class TurboAuthenticatedUploadService extends TurboUnauthenticatedUploadService implements TurboAuthenticatedUploadServiceInterface {
+    protected httpService: TurboHTTPService;
+    protected signer: TurboWalletSigner;
+    constructor({ url, retryConfig, signer, }: TurboAuthenticatedUploadServiceConfiguration);
+    uploadFile({ fileStreamFactory, signal, }: TurboFileFactory & TurboAbortSignal): Promise<TurboUploadDataItemResponse>;
+}

package/lib/esm/node/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/esm/types/arweave.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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 interface JWKPublicInterface {
+    kty: string;
+    e: string;
+    n: string;
+}
+export interface JWKInterface extends JWKPublicInterface {
+    d?: string;
+    p?: string;
+    q?: string;
+    dp?: string;
+    dq?: string;
+    qi?: string;
+}

package/lib/esm/types/index.js

@@ -0,0 +1,18 @@
+/**
+ * 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/esm/utils/axiosClient.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 { AxiosInstance, AxiosRequestConfig } from 'axios';
+import * as rax from 'retry-axios';
+export interface AxiosInstanceParameters {
+    axiosConfig?: Omit<AxiosRequestConfig, 'validateStatus'>;
+    retryConfig?: rax.RetryConfig;
+}
+export declare const createAxiosInstance: ({ axiosConfig, retryConfig, }: AxiosInstanceParameters) => AxiosInstance;

package/lib/esm/utils/errors.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/>.
+ */
+export declare class UnauthenticatedRequestError extends Error {
+    constructor();
+}
+export declare class FailedRequestError extends Error {
+    constructor(status: number, message: string);
+}

package/lib/esm/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/esm/web/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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';
+export * from '../types/index.js';

package/lib/esm/web/index.js

@@ -0,0 +1,20 @@
+/**
+ * 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';
+export * from '../types/index.js';

package/lib/{web → esm/web}/signer.d.ts

@@ -16,7 +16,7 @@
  * 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 { ArweaveSigner } from 'arbundles';
 import { ReadableStream } from 'node:stream/web';
 import { JWKInterface } from '../types/arweave.js';
 import { TurboWalletSigner } from '../types/turbo.js';

package/lib/{web → esm/web}/signer.js

@@ -23,8 +23,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
  * 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 { ArweaveSigner, createData } from 'arbundles';
+import Arweave from 'arweave';
 import { randomBytes } from 'node:crypto';
 import { toB64Url } from '../utils/base64.js';
 import { readableStreamToBuffer } from '../utils/readableStream.js';
@@ -50,7 +50,8 @@ export class TurboWebArweaveSigner {
         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);
+            // a bit hacky - but easiest way to solve web signing issues while still building for cjs
+            const signature = yield Arweave.default.crypto.sign(this.privateKey, buffer, {});
             return {
                 'x-public-key': this.privateKey.n,
                 'x-nonce': nonce,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ardrive/turbo-sdk",
-  "version": "1.0.0-alpha.5",
+  "version": "1.0.0-alpha.7",
   "main": "./lib/node/index.js",
   "types": "./lib/types/index.d.ts",
   "type": "module",
@@ -20,9 +20,14 @@
     "website": "https://ardrive.io"
   },
   "exports": {
+    ".": {
+      "import": "./lib/esm/node/index.js",
+      "require": "./lib/cjs/node/index.js",
+      "types": "./lib/node/index.d.ts"
+    },
     "./node": {
-      "import": "./lib/node/index.js",
-      "require": "./lib/node/index.js",
+      "import": "./lib/esm/node/index.js",
+      "require": "./lib/cjs/node/index.js",
       "types": "./lib/node/index.d.ts"
     },
     "./web": {
@@ -34,7 +39,7 @@
     "./*": {
       "import": "./*.js",
       "require": "./*.js",
-      "types": "./*.d.ts"
+      "types": "./lib/web/index.d.ts"
     }
   },
   "engines": {
@@ -43,8 +48,7 @@
   "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",
-    "build": "yarn clean && yarn build:web && yarn build:esm",
+    "build": "yarn clean && yarn tsc -p tsconfig.json && yarn tsc -p tsconfig.cjs.json",
     "clean": "rimraf [ lib coverage bundles ]",
     "lint": "eslint src",
     "lint:fix": "eslint src --fix",