permaweb-deploy 2.2.0 → 2.3.0

package/README.md

@@ -3,6 +3,7 @@
 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.
 
 ### 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
@@ -20,11 +21,13 @@ 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
 ```
@@ -32,6 +35,7 @@ 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:
@@ -43,16 +47,19 @@ Before using `permaweb-deploy`, you must:
 ⚠️ **Important:** Use a dedicated wallet for deployments to minimize security risks. Ensure your wallet has sufficient Turbo Credits for uploads.
 
 ### CLI Options
+
 ```bash
 permaweb-deploy [options]
 ```
 
-| 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 | `@` | ❌ |
+| 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`  | ❌       |
+| `--deploy-file`   | `-f`  | File to deploy                         | `./dist`  | ❌       |
+| `--undername`     | `-u`  | ANT undername to update                | `@`       | ❌       |
+| `--ttl-seconds`   | `-t`  | ArNS TTL Seconds                       | `3600`    | ❌       |
 
 ### Usage
 
@@ -66,6 +73,7 @@ To deploy your application, ensure you have a build script and a deployment scri
 ```
 
 **Example with custom options:**
+
 ```bash
 permaweb-deploy --arns-name "your-arns-name" --deploy-folder "./build" --undername "app"
 ```
@@ -73,6 +81,7 @@ permaweb-deploy --arns-name "your-arns-name" --deploy-folder "./build" --underna
 Replace `<ARNS_NAME>` with your ArNS name. You can also specify testnet, mainnet, and custom process IDs for the ARIO process to use.
 
 **Mainnet (default) config:**
+
 ```json
 "scripts": {
     "build": "your-build-command",
@@ -81,6 +90,7 @@ Replace `<ARNS_NAME>` with your ArNS name. You can also specify testnet, mainnet
 ```
 
 **Testnet config:**
+
 ```json
 "scripts": {
     "build": "your-build-command",
@@ -89,6 +99,7 @@ Replace `<ARNS_NAME>` with your ArNS name. You can also specify testnet, mainnet
 ```
 
 **Custom process ID config:**
+
 ```json
 "scripts": {
     "build": "your-build-command",
@@ -97,11 +108,13 @@ Replace `<ARNS_NAME>` with your ArNS name. You can also specify testnet, mainnet
 ```
 
 ### Manual CLI Deployment
+
 ```bash
 DEPLOY_KEY=$(base64 -i wallet.json) npx permaweb-deploy --arns-name <ARNS_NAME>
 ```
 
 ### 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`
@@ -137,6 +150,7 @@ jobs:
 ```
 
 ### 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
 - **ArNS Name:** The ArNS Name must be passed so that the ANT Process can be resolved to update the target undername or root record
@@ -145,6 +159,7 @@ jobs:
 - **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,6 +169,7 @@ 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

package/dist/index.js

@@ -40,6 +40,11 @@ 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',
@@ -48,6 +53,7 @@ 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 TTL_SECONDS = argv.ttlSeconds;
 var ARIO_PROCESS = argv.arioProcess;
 if (ARIO_PROCESS === 'mainnet') {
   ARIO_PROCESS = _sdk.ARIO_MAINNET_PROCESS_ID;
@@ -71,6 +77,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);
@@ -123,6 +133,14 @@ _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee() {
       case 5:
         txId = _context.v;
       case 6:
+        console.log('-------------------- DEPLOY DETAILS --------------------');
+        console.log("Tx ID: ".concat(txId));
+        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('--------------------------------------------------------');
         signer = new _sdk.ArweaveSigner(jwk);
         ant = _sdk.ANT.init({
           processId: arnsNameRecord.processId,
@@ -132,7 +150,7 @@ _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee() {
         return ant.setRecord({
           undername: argv.undername,
           transactionId: txId,
-          ttlSeconds: 3600
+          ttlSeconds: TTL_SECONDS
         }, {
           tags: [{
             name: 'App-Name',

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "permaweb-deploy",
-	"version": "2.2.0",
+	"version": "2.3.0",
 	"description": "Permaweb App Deployment Package",
 	"main": "index.js",
 	"scripts": {

package/src/index.js

@@ -37,6 +37,12 @@ const argv = yargs(hideBin(process.argv))
 		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',
@@ -46,6 +52,7 @@ const argv = yargs(hideBin(process.argv))
 
 const DEPLOY_KEY = process.env.DEPLOY_KEY;
 const ARNS_NAME = argv.arnsName;
+const TTL_SECONDS = argv.ttlSeconds;
 let ARIO_PROCESS = argv.arioProcess;
 if (ARIO_PROCESS === 'mainnet') {
 	ARIO_PROCESS = ARIO_MAINNET_PROCESS_ID;
@@ -69,6 +76,11 @@ 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);
@@ -111,6 +123,15 @@ if (ARIO_PROCESS === 'mainnet') {
 			txId = await uploadDirectory(argv, jwk);
 		}
 
+		console.log('-------------------- DEPLOY DETAILS --------------------');
+		console.log(`Tx ID: ${txId}`);
+		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 signer = new ArweaveSigner(jwk);
 		const ant = ANT.init({ processId: arnsNameRecord.processId, signer });
 
@@ -119,7 +140,7 @@ if (ARIO_PROCESS === 'mainnet') {
 			{
 				undername: argv.undername,
 				transactionId: txId,
-				ttlSeconds: 3600,
+				ttlSeconds: TTL_SECONDS,
 			},
 			{
 				tags: [