permaweb-deploy 2.2.0 → 2.4.0

package/README.md

@@ -1,8 +1,9 @@
 # Permaweb Deployment Package
 
-Inspired by the [cookbook github action deployment guide](https://cookbook.arweave.dev/guides/deployment/github-action.html), `permaweb-deploy` is a Node.js command-line tool designed to streamline the deployment of web applications to the permaweb using Arweave. It simplifies the process by uploading your build folder, creating Arweave manifests, and updating ArNS (Arweave Name Service) records via ANT (Arweave Name Token) with the transaction ID.
+Inspired by the [cookbook github action deployment guide](https://cookbook.arweave.dev/guides/deployment/github-action.html), `permaweb-deploy` is a Node.js command-line tool designed to streamline the deployment of web applications to the permaweb using Arweave. It uploads your build folder or a single file, creates Arweave manifests, and updates ArNS (Arweave Name Service) records via ANT (Arweave Name Token) with the transaction ID.
 
 ### Features
+
 - **Turbo SDK Integration:** Uses Turbo SDK for fast, reliable file uploads to Arweave
 - **Arweave Manifest v0.2.0:** Creates manifests with fallback support for SPAs
 - **ArNS Updates:** Updates ArNS records via ANT with new transaction IDs and metadata
@@ -10,6 +11,7 @@ Inspired by the [cookbook github action deployment guide](https://cookbook.arwea
 - **Git Hash Tagging:** Automatically tags deployments with Git commit hashes
 - **404 Fallback Detection:** Automatically detects and sets 404.html as fallback
 - **Network Support:** Supports mainnet, testnet, and custom ARIO process IDs
+- **Flexible Deployment:** Supports deploying a folder or a single file
 
 ### Installation
 
@@ -20,39 +22,30 @@ npm install permaweb-deploy
 ```
 
 For development use:
+
 ```bash
 npm install permaweb-deploy --save-dev
 ```
 
 For Yarn users:
+
 ```bash
 yarn add permaweb-deploy --dev --ignore-engines
 ```
 
 ### Prerequisites
 
-Before using `permaweb-deploy`, you must:
-1. **Arweave Wallet:** Have an Arweave wallet with Turbo Credits for uploading
-2. **ArNS Name:** Own or control an ArNS name (which has an associated ANT process)
-3. **Wallet Encoding:** Encode your Arweave wallet key in base64 format:
+1. **For Arweave signer (default):** Encode your Arweave wallet key in base64 format and set it as a GitHub secret:
+
    ```bash
    base64 -i wallet.json | pbcopy
    ```
-4. **GitHub Secret:** Set the encoded wallet as a GitHub secret named `DEPLOY_KEY`
 
-⚠️ **Important:** Use a dedicated wallet for deployments to minimize security risks. Ensure your wallet has sufficient Turbo Credits for uploads.
+2. **For Ethereum/Polygon/KYVE signers:** Use your raw private key (no encoding needed) as the `DEPLOY_KEY`.
 
-### CLI Options
-```bash
-permaweb-deploy [options]
-```
+3. Ensure that the secret name for the encoded wallet or private key is `DEPLOY_KEY`.
 
-| Option | Alias | Description | Default | Required |
-|--------|-------|-------------|---------|----------|
-| `--arns-name` | `-n` | ArNS name for deployment | - | ✅ |
-| `--ario-process` | `-p` | ARIO process ID or "mainnet"/"testnet" | `mainnet` | ❌ |
-| `--deploy-folder` | `-d` | Folder to deploy | `./dist` | ❌ |
-| `--undername` | `-u` | ANT undername to update | `@` | ❌ |
+⚠️ **Important:** Use a dedicated wallet for deployments to minimize security risks. Ensure your wallet has sufficient Turbo Credits for uploads.
 
 ### Usage
 
@@ -61,67 +54,107 @@ To deploy your application, ensure you have a build script and a deployment scri
 ```json
 "scripts": {
     "build": "your-build-command",
-    "deploy-main": "npm run build && permaweb-deploy --arns-name <ARNS_NAME>"
+    "deploy": "npm run build && permaweb-deploy --arns-name <ARNS_NAME>"
 }
 ```
 
-**Example with custom options:**
-```bash
-permaweb-deploy --arns-name "your-arns-name" --deploy-folder "./build" --undername "app"
+Replace `<ARNS_NAME>` with your ArNS name. To deploy to an undername, add `--undername <UNDERNAME>`.
+
+#### CLI Options
+
+- `--arns-name, -n` (required): The ArNS name to update.
+- `--ario-process, -p`: ARIO process to use (`mainnet`, `testnet`, or a custom process ID). Default: mainnet.
+- `--deploy-folder, -d`: Folder to deploy. Default: `./dist`.
+- `--deploy-file, -f`: Deploy a single file instead of a folder.
+- `--undername, -u`: ANT undername to update. Default: `@`.
+- `--ttl-seconds, -t`: TTL in seconds for the ANT record (60-86400). Default: `3600`.
+- `--sig-type, -s`: Signer type for deployment. Choices: `arweave`, `ethereum`, `polygon`, `kyve`. Default: `arweave`.
+- `--help`: Show all available options and usage examples.
+- `--version`: Show the current version number.
+
+#### Example CLI Usage
+
+Deploy a folder (default):
+
+```sh
+DEPLOY_KEY=$(base64 -i wallet.json) npx permaweb-deploy --arns-name my-app
+```
+
+Deploy a specific folder:
+
+```sh
+DEPLOY_KEY=$(base64 -i wallet.json) npx permaweb-deploy --arns-name my-app --deploy-folder ./build
+```
+
+Deploy a single file:
+
+```sh
+DEPLOY_KEY=$(base64 -i wallet.json) npx permaweb-deploy --arns-name my-app --deploy-file ./path/to/file.txt
+```
+
+Deploy to an undername:
+
+```sh
+DEPLOY_KEY=$(base64 -i wallet.json) npx permaweb-deploy --arns-name my-app --undername staging
+```
+
+Deploy with a custom TTL:
+
+```sh
+DEPLOY_KEY=$(base64 -i wallet.json) npx permaweb-deploy --arns-name my-app --ttl-seconds 7200
 ```
 
-Replace `<ARNS_NAME>` with your ArNS name. You can also specify testnet, mainnet, and custom process IDs for the ARIO process to use.
+Deploy using a different signer (e.g., Ethereum):
+
+```sh
+DEPLOY_KEY=<ETH_PRIVATE_KEY> npx permaweb-deploy --arns-name my-app --sig-type ethereum
+```
+
+#### Example `package.json` Scripts
 
-**Mainnet (default) config:**
 ```json
 "scripts": {
-    "build": "your-build-command",
-    "deploy-main": "npm run build && permaweb-deploy --arns-name <ARNS_NAME> --ario-process mainnet"
+    "build": "vite build",
+    "deploy": "npm run build && permaweb-deploy --arns-name <ARNS_NAME>"
 }
 ```
 
-**Testnet config:**
+#### ARIO Process Examples
+
+**Mainnet (default):**
+
 ```json
 "scripts": {
-    "build": "your-build-command",
-    "deploy-main": "npm run build && permaweb-deploy --arns-name <ARNS_NAME> --ario-process testnet"
+    "deploy-main": "npm run build && permaweb-deploy --arns-name <ARNS_NAME>"
 }
 ```
 
-**Custom process ID config:**
+**Testnet:**
+
 ```json
 "scripts": {
-    "build": "your-build-command",
-    "deploy-main": "npm run build && permaweb-deploy --arns-name <ARNS_NAME> --ario-process GaQrvEMKBpkjofgnBi_B3IgIDmY_XYelVLB6GcRGrHc"
+    "deploy-test": "npm run build && permaweb-deploy --arns-name <ARNS_NAME> --ario-process testnet"
 }
 ```
 
-### Manual CLI Deployment
-```bash
-DEPLOY_KEY=$(base64 -i wallet.json) npx permaweb-deploy --arns-name <ARNS_NAME>
-```
+**Custom process ID:**
 
-### Technical Details
-- **Upload Service:** Uses Turbo SDK for fast, reliable file uploads to Arweave
-- **Manifest Format:** Creates Arweave manifests using version 0.2.0 specification
-- **Fallback Support:** Automatically detects `404.html` and sets it as fallback, otherwise uses `index.html`
-- **Upload Timeout:** 10-second timeout per file upload for reliability
-- **ArNS Record TTL:** Sets 3600 seconds (1 hour) TTL for ArNS records via ANT
-- **Deployment Tags:** Automatically adds `App-Name: Permaweb-Deploy` and Git hash tags
-- **Network Support:** Supports mainnet, testnet, and custom ARIO process IDs
+```json
+"scripts": {
+    "deploy-custom": "npm run build && permaweb-deploy --arns-name <ARNS_NAME> --ario-process <PROCESS_ID>"
+}
+```
 
 ### GitHub Actions Workflow
 
 To automate the deployment, set up a GitHub Actions workflow as follows:
 
 ```yaml
-name: publish
-
+name: Deploy to Permaweb
 on:
   push:
     branches:
-      - 'main'
-
+      - main
 jobs:
   publish:
     runs-on: ubuntu-latest
@@ -131,20 +164,23 @@ jobs:
         with:
           node-version: 20.x
       - run: npm install
-      - run: npm run deploy-main
+      - run: npm run deploy
         env:
           DEPLOY_KEY: ${{ secrets.DEPLOY_KEY }}
 ```
 
+
 ### Security & Best Practices
+
 - **Dedicated Wallet:** Always use a dedicated wallet for deployments to minimize security risks
-- **Wallet Encoding:** The wallet must be base64 encoded to be used in the deployment script
+- **Wallet Encoding:** Arweave wallets must be base64 encoded to be used in the deployment script
 - **ArNS Name:** The ArNS Name must be passed so that the ANT Process can be resolved to update the target undername or root record
 - **Turbo Credits:** Ensure your wallet has sufficient Turbo Credits before deployment
 - **Secret Management:** Keep your `DEPLOY_KEY` secret secure and never commit it to your repository
 - **Build Security:** Always check your build for exposed environmental secrets before deployment, as data on Arweave is permanent
 
 ### Troubleshooting
+
 - **Error: "ARNS_NAME not configured":** Ensure you're passing the `--arns-name` flag with a valid ArNS name
 - **Error: "DEPLOY_KEY not configured":** Verify your base64 encoded wallet is set as the `DEPLOY_KEY` environment variable
 - **Error: "deploy-folder does not exist":** Check that your build folder exists and the path is correct
@@ -154,8 +190,8 @@ jobs:
 - **Insufficient Turbo Credits:** Ensure your wallet has enough Turbo Credits for the deployment
 
 ### Dependencies
+
 - **@ar.io/sdk:** - For ANT operations and ArNS management
 - **@ardrive/turbo-sdk:** - For fast file uploads to Arweave
 - **@permaweb/aoconnect:** - For AO network connectivity
-- **mime-types:** - For automatic content type detection
 - **yargs:** - For CLI argument parsing

package/dist/index.js

@@ -1,13 +1,13 @@
 #!/usr/bin/env node
 "use strict";
 
+var _turboSdk = require("@ardrive/turbo-sdk");
 var _fs = _interopRequireDefault(require("fs"));
 var _yargs = _interopRequireDefault(require("yargs"));
 var _helpers = require("yargs/helpers");
+var _mimeTypes = _interopRequireDefault(require("mime-types"));
 var _sdk = require("@ar.io/sdk");
-var _turboSdk = require("@ardrive/turbo-sdk");
 var _aoconnect = require("@permaweb/aoconnect");
-var _turbo = require("./turbo");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
 function _regenerator() { /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/babel/babel/blob/main/packages/babel-helpers/LICENSE */ var e, t, r = "function" == typeof Symbol ? Symbol : {}, n = r.iterator || "@@iterator", o = r.toStringTag || "@@toStringTag"; function i(r, n, o, i) { var c = n && n.prototype instanceof Generator ? n : Generator, u = Object.create(c.prototype); return _regeneratorDefine2(u, "_invoke", function (r, n, o) { var i, c, u, f = 0, p = o || [], y = !1, G = { p: 0, n: 0, v: e, a: d, f: d.bind(e, 4), d: function d(t, r) { return i = t, c = 0, u = e, G.n = r, a; } }; function d(r, n) { for (c = r, u = n, t = 0; !y && f && !o && t < p.length; t++) { var o, i = p[t], d = G.p, l = i[2]; r > 3 ? (o = l === n) && (u = i[(c = i[4]) ? 5 : (c = 3, 3)], i[4] = i[5] = e) : i[0] <= d && ((o = r < 2 && d < i[1]) ? (c = 0, G.v = n, G.n = i[1]) : d < l && (o = r < 3 || i[0] > n || n > l) && (i[4] = r, i[5] = n, G.n = l, c = 0)); } if (o || r > 1) return a; throw y = !0, n; } return function (o, p, l) { if (f > 1) throw TypeError("Generator is already running"); for (y && 1 === p && d(p, l), c = p, u = l; (t = c < 2 ? e : u) || !y;) { i || (c ? c < 3 ? (c > 1 && (G.n = -1), d(c, u)) : G.n = u : G.v = u); try { if (f = 2, i) { if (c || (o = "next"), t = i[o]) { if (!(t = t.call(i, u))) throw TypeError("iterator result is not an object"); if (!t.done) return t; u = t.value, c < 2 && (c = 0); } else 1 === c && (t = i["return"]) && t.call(i), c < 2 && (u = TypeError("The iterator does not provide a '" + o + "' method"), c = 1); i = e; } else if ((t = (y = G.n < 0) ? u : r.call(n, G)) !== a) break; } catch (t) { i = e, c = 1, u = t; } finally { f = 1; } } return { value: t, done: y }; }; }(r, o, i), !0), u; } var a = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} t = Object.getPrototypeOf; var c = [][n] ? t(t([][n]())) : (_regeneratorDefine2(t = {}, n, function () { return this; }), t), u = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(c); function f(e) { return Object.setPrototypeOf ? Object.setPrototypeOf(e, GeneratorFunctionPrototype) : (e.__proto__ = GeneratorFunctionPrototype, _regeneratorDefine2(e, o, "GeneratorFunction")), e.prototype = Object.create(u), e; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, _regeneratorDefine2(u, "constructor", GeneratorFunctionPrototype), _regeneratorDefine2(GeneratorFunctionPrototype, "constructor", GeneratorFunction), GeneratorFunction.displayName = "GeneratorFunction", _regeneratorDefine2(GeneratorFunctionPrototype, o, "GeneratorFunction"), _regeneratorDefine2(u), _regeneratorDefine2(u, o, "Generator"), _regeneratorDefine2(u, n, function () { return this; }), _regeneratorDefine2(u, "toString", function () { return "[object Generator]"; }), (_regenerator = function _regenerator() { return { w: i, m: f }; })(); }
 function _regeneratorDefine2(e, r, n, t) { var i = Object.defineProperty; try { i({}, "", {}); } catch (e) { i = 0; } _regeneratorDefine2 = function _regeneratorDefine(e, r, n, t) { if (r) i ? i(e, r, { value: n, enumerable: !t, configurable: !t, writable: !t }) : e[r] = n;else { var o = function o(r, n) { _regeneratorDefine2(e, r, function (e) { return this._invoke(r, n, e); }); }; o("next", 0), o("throw", 1), o("return", 2); } }, _regeneratorDefine2(e, r, n, t); }
@@ -20,7 +20,7 @@ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length)
 function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
 function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; }
 var arweaveTxIdRegex = /^[a-zA-Z0-9-_]{43}$/;
-var argv = (0, _yargs["default"])((0, _helpers.hideBin)(process.argv)).option('ario-process', {
+var argv = (0, _yargs["default"])((0, _helpers.hideBin)(process.argv)).version('2.1.0').help().usage('Usage: $0 --arns-name <name> [options]').example('$0 --arns-name my-app', 'Deploy to my-app.arweave.dev').example('$0 --arns-name my-app --undername staging', 'Deploy to staging.my-app.arweave.dev').option('ario-process', {
   alias: 'p',
   type: 'string',
   description: 'The ARIO process to use',
@@ -40,22 +40,41 @@ var argv = (0, _yargs["default"])((0, _helpers.hideBin)(process.argv)).option('a
   alias: 'f',
   type: 'string',
   description: 'File to deploy.'
+}).option('ttl-seconds', {
+  alias: 't',
+  type: 'number',
+  description: 'ArNS TTL Seconds',
+  "default": 3600
 }).option('undername', {
   alias: 'u',
   type: 'string',
   description: 'ANT undername to update.',
   "default": '@'
+}).option('sig-type', {
+  alias: 's',
+  type: 'string',
+  description: 'The type of signer to be used for deployment.',
+  choices: ['arweave', 'ethereum', 'polygon',
+  // 'solana',
+  'kyve'],
+  "default": 'arweave'
+}).check(function (argv) {
+  if (argv.ttl < 60 || argv.ttl > 86400) {
+    throw new Error('TTL must be between 60 seconds (1 minute) and 86400 seconds (1 day)');
+  }
+  return true;
 }).argv;
 var DEPLOY_KEY = process.env.DEPLOY_KEY;
-var ARNS_NAME = argv.arnsName;
-var ARIO_PROCESS = argv.arioProcess;
+var ARNS_NAME = argv['arns-name'];
+var ARIO_PROCESS = argv['ario-process'];
+var TTL_SECONDS = argv['ttl-seconds'];
 if (ARIO_PROCESS === 'mainnet') {
   ARIO_PROCESS = _sdk.ARIO_MAINNET_PROCESS_ID;
 } else if (ARIO_PROCESS === 'testnet') {
   ARIO_PROCESS = _sdk.ARIO_TESTNET_PROCESS_ID;
 }
 _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee() {
-  var jwk, ario, arnsNameRecord, txId, turbo, signer, ant, _t;
+  var ario, arnsNameRecord, signer, token, jwk, turbo, uploadResult, txOrManifestId, mimeType, ant, _t, _t2;
   return _regenerator().w(function (_context) {
     while (1) switch (_context.n) {
       case 0:
@@ -71,6 +90,10 @@ _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee() {
           console.error('ARNS_NAME not configured');
           process.exit(1);
         }
+        if (!Number.isFinite(TTL_SECONDS) || TTL_SECONDS < 60 || TTL_SECONDS > 86400) {
+          console.error('TTL_SECONDS must be a number between 60 and 86400 seconds');
+          process.exit(1);
+        }
         if (argv.deployFile && !_fs["default"].existsSync(argv.deployFile)) {
           console.error("deploy-file [".concat(argv.deployFolder, "] does not exist"));
           process.exit(1);
@@ -84,7 +107,6 @@ _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee() {
           console.error('undername must be set');
           process.exit(1);
         }
-        jwk = JSON.parse(Buffer.from(DEPLOY_KEY, 'base64').toString('utf-8'));
         ario = _sdk.ARIO.init({
           process: new _sdk.AOProcess({
             processId: ARIO_PROCESS,
@@ -104,35 +126,99 @@ _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee() {
       case 1:
         arnsNameRecord = _context.v;
         _context.p = 2;
-        if (!argv.deployFile) {
-          _context.n = 4;
-          break;
-        }
-        turbo = _turboSdk.TurboFactory.authenticated({
-          privateKey: jwk
-        });
-        _context.n = 3;
-        return (0, _turbo.uploadFile)(argv.deployFile, turbo);
-      case 3:
-        txId = _context.v.id;
-        _context.n = 6;
+        _t = argv['sig-type'];
+        _context.n = _t === 'ethereum' ? 3 : _t === 'polygon' ? 4 : _t === 'arweave' ? 5 : _t === 'kyve' ? 6 : 7;
         break;
+      case 3:
+        signer = new _turboSdk.EthereumSigner(DEPLOY_KEY);
+        token = 'ethereum';
+        return _context.a(3, 8);
       case 4:
-        _context.n = 5;
-        return (0, _turbo.uploadDirectory)(argv, jwk);
+        signer = new _turboSdk.EthereumSigner(DEPLOY_KEY);
+        token = 'pol';
+        return _context.a(3, 8);
       case 5:
-        txId = _context.v;
-      case 6:
+        jwk = JSON.parse(Buffer.from(DEPLOY_KEY, 'base64').toString('utf-8'));
         signer = new _sdk.ArweaveSigner(jwk);
+        token = 'arweave';
+        return _context.a(3, 8);
+      case 6:
+        signer = new _turboSdk.EthereumSigner(DEPLOY_KEY);
+        token = 'kyve';
+        return _context.a(3, 8);
+      case 7:
+        throw new Error("Invalid sig-type provided: ".concat(argv['sig-type'], ". Allowed values are 'arweave', 'ethereum', 'polygon', or 'kyve'."));
+      case 8:
+        turbo = _turboSdk.TurboFactory.authenticated({
+          signer: signer,
+          token: token
+        });
+        if (!argv['deploy-file']) {
+          _context.n = 10;
+          break;
+        }
+        // Detect MIME type for the file
+        mimeType = _mimeTypes["default"].lookup(argv['deploy-file']) || 'application/octet-stream';
+        _context.n = 9;
+        return turbo.uploadFile({
+          file: argv['deploy-file'],
+          dataItemOpts: {
+            tags: [{
+              name: 'App-Name',
+              value: 'Permaweb-Deploy'
+            },
+            // prevents identical transaction Ids from eth wallets
+            {
+              name: 'anchor',
+              value: new Date().toISOString()
+            }, {
+              name: 'Content-Type',
+              value: mimeType
+            }]
+          }
+        });
+      case 9:
+        uploadResult = _context.v;
+        txOrManifestId = uploadResult.id;
+        _context.n = 12;
+        break;
+      case 10:
+        _context.n = 11;
+        return turbo.uploadFolder({
+          folderPath: argv['deploy-folder'],
+          dataItemOpts: {
+            tags: [{
+              name: 'App-Name',
+              value: 'Permaweb-Deploy'
+            },
+            // prevents identical transaction Ids from eth wallets
+            {
+              name: 'anchor',
+              value: new Date().toISOString()
+            }]
+          }
+        });
+      case 11:
+        uploadResult = _context.v;
+        txOrManifestId = uploadResult.manifestResponse.id;
+      case 12:
+        console.log('-------------------- DEPLOY DETAILS --------------------');
+        console.log("Tx ID: ".concat(txOrManifestId));
+        console.log("ArNS Name: ".concat(ARNS_NAME));
+        console.log("Undername: ".concat(argv.undername));
+        console.log("ANT: ".concat(arnsNameRecord.processId));
+        console.log("AR IO Process: ".concat(ARIO_PROCESS));
+        console.log("TTL Seconds: ".concat(TTL_SECONDS));
+        console.log('--------------------------------------------------------');
         ant = _sdk.ANT.init({
           processId: arnsNameRecord.processId,
           signer: signer
         }); // Update the ANT record (assumes the JWK is a controller or owner)
-        _context.n = 7;
+        _context.n = 13;
         return ant.setRecord({
           undername: argv.undername,
-          transactionId: txId,
-          ttlSeconds: 3600
+          transactionId: txOrManifestId,
+          ttlSeconds: argv['ttl-seconds']
         }, {
           tags: [{
             name: 'App-Name',
@@ -142,17 +228,17 @@ _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee() {
             value: process.env.GITHUB_SHA
           }] : []))
         });
-      case 7:
-        console.log("Deployed TxId [".concat(txId, "] to name [").concat(ARNS_NAME, "] for ANT [").concat(arnsNameRecord.processId, "] using undername [").concat(argv.undername, "]"));
-        _context.n = 9;
+      case 13:
+        console.log("Deployed TxId [".concat(txOrManifestId, "] to name [").concat(ARNS_NAME, "] for ANT [").concat(arnsNameRecord.processId, "] using undername [").concat(argv.undername, "]"));
+        _context.n = 15;
         break;
-      case 8:
-        _context.p = 8;
-        _t = _context.v;
-        console.error('Deployment failed:', _t);
+      case 14:
+        _context.p = 14;
+        _t2 = _context.v;
+        console.error('Deployment failed:', _t2);
         process.exit(1); // Exit with error code
-      case 9:
+      case 15:
         return _context.a(2);
     }
-  }, _callee, null, [[2, 8]]);
+  }, _callee, null, [[2, 14]]);
 }))();

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "permaweb-deploy",
-	"version": "2.2.0",
+	"version": "2.4.0",
 	"description": "Permaweb App Deployment Package",
 	"main": "index.js",
 	"scripts": {
@@ -11,9 +11,9 @@
 	},
 	"dependencies": {
 		"@ar.io/sdk": "^3.10.1",
-		"@ardrive/turbo-sdk": "^1.17.0",
+		"@ardrive/turbo-sdk": "^1.28.2",
 		"@permaweb/aoconnect": "^0.0.85",
-		"mime-types": "^2.1.35",
+		"mime-types": "^3.0.1",
 		"yargs": "17.7.2"
 	},
 	"devDependencies": {

package/src/index.js

@@ -1,24 +1,27 @@
 #!/usr/bin/env node
-
+import { EthereumSigner, TurboFactory } from '@ardrive/turbo-sdk';
 import fs from 'fs';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
+import mime from 'mime-types';
 
 import { ANT, AOProcess, ARIO, ARIO_MAINNET_PROCESS_ID, ARIO_TESTNET_PROCESS_ID, ArweaveSigner } from '@ar.io/sdk';
-import { TurboFactory } from '@ardrive/turbo-sdk';
 import { connect } from '@permaweb/aoconnect';
 
-import { uploadDirectory, uploadFile } from './turbo';
-
 const arweaveTxIdRegex = /^[a-zA-Z0-9-_]{43}$/;
 
 const argv = yargs(hideBin(process.argv))
+	.version('2.1.0')
+	.help()
+	.usage('Usage: $0 --arns-name <name> [options]')
+	.example('$0 --arns-name my-app', 'Deploy to my-app.arweave.dev')
+	.example('$0 --arns-name my-app --undername staging', 'Deploy to staging.my-app.arweave.dev')
 	.option('ario-process', {
 		alias: 'p',
 		type: 'string',
 		description: 'The ARIO process to use',
 		demandOption: true,
-		default: ARIO_MAINNET_PROCESS_ID
+		default: ARIO_MAINNET_PROCESS_ID,
 	})
 	.option('arns-name', {
 		alias: 'n',
@@ -35,18 +38,45 @@ const argv = yargs(hideBin(process.argv))
 	.option('deploy-file', {
 		alias: 'f',
 		type: 'string',
-		description: 'File to deploy.'
+		description: 'File to deploy.',
+	})
+	.option('ttl-seconds', {
+		alias: 't',
+		type: 'number',
+		description: 'ArNS TTL Seconds',
+		default: 3600,
 	})
 	.option('undername', {
 		alias: 'u',
 		type: 'string',
 		description: 'ANT undername to update.',
 		default: '@',
+	})
+	.option('sig-type', {
+		alias: 's',
+		type: 'string',
+		description: 'The type of signer to be used for deployment.',
+		choices: [
+			'arweave',
+			'ethereum',
+			'polygon',
+			// 'solana',
+			'kyve',
+		],
+		default: 'arweave',
+	})
+	.check((argv) => {
+		if (argv.ttl < 60 || argv.ttl > 86400) {
+			throw new Error('TTL must be between 60 seconds (1 minute) and 86400 seconds (1 day)');
+		}
+		return true;
 	}).argv;
 
 const DEPLOY_KEY = process.env.DEPLOY_KEY;
-const ARNS_NAME = argv.arnsName;
-let ARIO_PROCESS = argv.arioProcess;
+const ARNS_NAME = argv['arns-name'];
+let ARIO_PROCESS = argv['ario-process'];
+const TTL_SECONDS = argv['ttl-seconds'];
+
 if (ARIO_PROCESS === 'mainnet') {
 	ARIO_PROCESS = ARIO_MAINNET_PROCESS_ID;
 } else if (ARIO_PROCESS === 'testnet') {
@@ -69,11 +99,15 @@ if (ARIO_PROCESS === 'mainnet') {
 		process.exit(1);
 	}
 
+	if (!Number.isFinite(TTL_SECONDS) || TTL_SECONDS < 60 || TTL_SECONDS > 86400) {
+		console.error('TTL_SECONDS must be a number between 60 and 86400 seconds');
+		process.exit(1);
+	}
+
 	if (argv.deployFile && !fs.existsSync(argv.deployFile)) {
 		console.error(`deploy-file [${argv.deployFolder}] does not exist`);
 		process.exit(1);
-	}
-	else {
+	} else {
 		if (!fs.existsSync(argv.deployFolder)) {
 			console.error(`deploy-folder [${argv.deployFolder}] does not exist`);
 			process.exit(1);
@@ -85,15 +119,14 @@ if (ARIO_PROCESS === 'mainnet') {
 		process.exit(1);
 	}
 
-	const jwk = JSON.parse(Buffer.from(DEPLOY_KEY, 'base64').toString('utf-8'));
 	const ario = ARIO.init({
 		process: new AOProcess({
 			processId: ARIO_PROCESS,
 			ao: connect({
 				MODE: 'legacy',
-				CU_URL: 'https://cu.ardrive.io'
-			})
-		})
+				CU_URL: 'https://cu.ardrive.io',
+			}),
+		}),
 	});
 
 	const arnsNameRecord = await ario.getArNSRecord({ name: ARNS_NAME }).catch((e) => {
@@ -102,24 +135,103 @@ if (ARIO_PROCESS === 'mainnet') {
 	});
 
 	try {
-		let txId;
-		if (argv.deployFile) {
-			const turbo = TurboFactory.authenticated({ privateKey: jwk });
-			txId = (await uploadFile(argv.deployFile, turbo)).id;
+		let signer;
+		let token;
+
+		// Creates the proper signer based on the sig-type value
+		switch (argv['sig-type']) {
+			case 'ethereum':
+				signer = new EthereumSigner(DEPLOY_KEY);
+				token = 'ethereum';
+				break;
+			case 'polygon':
+				signer = new EthereumSigner(DEPLOY_KEY);
+				token = 'pol';
+				break;
+			case 'arweave':
+				const jwk = JSON.parse(Buffer.from(DEPLOY_KEY, 'base64').toString('utf-8'));
+				signer = new ArweaveSigner(jwk);
+				token = 'arweave';
+				break;
+			case 'kyve':
+				signer = new EthereumSigner(DEPLOY_KEY);
+				token = 'kyve';
+				break;
+			default:
+				throw new Error(
+					`Invalid sig-type provided: ${argv['sig-type']}. Allowed values are 'arweave', 'ethereum', 'polygon', or 'kyve'.`
+				);
 		}
-		else {
-			txId = await uploadDirectory(argv, jwk);
+
+		const turbo = TurboFactory.authenticated({
+			signer: signer,
+			token: token,
+		});
+
+		let uploadResult;
+		let txOrManifestId;
+		if (argv['deploy-file']) {
+			// Detect MIME type for the file
+			const mimeType = mime.lookup(argv['deploy-file']) || 'application/octet-stream';
+
+			uploadResult = await turbo.uploadFile({
+				file: argv['deploy-file'],
+				dataItemOpts: {
+					tags: [
+						{
+							name: 'App-Name',
+							value: 'Permaweb-Deploy',
+						},
+						// prevents identical transaction Ids from eth wallets
+						{
+							name: 'anchor',
+							value: new Date().toISOString(),
+						},
+						{
+							name: 'Content-Type',
+							value: mimeType,
+						},
+					],
+				},
+			});
+			txOrManifestId = uploadResult.id;
+		} else {
+			uploadResult = await turbo.uploadFolder({
+				folderPath: argv['deploy-folder'],
+				dataItemOpts: {
+					tags: [
+						{
+							name: 'App-Name',
+							value: 'Permaweb-Deploy',
+						},
+						// prevents identical transaction Ids from eth wallets
+						{
+							name: 'anchor',
+							value: new Date().toISOString(),
+						},
+					],
+				},
+			});
+			txOrManifestId = uploadResult.manifestResponse.id;
 		}
 
-		const signer = new ArweaveSigner(jwk);
+		console.log('-------------------- DEPLOY DETAILS --------------------');
+		console.log(`Tx ID: ${txOrManifestId}`);
+		console.log(`ArNS Name: ${ARNS_NAME}`);
+		console.log(`Undername: ${argv.undername}`);
+		console.log(`ANT: ${arnsNameRecord.processId}`);
+		console.log(`AR IO Process: ${ARIO_PROCESS}`);
+		console.log(`TTL Seconds: ${TTL_SECONDS}`);
+		console.log('--------------------------------------------------------');
+
 		const ant = ANT.init({ processId: arnsNameRecord.processId, signer });
 
 		// Update the ANT record (assumes the JWK is a controller or owner)
 		await ant.setRecord(
 			{
 				undername: argv.undername,
-				transactionId: txId,
-				ttlSeconds: 3600,
+				transactionId: txOrManifestId,
+				ttlSeconds: argv['ttl-seconds'],
 			},
 			{
 				tags: [
@@ -127,15 +239,21 @@ if (ARIO_PROCESS === 'mainnet') {
 						name: 'App-Name',
 						value: 'Permaweb-Deploy',
 					},
-					...(process.env.GITHUB_SHA ? [{
-						name: 'GIT-HASH',
-						value: process.env.GITHUB_SHA,
-					}] : []),
-				]
+					...(process.env.GITHUB_SHA
+						? [
+								{
+									name: 'GIT-HASH',
+									value: process.env.GITHUB_SHA,
+								},
+						  ]
+						: []),
+				],
 			}
 		);
 
-		console.log(`Deployed TxId [${txId}] to name [${ARNS_NAME}] for ANT [${arnsNameRecord.processId}] using undername [${argv.undername}]`);
+		console.log(
+			`Deployed TxId [${txOrManifestId}] to name [${ARNS_NAME}] for ANT [${arnsNameRecord.processId}] using undername [${argv.undername}]`
+		);
 	} catch (e) {
 		console.error('Deployment failed:', e);
 		process.exit(1); // Exit with error code

package/src/turbo/index.js

@@ -1,121 +0,0 @@
-import fs from 'fs';
-import mime from 'mime-types';
-import path from 'path';
-import { Readable } from 'stream';
-
-import { TurboFactory } from '@ardrive/turbo-sdk';
-
-// Gets MIME types for each file to tag the upload
-function getContentType(filePath) {
-	const res = mime.lookup(filePath);
-	return res || 'application/octet-stream';
-}
-
-export async function uploadFile(path, turbo) {
-	console.log(`Uploading file: ${path}...`);
-	try {
-		const fileSize = fs.statSync(path).size;
-		const contentType = getContentType(path);
-		const uploadResult = await turbo.uploadFile({
-			fileStreamFactory: () => fs.createReadStream(path),
-			fileSizeFactory: () => fileSize,
-			signal: AbortSignal.timeout(10_000), // Cancel the upload after 10 seconds
-			dataItemOpts: {
-				tags: [
-					{ name: 'Content-Type', value: contentType },
-					{ name: 'App-Name', value: 'Permaweb-Deploy' },
-				],
-			},
-		});
-
-		console.log(`Uploaded ${path} with id:`, uploadResult.id);
-
-		return uploadResult;
-	} catch (err) {
-		console.error(`Error uploading file ${path}:`, err);
-	}
-}
-
-export async function uploadDirectory(argv, jwk) {
-	const turbo = TurboFactory.authenticated({ privateKey: jwk });
-
-	const deployFolder = argv.deployFolder;
-	
-	// Uses Arweave manifest version 0.2.0, which supports fallbacks
-	let newManifest = {
-		manifest: 'arweave/paths',
-		version: '0.2.0',
-		index: { path: 'index.html' },
-		fallback: {},
-		paths: {},
-	};
-
-	async function processFiles(dir) {
-		const files = fs.readdirSync(dir);
-
-		for (const file of files) {
-			try {
-				const filePath = path.join(dir, file);
-				const relativePath = path.relative(deployFolder, filePath);
-
-				if (fs.statSync(filePath).isDirectory()) {
-					// Recursively process all files in a directory
-					await processFiles(filePath);
-				} else {
-					const uploadResult = await uploadFile(filePath, turbo);
-
-					// Adds uploaded file txId to the new manifest json
-					newManifest.paths[relativePath] = { id: uploadResult.id };
-
-					if (file === '404.html') {
-						// Sets manifest fallback to 404.html if found
-						newManifest.fallback.id = uploadResult.id;
-					}
-				}
-			} catch (err) {
-				console.error('ERROR:', err);
-			}
-		}
-	}
-
-	async function uploadManifest(manifest) {
-		try {
-			const manifestString = JSON.stringify(manifest);
-			const uploadResult = await turbo.uploadFile({
-				fileStreamFactory: () => Readable.from(Buffer.from(manifestString)),
-				fileSizeFactory: () => Buffer.byteLength(manifestString),
-				signal: AbortSignal.timeout(10_000),
-				dataItemOpts: {
-					tags: [
-						{
-							name: 'Content-Type',
-							value: 'application/x.arweave-manifest+json',
-						},
-						{
-							name: 'App-Name',
-							value: 'Permaweb-Deploy',
-						},
-					],
-				},
-			});
-			return uploadResult.id;
-		} catch (error) {
-			console.error('Error uploading manifest:', error);
-			return null;
-		}
-	}
-
-	// Starts processing files in the selected directory
-	await processFiles(deployFolder);
-
-	if (!newManifest.fallback.id) {
-		// If no 404.html file is found, manifest fallback is set to the txId of index.html
-		newManifest.fallback.id = newManifest.paths['index.html'].id;
-	}
-
-	const manifestId = await uploadManifest(newManifest);
-	if (manifestId) {
-		console.log(`Manifest uploaded with Id: ${manifestId}`);
-		return manifestId;
-	}
-}