Initial commit

Author: rgbrota

.gitignore

@@ -0,0 +1,125 @@
+
+# Created by https://www.toptal.com/developers/gitignore/api/node
+# Edit at https://www.toptal.com/developers/gitignore?templates=node
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+.env.production
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# End of https://www.toptal.com/developers/gitignore/api/node

Dockerfile

@@ -0,0 +1,10 @@
+FROM node:12-alpine
+
+COPY index.js /index.js
+COPY ["package.json", "package-lock.json*", "./"]
+
+RUN npm i
+
+RUN npm i -g arweave-deploy@1.9.0
+
+ENTRYPOINT ["node", "/index.js"]

LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2021 Raúl García
+
+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.

README.md

@@ -0,0 +1,70 @@
+# Arweave-upload-file v1
+
+## Overview
+
+This action will allow you to upload a file to the Arweave permaweb in an easy manner during your action workflows, with just a couple inputs.
+
+It uses [Arweave-deploy](https://github.com/ArweaveTeam/arweave-deploy) under the hood, wrapping the CLI into an easy-to-use action for developers or any interested party.
+
+If your use case requires the upload of a directory, please refer to [rgbrota/arweave-upload-directory](https://github.com/rgbrota/arweave-upload-directory).
+## Usage
+
+See [action.yml](action.yml).
+
+### Inputs
+
+The action expects the following inputs:
+
+| Input | Type | Required | Default | Description |
+| --- | --- | :---: | :---: | --- |
+| `key_file_content` | JSON | ✔️ | - | The content of the Arweave key file JSON used to upload the data. It should be setup as a secret inside the repository. |
+| `file_path` | String | ✔️ | - | Path of the file to be uploaded. |
+| `ipfs` | Boolean | ❌ | `false` | Upload to IPFS as well (experimental). |
+| `package` | Boolean | ❌ | `false` | Package HTML dependencies into a single self-contained file. |
+### Outputs
+
+The action also has the following outputs:
+
+| Output | Type | Description |
+| --- | --- | --- |
+| `arweave_url` | String | Arweave URL where the uploaded file will be available once mined. |
+| `ipfs_url` | String | IPFS URL where the uploaded file will be available once mined, if the input ```ipfs``` was set to true. |
+| `cost` | Integer | Total cost of the transaction in the Arweave blockchain currency, AR. |
+### Examples
+#### Upload a file - basic usage
+
+```yaml
+steps:
+- uses: actions/checkout@v2
+
+- uses: rgbrota/arweave-upload-file@v1
+    with:
+        key_file_content: ${{ secrets.xx }}
+        file_path: 'xx'
+```
+
+#### Upload a file - Arweave + IPFS
+
+```yaml
+steps:
+- uses: actions/checkout@v2
+
+- uses: rgbrota/arweave-upload-file@v1
+    with:
+        key_file_content: ${{ secrets.xx }}
+        file_path: 'xx'
+        ipfs: true
+```
+
+#### Upload a file - Packing HTML and dependencies
+
+```yaml
+steps:
+- uses: actions/checkout@v2
+
+- uses: rgbrota/arweave-upload-file@v1
+    with:
+        key_file_content: ${{ secrets.xx }}
+        file_path: 'xx'
+        package: true
+```

action.yml

@@ -0,0 +1,38 @@
+# Arweave upload file
+name: 'Arweave upload file'
+description: 'Upload a file to the Arweave blockchain'
+inputs:
+  key_file_content:
+    description: 'Arweave key file content'
+    required: true
+    default: false
+  file_path:
+    description: 'Path to the file to be uploaded'
+    required: true
+    default: false
+  package:
+    description: 'Package HTML dependencies into a single self-contained file'
+    required: false
+    default: false
+  ipfs:
+    description: 'Upload to IPFS as well (experimental)'
+    required: false
+    default: false
+outputs:
+  arweave_url:
+    description: 'The Arweave URL your file will be available at once mined'
+  ipfs_url:
+    description: 'The IPFS URL your file will be available at once mined'
+  cost:
+    description: 'Transaction cost'
+runs:
+  using: 'docker'
+  image: 'Dockerfile'
+  args:
+    - ${{ inputs.key-file-content }}
+    - ${{ inputs.file-path }}
+    - ${{ inputs.package }}
+    - ${{ inputs.ipfs }}
+branding:
+  icon: 'file-plus'  
+  color: 'gray-dark'

index.js

@@ -0,0 +1,91 @@
+const core = require("@actions/core");
+const exec = require("@actions/exec");
+const jsonfile = require("jsonfile");
+
+const commands = {
+  uploadFile: "arweave deploy",
+};
+
+const flags = {
+  deploy: {
+    ipfs: "--ipfs-publish",
+    keyFile: "--key-file",
+    package: "--package",
+    skipConfirmation: "--force-skip-confirmation",
+  },
+};
+
+const paths = {
+  keyFile: "keyfile.json",
+};
+
+const outputs = {
+  arweaveUrl: "arweave_url",
+  ipfsUrl: "ipfs_url",
+  cost: "cost",
+};
+
+async function run() {
+  try {
+    const inputs = {
+      keyFileContent: JSON.parse(core.getInput("KEY_FILE_CONTENT")),
+      filePath: core.getInput("FILE_PATH"),
+      package: core.getInput("PACKAGE").toLowerCase() === "true",
+      ipfs: core.getInput("IPFS").toLowerCase() === "true",
+    };
+
+    jsonfile
+      .writeFile(paths.keyFile, inputs.keyFileContent)
+      .then(async () => {
+        const args = [
+          inputs.filePath,
+          flags.deploy.keyFile,
+          paths.keyFile,
+          flags.deploy.skipConfirmation,
+          ...(inputs.package ? [flags.deploy.package] : []),
+          ...(inputs.ipfs ? [flags.deploy.ipfs] : []),
+        ];
+
+        let commandOutput = "";
+        const options = {
+          listeners: {
+            stdout: (data) => {
+              commandOutput += data.toString();
+            },
+          },
+        };
+
+        await exec.exec(commands.uploadFile, args, options);
+
+        const result = getResults(commandOutput, inputs.ipfs);
+
+        core.setOutput(outputs.arweaveUrl, result.arweaveUrl);
+        core.setOutput(outputs.ipfsUrl, result.ipfsUrl);
+        core.setOutput(outputs.cost, result.cost);
+      })
+      .catch((error) => {
+        core.setFailed(error.message);
+      });
+  } catch (error) {
+    core.setFailed(error.message);
+  }
+}
+
+function getResults(output, ipfs) {
+  // Ugly function, but the output data is not structured, just a huuge string
+  const splittedOutput = output.split("\n");
+
+  const indexes = {
+    arweaveUrlIndex: splittedOutput.findIndex(e => e.includes("https://arweave.net")),
+    ipfsUrlIndex: ipfs && splittedOutput.findIndex(e => e.includes("https://ipfs.io")),
+    costIndex: splittedOutput.findIndex(e => e.includes("Price")),
+  };
+
+  return {
+    arweaveUrl: splittedOutput[indexes.arweaveUrlIndex],
+    ipfsUrl: ipfs ? splittedOutput[indexes.ipfsUrlIndex] : "",
+    cost: splittedOutput[indexes.costIndex].split(" ")[1],
+  };
+}
+
+run();