permaweb-deploy 1.1.10 → 2.0.1

package/README.md

@@ -28,11 +28,11 @@ 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 --ant-process <ANT_PROCESS>"
+    "deploy-main": "npm run build && permaweb-deploy --arns-name <ARNS_NAME>"
 }
 ```
 
-Replace `<ANT_PROCESS>` with your actual ANT process.
+Replace `<ARNS_NAME>` with your ArNS name.
 
 ### GitHub Actions Workflow
 To automate the deployment, set up a GitHub Actions workflow as follows:
@@ -61,10 +61,10 @@ jobs:
 ### To deploy to permaweb manually via cli
 
 ```sh
-DEPLOY_KEY=$(base64 -i wallet.json) npx permaweb-deploy --ant-process <ANT_PROCESS>
+DEPLOY_KEY=$(base64 -i wallet.json) npx permaweb-deploy --arns-name <ARNS_NAME>
 ```
 
 ### Important Notes
 - **Security:** Always use a dedicated wallet for deployments to minimize risk.
 - **Wallet Key:** The wallet must be base64 encoded to be used in the deployment script.
-- **ANT Process:** The ANT process must be passed at runtime to associate your deployment with a specific ANT process on AO.
+- **ARNS Name:** The ArNS Name must be passed in so that the ANT Process can be resolved to update the target undername or root record.

package/dist/index.js

@@ -21,10 +21,10 @@ 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('ant-process', {
-  alias: 'a',
+var argv = (0, _yargs["default"])((0, _helpers.hideBin)(process.argv)).option('arns-name', {
+  alias: 'n',
   type: 'string',
-  description: 'The ANT process',
+  description: 'The ARNS name',
   demandOption: true
 }).option('deploy-folder', {
   alias: 'd',
@@ -38,7 +38,7 @@ var argv = (0, _yargs["default"])((0, _helpers.hideBin)(process.argv)).option('a
   "default": '@'
 }).argv;
 var DEPLOY_KEY = process.env.DEPLOY_KEY;
-var ANT_PROCESS = argv.antProcess;
+var ARNS_NAME = argv.arnsName;
 function getTagValue(list, name) {
   for (var i = 0; i < list.length; i++) {
     if (list[i]) {
@@ -50,7 +50,7 @@ function getTagValue(list, name) {
   return STORAGE.none;
 }
 _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee() {
-  var jwk, manifestId, signer, ant;
+  var jwk, ario, arnsNameRecord, manifestId, signer, ant;
   return _regeneratorRuntime().wrap(function _callee$(_context) {
     while (1) switch (_context.prev = _context.next) {
       case 0:
@@ -58,8 +58,8 @@ _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee() {
           console.error('DEPLOY_KEY not configured');
           process.exit(1);
         }
-        if (!ANT_PROCESS) {
-          console.error('ANT_PROCESS not configured');
+        if (!ARNS_NAME) {
+          console.error('ARNS_NAME not configured');
           process.exit(1);
         }
         if (argv.deployFolder.length == 0) {
@@ -75,17 +75,27 @@ _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee() {
           process.exit(1);
         }
         jwk = JSON.parse(Buffer.from(DEPLOY_KEY, 'base64').toString('utf-8'));
-        _context.prev = 6;
+        ario = _sdk.ARIO.init();
         _context.next = 9;
-        return (0, _turbo["default"])(argv, jwk);
+        return ario.getArNSRecord({
+          name: ARNS_NAME
+        })["catch"](function (e) {
+          console.error("ARNS name [".concat(ARNS_NAME, "] does not exist"));
+          process.exit(1);
+        });
       case 9:
+        arnsNameRecord = _context.sent;
+        _context.prev = 10;
+        _context.next = 13;
+        return (0, _turbo["default"])(argv, jwk);
+      case 13:
         manifestId = _context.sent;
         signer = new _sdk.ArweaveSigner(jwk);
         ant = _sdk.ANT.init({
-          processId: ANT_PROCESS,
+          processId: arnsNameRecord.processId,
           signer: signer
         }); // Update the ANT record (assumes the JWK is a controller or owner)
-        _context.next = 14;
+        _context.next = 18;
         return ant.setRecord({
           undername: argv.undername,
           transactionId: manifestId,
@@ -99,18 +109,18 @@ _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee() {
             value: process.env.GITHUB_SHA
           }] : []))
         });
-      case 14:
-        console.log("Deployed TxId [".concat(manifestId, "] to ANT [").concat(ANT_PROCESS, "] using undername [").concat(argv.undername, "]"));
-        _context.next = 21;
+      case 18:
+        console.log("Deployed TxId [".concat(manifestId, "] to name [").concat(ARNS_NAME, "] for ANT [").concat(arnsNameRecord.processId, "] using undername [").concat(argv.undername, "]"));
+        _context.next = 25;
         break;
-      case 17:
-        _context.prev = 17;
-        _context.t0 = _context["catch"](6);
+      case 21:
+        _context.prev = 21;
+        _context.t0 = _context["catch"](10);
         console.error('Deployment failed:', _context.t0);
         process.exit(1); // Exit with error code
-      case 21:
+      case 25:
       case "end":
         return _context.stop();
     }
-  }, _callee, null, [[6, 17]]);
+  }, _callee, null, [[10, 21]]);
 }))();

package/package.json

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

package/src/index.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-import { ANT, ArweaveSigner } from '@ar.io/sdk';
+import { ANT, ARIO, ArweaveSigner } from '@ar.io/sdk';
 import fs from 'fs';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
@@ -8,10 +8,10 @@ import { hideBin } from 'yargs/helpers';
 import TurboDeploy from './turbo';
 
 const argv = yargs(hideBin(process.argv))
-	.option('ant-process', {
-		alias: 'a',
+	.option('arns-name', {
+		alias: 'n',
 		type: 'string',
-		description: 'The ANT process',
+		description: 'The ARNS name',
 		demandOption: true,
 	})
 	.option('deploy-folder', {
@@ -28,7 +28,7 @@ const argv = yargs(hideBin(process.argv))
 	}).argv;
 
 const DEPLOY_KEY = process.env.DEPLOY_KEY;
-const ANT_PROCESS = argv.antProcess;
+const ARNS_NAME = argv.arnsName;
 
 export function getTagValue(list, name) {
 	for (let i = 0; i < list.length; i++) {
@@ -47,11 +47,12 @@ export function getTagValue(list, name) {
 		process.exit(1);
 	}
 
-	if (!ANT_PROCESS) {
-		console.error('ANT_PROCESS not configured');
+	if (!ARNS_NAME) {
+		console.error('ARNS_NAME not configured');
 		process.exit(1);
 	}
 
+
 	if (argv.deployFolder.length == 0) {
 		console.error('deploy folder must not be empty');
 		process.exit(1);
@@ -67,11 +68,18 @@ export function getTagValue(list, name) {
 		process.exit(1);
 	}
 
-	let jwk = JSON.parse(Buffer.from(DEPLOY_KEY, 'base64').toString('utf-8'));
+	const jwk = JSON.parse(Buffer.from(DEPLOY_KEY, 'base64').toString('utf-8'));
+	const ario = ARIO.init()
+	const arnsNameRecord = await ario.getArNSRecord({name: ARNS_NAME}).catch((e) => {
+		console.error(`ARNS name [${ARNS_NAME}] does not exist`);
+		process.exit(1);
+	});
+
+
 	try {
 		const manifestId = await TurboDeploy(argv, jwk);
 		const signer = new ArweaveSigner(jwk);
-		const ant = ANT.init({ processId: ANT_PROCESS, signer });
+		const ant = ANT.init({ processId: arnsNameRecord.processId, signer });
 
 		// Update the ANT record (assumes the JWK is a controller or owner)
 		await ant.setRecord(
@@ -93,7 +101,7 @@ export function getTagValue(list, name) {
 			}
 		);
 
-		console.log(`Deployed TxId [${manifestId}] to ANT [${ANT_PROCESS}] using undername [${argv.undername}]`);
+		console.log(`Deployed TxId [${manifestId}] 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