permaweb-deploy 2.0.2 → 2.1.0

package/README.md

@@ -34,6 +34,32 @@ To deploy your application, ensure you have a build script and a deployment scri
 
 Replace `<ARNS_NAME>` with your ArNS name.
 
+You can also specify testnet, mainnet, and custom process id's for the ARIO process to use.
+
+Maninnet (default) config:
+```json
+"scripts": {
+    "build": "your-build-command",
+    "deploy-main": "npm run build && permaweb-deploy --arns-name <ARNS_NAME> --ario-process mainnet"
+}
+```
+
+Testnet config:
+```json
+"scripts": {
+    "build": "your-build-command",
+    "deploy-main": "npm run build && permaweb-deploy --arns-name <ARNS_NAME> --ario-process testnet"
+}
+```
+
+Custom process ID config:
+```json
+"scripts": {
+    "build": "your-build-command",
+    "deploy-main": "npm run build && permaweb-deploy --arns-name <ARNS_NAME> --ario-process GaQrvEMKBpkjofgnBi_B3IgIDmY_XYelVLB6GcRGrHc"
+}
+```
+
 ### GitHub Actions Workflow
 To automate the deployment, set up a GitHub Actions workflow as follows:
 ```yaml

package/dist/index.js

@@ -10,6 +10,7 @@ var _sdk = require("@ar.io/sdk");
 var _fs = _interopRequireDefault(require("fs"));
 var _yargs = _interopRequireDefault(require("yargs"));
 var _helpers = require("yargs/helpers");
+var _aoconnect = require("@permaweb/aoconnect");
 var _turbo = _interopRequireDefault(require("./turbo"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
 function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return e; }; var t, e = {}, r = Object.prototype, n = r.hasOwnProperty, o = Object.defineProperty || function (t, e, r) { t[e] = r.value; }, i = "function" == typeof Symbol ? Symbol : {}, a = i.iterator || "@@iterator", c = i.asyncIterator || "@@asyncIterator", u = i.toStringTag || "@@toStringTag"; function define(t, e, r) { return Object.defineProperty(t, e, { value: r, enumerable: !0, configurable: !0, writable: !0 }), t[e]; } try { define({}, ""); } catch (t) { define = function define(t, e, r) { return t[e] = r; }; } function wrap(t, e, r, n) { var i = e && e.prototype instanceof Generator ? e : Generator, a = Object.create(i.prototype), c = new Context(n || []); return o(a, "_invoke", { value: makeInvokeMethod(t, r, c) }), a; } function tryCatch(t, e, r) { try { return { type: "normal", arg: t.call(e, r) }; } catch (t) { return { type: "throw", arg: t }; } } e.wrap = wrap; var h = "suspendedStart", l = "suspendedYield", f = "executing", s = "completed", y = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var p = {}; define(p, a, function () { return this; }); var d = Object.getPrototypeOf, v = d && d(d(values([]))); v && v !== r && n.call(v, a) && (p = v); var g = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(p); function defineIteratorMethods(t) { ["next", "throw", "return"].forEach(function (e) { define(t, e, function (t) { return this._invoke(e, t); }); }); } function AsyncIterator(t, e) { function invoke(r, o, i, a) { var c = tryCatch(t[r], t, o); if ("throw" !== c.type) { var u = c.arg, h = u.value; return h && "object" == _typeof(h) && n.call(h, "__await") ? e.resolve(h.__await).then(function (t) { invoke("next", t, i, a); }, function (t) { invoke("throw", t, i, a); }) : e.resolve(h).then(function (t) { u.value = t, i(u); }, function (t) { return invoke("throw", t, i, a); }); } a(c.arg); } var r; o(this, "_invoke", { value: function value(t, n) { function callInvokeWithMethodAndArg() { return new e(function (e, r) { invoke(t, n, e, r); }); } return r = r ? r.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(e, r, n) { var o = h; return function (i, a) { if (o === f) throw Error("Generator is already running"); if (o === s) { if ("throw" === i) throw a; return { value: t, done: !0 }; } for (n.method = i, n.arg = a;;) { var c = n.delegate; if (c) { var u = maybeInvokeDelegate(c, n); if (u) { if (u === y) continue; return u; } } if ("next" === n.method) n.sent = n._sent = n.arg;else if ("throw" === n.method) { if (o === h) throw o = s, n.arg; n.dispatchException(n.arg); } else "return" === n.method && n.abrupt("return", n.arg); o = f; var p = tryCatch(e, r, n); if ("normal" === p.type) { if (o = n.done ? s : l, p.arg === y) continue; return { value: p.arg, done: n.done }; } "throw" === p.type && (o = s, n.method = "throw", n.arg = p.arg); } }; } function maybeInvokeDelegate(e, r) { var n = r.method, o = e.iterator[n]; if (o === t) return r.delegate = null, "throw" === n && e.iterator["return"] && (r.method = "return", r.arg = t, maybeInvokeDelegate(e, r), "throw" === r.method) || "return" !== n && (r.method = "throw", r.arg = new TypeError("The iterator does not provide a '" + n + "' method")), y; var i = tryCatch(o, e.iterator, r.arg); if ("throw" === i.type) return r.method = "throw", r.arg = i.arg, r.delegate = null, y; var a = i.arg; return a ? a.done ? (r[e.resultName] = a.value, r.next = e.nextLoc, "return" !== r.method && (r.method = "next", r.arg = t), r.delegate = null, y) : a : (r.method = "throw", r.arg = new TypeError("iterator result is not an object"), r.delegate = null, y); } function pushTryEntry(t) { var e = { tryLoc: t[0] }; 1 in t && (e.catchLoc = t[1]), 2 in t && (e.finallyLoc = t[2], e.afterLoc = t[3]), this.tryEntries.push(e); } function resetTryEntry(t) { var e = t.completion || {}; e.type = "normal", delete e.arg, t.completion = e; } function Context(t) { this.tryEntries = [{ tryLoc: "root" }], t.forEach(pushTryEntry, this), this.reset(!0); } function values(e) { if (e || "" === e) { var r = e[a]; if (r) return r.call(e); if ("function" == typeof e.next) return e; if (!isNaN(e.length)) { var o = -1, i = function next() { for (; ++o < e.length;) if (n.call(e, o)) return next.value = e[o], next.done = !1, next; return next.value = t, next.done = !0, next; }; return i.next = i; } } throw new TypeError(_typeof(e) + " is not iterable"); } return GeneratorFunction.prototype = GeneratorFunctionPrototype, o(g, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), o(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, u, "GeneratorFunction"), e.isGeneratorFunction = function (t) { var e = "function" == typeof t && t.constructor; return !!e && (e === GeneratorFunction || "GeneratorFunction" === (e.displayName || e.name)); }, e.mark = function (t) { return Object.setPrototypeOf ? Object.setPrototypeOf(t, GeneratorFunctionPrototype) : (t.__proto__ = GeneratorFunctionPrototype, define(t, u, "GeneratorFunction")), t.prototype = Object.create(g), t; }, e.awrap = function (t) { return { __await: t }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, c, function () { return this; }), e.AsyncIterator = AsyncIterator, e.async = function (t, r, n, o, i) { void 0 === i && (i = Promise); var a = new AsyncIterator(wrap(t, r, n, o), i); return e.isGeneratorFunction(r) ? a : a.next().then(function (t) { return t.done ? t.value : a.next(); }); }, defineIteratorMethods(g), define(g, u, "Generator"), define(g, a, function () { return this; }), define(g, "toString", function () { return "[object Generator]"; }), e.keys = function (t) { var e = Object(t), r = []; for (var n in e) r.push(n); return r.reverse(), function next() { for (; r.length;) { var t = r.pop(); if (t in e) return next.value = t, next.done = !1, next; } return next.done = !0, next; }; }, e.values = values, Context.prototype = { constructor: Context, reset: function reset(e) { if (this.prev = 0, this.next = 0, this.sent = this._sent = t, this.done = !1, this.delegate = null, this.method = "next", this.arg = t, this.tryEntries.forEach(resetTryEntry), !e) for (var r in this) "t" === r.charAt(0) && n.call(this, r) && !isNaN(+r.slice(1)) && (this[r] = t); }, stop: function stop() { this.done = !0; var t = this.tryEntries[0].completion; if ("throw" === t.type) throw t.arg; return this.rval; }, dispatchException: function dispatchException(e) { if (this.done) throw e; var r = this; function handle(n, o) { return a.type = "throw", a.arg = e, r.next = n, o && (r.method = "next", r.arg = t), !!o; } for (var o = this.tryEntries.length - 1; o >= 0; --o) { var i = this.tryEntries[o], a = i.completion; if ("root" === i.tryLoc) return handle("end"); if (i.tryLoc <= this.prev) { var c = n.call(i, "catchLoc"), u = n.call(i, "finallyLoc"); if (c && u) { if (this.prev < i.catchLoc) return handle(i.catchLoc, !0); if (this.prev < i.finallyLoc) return handle(i.finallyLoc); } else if (c) { if (this.prev < i.catchLoc) return handle(i.catchLoc, !0); } else { if (!u) throw Error("try statement without catch or finally"); if (this.prev < i.finallyLoc) return handle(i.finallyLoc); } } } }, abrupt: function abrupt(t, e) { for (var r = this.tryEntries.length - 1; r >= 0; --r) { var o = this.tryEntries[r]; if (o.tryLoc <= this.prev && n.call(o, "finallyLoc") && this.prev < o.finallyLoc) { var i = o; break; } } i && ("break" === t || "continue" === t) && i.tryLoc <= e && e <= i.finallyLoc && (i = null); var a = i ? i.completion : {}; return a.type = t, a.arg = e, i ? (this.method = "next", this.next = i.finallyLoc, y) : this.complete(a); }, complete: function complete(t, e) { if ("throw" === t.type) throw t.arg; return "break" === t.type || "continue" === t.type ? this.next = t.arg : "return" === t.type ? (this.rval = this.arg = t.arg, this.method = "return", this.next = "end") : "normal" === t.type && e && (this.next = e), y; }, finish: function finish(t) { for (var e = this.tryEntries.length - 1; e >= 0; --e) { var r = this.tryEntries[e]; if (r.finallyLoc === t) return this.complete(r.completion, r.afterLoc), resetTryEntry(r), y; } }, "catch": function _catch(t) { for (var e = this.tryEntries.length - 1; e >= 0; --e) { var r = this.tryEntries[e]; if (r.tryLoc === t) { var n = r.completion; if ("throw" === n.type) { var o = n.arg; resetTryEntry(r); } return o; } } throw Error("illegal catch attempt"); }, delegateYield: function delegateYield(e, r, n) { return this.delegate = { iterator: values(e), resultName: r, nextLoc: n }, "next" === this.method && (this.arg = t), y; } }, e; }
@@ -21,7 +22,14 @@ function _arrayWithoutHoles(r) { if (Array.isArray(r)) return _arrayLikeToArray(
 function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
 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 argv = (0, _yargs["default"])((0, _helpers.hideBin)(process.argv)).option('arns-name', {
+var arweaveTxIdRegex = /^[a-zA-Z0-9-_]{43}$/;
+var argv = (0, _yargs["default"])((0, _helpers.hideBin)(process.argv)).option('ario-process', {
+  alias: 'p',
+  type: 'string',
+  description: 'The ARIO process to use',
+  demandOption: true,
+  "default": _sdk.ARIO_MAINNET_PROCESS_ID
+}).option('arns-name', {
   alias: 'n',
   type: 'string',
   description: 'The ARNS name',
@@ -39,6 +47,12 @@ var argv = (0, _yargs["default"])((0, _helpers.hideBin)(process.argv)).option('a
 }).argv;
 var DEPLOY_KEY = process.env.DEPLOY_KEY;
 var ARNS_NAME = argv.arnsName;
+var ARIO_PROCESS = argv.arioProcess;
+if (ARIO_PROCESS === 'mainnet') {
+  ARIO_PROCESS = _sdk.ARIO_MAINNET_PROCESS_ID;
+} else if (ARIO_PROCESS === 'testnet') {
+  ARIO_PROCESS = _sdk.ARIO_TESTNET_PROCESS_ID;
+}
 function getTagValue(list, name) {
   for (var i = 0; i < list.length; i++) {
     if (list[i]) {
@@ -54,6 +68,10 @@ _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee() {
   return _regeneratorRuntime().wrap(function _callee$(_context) {
     while (1) switch (_context.prev = _context.next) {
       case 0:
+        if (!ARIO_PROCESS || !arweaveTxIdRegex.test(ARIO_PROCESS)) {
+          console.error('ARIO_PROCESS must be a valid Arweave transaction ID, or "mainnet" or "testnet"');
+          process.exit(1);
+        }
         if (!DEPLOY_KEY) {
           console.error('DEPLOY_KEY not configured');
           process.exit(1);
@@ -75,27 +93,35 @@ _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee() {
           process.exit(1);
         }
         jwk = JSON.parse(Buffer.from(DEPLOY_KEY, 'base64').toString('utf-8'));
-        ario = _sdk.ARIO.init();
-        _context.next = 9;
+        ario = _sdk.ARIO.init({
+          process: new _sdk.AOProcess({
+            processId: ARIO_PROCESS,
+            ao: (0, _aoconnect.connect)({
+              MODE: 'legacy',
+              CU_URL: "https://cu.ardrive.io"
+            })
+          })
+        });
+        _context.next = 10;
         return ario.getArNSRecord({
           name: ARNS_NAME
         })["catch"](function (e) {
           console.error("ARNS name [".concat(ARNS_NAME, "] does not exist"));
           process.exit(1);
         });
-      case 9:
+      case 10:
         arnsNameRecord = _context.sent;
-        _context.prev = 10;
-        _context.next = 13;
+        _context.prev = 11;
+        _context.next = 14;
         return (0, _turbo["default"])(argv, jwk);
-      case 13:
+      case 14:
         manifestId = _context.sent;
         signer = new _sdk.ArweaveSigner(jwk);
         ant = _sdk.ANT.init({
           processId: arnsNameRecord.processId,
           signer: signer
         }); // Update the ANT record (assumes the JWK is a controller or owner)
-        _context.next = 18;
+        _context.next = 19;
         return ant.setRecord({
           undername: argv.undername,
           transactionId: manifestId,
@@ -109,18 +135,18 @@ _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee() {
             value: process.env.GITHUB_SHA
           }] : []))
         });
-      case 18:
+      case 19:
         console.log("Deployed TxId [".concat(manifestId, "] to name [").concat(ARNS_NAME, "] for ANT [").concat(arnsNameRecord.processId, "] using undername [").concat(argv.undername, "]"));
-        _context.next = 25;
+        _context.next = 26;
         break;
-      case 21:
-        _context.prev = 21;
-        _context.t0 = _context["catch"](10);
+      case 22:
+        _context.prev = 22;
+        _context.t0 = _context["catch"](11);
         console.error('Deployment failed:', _context.t0);
         process.exit(1); // Exit with error code
-      case 25:
+      case 26:
       case "end":
         return _context.stop();
     }
-  }, _callee, null, [[10, 21]]);
+  }, _callee, null, [[11, 22]]);
 }))();

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "permaweb-deploy",
-	"version": "2.0.2",
+	"version": "2.1.0",
 	"description": "Permaweb app deployment package",
 	"main": "index.js",
 	"scripts": {
@@ -12,6 +12,7 @@
 	"dependencies": {
 		"@ar.io/sdk": "^3.10.1",
 		"@ardrive/turbo-sdk": "^1.17.0",
+		"@permaweb/aoconnect": "^0.0.84",
 		"mime-types": "^2.1.35",
 		"yargs": "17.7.2"
 	},

package/src/index.js

@@ -1,13 +1,24 @@
 #!/usr/bin/env node
 
-import { ANT, ARIO, ArweaveSigner } from '@ar.io/sdk';
+import { ANT, AOProcess, ARIO, ARIO_MAINNET_PROCESS_ID, ARIO_TESTNET_PROCESS_ID, ArweaveSigner } from '@ar.io/sdk';
 import fs from 'fs';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 
+import { connect } from '@permaweb/aoconnect';
+
 import TurboDeploy from './turbo';
 
+const arweaveTxIdRegex = /^[a-zA-Z0-9-_]{43}$/;
+
 const argv = yargs(hideBin(process.argv))
+	.option('ario-process', {
+		alias: 'p',
+		type: 'string',
+		description: 'The ARIO process to use',
+		demandOption: true,
+		default: ARIO_MAINNET_PROCESS_ID
+	})
 	.option('arns-name', {
 		alias: 'n',
 		type: 'string',
@@ -29,6 +40,12 @@ const argv = yargs(hideBin(process.argv))
 
 const DEPLOY_KEY = process.env.DEPLOY_KEY;
 const ARNS_NAME = argv.arnsName;
+let ARIO_PROCESS = argv.arioProcess;
+if (ARIO_PROCESS === 'mainnet') {
+	ARIO_PROCESS = ARIO_MAINNET_PROCESS_ID;
+} else if (ARIO_PROCESS === 'testnet') {
+	ARIO_PROCESS = ARIO_TESTNET_PROCESS_ID;
+}
 
 export function getTagValue(list, name) {
 	for (let i = 0; i < list.length; i++) {
@@ -42,6 +59,11 @@ export function getTagValue(list, name) {
 }
 
 (async () => {
+	if (!ARIO_PROCESS || !arweaveTxIdRegex.test(ARIO_PROCESS)) {
+		console.error('ARIO_PROCESS must be a valid Arweave transaction ID, or "mainnet" or "testnet"');
+		process.exit(1);
+	}
+
 	if (!DEPLOY_KEY) {
 		console.error('DEPLOY_KEY not configured');
 		process.exit(1);
@@ -69,7 +91,13 @@ export function getTagValue(list, name) {
 	}
 
 	const jwk = JSON.parse(Buffer.from(DEPLOY_KEY, 'base64').toString('utf-8'));
-	const ario = ARIO.init()
+	const ario = ARIO.init({process: new AOProcess({
+		processId: ARIO_PROCESS,
+		ao: connect({
+			MODE: 'legacy',
+			CU_URL:"https://cu.ardrive.io"
+		})
+	})});
 	const arnsNameRecord = await ario.getArNSRecord({name: ARNS_NAME}).catch((e) => {
 		console.error(`ARNS name [${ARNS_NAME}] does not exist`);
 		process.exit(1);