@ardrive/turbo-sdk 1.7.1 → 1.8.0

package/lib/cjs/common/factory.js

@@ -1,8 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TurboBaseFactory = void 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/>.
+ */
+const arbundles_1 = require("arbundles");
+const signer_js_1 = require("../node/signer.js");
+const types_js_1 = require("../types.js");
+const signer_js_2 = require("../web/signer.js");
 const logger_js_1 = require("./logger.js");
 const payment_js_1 = require("./payment.js");
+const index_js_1 = require("./token/index.js");
 const turbo_js_1 = require("./turbo.js");
 const upload_js_1 = require("./upload.js");
 class TurboBaseFactory {
@@ -26,6 +47,83 @@ class TurboBaseFactory {
             paymentService,
         });
     }
+    static getSigner(providedSigner, providedPrivateKey, token) {
+        let signer;
+        if (providedSigner !== undefined) {
+            signer = providedSigner;
+        }
+        else if (providedPrivateKey !== undefined) {
+            if (token === 'solana') {
+                signer = new arbundles_1.HexSolanaSigner(providedPrivateKey);
+                // TODO: else if (token === 'ethereum') {signer = new EthereumSigner(providedPrivateKey);}
+            }
+            else {
+                if (!(0, types_js_1.isJWK)(providedPrivateKey)) {
+                    throw new Error('A JWK must be provided for ArweaveSigner.');
+                }
+                signer = new arbundles_1.ArweaveSigner(providedPrivateKey);
+            }
+        }
+        else {
+            throw new Error('A privateKey or signer must be provided.');
+        }
+        if (typeof window !== 'undefined') {
+            return new signer_js_2.TurboWebArweaveSigner({
+                signer,
+                logger: this.logger,
+            });
+        }
+        return new signer_js_1.TurboNodeSigner({
+            signer,
+            logger: this.logger,
+        });
+    }
+    static authenticated({ privateKey, signer: providedSigner, paymentServiceConfig = {}, uploadServiceConfig = {}, token, tokenMap, gatewayUrl, tokenTools, }) {
+        if (!token) {
+            if (providedSigner) {
+                // Derive token from signer if not provided
+                if (providedSigner instanceof arbundles_1.EthereumSigner) {
+                    token = 'ethereum';
+                }
+                else if (providedSigner instanceof arbundles_1.HexSolanaSigner) {
+                    token = 'solana';
+                }
+                else {
+                    token = 'arweave';
+                }
+            }
+            else {
+                token = 'arweave';
+            }
+        }
+        const turboSigner = this.getSigner(providedSigner, privateKey, token);
+        if (!tokenTools) {
+            if (tokenMap && token === 'arweave') {
+                tokenTools = tokenMap.arweave;
+            }
+            tokenTools = index_js_1.defaultTokenMap[token]?.({
+                gatewayUrl,
+                logger: this.logger,
+            });
+        }
+        const paymentService = new payment_js_1.TurboAuthenticatedPaymentService({
+            ...paymentServiceConfig,
+            signer: turboSigner,
+            logger: this.logger,
+            token,
+            tokenTools,
+        });
+        const uploadService = new upload_js_1.TurboAuthenticatedUploadService({
+            ...uploadServiceConfig,
+            signer: turboSigner,
+            logger: this.logger,
+            token,
+        });
+        return new turbo_js_1.TurboAuthenticatedClient({
+            uploadService,
+            paymentService,
+        });
+    }
 }
 exports.TurboBaseFactory = TurboBaseFactory;
 TurboBaseFactory.logger = new logger_js_1.TurboWinstonLogger();

package/lib/cjs/common/index.js

@@ -34,4 +34,4 @@ __exportStar(require("./upload.js"), exports);
 __exportStar(require("./payment.js"), exports);
 __exportStar(require("./turbo.js"), exports);
 __exportStar(require("./currency.js"), exports);
-__exportStar(require("./token.js"), exports);
+__exportStar(require("./token/index.js"), exports);

package/lib/cjs/common/payment.js

@@ -20,7 +20,6 @@ exports.TurboAuthenticatedPaymentService = exports.TurboUnauthenticatedPaymentSe
 const bignumber_js_1 = require("bignumber.js");
 const http_js_1 = require("./http.js");
 const logger_js_1 = require("./logger.js");
-const token_js_1 = require("./token.js");
 exports.developmentPaymentServiceURL = 'https://payment.ardrive.dev';
 exports.defaultPaymentServiceURL = 'https://payment.ardrive.io';
 class TurboUnauthenticatedPaymentService {
@@ -134,14 +133,10 @@ class TurboUnauthenticatedPaymentService {
 exports.TurboUnauthenticatedPaymentService = TurboUnauthenticatedPaymentService;
 // NOTE: to avoid redundancy, we use inheritance here - but generally prefer composition over inheritance
 class TurboAuthenticatedPaymentService extends TurboUnauthenticatedPaymentService {
-    constructor({ url = exports.defaultPaymentServiceURL, retryConfig, signer, logger = new logger_js_1.TurboWinstonLogger(), token = 'arweave', tokenMap = {
-        arweave: new token_js_1.ArweaveToken({
-            logger,
-        }),
-    }, }) {
+    constructor({ url = exports.defaultPaymentServiceURL, retryConfig, signer, logger = new logger_js_1.TurboWinstonLogger(), token = 'arweave', tokenTools, }) {
         super({ url, retryConfig, logger, token });
         this.signer = signer;
-        this.tokenMap = tokenMap;
+        this.tokenTools = tokenTools;
     }
     async getBalance() {
         const headers = await this.signer.generateSignedRequestHeaders();
@@ -173,7 +168,7 @@ class TurboAuthenticatedPaymentService extends TurboUnauthenticatedPaymentServic
         return walletAddress;
     }
     async topUpWithTokens({ feeMultiplier = 1, tokenAmount: tokenAmountV, }) {
-        if (!this.tokenMap[this.token]) {
+        if (!this.tokenTools) {
             throw new Error(`Token type not supported for crypto fund ${this.token}`);
         }
         const tokenAmount = new bignumber_js_1.BigNumber(tokenAmountV);
@@ -183,18 +178,16 @@ class TurboAuthenticatedPaymentService extends TurboUnauthenticatedPaymentServic
             tokenAmount,
             target,
         });
-        const fundTx = await this.tokenMap[this.token].createSignedTx({
+        const fundTx = await this.tokenTools.createAndSubmitTx({
             target,
             tokenAmount,
             feeMultiplier,
             signer: this.signer,
         });
         const txId = fundTx.id;
-        this.logger.debug('Submitting fund transaction...', { txId });
-        await this.tokenMap[this.token].submitTx({ tx: fundTx });
         try {
             // Let transaction settle some time
-            await this.tokenMap[this.token].pollForTxBeingAvailable({ txId });
+            await this.tokenTools.pollForTxBeingAvailable({ txId });
             return {
                 ...(await this.submitFundTransaction({ txId })),
                 target: fundTx.target,

package/lib/cjs/common/signer.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TurboDataItemAbstractSigner = void 0;
 /**
@@ -19,6 +22,7 @@ exports.TurboDataItemAbstractSigner = void 0;
  */
 const arbundles_1 = require("arbundles");
 const crypto_1 = require("crypto");
+const tweetnacl_1 = __importDefault(require("tweetnacl"));
 const base64_js_1 = require("../utils/base64.js");
 /**
  * Abstract class for signing TurboDataItems.
@@ -62,6 +66,16 @@ class TurboDataItemAbstractSigner {
         return this.signer.publicKey;
     }
     async signData(dataToSign) {
+        if (this.signer instanceof arbundles_1.HexSolanaSigner) {
+            const privateKey = this.signer.key;
+            const publicKey = Uint8Array.from(await this.getPublicKey());
+            // Concatenate the private and public keys correctly
+            const combinedKey = new Uint8Array(privateKey.length + publicKey.length);
+            combinedKey.set(privateKey);
+            combinedKey.set(publicKey, privateKey.length);
+            const signature = tweetnacl_1.default.sign.detached(dataToSign, combinedKey);
+            return signature;
+        }
         return this.signer.sign(dataToSign);
     }
 }

package/lib/cjs/common/{token.js → token/arweave.js}

@@ -22,23 +22,23 @@ exports.ARToTokenAmount = exports.WinstonToTokenAmount = exports.ArweaveToken =
  */
 const arweave_1 = __importDefault(require("@irys/arweave"));
 const bignumber_js_1 = require("bignumber.js");
-const base64_js_1 = require("../utils/base64.js");
-const common_js_1 = require("../utils/common.js");
-const logger_js_1 = require("./logger.js");
+const base64_js_1 = require("../../utils/base64.js");
+const common_js_1 = require("../../utils/common.js");
+const logger_js_1 = require("../logger.js");
 class ArweaveToken {
-    constructor({ arweave = arweave_1.default.init({
-        url: 'https://arweave.net',
+    constructor({ gatewayUrl = 'https://arweave.net', arweave = arweave_1.default.init({
+        url: gatewayUrl,
     }), logger = new logger_js_1.TurboWinstonLogger(), mintU = true, pollingOptions = {
         maxAttempts: 10,
         pollingIntervalMs: 3000,
         initialBackoffMs: 7000,
-    }, }) {
+    }, } = {}) {
         this.arweave = arweave;
         this.logger = logger;
         this.mintU = mintU;
         this.pollingOptions = pollingOptions;
     }
-    async createSignedTx({ feeMultiplier, target, tokenAmount, signer, }) {
+    async createAndSubmitTx({ feeMultiplier, target, tokenAmount, signer, }) {
         const tx = await this.arweave.createTransaction({
             target,
             quantity: tokenAmount.toString(),
@@ -66,7 +66,9 @@ class ArweaveToken {
             owner: publicKeyB64Url,
             signature: (0, base64_js_1.toB64Url)(signatureBuffer),
         });
-        return tx;
+        this.logger.debug('Submitting fund transaction...', { id });
+        await this.submitTx(tx);
+        return { id, target, reward: tx.reward };
     }
     async pollForTxBeingAvailable({ txId, }) {
         const { maxAttempts, pollingIntervalMs, initialBackoffMs } = this.pollingOptions;
@@ -111,12 +113,13 @@ class ArweaveToken {
         }
         throw new Error('Transaction not found after polling, transaction id: ' + txId);
     }
-    async submitTx({ tx }) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    async submitTx(tx) {
         try {
             const response = await this.arweave.transactions.post(tx);
             if (response.status !== 200) {
                 throw new Error('Failed to post transaction -- ' +
-                    `Status ${response.status}, ${response.statusText}`);
+                    `Status ${response.status}, ${response.statusText}, ${response.data}`);
             }
             this.logger.debug('Successfully posted fund transaction...', { tx });
         }

package/lib/cjs/common/token/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultTokenMap = void 0;
+const arweave_js_1 = require("./arweave.js");
+const solana_js_1 = require("./solana.js");
+exports.defaultTokenMap = {
+    arweave: (config) => new arweave_js_1.ArweaveToken(config),
+    solana: (config) => new solana_js_1.SolanaToken(config),
+    // ethereum: (config: TokenConfig) => new EthereumToken(config)
+};
+__exportStar(require("./arweave.js"), exports);
+__exportStar(require("./solana.js"), exports);

package/lib/cjs/common/token/solana.js

@@ -0,0 +1,112 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SolanaToken = exports.SOLToTokenAmount = exports.lamportToTokenAmount = void 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/>.
+ */
+const web3_js_1 = require("@solana/web3.js");
+const bignumber_js_1 = require("bignumber.js");
+const bs58_1 = __importDefault(require("bs58"));
+const common_js_1 = require("../../utils/common.js");
+const logger_js_1 = require("../logger.js");
+const lamportToTokenAmount = (winston) => winston;
+exports.lamportToTokenAmount = lamportToTokenAmount;
+const SOLToTokenAmount = (sol) => new bignumber_js_1.BigNumber(sol).times(1e9).valueOf();
+exports.SOLToTokenAmount = SOLToTokenAmount;
+class SolanaToken {
+    constructor({ logger = new logger_js_1.TurboWinstonLogger(), gatewayUrl = 'https://api.mainnet-beta.solana.com', pollingOptions = {
+        maxAttempts: 10,
+        pollingIntervalMs: 5000,
+        initialBackoffMs: 7000,
+    }, } = {}) {
+        this.logger = logger;
+        this.gatewayUrl = gatewayUrl;
+        this.connection = new web3_js_1.Connection(gatewayUrl, 'confirmed');
+        this.pollingOptions = pollingOptions;
+    }
+    async createAndSubmitTx({ target, tokenAmount, signer, }) {
+        const publicKey = new web3_js_1.PublicKey(bs58_1.default.encode(await signer.getPublicKey()));
+        const tx = new web3_js_1.Transaction({
+            feePayer: publicKey,
+            ...(await this.connection.getLatestBlockhash()),
+        });
+        tx.add(web3_js_1.SystemProgram.transfer({
+            fromPubkey: publicKey,
+            toPubkey: new web3_js_1.PublicKey(target),
+            lamports: +new bignumber_js_1.BigNumber(tokenAmount),
+        }));
+        const serializedTx = tx.serializeMessage();
+        const signature = await signer.signData(serializedTx);
+        tx.addSignature(publicKey, Buffer.from(signature));
+        const id = bs58_1.default.encode(signature);
+        await this.submitTx(tx, id);
+        return { id, target };
+    }
+    async submitTx(tx, id) {
+        this.logger.debug('Submitting fund transaction...', { id });
+        await this.connection.sendRawTransaction(tx.serialize(), {
+            maxRetries: this.pollingOptions.maxAttempts,
+        });
+        if (tx.recentBlockhash === undefined ||
+            tx.lastValidBlockHeight === undefined) {
+            throw new Error('Failed to submit Transaction --  missing blockhash or lastValidBlockHeight from transaction creation. Solana Gateway Url:' +
+                this.gatewayUrl);
+        }
+        await this.connection.confirmTransaction({
+            signature: id,
+            blockhash: tx.recentBlockhash,
+            lastValidBlockHeight: tx.lastValidBlockHeight,
+        }, 'finalized');
+    }
+    async pollForTxBeingAvailable({ txId, }) {
+        const { maxAttempts, pollingIntervalMs, initialBackoffMs } = this.pollingOptions;
+        this.logger.debug('Polling for transaction...', {
+            txId,
+            pollingOptions: this.pollingOptions,
+        });
+        await (0, common_js_1.sleep)(initialBackoffMs);
+        let attempts = 0;
+        while (attempts < maxAttempts) {
+            let status = undefined;
+            attempts++;
+            try {
+                status = await this.connection.getSignatureStatus(txId);
+            }
+            catch (err) {
+                // Continue retries when request errors
+                this.logger.debug('Failed to poll for transaction...', { err });
+            }
+            if (status && status.value && status.value.err !== null) {
+                throw new Error(`Transaction failed: ${status.value.err}`);
+            }
+            if (status && status.value && status.value.slot !== null) {
+                return;
+            }
+            this.logger.debug('Transaction not found, polling...', {
+                txId,
+                attempts,
+                maxAttempts,
+                pollingIntervalMs,
+            });
+            await (0, common_js_1.sleep)(pollingIntervalMs);
+        }
+        throw new Error('Transaction not found after polling, transaction id: ' + txId);
+    }
+}
+exports.SolanaToken = SolanaToken;

package/lib/cjs/node/factory.js

@@ -17,56 +17,7 @@ exports.TurboFactory = void 0;
  * 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/>.
  */
-const arbundles_1 = require("arbundles");
 const factory_js_1 = require("../common/factory.js");
-const index_js_1 = require("../common/index.js");
-const signer_js_1 = require("../web/signer.js");
-const signer_js_2 = require("./signer.js");
 class TurboFactory extends factory_js_1.TurboBaseFactory {
-    static authenticated({ privateKey, signer: providedSigner, paymentServiceConfig = {}, uploadServiceConfig = {}, tokenMap, token, }) {
-        let signer;
-        if (providedSigner) {
-            signer = providedSigner;
-            if (!token) {
-                if (signer instanceof arbundles_1.EthereumSigner) {
-                    token = 'ethereum';
-                }
-                else if (signer instanceof arbundles_1.HexSolanaSigner) {
-                    token = 'solana';
-                }
-            }
-        }
-        else if (privateKey) {
-            signer = new arbundles_1.ArweaveSigner(privateKey);
-        }
-        else {
-            throw new Error('A privateKey or signer must be provided.');
-        }
-        // when in browser, we use TurboWebArweaveSigner
-        const turboSigner = typeof window !== 'undefined'
-            ? new signer_js_1.TurboWebArweaveSigner({
-                signer,
-                logger: this.logger,
-            })
-            : new signer_js_2.TurboNodeSigner({
-                signer,
-                logger: this.logger,
-            });
-        const paymentService = new index_js_1.TurboAuthenticatedPaymentService({
-            ...paymentServiceConfig,
-            signer: turboSigner,
-            logger: this.logger,
-            tokenMap,
-        });
-        const uploadService = new index_js_1.TurboAuthenticatedUploadService({
-            ...uploadServiceConfig,
-            signer: turboSigner,
-            logger: this.logger,
-        });
-        return new index_js_1.TurboAuthenticatedClient({
-            uploadService,
-            paymentService,
-        });
-    }
 }
 exports.TurboFactory = TurboFactory;

package/lib/cjs/types.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tokenTypes = exports.allowedFiatTokens = void 0;
+exports.isJWK = exports.tokenTypes = exports.allowedFiatTokens = void 0;
 // TODO: Remove this var and Allow all tokens when crypto fund implemented for each PE-5993, PE-5992
 exports.allowedFiatTokens = ['arweave', 'solana', 'ethereum'];
-exports.tokenTypes = ['arweave' /*'solana', 'ethereum'*/];
+exports.tokenTypes = ['arweave', 'solana' /* 'ethereum'*/];
+const isJWK = (wallet) => wallet.kty !== undefined;
+exports.isJWK = isJWK;

package/lib/cjs/version.js

@@ -18,4 +18,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-exports.version = '1.7.1';
+exports.version = '1.8.0';

package/lib/cjs/web/factory.js

@@ -20,42 +20,75 @@ exports.TurboFactory = void 0;
 const arbundles_1 = require("arbundles");
 const factory_js_1 = require("../common/factory.js");
 const index_js_1 = require("../common/index.js");
+const types_js_1 = require("../types.js");
 const signer_js_1 = require("./signer.js");
 class TurboFactory extends factory_js_1.TurboBaseFactory {
-    static authenticated({ privateKey, signer: providedSigner, paymentServiceConfig = {}, uploadServiceConfig = {}, tokenMap, token, }) {
+    static getSigner(providedSigner, providedPrivateKey, token) {
         let signer;
-        if (providedSigner) {
+        if (providedSigner !== undefined) {
             signer = providedSigner;
-            if (!token) {
-                if (signer instanceof arbundles_1.EthereumSigner) {
-                    token = 'ethereum';
-                }
-                else if (signer instanceof arbundles_1.HexSolanaSigner) {
-                    token = 'solana';
+        }
+        else if (providedPrivateKey !== undefined) {
+            if (token === 'solana') {
+                signer = new arbundles_1.HexSolanaSigner(providedPrivateKey);
+                // TODO: else if (token === 'ethereum') {signer = new EthereumSigner(providedPrivateKey);}
+            }
+            else {
+                if (!(0, types_js_1.isJWK)(providedPrivateKey)) {
+                    throw new Error('A JWK must be provided for ArweaveSigner.');
                 }
+                signer = new arbundles_1.ArweaveSigner(providedPrivateKey);
             }
         }
-        else if (privateKey) {
-            signer = new arbundles_1.ArweaveSigner(privateKey);
-        }
         else {
             throw new Error('A privateKey or signer must be provided.');
         }
-        const turboSigner = new signer_js_1.TurboWebArweaveSigner({
+        return new signer_js_1.TurboWebArweaveSigner({
             signer,
             logger: this.logger,
         });
+    }
+    static authenticated({ privateKey, signer: providedSigner, paymentServiceConfig = {}, uploadServiceConfig = {}, token, gatewayUrl, tokenMap, tokenTools, }) {
+        if (!token) {
+            if (providedSigner) {
+                // Derive token from signer if not provided
+                if (providedSigner instanceof arbundles_1.EthereumSigner) {
+                    token = 'ethereum';
+                }
+                else if (providedSigner instanceof arbundles_1.HexSolanaSigner) {
+                    token = 'solana';
+                }
+                else {
+                    token = 'arweave';
+                }
+            }
+            else {
+                token = 'arweave';
+            }
+        }
+        const turboSigner = this.getSigner(providedSigner, privateKey, token);
+        token ??= 'arweave'; // default to arweave if token is not provided
+        if (!tokenTools) {
+            if (tokenMap && token === 'arweave') {
+                tokenTools = tokenMap.arweave;
+            }
+            tokenTools = index_js_1.defaultTokenMap[token]?.({
+                gatewayUrl,
+                logger: this.logger,
+            });
+        }
         const paymentService = new index_js_1.TurboAuthenticatedPaymentService({
             ...paymentServiceConfig,
             signer: turboSigner,
             logger: this.logger,
-            tokenMap,
             token,
+            tokenTools,
         });
         const uploadService = new index_js_1.TurboAuthenticatedUploadService({
             ...uploadServiceConfig,
             signer: turboSigner,
             logger: this.logger,
+            token,
         });
         return new index_js_1.TurboAuthenticatedClient({
             uploadService,