permaweb-deploy 2.5.0 → 2.5.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Forward Research
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,10 +1,11 @@
-# Permaweb Deployment Package
+# Permaweb Deploy
 
 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
+## Features
 
 - **Turbo SDK Integration:** Uses Turbo SDK for fast, reliable file uploads to Arweave
+- **On-Demand Payment:** Pay with ARIO or Base-ETH tokens on-demand during upload
 - **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
 - **Automated Workflow:** Integrates with GitHub Actions for continuous deployment
@@ -12,28 +13,30 @@ Inspired by the [cookbook github action deployment guide](https://cookbook.arwea
 - **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
+- **Modern CLI:** Built with oclif for a robust command-line experience
+- **TypeScript:** Fully typed for better developer experience
 
-### Installation
+## Installation
 
-Install the package using npm:
+Install the package using pnpm (recommended):
 
 ```bash
-npm install permaweb-deploy
+pnpm add -D permaweb-deploy
 ```
 
-For development use:
+Or with npm:
 
 ```bash
-npm install permaweb-deploy --save-dev
+npm install --save-dev permaweb-deploy
 ```
 
-For Yarn users:
+Or with yarn:
 
 ```bash
-yarn add permaweb-deploy --dev --ignore-engines
+yarn add --dev permaweb-deploy
 ```
 
-### Prerequisites
+## Prerequisites
 
 1. **For Arweave signer (default):** Encode your Arweave wallet key in base64 format and set it as a GitHub secret:
 
@@ -42,156 +45,490 @@ yarn add permaweb-deploy --dev --ignore-engines
    ```
 
 2. **For Ethereum/Polygon/KYVE signers:** Use your raw private key (no encoding needed) as the `DEPLOY_KEY`.
-
 3. Ensure that the secret name for the encoded wallet or private key is `DEPLOY_KEY`.
 
 ⚠️ **Important:** Use a dedicated wallet for deployments to minimize security risks. Ensure your wallet has sufficient Turbo Credits for uploads.
 
-### Usage
+## Usage
 
-To deploy your application, ensure you have a build script and a deployment script in your `package.json`:
+### Interactive Mode (Easiest)
 
-```json
-"scripts": {
-    "build": "your-build-command",
-    "deploy": "npm run build && permaweb-deploy --arns-name <ARNS_NAME>"
-}
+**Command Menu:**
+
+Simply run the CLI for an interactive command selector:
+
+```bash
+permaweb-deploy
+# or explicitly
+permaweb-deploy interactive
+```
+
+This shows a menu with options:
+
+- **Deploy to Permaweb** - Start the deployment wizard
+- **Show Help** - Display help information
+- **Exit** - Exit the CLI
+
+**Interactive Deploy (Guided):**
+
+Run the deploy command without arguments to be guided through all deployment options:
+
+```bash
+permaweb-deploy deploy
 ```
 
-Replace `<ARNS_NAME>` with your ArNS name. To deploy to an undername, add `--undername <UNDERNAME>`.
+This will prompt you for:
+
+- ArNS name
+- Wallet method (file, string, or environment variable)
+- Signer type (Arweave, Ethereum, Polygon, KYVE)
+- What to deploy (folder or file)
+- Advanced options (optional: undername, TTL, network)
 
-#### CLI Options
+### Direct Commands
 
-- `--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.
+Use flags for faster, scriptable deployments:
 
-#### Example CLI Usage
+```bash
+# Basic deployment with wallet file
+permaweb-deploy deploy --arns-name my-app --wallet ./wallet.json
+```
 
-Deploy a folder (default):
+Deploy using private key directly:
 
-```sh
-DEPLOY_KEY=$(base64 -i wallet.json) npx permaweb-deploy --arns-name my-app
+```bash
+permaweb-deploy deploy --arns-name my-app --private-key "$(cat wallet.json)"
+```
+
+Deploy using environment variable:
+
+```bash
+DEPLOY_KEY=$(base64 -i wallet.json) permaweb-deploy 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
+```bash
+permaweb-deploy deploy --arns-name my-app --wallet ./wallet.json --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
+```bash
+permaweb-deploy deploy --arns-name my-app --wallet ./wallet.json --deploy-file ./path/to/file.txt
 ```
 
-Deploy to an undername:
+### Advanced Usage
+
+Deploy to an undername (subdomain):
 
-```sh
-DEPLOY_KEY=$(base64 -i wallet.json) npx permaweb-deploy --arns-name my-app --undername staging
+```bash
+permaweb-deploy deploy --arns-name my-app --wallet ./wallet.json --undername staging
 ```
 
 Deploy with a custom TTL:
 
-```sh
-DEPLOY_KEY=$(base64 -i wallet.json) npx permaweb-deploy --arns-name my-app --ttl-seconds 7200
+```bash
+permaweb-deploy deploy --arns-name my-app --wallet ./wallet.json --ttl-seconds 7200
 ```
 
-Deploy using a different signer (e.g., Ethereum):
+Deploy using Ethereum wallet (file):
 
-```sh
-DEPLOY_KEY=<ETH_PRIVATE_KEY> npx permaweb-deploy --arns-name my-app --sig-type ethereum
+```bash
+permaweb-deploy deploy --arns-name my-app --sig-type ethereum --wallet ./private-key.txt
 ```
 
-#### Example `package.json` Scripts
+Deploy using Ethereum wallet (direct key):
+
+```bash
+permaweb-deploy deploy --arns-name my-app --sig-type ethereum --private-key "0x1234..."
+```
+
+### On-Demand Payment
+
+Use on-demand payment to automatically fund uploads with ARIO or Base-ETH tokens when your Turbo balance is insufficient:
+
+Deploy with ARIO on-demand payment:
+
+```bash
+permaweb-deploy deploy --arns-name my-app --wallet ./wallet.json --on-demand ario --max-token-amount 1.5
+```
+
+Deploy with Base-ETH on-demand payment (using Ethereum signer):
+
+```bash
+permaweb-deploy deploy --arns-name my-app --sig-type ethereum --private-key "0x..." --on-demand base-eth --max-token-amount 0.1
+```
+
+**On-Demand Payment Options:**
+
+- `--on-demand`: Token to use for on-demand payment (`ario` or `base-eth`)
+- `--max-token-amount`: Maximum token amount to spend (in native token units, e.g., `1.5` for 1.5 ARIO or `0.1` for 0.1 ETH)
+
+**How it works:**
+
+1. Checks your Turbo balance before upload
+2. If balance is insufficient, converts tokens to Turbo credits on-demand
+3. Automatically adds a 10% buffer (`topUpBufferMultiplier: 1.1`) for reliability
+4. Proceeds with upload once funded
+
+**Token compatibility:**
+
+- **ARIO**: Works with Arweave signer
+- **Base-ETH**: Works with Ethereum signer (Base Network)
+
+### Command 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: `60`
+- `--sig-type, -s`: Signer type for deployment. Choices: `arweave`, `ethereum`, `polygon`, `kyve`. Default: `arweave`
+- `--wallet, -w`: Path to wallet file (JWK for Arweave, private key for Ethereum/Polygon/KYVE)
+- `--private-key, -k`: Private key or JWK JSON string (alternative to `--wallet`)
+- `--on-demand`: Enable on-demand payment with specified token. Choices: `ario`, `base-eth`
+- `--max-token-amount`: Maximum token amount for on-demand payment (used with `--on-demand`)
+
+### Package.json Scripts
+
+Add deployment scripts to your `package.json`:
 
 ```json
-"scripts": {
+{
+  "scripts": {
     "build": "vite build",
-    "deploy": "npm run build && permaweb-deploy --arns-name <ARNS_NAME>"
+    "deploy": "pnpm build && permaweb-deploy deploy --arns-name <ARNS_NAME>",
+    "deploy:staging": "pnpm build && permaweb-deploy deploy --arns-name <ARNS_NAME> --undername staging",
+    "deploy:testnet": "pnpm build && permaweb-deploy deploy --arns-name <ARNS_NAME> --ario-process testnet",
+    "deploy:on-demand": "pnpm build && permaweb-deploy deploy --arns-name <ARNS_NAME> --on-demand ario --max-token-amount 1.5"
+  }
 }
 ```
 
-#### ARIO Process Examples
+Then deploy with:
 
-**Mainnet (default):**
+```bash
+DEPLOY_KEY=$(base64 -i wallet.json) pnpm deploy
+```
 
-```json
-"scripts": {
-    "deploy-main": "npm run build && permaweb-deploy --arns-name <ARNS_NAME>"
-}
+Or with on-demand payment:
+
+```bash
+DEPLOY_KEY=$(base64 -i wallet.json) pnpm deploy:on-demand
 ```
 
-**Testnet:**
+## GitHub Action
 
-```json
-"scripts": {
-    "deploy-test": "npm run build && permaweb-deploy --arns-name <ARNS_NAME> --ario-process testnet"
-}
+The easiest way to integrate permaweb-deploy into your CI/CD pipeline is using our official GitHub Action.
+
+### Basic Usage
+
+```yaml
+- uses: permaweb/permaweb-deploy@v1
+  with:
+    deploy-key: ${{ secrets.DEPLOY_KEY }}
+    arns-name: myapp
+    deploy-folder: ./dist
 ```
 
-**Custom process ID:**
+### PR Preview Deployments
 
-```json
-"scripts": {
-    "deploy-custom": "npm run build && permaweb-deploy --arns-name <ARNS_NAME> --ario-process <PROCESS_ID>"
-}
+Automatically deploy preview builds for each pull request. The `preview` mode auto-generates an undername from the PR number and posts a comment with the preview URL:
+
+```yaml
+name: Deploy PR Preview
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  deploy-preview:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Deploy Preview
+        uses: permaweb/permaweb-deploy@v1
+        with:
+          deploy-key: ${{ secrets.DEPLOY_KEY }}
+          arns-name: myapp
+          preview: 'true'
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          deploy-folder: ./dist
+```
+
+When `preview` is enabled, the action will:
+
+- Auto-generate an undername like `pr-123` from the PR number
+- Post a comment on the PR with the preview URL
+- Update the comment on subsequent pushes instead of creating new ones
+
+### Production Deployment
+
+Deploy to your base ArNS name when pushing to main:
+
+```yaml
+name: Deploy to Production
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Deploy to Permaweb
+        uses: permaweb/permaweb-deploy@v1
+        with:
+          deploy-key: ${{ secrets.DEPLOY_KEY }}
+          arns-name: myapp
+          deploy-folder: ./dist
+```
+
+### With On-Demand Payment
+
+```yaml
+- name: Deploy with ARIO on-demand
+  uses: permaweb/permaweb-deploy@v1
+  with:
+    deploy-key: ${{ secrets.DEPLOY_KEY }}
+    arns-name: myapp
+    deploy-folder: ./dist
+    on-demand: ario
+    max-token-amount: '2.0'
 ```
 
-### GitHub Actions Workflow
+---
 
-To automate the deployment, set up a GitHub Actions workflow as follows:
+## CLI in GitHub Actions
+
+You can also use the CLI directly in your workflows:
+
+**Basic Workflow:**
 
 ```yaml
 name: Deploy to Permaweb
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v3
+        with:
+          version: 9
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'pnpm'
+
+      - run: pnpm install
+
+      - run: pnpm deploy
+        env:
+          DEPLOY_KEY: ${{ secrets.DEPLOY_KEY }}
+```
+
+**With On-Demand Payment:**
+
+```yaml
+name: Deploy to Permaweb with On-Demand Payment
+
 on:
   push:
     branches:
       - main
+
 jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v3
+        with:
+          version: 9
+
       - uses: actions/setup-node@v4
         with:
-          node-version: 20.x
-      - run: npm install
-      - run: npm run deploy
+          node-version: 20
+          cache: 'pnpm'
+
+      - run: pnpm install
+      - run: pnpm build
+
+      - name: Deploy with ARIO on-demand
+        run: permaweb-deploy deploy --arns-name my-app --on-demand ario --max-token-amount 2.0
         env:
           DEPLOY_KEY: ${{ secrets.DEPLOY_KEY }}
+
+      # Or deploy with Ethereum and Base-ETH:
+      # - name: Deploy with Base-ETH on-demand
+      #   run: |
+      #     permaweb-deploy deploy \
+      #       --arns-name my-app \
+      #       --sig-type ethereum \
+      #       --on-demand base-eth \
+      #       --max-token-amount 0.2
+      #   env:
+      #     DEPLOY_KEY: ${{ secrets.ETH_PRIVATE_KEY }}
+```
+
+## Development
+
+### Setup
+
+```bash
+# Install dependencies
+pnpm install
+
+# Build the project
+pnpm build
+
+# Run in development mode
+pnpm dev
+
+# Run tests
+pnpm test
+
+# Run linter
+pnpm lint
+
+# Format code
+pnpm format
 ```
 
+### Project Structure
 
-### Security & Best Practices
+```
+permaweb-deploy/
+├── src/
+│   ├── commands/        # oclif commands
+│   │   └── deploy.ts
+│   ├── types/           # TypeScript type definitions
+│   │   └── index.ts
+│   ├── utils/           # Utility functions
+│   │   ├── constants.ts
+│   │   ├── signer.ts
+│   │   ├── uploader.ts
+│   │   └── __tests__/   # Unit tests
+│   └── index.ts         # Main entry point
+├── bin/                 # Executable scripts
+│   ├── run.js
+│   └── dev.js
+├── .changeset/          # Changesets configuration
+├── .husky/              # Git hooks
+└── dist/                # Build output
+```
+
+## Security & Best Practices
 
 - **Dedicated Wallet:** Always use a dedicated wallet for deployments to minimize security risks
 - **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
+- **Turbo Credits:** Ensure your wallet has sufficient Turbo Credits, or use on-demand payment for automatic funding
+- **On-Demand Limits:** Set reasonable `--max-token-amount` limits to prevent unexpected costs
 - **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
+## 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_KEY environment variable not set":** 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
 - **Error: "deploy-file does not exist":** Check that your build file exists and the path is correct
-- **Error: "ARNS name does not exist":** Verify the ArNS name is correct and exists in the specified network
-- **Upload timeouts:** Files have a 10-second upload timeout. Large files may fail and require optimization
-- **Insufficient Turbo Credits:** Ensure your wallet has enough Turbo Credits for the deployment
+- **Error: "ArNS name does not exist":** Verify the ArNS name is correct and exists in the specified network
+- **Upload timeouts:** Files have a timeout for upload. Large files may fail and require optimization
+- **Insufficient Turbo Credits:** Use `--on-demand` with `--max-token-amount` to automatically fund uploads when balance is low
+- **On-demand payment fails:** Ensure your wallet has sufficient tokens (ARIO or Base-ETH) and the token type matches your signer (`ario` with Arweave, `base-eth` with Ethereum)
+
+## Contributing
+
+Contributions are welcome! Please follow these guidelines:
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run tests and linter: `pnpm test && pnpm lint`
+5. Create a changeset: `pnpm changeset`
+6. Commit your changes using conventional commits
+7. Push and create a pull request
+
+### Conventional Commits
+
+This project uses [Conventional Commits](https://www.conventionalcommits.org/). Commit messages should follow this format:
+
+```
+type(scope): subject
+
+body (optional)
+```
+
+Types: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `revert`
+
+### Changesets
+
+We use [changesets](https://github.com/changesets/changesets) for version management. When making changes:
+
+```bash
+pnpm changeset
+```
+
+Follow the prompts to describe your changes.
+
+## 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
+- **@oclif/core** - CLI framework
+- **mime-types** - MIME type detection
+
+## License
+
+ISC
+
+## Author
+
+NickJ202
 
-### Dependencies
+## Links
 
-- **@ar.io/sdk:** - For ANT operations and ArNS management
-- **@ardrive/turbo-sdk:** - For fast file uploads to Arweave
-- **@permaweb/aoconnect:** - For AO network connectivity
-- **yargs:** - For CLI argument parsing
+- [GitHub Repository](https://github.com/permaweb/permaweb-deploy)
+- [Issues](https://github.com/permaweb/permaweb-deploy/issues)
+- [Arweave Documentation](https://docs.arweave.org/)
+- [AR.IO Documentation](https://docs.ar.io/)

package/bin/dev.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env tsx
+
+import { execute } from '@oclif/core'
+
+await execute({ development: true, dir: import.meta.url })

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { execute } from '@oclif/core'
+
+await execute({ development: false, dir: import.meta.url })