@ardrive/turbo-sdk 1.0.0-alpha.1

package/lib/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/node/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 { TurboNodeArweaveSigner } from './signer.js';
+export class TurboFactory extends TurboBaseFactory {
+    static authenticated({ privateKey, paymentServiceConfig = {}, uploadServiceConfig = {}, }) {
+        const signer = new TurboNodeArweaveSigner({ 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/node/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/node/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/node/signer.d.ts

@@ -0,0 +1,36 @@
+/// <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';
+import { Readable } from 'node:stream';
+import { JWKInterface } from '../types/arweave.js';
+import { TurboWalletSigner } from '../types/turbo.js';
+export declare class TurboNodeArweaveSigner implements TurboWalletSigner {
+    protected privateKey: JWKInterface;
+    protected signer: ArweaveSigner;
+    constructor({ privateKey }: {
+        privateKey: JWKInterface;
+    });
+    signDataItem({ fileStreamFactory, }: {
+        fileStreamFactory: () => Readable;
+    }): Promise<Readable>;
+    generateSignedRequestHeaders(): Promise<{
+        'x-public-key': string;
+        'x-nonce': string;
+        'x-signature': string;
+    }>;
+}

package/lib/node/signer.js

@@ -0,0 +1,54 @@
+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, streamSigner } from 'arbundles';
+import Arweave from 'arweave/node/index.js';
+import { randomBytes } from 'node:crypto';
+import { toB64Url } from '../utils/base64.js';
+export class TurboNodeArweaveSigner {
+    // TODO: replace with internal signer class
+    constructor({ privateKey }) {
+        this.privateKey = privateKey;
+        this.signer = new ArweaveSigner(this.privateKey);
+    }
+    signDataItem({ fileStreamFactory, }) {
+        // TODO: replace with our own signer implementation
+        const [stream1, stream2] = [fileStreamFactory(), fileStreamFactory()];
+        return streamSigner(stream1, stream2, this.signer);
+    }
+    // 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.crypto.sign(this.privateKey, buffer);
+            return {
+                'x-public-key': this.privateKey.n,
+                'x-nonce': nonce,
+                'x-signature': toB64Url(Buffer.from(signature)),
+            };
+        });
+    }
+}

package/lib/package.json

@@ -0,0 +1,106 @@
+{
+  "name": "@ardrive/turbo-sdk",
+  "version": "0.0.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"
+  }
+}

package/lib/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/types/arweave.js

@@ -0,0 +1 @@
+export {};

package/lib/types/index.d.ts

@@ -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/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/types/turbo.d.ts

@@ -0,0 +1,149 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <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 { Readable } from 'node:stream';
+import { ReadableStream } from 'node:stream/web';
+import { RetryConfig } from 'retry-axios';
+import winston from 'winston';
+import { JWKInterface } from './arweave.js';
+export type Base64String = string;
+export type PublicArweaveAddress = Base64String;
+export type TransactionId = Base64String;
+export type UserAddress = string | PublicArweaveAddress;
+export type Currency = 'usd' | 'eur' | 'gbp' | 'cad' | 'aud' | 'nzd' | 'jpy';
+export type Country = 'United States' | 'United Kingdom' | 'Canada';
+export type CurrencyLimit = {
+    minimumPaymentAmount: number;
+    maximumPaymentAmount: number;
+    suggestedPaymentAmount: number[];
+    zeroDecimalCurrency: boolean;
+};
+export type TurboPriceResponse = {
+    winc: string;
+    adjustments: any;
+};
+export type TurboBalanceResponse = Omit<TurboPriceResponse, 'adjustments'>;
+export type TurboFiatToArResponse = {
+    currency: Currency;
+    rate: number;
+};
+export type TurboRatesResponse = TurboPriceResponse & Record<'fiat', Record<Currency, number>>;
+export type TurboCountriesResponse = Country[];
+export type TurboCurrenciesResponse = {
+    supportedCurrencies: Currency[];
+    limits: Record<Currency, CurrencyLimit>;
+};
+export type TurboUploadDataItemResponse = {
+    dataCaches: string[];
+    fastFinalityIndexes: string[];
+    id: TransactionId;
+    owner: PublicArweaveAddress;
+};
+export type TurboWallet = JWKInterface;
+export type TurboSignedRequestHeaders = {
+    'x-public-key': string;
+    'x-nonce': string;
+    'x-signature': string;
+};
+type TurboAuthConfiguration = {
+    signer: TurboWalletSigner;
+};
+type TurboServiceConfiguration = {
+    url?: string;
+    retryConfig?: RetryConfig;
+    logger?: winston.Logger;
+};
+export type TurboUnauthenticatedUploadServiceInterfaceConfiguration = TurboServiceConfiguration;
+export type TurboAuthenticatedUploadServiceConfiguration = TurboUnauthenticatedUploadServiceInterfaceConfiguration & TurboAuthConfiguration;
+export type TurboUnauthenticatedPaymentServiceInterfaceConfiguration = TurboServiceConfiguration;
+export type TurboAuthenticatedPaymentServiceInterfaceConfiguration = TurboServiceConfiguration & TurboAuthConfiguration;
+export type TurboPublicConfiguration = {
+    paymentServiceConfig?: TurboUnauthenticatedPaymentServiceInterfaceConfiguration;
+    uploadServiceConfig?: TurboUnauthenticatedUploadServiceInterfaceConfiguration;
+};
+export type TurboPrivateConfiguration = TurboPublicConfiguration & {
+    privateKey: TurboWallet;
+};
+export type TurboPublicClientConfiguration = {
+    paymentService: TurboUnauthenticatedPaymentServiceInterface;
+    uploadService: TurboUnauthenticatedUploadServiceInterface;
+};
+export type TurboPrivateClientConfiguration = {
+    paymentService: TurboAuthenticatedPaymentServiceInterface;
+    uploadService: TurboAuthenticatedUploadServiceInterface;
+};
+export type FileStreamFactory = (() => Readable) | (() => ReadableStream) | (() => Buffer);
+export type SignedDataStreamFactory = FileStreamFactory;
+export type TurboFileFactory = {
+    fileStreamFactory: FileStreamFactory;
+};
+export type TurboSignedDataItemFactory = {
+    dataItemStreamFactory: SignedDataStreamFactory;
+};
+export type TurboAbortSignal = {
+    signal?: AbortSignal;
+};
+export interface TurboHTTPServiceInterface {
+    get<T>({ endpoint, signal, headers, allowedStatuses, }: {
+        endpoint: string;
+        signal?: AbortSignal;
+        headers?: Partial<TurboSignedRequestHeaders> & Record<string, string>;
+        allowedStatuses?: number[];
+    }): Promise<T>;
+    post<T>({ endpoint, signal, headers, allowedStatuses, data, }: {
+        endpoint: string;
+        signal: AbortSignal;
+        headers?: Partial<TurboSignedRequestHeaders> & Record<string, string>;
+        allowedStatuses?: number[];
+        data: Readable | ReadableStream | Buffer;
+    }): Promise<T>;
+}
+export interface TurboWalletSigner {
+    signDataItem({ fileStreamFactory, }: TurboFileFactory): Promise<Readable> | Promise<Buffer>;
+    generateSignedRequestHeaders(): Promise<TurboSignedRequestHeaders>;
+}
+export interface TurboUnauthenticatedPaymentServiceInterface {
+    getSupportedCurrencies(): Promise<TurboCurrenciesResponse>;
+    getSupportedCountries(): Promise<TurboCountriesResponse>;
+    getFiatToAR({ currency, }: {
+        currency: Currency;
+    }): Promise<TurboFiatToArResponse>;
+    getFiatRates(): Promise<TurboRatesResponse>;
+    getWincForFiat({ amount, currency, }: {
+        amount: number;
+        currency: Currency;
+    }): Promise<Omit<TurboPriceResponse, 'adjustments'>>;
+    getUploadCosts({ bytes }: {
+        bytes: number[];
+    }): Promise<TurboPriceResponse[]>;
+}
+export interface TurboAuthenticatedPaymentServiceInterface extends TurboUnauthenticatedPaymentServiceInterface {
+    getBalance: () => Promise<TurboBalanceResponse>;
+}
+export interface TurboUnauthenticatedUploadServiceInterface {
+    uploadSignedDataItem({ dataItemStreamFactory, signal, }: TurboSignedDataItemFactory & TurboAbortSignal): Promise<TurboUploadDataItemResponse>;
+}
+export interface TurboAuthenticatedUploadServiceInterface extends TurboUnauthenticatedUploadServiceInterface {
+    uploadFile({ fileStreamFactory, }: TurboFileFactory & TurboAbortSignal): Promise<TurboUploadDataItemResponse>;
+}
+export interface TurboUnauthenticatedClientInterface extends TurboUnauthenticatedPaymentServiceInterface, TurboUnauthenticatedUploadServiceInterface {
+}
+export interface TurboAuthenticatedClientInterface extends TurboAuthenticatedPaymentServiceInterface, TurboAuthenticatedUploadServiceInterface {
+}
+export {};

package/lib/types/turbo.js

@@ -0,0 +1 @@
+export {};

package/lib/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/utils/axiosClient.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 axios from 'axios';
+import * as rax from 'retry-axios';
+export const createAxiosInstance = ({ axiosConfig = {}, retryConfig = {
+    backoffType: 'exponential',
+    retry: 3,
+    onRetryAttempt: (err) => {
+        const cfg = rax.getConfig(err);
+        console.debug(`Retry attempt #${cfg === null || cfg === void 0 ? void 0 : cfg.currentRetryAttempt}`);
+    },
+}, }) => {
+    const axiosInstance = axios.create(Object.assign(Object.assign({}, axiosConfig), { validateStatus: () => true }));
+    axiosInstance.defaults.raxConfig = Object.assign({ instance: axiosInstance }, retryConfig);
+    return axiosInstance;
+};

package/lib/utils/base64.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="node" resolution-mode="require"/>
+import { JWKInterface } from '../types/index.js';
+import { Base64String, PublicArweaveAddress } from '../types/index.js';
+export declare const base64URLRegex: RegExp;
+export declare function jwkToPublicArweaveAddress(jwk: JWKInterface): PublicArweaveAddress;
+export declare function ownerToAddress(owner: Base64String): PublicArweaveAddress;
+export declare function fromB64Url(input: Base64String): Buffer;
+export declare function toB64Url(buffer: Buffer): Base64String;
+export declare function sha256B64Url(input: Buffer): Base64String;

package/lib/utils/base64.js

@@ -0,0 +1,39 @@
+/**
+ * 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 { bufferTob64Url } from 'arweave/node/lib/utils.js';
+import { createHash } from 'crypto';
+export const base64URLRegex = /^[a-zA-Z0-9_-]{43}$/;
+export function jwkToPublicArweaveAddress(jwk) {
+    return ownerToAddress(jwk.n);
+}
+export function ownerToAddress(owner) {
+    return sha256B64Url(fromB64Url(owner));
+}
+export function fromB64Url(input) {
+    const paddingLength = input.length % 4 === 0 ? 0 : 4 - (input.length % 4);
+    const base64 = input
+        .replace(/-/g, '+')
+        .replace(/_/g, '/')
+        .concat('='.repeat(paddingLength));
+    return Buffer.from(base64, 'base64');
+}
+export function toB64Url(buffer) {
+    return bufferTob64Url(buffer);
+}
+export function sha256B64Url(input) {
+    return toB64Url(createHash('sha256').update(input).digest());
+}

package/lib/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);
+}