feat(ETH/POL): Added support for ETH and POL/matic wallets.

README.md

@@ -3,26 +3,36 @@
 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 JavaScript bundles to the permaweb using Arweave. It simplifies the process by bundling JS code, deploying it as a transaction to Arweave, and updating ArNS (Arweave Name Service) with the transaction ID.
 
 ### Features
+
 - **Bundle Deployment:** Automatically bundles your JS code and deploys it to Arweave.
 - **ArNS Update:** Updates ArNS with the new transaction ID each time new content is deployed.
 - **Automated Workflow:** Integrates with GitHub Actions for continuous deployment directly from your repository.
+- **Cross-chain support:** Upload data to Arweave and update ArNS using Arweave, Eth, or POL/Matic wallets.
 
 ### Installation
+
 Install the package using npm:
+
 ```bash
 npm install permaweb-deploy
 ```
 
 ### Prerequisites
+
 Before using `permaweb-deploy`, you must:
+
 1. Encode your Arweave wallet key in base64 format and set it as a GitHub secret:
 
    ```bash
    base64 -i wallet.json | pbcopy
    ```
-3. Ensure that the secret name for the encoded wallet is `DEPLOY_KEY`.
+
+2. Ensure that the secret name for the encoded wallet is `DEPLOY_KEY`.
+
+**NOTE:** ETH and POL/Matic wallets should use their private key, **_WITHOUT_** base64 encoding for `DEPLOY_KEY`
 
 ### Usage
+
 To deploy your application, ensure you have a build script and a deployment script in your `package.json`:
 
 ```json
@@ -34,8 +44,40 @@ To deploy your application, ensure you have a build script and a deployment scri
 
 Replace `<ANT_PROCESS>` with your actual ANT process.
 
+#### Deploy Folder
+
+The default folder to upload is `./dist`, you can specify a different folder path using the `--deploy-folder` flag:
+
+```bash
+permaweb-deploy --ant-process <ANT_PROCESS> --deploy-folder "./next"
+```
+
+#### Ethereum and POL/Matic
+
+Permaweb-deploy defaults to uploading with an Arweave Wallet. You can specify an ETH or POL/Matic wallet by providing a `--sig-type` flag with the values "ethereum" or "polygon".
+
+```bash
+permaweb-deploy --ant-process <ANT_PROCESS> --sig-type 'polygon'
+```
+
+The `DEPLOY_KEY` environmental variable must be set to the private key of the ETH or POL/Matic wallet, without any additional encoding.
+
+**NOTE:** All uploads via Permaweb-deploy are paid for using Turbo Credits, you cannot pay for an upload using the native token for ETH or POL/Matic directly. Get Turbo Credits at [turbo-topup.com](https://turbo-topup.com/)
+
+#### Undernames
+
+Permaweb-deploy can update undername records for an ArNS name instead of the top level name. That is, you can deploy your project to `this-project_my-name` where `this-project` is an undername on the ArNS name `my-name`.
+
+This is done by specifying the undername using the `--undername` flag:
+
+```bash
+permaweb-deploy --ant-process <ANT_PROCESS> --undername "this-project"
+```
+
 ### GitHub Actions Workflow
+
 To automate the deployment, set up a GitHub Actions workflow as follows:
+
 ```yaml
 name: publish
 
@@ -65,6 +107,7 @@ DEPLOY_KEY=$(base64 -i wallet.json) npx permaweb-deploy --ant-process <ANT_PROCE
 ```
 
 ### 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.
+- **Wallet Key:** Arweave wallets must be base64 encoded to be used in the deployment script. Ethereum and POL/Matic wallets should use their raw private key.
 - **ANT Process:** The ANT process must be passed at runtime to associate your deployment with a specific ANT process on AO.

package.json

@@ -10,8 +10,8 @@
 		"permaweb-deploy": "./dist/index.js"
 	},
 	"dependencies": {
-		"@ar.io/sdk": "^2.2.5",
-		"@ardrive/turbo-sdk": "^1.17.0",
+		"@ar.io/sdk": "^3.0.0",
+		"@ardrive/turbo-sdk": "^1.21.0",
 		"mime-types": "^2.1.35",
 		"yargs": "17.7.2"
 	},

src/index.js

@@ -1,17 +1,16 @@
 #!/usr/bin/env node
 
 import { ANT, ArweaveSigner } from '@ar.io/sdk';
+import { EthereumSigner, TurboFactory } from '@ardrive/turbo-sdk';
 import fs from 'fs';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 
-import TurboDeploy from './turbo';
-
 const argv = yargs(hideBin(process.argv))
 	.option('ant-process', {
 		alias: 'a',
 		type: 'string',
-		description: 'The ANT process',
+		description: 'The ANT process.',
 		demandOption: true,
 	})
 	.option('deploy-folder', {
@@ -25,6 +24,13 @@ const argv = yargs(hideBin(process.argv))
 		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'],
+		default: 'arweave',
 	}).argv;
 
 const DEPLOY_KEY = process.env.DEPLOY_KEY;
@@ -67,29 +73,80 @@ export function getTagValue(list, name) {
 		return;
 	}
 
-	let jwk = JSON.parse(Buffer.from(DEPLOY_KEY, 'base64').toString('utf-8'));
 	try {
-		const manifestId = await TurboDeploy(argv, jwk);
-		const signer = new ArweaveSigner(jwk);
+		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 parsedKey = JSON.parse(Buffer.from(DEPLOY_KEY, 'base64').toString('utf-8')); // Parse DEPLOY_KEY for Arweave
+				signer = new ArweaveSigner(parsedKey);
+				token = 'arweave';
+				break;
+			default:
+				throw new Error(
+					`Invalid sig-type provided: ${argv['sig-type']}. Allowed values are 'arweave', 'ethereum', or 'polygon'.`
+				);
+		}
+
+		const turbo = TurboFactory.authenticated({
+			signer: signer,
+			token: token,
+		});
+
+		const 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(),
+					},
+				],
+			},
+		});
+
+		const manifestId = uploadResult.manifestResponse.id;
+
+		//TODO: Add support for custom AO network configurations.
 		const ant = ANT.init({ processId: ANT_PROCESS, signer });
 
-		// Update the ANT record (assumes the JWK is a controller or owner)
+		// Update the ANT record (assumes the signer is a controller or owner)
 		await ant.setRecord(
 			{
 				undername: argv.undername,
 				transactionId: manifestId,
 				ttlSeconds: 3600,
-			},{
+			},
+			{
 				tags: [
 					{
 						name: 'GIT-HASH',
-						value: process.env.GITHUB_SHA,
+						value: process.env.GITHUB_SHA || '',
 					},
 					{
 						name: 'App-Name',
 						value: 'Permaweb-Deploy',
 					},
-				]
+					{
+						name: 'anchor',
+						value: new Date().toISOString(),
+					},
+				],
 			}
 		);