From 90b511dfc5683644b92563445ccf352360b7006c Mon Sep 17 00:00:00 2001 From: Bobinstein Date: Thu, 7 Mar 2024 21:32:25 +0000 Subject: [PATCH] deploy: ef4e822b3ef346d1687cac3772c65c3115253fef --- 404.html | 4 ++-- assets/js/{10.d7c5128d.js => 10.e5a5e526.js} | 2 +- assets/js/{11.dcae2d7b.js => 11.ea03c039.js} | 2 +- assets/js/{12.4de5a84e.js => 12.853b2a12.js} | 2 +- assets/js/{13.060b9d35.js => 13.49c6dcee.js} | 2 +- assets/js/{14.b3663908.js => 14.a127f197.js} | 2 +- assets/js/{15.3cf20579.js => 15.e63c2fa6.js} | 2 +- assets/js/{17.c1d457d0.js => 17.7740bf0c.js} | 2 +- assets/js/{18.deda347f.js => 18.f609ea5c.js} | 2 +- assets/js/{19.22577e4b.js => 19.0a458b86.js} | 2 +- assets/js/{20.59dd276e.js => 20.71afe113.js} | 2 +- assets/js/{21.d4a39ff3.js => 21.655e9c3c.js} | 2 +- assets/js/{23.5d08d49e.js => 23.b5f1a450.js} | 2 +- assets/js/{25.45565194.js => 25.64356d41.js} | 2 +- assets/js/{26.62aee52c.js => 26.9b18c13b.js} | 2 +- assets/js/{27.998725d5.js => 27.bd4763c5.js} | 2 +- assets/js/{28.478b5652.js => 28.d4be7657.js} | 2 +- assets/js/{29.ecebea02.js => 29.d7450a84.js} | 2 +- assets/js/{30.f2a32b70.js => 30.3be995ed.js} | 2 +- assets/js/{31.e7ba423f.js => 31.2ba5cc6f.js} | 2 +- assets/js/{32.53261034.js => 32.ae676860.js} | 2 +- assets/js/{33.fca37d1f.js => 33.71e942e2.js} | 2 +- assets/js/{34.85e10a92.js => 34.ddf8b0d8.js} | 2 +- assets/js/{35.5091c8e4.js => 35.fdb54256.js} | 2 +- assets/js/{36.40c32257.js => 36.4d70737f.js} | 2 +- assets/js/{37.4db136a4.js => 37.9d454746.js} | 2 +- assets/js/{39.cd700cca.js => 39.97331bb6.js} | 2 +- assets/js/{40.35038ceb.js => 40.6c41e12f.js} | 2 +- assets/js/{41.42b360cd.js => 41.9b0828f2.js} | 2 +- assets/js/{43.607caec2.js => 43.f5f23fa5.js} | 2 +- assets/js/{8.c9ca9ade.js => 8.adcff5a3.js} | 2 +- assets/js/{9.6ede0db4.js => 9.5c2e713c.js} | 2 +- assets/js/{app.846d4f25.js => app.a0503b5c.js} | 6 +++--- docs/arfs/content-types.html | 4 ++-- docs/arfs/data-model.html | 4 ++-- docs/arfs/entity-types.html | 4 ++-- docs/arfs/index.html | 4 ++-- docs/arfs/privacy.html | 4 ++-- docs/arfs/schema-diagrams.html | 4 ++-- docs/arfs/usage/change/drives.html | 4 ++-- docs/arfs/usage/change/files.html | 4 ++-- docs/arfs/usage/change/folders.html | 4 ++-- docs/arfs/usage/change/snapshots.html | 4 ++-- docs/arfs/usage/create/create-file.html | 4 ++-- docs/arfs/usage/create/create-folder.html | 4 ++-- docs/arfs/usage/create/create-snapshot.html | 4 ++-- docs/arfs/usage/create/index.html | 4 ++-- docs/arfs/usage/extending-schemas.html | 4 ++-- docs/arfs/usage/read/index.html | 4 ++-- docs/cli/all-commands.html | 4 ++-- docs/cli/getting-help.html | 4 ++-- docs/cli/getting-started.html | 4 ++-- docs/cli/index.html | 4 ++-- docs/cli/using-the-cli.html | 4 ++-- docs/core-sdk.html | 4 ++-- docs/index.html | 4 ++-- docs/misc/deploy/deploy.html | 4 ++-- docs/misc/deploy/examples.html | 4 ++-- docs/misc/deploy/index.html | 4 ++-- docs/misc/deploy/paths.html | 4 ++-- docs/misc/deploy/routing.html | 4 ++-- docs/misc/permasite.html | 4 ++-- docs/misc/price-calculator.html | 4 ++-- docs/turbo/api/payment.html | 4 ++-- docs/turbo/api/upload.html | 4 ++-- docs/turbo/migrating.html | 4 ++-- docs/turbo/turbo-sdk/index.html | 4 ++-- docs/turbo/turbo-sdk/release-notes.html | 4 ++-- docs/turbo/turbo-sdk/turbo-web.html | 4 ++-- docs/turbo/what-is-turbo.html | 4 ++-- index.html | 4 ++-- 71 files changed, 112 insertions(+), 112 deletions(-) rename assets/js/{10.d7c5128d.js => 10.e5a5e526.js} (99%) rename assets/js/{11.dcae2d7b.js => 11.ea03c039.js} (99%) rename assets/js/{12.4de5a84e.js => 12.853b2a12.js} (95%) rename assets/js/{13.060b9d35.js => 13.49c6dcee.js} (95%) rename assets/js/{14.b3663908.js => 14.a127f197.js} (98%) rename assets/js/{15.3cf20579.js => 15.e63c2fa6.js} (97%) rename assets/js/{17.c1d457d0.js => 17.7740bf0c.js} (98%) rename assets/js/{18.deda347f.js => 18.f609ea5c.js} (97%) rename assets/js/{19.22577e4b.js => 19.0a458b86.js} (97%) rename assets/js/{20.59dd276e.js => 20.71afe113.js} (77%) rename assets/js/{21.d4a39ff3.js => 21.655e9c3c.js} (96%) rename assets/js/{23.5d08d49e.js => 23.b5f1a450.js} (98%) rename assets/js/{25.45565194.js => 25.64356d41.js} (99%) rename assets/js/{26.62aee52c.js => 26.9b18c13b.js} (99%) rename assets/js/{27.998725d5.js => 27.bd4763c5.js} (99%) rename assets/js/{28.478b5652.js => 28.d4be7657.js} (99%) rename assets/js/{29.ecebea02.js => 29.d7450a84.js} (98%) rename assets/js/{30.f2a32b70.js => 30.3be995ed.js} (97%) rename assets/js/{31.e7ba423f.js => 31.2ba5cc6f.js} (98%) rename assets/js/{32.53261034.js => 32.ae676860.js} (95%) rename assets/js/{33.fca37d1f.js => 33.71e942e2.js} (97%) rename assets/js/{34.85e10a92.js => 34.ddf8b0d8.js} (99%) rename assets/js/{35.5091c8e4.js => 35.fdb54256.js} (99%) rename assets/js/{36.40c32257.js => 36.4d70737f.js} (88%) rename assets/js/{37.4db136a4.js => 37.9d454746.js} (99%) rename assets/js/{39.cd700cca.js => 39.97331bb6.js} (99%) rename assets/js/{40.35038ceb.js => 40.6c41e12f.js} (99%) rename assets/js/{41.42b360cd.js => 41.9b0828f2.js} (99%) rename assets/js/{43.607caec2.js => 43.f5f23fa5.js} (98%) rename assets/js/{8.c9ca9ade.js => 8.adcff5a3.js} (99%) rename assets/js/{9.6ede0db4.js => 9.5c2e713c.js} (99%) rename assets/js/{app.846d4f25.js => app.a0503b5c.js} (83%) diff --git a/404.html b/404.html index 3d3b0ac..0c5a56b 100644 --- a/404.html +++ b/404.html @@ -12,13 +12,13 @@ - +

404

Looks like we've got some broken links.
Take me home.
- + diff --git a/assets/js/10.d7c5128d.js b/assets/js/10.e5a5e526.js similarity index 99% rename from assets/js/10.d7c5128d.js rename to assets/js/10.e5a5e526.js index 4736fde..5411262 100644 --- a/assets/js/10.d7c5128d.js +++ b/assets/js/10.e5a5e526.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[10],{289:function(e,t,a){"use strict";a.r(t);var r=a(10),s=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"arfs-protocol-a-decentralized-file-system-on-arweave"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#arfs-protocol-a-decentralized-file-system-on-arweave"}},[e._v("#")]),e._v(" ArFS Protocol: A Decentralized File System on Arweave")]),e._v(" "),t("p",[e._v("Arweave File System, or “ArFS” is a data modeling, storage, and retrieval protocol designed to emulate common file system operations and to provide aspects of mutability to your data hierarchy on "),t("a",{attrs:{href:"https://ardrive.io/what-is-arweave/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Arweave"),t("OutboundLink")],1),e._v("'s otherwise permanent, immutable data storage blockweave.")]),e._v(" "),t("p",[e._v("Due to Arweave's permanent, immutable and public nature traditional file system operations such as permissions, file/folder renaming and moving, and file updates cannot be done by simply updating the on-chain data model.")]),e._v(" "),t("p",[e._v("ArFS works around this by implementing a privacy and encryption pattern and defining an append-only transaction data model using tags within "),t("a",{attrs:{href:"https://docs.arweave.org/developers/server/http-api#transaction-format",target:"_blank",rel:"noopener noreferrer"}},[e._v("Arweave Transaction headers"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"key-features"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#key-features"}},[e._v("#")]),e._v(" Key Features")]),e._v(" "),t("h3",{attrs:{id:"file-structure"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#file-structure"}},[e._v("#")]),e._v(" File Structure")]),e._v(" "),t("p",[e._v("ArFS organizes files and folders using a hierarchical structure. Files are stored as individual transactions on the Arweave blockchain, while folders are metadata that reference these file transactions.")]),e._v(" "),t("h3",{attrs:{id:"metadata"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#metadata"}},[e._v("#")]),e._v(" Metadata")]),e._v(" "),t("p",[e._v("Each file and folder has associated metadata, such as the name, type, size, and modification timestamp. ArFS leverages Arweave's tagging system to store this metadata in a standardized format, which allows for easy querying and organization.")]),e._v(" "),t("h3",{attrs:{id:"file-permissions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#file-permissions"}},[e._v("#")]),e._v(" File Permissions")]),e._v(" "),t("p",[e._v("ArFS supports public and private file permissions. Public files can be accessed by anyone on the network, while private files are encrypted using the owner's private key, ensuring only they can decrypt and access the content.")]),e._v(" "),t("h3",{attrs:{id:"file-versioning"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#file-versioning"}},[e._v("#")]),e._v(" File Versioning")]),e._v(" "),t("p",[e._v("ArFS supports versioning of files, allowing users to store multiple versions of a file and access previous versions at any time. This is achieved by linking new file transactions to previous versions through the use of metadata tags.")]),e._v(" "),t("h3",{attrs:{id:"data-deduplication"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#data-deduplication"}},[e._v("#")]),e._v(" Data Deduplication")]),e._v(" "),t("p",[e._v("To minimize storage redundancy and costs, ArFS employs data deduplication techniques. If a user tries to store a file that already exists on the network, the protocol will simply create a new reference to the existing file instead of storing a duplicate copy.")]),e._v(" "),t("h3",{attrs:{id:"search-and-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#search-and-discovery"}},[e._v("#")]),e._v(" Search and Discovery")]),e._v(" "),t("p",[e._v("ArFS enables users to search and discover files based on their metadata, such as file names, types, and tags. This is made possible by indexing the metadata stored within the Arweave blockchain.")]),e._v(" "),t("h3",{attrs:{id:"interoperability"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#interoperability"}},[e._v("#")]),e._v(" Interoperability")]),e._v(" "),t("p",[e._v("ArFS is designed to be interoperable with other decentralized applications and services built on the Arweave network. This allows for seamless integration and collaboration between different applications and users.")]),e._v(" "),t("h2",{attrs:{id:"getting-started"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getting-started"}},[e._v("#")]),e._v(" Getting Started")]),e._v(" "),t("p",[e._v("To start using ArFS, you'll need to familiarize yourself with the Arweave ecosystem, acquire AR tokens to cover storage costs, and choose a compatible client or library to interact with the ArFS protocol.")]),e._v(" "),t("h2",{attrs:{id:"arfs-version-history"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#arfs-version-history"}},[e._v("#")]),e._v(" ArFS Version History")]),e._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("table",{staticClass:"inline-table"},[t("tr",[t("th",[e._v("Version")]),e._v(" "),t("th",[e._v("Date")]),e._v(" "),t("th",[e._v("Release Notes")])]),e._v(" "),t("tr",[t("td",[e._v("0.10")]),e._v(" "),t("td",[e._v("August 2020")]),e._v(" "),t("td",[e._v("The brief, beta version that was in use during initial testing of ArDrive across Web (Dart) and legacy CLI (Typescript).")])]),e._v(" "),t("tr",[t("td",[e._v("0.11")]),e._v(" "),t("td",[e._v("September 2020")]),e._v(" "),t("td",[e._v("Includes all of the major functionality supporting file systems on Arweave including new drives, folders, files, renames, moves and privacy.")])]),e._v(" "),t("tr",[t("td",[e._v("0.12")]),e._v(" "),t("td",[e._v("December 2022")]),e._v(" "),t("td",[e._v("Added Snapshot entities to support quick synchronization of drive state.")])]),e._v(" "),t("tr",[t("td",[e._v("0.13")]),e._v(" "),t("td",[e._v("August 2023")]),e._v(" "),t("td",[e._v("Added pins")])]),e._v(" "),t("tr",[t("td",[e._v("0.14")]),e._v(" "),t("td",[e._v("January 2024")]),e._v(" "),t("td",[e._v("Added "),t("code",[e._v("isHidden")]),e._v(' property to file and folder metadata to enable clients to "hide" content from end users.')])])])]),e._v(" "),t("h2",{attrs:{id:"resources"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#resources"}},[e._v("#")]),e._v(" Resources")]),e._v(" "),t("p",[e._v("For more information, documentation, and community support, refer to the following resources:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://www.arweave.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Arweave Official Website"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://docs.arweave.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Arweave Developer Documentation"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://community.arweave.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Arweave Community Forums"),t("OutboundLink")],1)])])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[10],{290:function(e,t,a){"use strict";a.r(t);var r=a(10),s=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"arfs-protocol-a-decentralized-file-system-on-arweave"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#arfs-protocol-a-decentralized-file-system-on-arweave"}},[e._v("#")]),e._v(" ArFS Protocol: A Decentralized File System on Arweave")]),e._v(" "),t("p",[e._v("Arweave File System, or “ArFS” is a data modeling, storage, and retrieval protocol designed to emulate common file system operations and to provide aspects of mutability to your data hierarchy on "),t("a",{attrs:{href:"https://ardrive.io/what-is-arweave/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Arweave"),t("OutboundLink")],1),e._v("'s otherwise permanent, immutable data storage blockweave.")]),e._v(" "),t("p",[e._v("Due to Arweave's permanent, immutable and public nature traditional file system operations such as permissions, file/folder renaming and moving, and file updates cannot be done by simply updating the on-chain data model.")]),e._v(" "),t("p",[e._v("ArFS works around this by implementing a privacy and encryption pattern and defining an append-only transaction data model using tags within "),t("a",{attrs:{href:"https://docs.arweave.org/developers/server/http-api#transaction-format",target:"_blank",rel:"noopener noreferrer"}},[e._v("Arweave Transaction headers"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"key-features"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#key-features"}},[e._v("#")]),e._v(" Key Features")]),e._v(" "),t("h3",{attrs:{id:"file-structure"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#file-structure"}},[e._v("#")]),e._v(" File Structure")]),e._v(" "),t("p",[e._v("ArFS organizes files and folders using a hierarchical structure. Files are stored as individual transactions on the Arweave blockchain, while folders are metadata that reference these file transactions.")]),e._v(" "),t("h3",{attrs:{id:"metadata"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#metadata"}},[e._v("#")]),e._v(" Metadata")]),e._v(" "),t("p",[e._v("Each file and folder has associated metadata, such as the name, type, size, and modification timestamp. ArFS leverages Arweave's tagging system to store this metadata in a standardized format, which allows for easy querying and organization.")]),e._v(" "),t("h3",{attrs:{id:"file-permissions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#file-permissions"}},[e._v("#")]),e._v(" File Permissions")]),e._v(" "),t("p",[e._v("ArFS supports public and private file permissions. Public files can be accessed by anyone on the network, while private files are encrypted using the owner's private key, ensuring only they can decrypt and access the content.")]),e._v(" "),t("h3",{attrs:{id:"file-versioning"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#file-versioning"}},[e._v("#")]),e._v(" File Versioning")]),e._v(" "),t("p",[e._v("ArFS supports versioning of files, allowing users to store multiple versions of a file and access previous versions at any time. This is achieved by linking new file transactions to previous versions through the use of metadata tags.")]),e._v(" "),t("h3",{attrs:{id:"data-deduplication"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#data-deduplication"}},[e._v("#")]),e._v(" Data Deduplication")]),e._v(" "),t("p",[e._v("To minimize storage redundancy and costs, ArFS employs data deduplication techniques. If a user tries to store a file that already exists on the network, the protocol will simply create a new reference to the existing file instead of storing a duplicate copy.")]),e._v(" "),t("h3",{attrs:{id:"search-and-discovery"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#search-and-discovery"}},[e._v("#")]),e._v(" Search and Discovery")]),e._v(" "),t("p",[e._v("ArFS enables users to search and discover files based on their metadata, such as file names, types, and tags. This is made possible by indexing the metadata stored within the Arweave blockchain.")]),e._v(" "),t("h3",{attrs:{id:"interoperability"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#interoperability"}},[e._v("#")]),e._v(" Interoperability")]),e._v(" "),t("p",[e._v("ArFS is designed to be interoperable with other decentralized applications and services built on the Arweave network. This allows for seamless integration and collaboration between different applications and users.")]),e._v(" "),t("h2",{attrs:{id:"getting-started"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getting-started"}},[e._v("#")]),e._v(" Getting Started")]),e._v(" "),t("p",[e._v("To start using ArFS, you'll need to familiarize yourself with the Arweave ecosystem, acquire AR tokens to cover storage costs, and choose a compatible client or library to interact with the ArFS protocol.")]),e._v(" "),t("h2",{attrs:{id:"arfs-version-history"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#arfs-version-history"}},[e._v("#")]),e._v(" ArFS Version History")]),e._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("table",{staticClass:"inline-table"},[t("tr",[t("th",[e._v("Version")]),e._v(" "),t("th",[e._v("Date")]),e._v(" "),t("th",[e._v("Release Notes")])]),e._v(" "),t("tr",[t("td",[e._v("0.10")]),e._v(" "),t("td",[e._v("August 2020")]),e._v(" "),t("td",[e._v("The brief, beta version that was in use during initial testing of ArDrive across Web (Dart) and legacy CLI (Typescript).")])]),e._v(" "),t("tr",[t("td",[e._v("0.11")]),e._v(" "),t("td",[e._v("September 2020")]),e._v(" "),t("td",[e._v("Includes all of the major functionality supporting file systems on Arweave including new drives, folders, files, renames, moves and privacy.")])]),e._v(" "),t("tr",[t("td",[e._v("0.12")]),e._v(" "),t("td",[e._v("December 2022")]),e._v(" "),t("td",[e._v("Added Snapshot entities to support quick synchronization of drive state.")])]),e._v(" "),t("tr",[t("td",[e._v("0.13")]),e._v(" "),t("td",[e._v("August 2023")]),e._v(" "),t("td",[e._v("Added pins")])]),e._v(" "),t("tr",[t("td",[e._v("0.14")]),e._v(" "),t("td",[e._v("January 2024")]),e._v(" "),t("td",[e._v("Added "),t("code",[e._v("isHidden")]),e._v(' property to file and folder metadata to enable clients to "hide" content from end users.')])])])]),e._v(" "),t("h2",{attrs:{id:"resources"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#resources"}},[e._v("#")]),e._v(" Resources")]),e._v(" "),t("p",[e._v("For more information, documentation, and community support, refer to the following resources:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://www.arweave.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Arweave Official Website"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://docs.arweave.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Arweave Developer Documentation"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://community.arweave.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Arweave Community Forums"),t("OutboundLink")],1)])])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/11.dcae2d7b.js b/assets/js/11.ea03c039.js similarity index 99% rename from assets/js/11.dcae2d7b.js rename to assets/js/11.ea03c039.js index f5e93ae..578db1a 100644 --- a/assets/js/11.dcae2d7b.js +++ b/assets/js/11.ea03c039.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[11],{292:function(e,t,a){"use strict";a.r(t);var i=a(10),r=Object(i.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"privacy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#privacy"}},[e._v("#")]),e._v(" Privacy")]),e._v(" "),t("p",[e._v("The Arweave blockweave is inherently public. But with apps that use ArFS, like ArDrive, your private data never leaves your computer without using military grade (and "),t("a",{attrs:{href:"https://blog.boot.dev/cryptography/is-aes-256-quantum-resistant/#:~:text=Symmetric%20encryption%2C%20or%20more%20specifically,key%20sizes%20are%20large%20enough",target:"_blank",rel:"noopener noreferrer"}},[e._v("quantum resistant"),t("OutboundLink")],1),e._v(") encryption. This privacy layer is applied at the Drive level, and users determine whether a Drive is public or private when they first create it. Private drives must follow the ArFS privacy model.")]),e._v(" "),t("p",[e._v("With ArDrive specifically, every file within a Private Drive is symmetrically encrypted using "),t("a",{attrs:{href:"https://iopscience.iop.org/article/10.1088/1742-6596/1019/1/012008/pdf",target:"_blank",rel:"noopener noreferrer"}},[e._v("AES-256-GCM"),t("OutboundLink")],1),e._v(" (for small files and metadata transactions) or "),t("a",{attrs:{href:"https://xilinx.github.io/Vitis_Libraries/security/2020.1/guide_L1/internals/ctr.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("AES-256-CTR"),t("OutboundLink")],1),e._v(' (for large files, over 100MiB). Every Private drive has a master "Drive Key" which uses a combination of the user\'s Arweave wallet signature, a user defined drive password, and a unique drive identifier ('),t("a",{attrs:{href:"https://en.wikipedia.org/wiki/Universally_unique_identifier",target:"_blank",rel:"noopener noreferrer"}},[e._v("uuidv4"),t("OutboundLink")],1),e._v('). Each file has its own "File Key" derived from the "Drive Key". This allows for single files to be shared without exposing access to the other files within the Drive.')]),e._v(" "),t("p",[e._v("Once a file is encrypted and stored on Arweave, it is locked forever and can only be decrypted using its file key.")]),e._v(" "),t("p",[t("strong",[e._v("NOTE")]),e._v(": Usable encryption standards are not limited to AES-256-GCM or AES-256-CTR. Any Encryption method may be used so long as it is clearly indicated in the "),t("code",[e._v("cipher")]),e._v(" tag.")]),e._v(" "),t("h2",{attrs:{id:"deriving-keys"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#deriving-keys"}},[e._v("#")]),e._v(" Deriving Keys")]),e._v(" "),t("p",[e._v("Private drives have a global drive key, "),t("code",[e._v("D")]),e._v(", and multiple file keys "),t("code",[e._v("F")]),e._v(", for encryption. This enables a drive to have as many uniquely encrypted files as needed. One key is used for all versions of a single file (since new file versions use the same File-Id)")]),e._v(" "),t("p",[t("code",[e._v("D")]),e._v(" is used for encrypting both Drive and Folder metadata, while "),t("code",[e._v("F")]),e._v(" is used for encrypting File metadata and the actual stored data. Having these different keys, "),t("code",[e._v("D")]),e._v(" and "),t("code",[e._v("F")]),e._v(", allows a user to share specific files without revealing the contents of their entire drive.")]),e._v(" "),t("p",[t("code",[e._v("D")]),e._v(" is derived using HKDF-SHA256 with an "),t("a",{attrs:{href:"https://en.wikipedia.org/wiki/Salt_(cryptography)",target:"_blank",rel:"noopener noreferrer"}},[e._v("unsalted"),t("OutboundLink")],1),e._v(" RSA-PSS signature of the drive's id and a user provided password.")]),e._v(" "),t("p",[t("code",[e._v("F")]),e._v(" is also derived using HKDF-SHA256 with the drive key and the file's id.")]),e._v(" "),t("img",{staticClass:"amazingdiagram",staticStyle:{width:"75%"},attrs:{src:e.$withBase("/images/encryption-diagram.png")}}),e._v(" "),t("p",[e._v("Other wallets (like "),t("a",{attrs:{href:"https://www.arconnect.io/",target:"_blank",rel:"noopener noreferrer"}},[e._v("ArConnect"),t("OutboundLink")],1),e._v(") integrate with this Key Derivation protocol just exposing an API to collect a signature from a given Arweave Wallet in order to get the SHA-256 signature needed for the "),t("a",{attrs:{href:"https://en.wikipedia.org/wiki/HKDF",target:"_blank",rel:"noopener noreferrer"}},[e._v("HKDF"),t("OutboundLink")],1),e._v(" to derive the Drive Key.")]),e._v(" "),t("p",[e._v("An example implementation, using Dart, is available "),t("a",{attrs:{href:"https://github.com/ardriveapp/ardrive-web/blob/187b3fb30808bda452123c2b18931c898df6a3fb/docs/private_drive_kdf_reference.dart",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1),e._v(", with a Typescript implementation "),t("a",{attrs:{href:"https://github.com/ardriveapp/ardrive-core-js/blob/f19da30efd30a4370be53c9b07834eae764f8535/src/utils/crypto.ts",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"private-drives"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#private-drives"}},[e._v("#")]),e._v(" Private Drives")]),e._v(" "),t("p",[e._v("Drives can store either public or private data. This is indicated by the "),t("code",[e._v("Drive-Privacy")]),e._v(" tag in the Drive entity metadata.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('Drive-Privacy: ""\n')])])]),t("p",[e._v("If a Drive entity is private, an additional tag "),t("code",[e._v("Drive-Auth-Mode")]),e._v(" must also be used to indicate how the Drive Key is derived. ArDrive clients currently leverage a secure password along with the Arweave Wallet private key signature to derive the global Drive Key.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("Drive-Auth-Mode?: 'password'\n")])])]),t("p",[e._v("On every encrypted Drive Entity, a "),t("code",[e._v("Cipher")]),e._v(" tag must be specified, along with the public parameters for decrypting the data. This is done by specifying the parameter with a "),t("code",[e._v("Cipher-*")]),e._v(" tag. eg. "),t("code",[e._v("Cipher-IV")]),e._v(". If the parameter is byte data, it must be encoded as Base64 in the tag.")]),e._v(" "),t("p",[e._v("ArDrive clients currently leverage AES256-GCM for all symmetric encryption, which requires a Cipher Initialization Vector consisting of 12 random bytes.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('Cipher?: "AES256-GCM"\nCipher-IV?: "<12 byte initialization vector as Base64>"\n')])])]),t("p",[e._v("Additionally, all encrypted transactions must have the "),t("code",[e._v("Content-Type")]),e._v(" tag "),t("code",[e._v("application/octet-stream")]),e._v(" as opposed to "),t("code",[e._v("application/json")])]),e._v(" "),t("p",[e._v("Private Drive Entities and their corresponding Root Folder Entities will both use these keys and ciphers generated to symmetrically encrypt the JSON files that are included in the transaction. This ensures that only the Drive Owner (and whomever the keys have been shared with) can open the drive, discover the root folder, and continue to load the rest of the children in the drive.")]),e._v(" "),t("h2",{attrs:{id:"private-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#private-files"}},[e._v("#")]),e._v(" Private Files")]),e._v(" "),t("p",[e._v("When a file is uploaded to a private drive, it by default also becomes private and leverages the same drive keys used for its parent drive. Each unique file in a drive will get its own set of file keys based off of that file's unique "),t("code",[e._v("FileId")]),e._v(". If a single file gets a new version, its "),t("code",[e._v("File-Id")]),e._v(" will be reused, effectively leveraging the same File Key for all versions in that file's history.")]),e._v(" "),t("p",[e._v("These file keys can be shared by the drive's owner as needed.")]),e._v(" "),t("p",[e._v("Private File entities have both its metadata and data transactions encrypted using the same File Key, ensuring all facets of the data is truly private. As such, both the file's metadata and data transactions must both have a unique "),t("code",[e._v("Cipher-IV")]),e._v(" and "),t("code",[e._v("Cipher")]),e._v(" tag:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('Cipher?: "AES256-GCM"\nCipher-IV?: "<12 byte initialization vector as Base64>"\n')])])]),t("p",[e._v("Just like drives, private files must have the "),t("code",[e._v("Content-Type")]),e._v(" tag set as "),t("code",[e._v("application/octet-stream")]),e._v(" in both its metadata and data transactions:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('Content-Type: "application/octet-stream"\n')])])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[11],{289:function(e,t,a){"use strict";a.r(t);var i=a(10),r=Object(i.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"privacy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#privacy"}},[e._v("#")]),e._v(" Privacy")]),e._v(" "),t("p",[e._v("The Arweave blockweave is inherently public. But with apps that use ArFS, like ArDrive, your private data never leaves your computer without using military grade (and "),t("a",{attrs:{href:"https://blog.boot.dev/cryptography/is-aes-256-quantum-resistant/#:~:text=Symmetric%20encryption%2C%20or%20more%20specifically,key%20sizes%20are%20large%20enough",target:"_blank",rel:"noopener noreferrer"}},[e._v("quantum resistant"),t("OutboundLink")],1),e._v(") encryption. This privacy layer is applied at the Drive level, and users determine whether a Drive is public or private when they first create it. Private drives must follow the ArFS privacy model.")]),e._v(" "),t("p",[e._v("With ArDrive specifically, every file within a Private Drive is symmetrically encrypted using "),t("a",{attrs:{href:"https://iopscience.iop.org/article/10.1088/1742-6596/1019/1/012008/pdf",target:"_blank",rel:"noopener noreferrer"}},[e._v("AES-256-GCM"),t("OutboundLink")],1),e._v(" (for small files and metadata transactions) or "),t("a",{attrs:{href:"https://xilinx.github.io/Vitis_Libraries/security/2020.1/guide_L1/internals/ctr.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("AES-256-CTR"),t("OutboundLink")],1),e._v(' (for large files, over 100MiB). Every Private drive has a master "Drive Key" which uses a combination of the user\'s Arweave wallet signature, a user defined drive password, and a unique drive identifier ('),t("a",{attrs:{href:"https://en.wikipedia.org/wiki/Universally_unique_identifier",target:"_blank",rel:"noopener noreferrer"}},[e._v("uuidv4"),t("OutboundLink")],1),e._v('). Each file has its own "File Key" derived from the "Drive Key". This allows for single files to be shared without exposing access to the other files within the Drive.')]),e._v(" "),t("p",[e._v("Once a file is encrypted and stored on Arweave, it is locked forever and can only be decrypted using its file key.")]),e._v(" "),t("p",[t("strong",[e._v("NOTE")]),e._v(": Usable encryption standards are not limited to AES-256-GCM or AES-256-CTR. Any Encryption method may be used so long as it is clearly indicated in the "),t("code",[e._v("cipher")]),e._v(" tag.")]),e._v(" "),t("h2",{attrs:{id:"deriving-keys"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#deriving-keys"}},[e._v("#")]),e._v(" Deriving Keys")]),e._v(" "),t("p",[e._v("Private drives have a global drive key, "),t("code",[e._v("D")]),e._v(", and multiple file keys "),t("code",[e._v("F")]),e._v(", for encryption. This enables a drive to have as many uniquely encrypted files as needed. One key is used for all versions of a single file (since new file versions use the same File-Id)")]),e._v(" "),t("p",[t("code",[e._v("D")]),e._v(" is used for encrypting both Drive and Folder metadata, while "),t("code",[e._v("F")]),e._v(" is used for encrypting File metadata and the actual stored data. Having these different keys, "),t("code",[e._v("D")]),e._v(" and "),t("code",[e._v("F")]),e._v(", allows a user to share specific files without revealing the contents of their entire drive.")]),e._v(" "),t("p",[t("code",[e._v("D")]),e._v(" is derived using HKDF-SHA256 with an "),t("a",{attrs:{href:"https://en.wikipedia.org/wiki/Salt_(cryptography)",target:"_blank",rel:"noopener noreferrer"}},[e._v("unsalted"),t("OutboundLink")],1),e._v(" RSA-PSS signature of the drive's id and a user provided password.")]),e._v(" "),t("p",[t("code",[e._v("F")]),e._v(" is also derived using HKDF-SHA256 with the drive key and the file's id.")]),e._v(" "),t("img",{staticClass:"amazingdiagram",staticStyle:{width:"75%"},attrs:{src:e.$withBase("/images/encryption-diagram.png")}}),e._v(" "),t("p",[e._v("Other wallets (like "),t("a",{attrs:{href:"https://www.arconnect.io/",target:"_blank",rel:"noopener noreferrer"}},[e._v("ArConnect"),t("OutboundLink")],1),e._v(") integrate with this Key Derivation protocol just exposing an API to collect a signature from a given Arweave Wallet in order to get the SHA-256 signature needed for the "),t("a",{attrs:{href:"https://en.wikipedia.org/wiki/HKDF",target:"_blank",rel:"noopener noreferrer"}},[e._v("HKDF"),t("OutboundLink")],1),e._v(" to derive the Drive Key.")]),e._v(" "),t("p",[e._v("An example implementation, using Dart, is available "),t("a",{attrs:{href:"https://github.com/ardriveapp/ardrive-web/blob/187b3fb30808bda452123c2b18931c898df6a3fb/docs/private_drive_kdf_reference.dart",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1),e._v(", with a Typescript implementation "),t("a",{attrs:{href:"https://github.com/ardriveapp/ardrive-core-js/blob/f19da30efd30a4370be53c9b07834eae764f8535/src/utils/crypto.ts",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"private-drives"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#private-drives"}},[e._v("#")]),e._v(" Private Drives")]),e._v(" "),t("p",[e._v("Drives can store either public or private data. This is indicated by the "),t("code",[e._v("Drive-Privacy")]),e._v(" tag in the Drive entity metadata.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('Drive-Privacy: ""\n')])])]),t("p",[e._v("If a Drive entity is private, an additional tag "),t("code",[e._v("Drive-Auth-Mode")]),e._v(" must also be used to indicate how the Drive Key is derived. ArDrive clients currently leverage a secure password along with the Arweave Wallet private key signature to derive the global Drive Key.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("Drive-Auth-Mode?: 'password'\n")])])]),t("p",[e._v("On every encrypted Drive Entity, a "),t("code",[e._v("Cipher")]),e._v(" tag must be specified, along with the public parameters for decrypting the data. This is done by specifying the parameter with a "),t("code",[e._v("Cipher-*")]),e._v(" tag. eg. "),t("code",[e._v("Cipher-IV")]),e._v(". If the parameter is byte data, it must be encoded as Base64 in the tag.")]),e._v(" "),t("p",[e._v("ArDrive clients currently leverage AES256-GCM for all symmetric encryption, which requires a Cipher Initialization Vector consisting of 12 random bytes.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('Cipher?: "AES256-GCM"\nCipher-IV?: "<12 byte initialization vector as Base64>"\n')])])]),t("p",[e._v("Additionally, all encrypted transactions must have the "),t("code",[e._v("Content-Type")]),e._v(" tag "),t("code",[e._v("application/octet-stream")]),e._v(" as opposed to "),t("code",[e._v("application/json")])]),e._v(" "),t("p",[e._v("Private Drive Entities and their corresponding Root Folder Entities will both use these keys and ciphers generated to symmetrically encrypt the JSON files that are included in the transaction. This ensures that only the Drive Owner (and whomever the keys have been shared with) can open the drive, discover the root folder, and continue to load the rest of the children in the drive.")]),e._v(" "),t("h2",{attrs:{id:"private-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#private-files"}},[e._v("#")]),e._v(" Private Files")]),e._v(" "),t("p",[e._v("When a file is uploaded to a private drive, it by default also becomes private and leverages the same drive keys used for its parent drive. Each unique file in a drive will get its own set of file keys based off of that file's unique "),t("code",[e._v("FileId")]),e._v(". If a single file gets a new version, its "),t("code",[e._v("File-Id")]),e._v(" will be reused, effectively leveraging the same File Key for all versions in that file's history.")]),e._v(" "),t("p",[e._v("These file keys can be shared by the drive's owner as needed.")]),e._v(" "),t("p",[e._v("Private File entities have both its metadata and data transactions encrypted using the same File Key, ensuring all facets of the data is truly private. As such, both the file's metadata and data transactions must both have a unique "),t("code",[e._v("Cipher-IV")]),e._v(" and "),t("code",[e._v("Cipher")]),e._v(" tag:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('Cipher?: "AES256-GCM"\nCipher-IV?: "<12 byte initialization vector as Base64>"\n')])])]),t("p",[e._v("Just like drives, private files must have the "),t("code",[e._v("Content-Type")]),e._v(" tag set as "),t("code",[e._v("application/octet-stream")]),e._v(" in both its metadata and data transactions:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('Content-Type: "application/octet-stream"\n')])])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/12.4de5a84e.js b/assets/js/12.853b2a12.js similarity index 95% rename from assets/js/12.4de5a84e.js rename to assets/js/12.853b2a12.js index 0225e70..9ac13b9 100644 --- a/assets/js/12.4de5a84e.js +++ b/assets/js/12.853b2a12.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[12],{300:function(a,t,e){"use strict";e.r(t);var i=e(10),s=Object(i.a)({},(function(){var a=this,t=a._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[t("h2",{attrs:{id:"schema-diagrams"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#schema-diagrams"}},[a._v("#")]),a._v(" Schema Diagrams")]),a._v(" "),t("p",[a._v("The following diagrams show complete examples of Drive, Folder, and File entity Schemas.")]),a._v(" "),t("h3",{attrs:{id:"public-drive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#public-drive"}},[a._v("#")]),a._v(" Public Drive")]),a._v(" "),t("img",{staticClass:"amazingdiagram",staticStyle:{width:"75%"},attrs:{src:a.$withBase("/images/public-drive-schema.png")}}),a._v(" "),t("div",{staticClass:"caption"},[a._v("Public Drive Schema")]),a._v(" "),t("h3",{attrs:{id:"private-drive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#private-drive"}},[a._v("#")]),a._v(" Private Drive")]),a._v(" "),t("img",{staticClass:"amazingdiagram",staticStyle:{width:"75%"},attrs:{src:a.$withBase("/images/private-drive-schema.png")}}),a._v(" "),t("div",{staticClass:"caption"},[a._v("Private Drive Schema")]),a._v(" "),t("p",[a._v("Arweave GQL Tag Byte Limit is restricted to "),t("code",[a._v("2048")]),a._v(". There is no determined limit on Data JSON custom metadata, though more data results in a higher upload cost.")])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[12],{291:function(a,t,e){"use strict";e.r(t);var i=e(10),s=Object(i.a)({},(function(){var a=this,t=a._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[t("h2",{attrs:{id:"schema-diagrams"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#schema-diagrams"}},[a._v("#")]),a._v(" Schema Diagrams")]),a._v(" "),t("p",[a._v("The following diagrams show complete examples of Drive, Folder, and File entity Schemas.")]),a._v(" "),t("h3",{attrs:{id:"public-drive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#public-drive"}},[a._v("#")]),a._v(" Public Drive")]),a._v(" "),t("img",{staticClass:"amazingdiagram",staticStyle:{width:"75%"},attrs:{src:a.$withBase("/images/public-drive-schema.png")}}),a._v(" "),t("div",{staticClass:"caption"},[a._v("Public Drive Schema")]),a._v(" "),t("h3",{attrs:{id:"private-drive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#private-drive"}},[a._v("#")]),a._v(" Private Drive")]),a._v(" "),t("img",{staticClass:"amazingdiagram",staticStyle:{width:"75%"},attrs:{src:a.$withBase("/images/private-drive-schema.png")}}),a._v(" "),t("div",{staticClass:"caption"},[a._v("Private Drive Schema")]),a._v(" "),t("p",[a._v("Arweave GQL Tag Byte Limit is restricted to "),t("code",[a._v("2048")]),a._v(". There is no determined limit on Data JSON custom metadata, though more data results in a higher upload cost.")])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/13.060b9d35.js b/assets/js/13.49c6dcee.js similarity index 95% rename from assets/js/13.060b9d35.js rename to assets/js/13.49c6dcee.js index 806acea..b3675e5 100644 --- a/assets/js/13.060b9d35.js +++ b/assets/js/13.49c6dcee.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[13],{293:function(e,t,a){"use strict";a.r(t);var r=a(10),n=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"drive-write-operations"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#drive-write-operations"}},[e._v("#")]),e._v(" Drive Write Operations")]),e._v(" "),t("h2",{attrs:{id:"rename-drives"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rename-drives"}},[e._v("#")]),e._v(" Rename Drives")]),e._v(" "),t("ul",[t("li",[e._v("A new root folder metadata transaction is created when a user wants to rename an existing drive.")]),e._v(" "),t("li",[e._v("The new root folder metadata transaction reuses the existing drive's "),t("code",[e._v("Drive-Id")]),e._v(" and "),t("code",[e._v("Folder-Id")]),e._v(", and copies all of its old metadata values, except the drive's and folder's "),t("code",[e._v("name")]),e._v(" field must be updated in its data JSON to the new drive name.\n"),t("ul",[t("li",[e._v("For private drives, new ciphers are generated for this new root folder metadata transaction.")])])]),e._v(" "),t("li",[e._v("The new root folder transaction must not have any "),t("code",[e._v("Parent-Folder-Id")]),e._v(" since it is a root folder.")])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[13],{292:function(e,t,a){"use strict";a.r(t);var r=a(10),n=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"drive-write-operations"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#drive-write-operations"}},[e._v("#")]),e._v(" Drive Write Operations")]),e._v(" "),t("h2",{attrs:{id:"rename-drives"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rename-drives"}},[e._v("#")]),e._v(" Rename Drives")]),e._v(" "),t("ul",[t("li",[e._v("A new root folder metadata transaction is created when a user wants to rename an existing drive.")]),e._v(" "),t("li",[e._v("The new root folder metadata transaction reuses the existing drive's "),t("code",[e._v("Drive-Id")]),e._v(" and "),t("code",[e._v("Folder-Id")]),e._v(", and copies all of its old metadata values, except the drive's and folder's "),t("code",[e._v("name")]),e._v(" field must be updated in its data JSON to the new drive name.\n"),t("ul",[t("li",[e._v("For private drives, new ciphers are generated for this new root folder metadata transaction.")])])]),e._v(" "),t("li",[e._v("The new root folder transaction must not have any "),t("code",[e._v("Parent-Folder-Id")]),e._v(" since it is a root folder.")])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/14.b3663908.js b/assets/js/14.a127f197.js similarity index 98% rename from assets/js/14.b3663908.js rename to assets/js/14.a127f197.js index 75d0828..508bd4d 100644 --- a/assets/js/14.b3663908.js +++ b/assets/js/14.a127f197.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[14],{291:function(e,a,t){"use strict";t.r(a);var i=t(10),n=Object(i.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"file-write-operations"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#file-write-operations"}},[e._v("#")]),e._v(" File Write Operations")]),e._v(" "),a("h2",{attrs:{id:"move-file"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#move-file"}},[e._v("#")]),e._v(" Move File")]),e._v(" "),a("p",[e._v("Files can be moved from one folder to another within the same Drive.")]),e._v(" "),a("ul",[a("li",[e._v("A new file metadata transaction is created when a user wants to move a file into a different folder.")]),e._v(" "),a("li",[e._v("The new file metadata transaction copies all of the file’s old metadata values, but the file’s "),a("code",[e._v("Parent-Folder-Id")]),e._v(" must be updated to the "),a("code",[e._v("Folder-Id")]),e._v(" of the folder is was just moved to.\n"),a("ul",[a("li",[e._v("For private files, a new "),a("code",[e._v("Cipher-IV")]),e._v(" is generated for this new metadata transaction.")])])]),e._v(" "),a("li",[e._v("File’s must not be allowed to be moved into a folder if a file exists in that folder with the same file name.")])]),e._v(" "),a("h2",{attrs:{id:"rename-file"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#rename-file"}},[e._v("#")]),e._v(" Rename File")]),e._v(" "),a("p",[e._v("Files can be renamed from one name to another.")]),e._v(" "),a("ul",[a("li",[e._v("A new file metadata transaction is created when a user wants to rename an existing file.")]),e._v(" "),a("li",[e._v("The new file metadata transaction reuses the existing file’s "),a("code",[e._v("File-Id")]),e._v(" and copies all of it’s old metadata values, but the file’s "),a("code",[e._v("name")]),e._v(" field in its Data JSON must be updated to the new file name and extension.\n"),a("ul",[a("li",[e._v("For private files, a new "),a("code",[e._v("Cipher-IV")]),e._v(" is generated for this new metadata transaction.")])])]),e._v(" "),a("li",[e._v("File’s must not be allowed to be renamed to the name of another file with that same name in that same folder.")])]),e._v(" "),a("h2",{attrs:{id:"update-file-version"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#update-file-version"}},[e._v("#")]),e._v(" Update File Version")]),e._v(" "),a("p",[e._v("When a user adds a new file to a folder, and there is a file in that folder with the same name, then a new file version is created.")]),e._v(" "),a("ul",[a("li",[e._v("A new file version uses the same "),a("code",[e._v("File-Id")]),e._v(" of the file with the matching name and same "),a("code",[e._v("Parent-Folder-Id")]),e._v(".")]),e._v(" "),a("li",[e._v("The file upload process is followed and new File Metadata and Data transactions are created.")]),e._v(" "),a("li",[e._v("However a new UUID is not generated and the same "),a("code",[e._v("File-Id")]),e._v(" and associated metadata is used for this new version")]),e._v(" "),a("li",[e._v("The new File Metadata Transaction points to the new Data transaction.\n"),a("ul",[a("li",[e._v("Since the "),a("code",[e._v("File-Id")]),e._v(" remains the same, the File Keys for private files can decrypt all versions of that file.")]),e._v(" "),a("li",[e._v("For private files, new "),a("code",[e._v("Cipher-IV")]),e._v("s are generated for this new metadata and data transaction")])])]),e._v(" "),a("li",[e._v("ArFS clients can now iterate through the state of this file, since it will have multiple versions using the same "),a("code",[e._v("File-Id")]),e._v(".")])]),e._v(" "),a("h2",{attrs:{id:"hide-or-unhide-file"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hide-or-unhide-file"}},[e._v("#")]),e._v(" Hide or Unhide File")]),e._v(" "),a("p",[e._v("Changing the value of "),a("code",[e._v("isHidden")]),e._v(" in a file's metadata will change whether or not a client should display that file.")])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[14],{294:function(e,a,t){"use strict";t.r(a);var i=t(10),n=Object(i.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"file-write-operations"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#file-write-operations"}},[e._v("#")]),e._v(" File Write Operations")]),e._v(" "),a("h2",{attrs:{id:"move-file"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#move-file"}},[e._v("#")]),e._v(" Move File")]),e._v(" "),a("p",[e._v("Files can be moved from one folder to another within the same Drive.")]),e._v(" "),a("ul",[a("li",[e._v("A new file metadata transaction is created when a user wants to move a file into a different folder.")]),e._v(" "),a("li",[e._v("The new file metadata transaction copies all of the file’s old metadata values, but the file’s "),a("code",[e._v("Parent-Folder-Id")]),e._v(" must be updated to the "),a("code",[e._v("Folder-Id")]),e._v(" of the folder is was just moved to.\n"),a("ul",[a("li",[e._v("For private files, a new "),a("code",[e._v("Cipher-IV")]),e._v(" is generated for this new metadata transaction.")])])]),e._v(" "),a("li",[e._v("File’s must not be allowed to be moved into a folder if a file exists in that folder with the same file name.")])]),e._v(" "),a("h2",{attrs:{id:"rename-file"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#rename-file"}},[e._v("#")]),e._v(" Rename File")]),e._v(" "),a("p",[e._v("Files can be renamed from one name to another.")]),e._v(" "),a("ul",[a("li",[e._v("A new file metadata transaction is created when a user wants to rename an existing file.")]),e._v(" "),a("li",[e._v("The new file metadata transaction reuses the existing file’s "),a("code",[e._v("File-Id")]),e._v(" and copies all of it’s old metadata values, but the file’s "),a("code",[e._v("name")]),e._v(" field in its Data JSON must be updated to the new file name and extension.\n"),a("ul",[a("li",[e._v("For private files, a new "),a("code",[e._v("Cipher-IV")]),e._v(" is generated for this new metadata transaction.")])])]),e._v(" "),a("li",[e._v("File’s must not be allowed to be renamed to the name of another file with that same name in that same folder.")])]),e._v(" "),a("h2",{attrs:{id:"update-file-version"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#update-file-version"}},[e._v("#")]),e._v(" Update File Version")]),e._v(" "),a("p",[e._v("When a user adds a new file to a folder, and there is a file in that folder with the same name, then a new file version is created.")]),e._v(" "),a("ul",[a("li",[e._v("A new file version uses the same "),a("code",[e._v("File-Id")]),e._v(" of the file with the matching name and same "),a("code",[e._v("Parent-Folder-Id")]),e._v(".")]),e._v(" "),a("li",[e._v("The file upload process is followed and new File Metadata and Data transactions are created.")]),e._v(" "),a("li",[e._v("However a new UUID is not generated and the same "),a("code",[e._v("File-Id")]),e._v(" and associated metadata is used for this new version")]),e._v(" "),a("li",[e._v("The new File Metadata Transaction points to the new Data transaction.\n"),a("ul",[a("li",[e._v("Since the "),a("code",[e._v("File-Id")]),e._v(" remains the same, the File Keys for private files can decrypt all versions of that file.")]),e._v(" "),a("li",[e._v("For private files, new "),a("code",[e._v("Cipher-IV")]),e._v("s are generated for this new metadata and data transaction")])])]),e._v(" "),a("li",[e._v("ArFS clients can now iterate through the state of this file, since it will have multiple versions using the same "),a("code",[e._v("File-Id")]),e._v(".")])]),e._v(" "),a("h2",{attrs:{id:"hide-or-unhide-file"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hide-or-unhide-file"}},[e._v("#")]),e._v(" Hide or Unhide File")]),e._v(" "),a("p",[e._v("Changing the value of "),a("code",[e._v("isHidden")]),e._v(" in a file's metadata will change whether or not a client should display that file.")])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/15.3cf20579.js b/assets/js/15.e63c2fa6.js similarity index 97% rename from assets/js/15.3cf20579.js rename to assets/js/15.e63c2fa6.js index 5f948c5..177a505 100644 --- a/assets/js/15.3cf20579.js +++ b/assets/js/15.e63c2fa6.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[15],{294:function(e,t,a){"use strict";a.r(t);var o=a(10),r=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"folder-write-operations"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#folder-write-operations"}},[e._v("#")]),e._v(" Folder Write Operations")]),e._v(" "),t("h2",{attrs:{id:"move-folder"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#move-folder"}},[e._v("#")]),e._v(" Move Folder")]),e._v(" "),t("p",[e._v("Folders can be moved from one folder to another within the same Drive.")]),e._v(" "),t("ul",[t("li",[e._v("A new file metadata transaction is created when a user wants to move a folder into a different folder.")]),e._v(" "),t("li",[e._v("The new file metadata transaction reuses the existing folder’s "),t("code",[e._v("Folder-Id")]),e._v(" and copies all of it’s old metadata values, but the file’s "),t("code",[e._v("Parent-Folder-Id")]),e._v(" must be updated to the "),t("code",[e._v("Folder-Id")]),e._v(" of the folder is was just moved to.\n"),t("ul",[t("li",[e._v("For private folders, new ciphers are generated for this new metadata transaction.")])])]),e._v(" "),t("li",[e._v("Folder’s must not be allowed to be moved into a folder if another folder exists in that folder with the same folder name.")])]),e._v(" "),t("h2",{attrs:{id:"rename-folder"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rename-folder"}},[e._v("#")]),e._v(" Rename Folder")]),e._v(" "),t("p",[e._v("Folders can be renamed from one name to another.")]),e._v(" "),t("ul",[t("li",[e._v("A new folder metadata transaction is created when a user wants to rename an existing folder.")]),e._v(" "),t("li",[e._v("The new folder metadata transaction reuses the existing folder’s "),t("code",[e._v("Folder-Id")]),e._v(" and copies all of it’s old metadata values, but the folder’s "),t("code",[e._v("name")]),e._v(" field in its Data JSON must be updated to the new folder name.\n"),t("ul",[t("li",[e._v("For private folders, new ciphers are generated for this new metadata transaction.")])])]),e._v(" "),t("li",[e._v("Folders must not be allowed to be renamed to the name of another folder with that same name in that same folder.")])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[15],{296:function(e,t,a){"use strict";a.r(t);var o=a(10),r=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"folder-write-operations"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#folder-write-operations"}},[e._v("#")]),e._v(" Folder Write Operations")]),e._v(" "),t("h2",{attrs:{id:"move-folder"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#move-folder"}},[e._v("#")]),e._v(" Move Folder")]),e._v(" "),t("p",[e._v("Folders can be moved from one folder to another within the same Drive.")]),e._v(" "),t("ul",[t("li",[e._v("A new file metadata transaction is created when a user wants to move a folder into a different folder.")]),e._v(" "),t("li",[e._v("The new file metadata transaction reuses the existing folder’s "),t("code",[e._v("Folder-Id")]),e._v(" and copies all of it’s old metadata values, but the file’s "),t("code",[e._v("Parent-Folder-Id")]),e._v(" must be updated to the "),t("code",[e._v("Folder-Id")]),e._v(" of the folder is was just moved to.\n"),t("ul",[t("li",[e._v("For private folders, new ciphers are generated for this new metadata transaction.")])])]),e._v(" "),t("li",[e._v("Folder’s must not be allowed to be moved into a folder if another folder exists in that folder with the same folder name.")])]),e._v(" "),t("h2",{attrs:{id:"rename-folder"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rename-folder"}},[e._v("#")]),e._v(" Rename Folder")]),e._v(" "),t("p",[e._v("Folders can be renamed from one name to another.")]),e._v(" "),t("ul",[t("li",[e._v("A new folder metadata transaction is created when a user wants to rename an existing folder.")]),e._v(" "),t("li",[e._v("The new folder metadata transaction reuses the existing folder’s "),t("code",[e._v("Folder-Id")]),e._v(" and copies all of it’s old metadata values, but the folder’s "),t("code",[e._v("name")]),e._v(" field in its Data JSON must be updated to the new folder name.\n"),t("ul",[t("li",[e._v("For private folders, new ciphers are generated for this new metadata transaction.")])])]),e._v(" "),t("li",[e._v("Folders must not be allowed to be renamed to the name of another folder with that same name in that same folder.")])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/17.c1d457d0.js b/assets/js/17.7740bf0c.js similarity index 98% rename from assets/js/17.c1d457d0.js rename to assets/js/17.7740bf0c.js index aafb8cf..5cb4824 100644 --- a/assets/js/17.c1d457d0.js +++ b/assets/js/17.7740bf0c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[17],{301:function(e,t,i){"use strict";i.r(t);var r=i(10),v=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"create-drive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-drive"}},[e._v("#")]),e._v(" Create Drive")]),e._v(" "),t("p",[e._v("To properly create a new drive, two new entities need to be created: a new Drive entity and a new Folder entity to serve as the root folder of that drive.")]),e._v(" "),t("h2",{attrs:{id:"new-drive-entity"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#new-drive-entity"}},[e._v("#")]),e._v(" New Drive Entity")]),e._v(" "),t("ul",[t("li",[e._v("The user must specify a "),t("code",[e._v("name")]),e._v(" of the drive which is stored within the Drive Entity's metadata JSON.")]),e._v(" "),t("li",[e._v("ArDrive generates a new unique uuidv4 for the drive entity's "),t("code",[e._v("Drive-Id")]),e._v(".")]),e._v(" "),t("li",[e._v("ArDrive also generates a new unique uuidv4 for the drive entity's "),t("code",[e._v("rootFolderId")]),e._v(", which will refer to the "),t("code",[e._v("Folder-Id")]),e._v(" of the new folder entity that will be created.\n"),t("ul",[t("li",[e._v("This "),t("code",[e._v("rootFolderId")]),e._v(" is stored within the Drive Entity's metadata JSON.")])])]),e._v(" "),t("li",[e._v("Drive Entity Metadata transactions must have "),t("code",[e._v('Entity-Type: "drive"')]),e._v(".")]),e._v(" "),t("li",[e._v("ArDrive will that the current local system time as seconds since Unix epoch for the Drive Entity's "),t("code",[e._v("Unix-Time")]),e._v(".")]),e._v(" "),t("li",[e._v("The Drive Entity's "),t("code",[e._v("Drive-Privacy")]),e._v(" must also be set to "),t("code",[e._v("public")]),e._v(" or "),t("code",[e._v("private")]),e._v(" in order for its subfolders and files to have the correct security settings.")]),e._v(" "),t("li",[e._v("If the drive is private:\n"),t("ul",[t("li",[e._v("Its "),t("code",[e._v("Cipher")]),e._v(" tag must be filled out with the correct encryption algorithm (currently "),t("code",[e._v("AES256-GCM")]),e._v(").")]),e._v(" "),t("li",[e._v("Its "),t("code",[e._v("Cipher-IV")]),e._v(" tag must be filled out with the generated Initialization Vector for the private drive.")]),e._v(" "),t("li",[e._v("The ArFS client must derive the Drive Key and encrypt the Drive Entity's metadata JSON using the assigned "),t("code",[e._v("Cipher")]),e._v(" and "),t("code",[e._v("Cipher-IV")]),e._v(".")])])])]),e._v(" "),t("h2",{attrs:{id:"new-root-folder-entity"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#new-root-folder-entity"}},[e._v("#")]),e._v(" New Root Folder Entity")]),e._v(" "),t("ul",[t("li",[e._v("The "),t("code",[e._v("name")]),e._v(" of the drive and folder entities must be the same.\n"),t("ul",[t("li",[e._v("This "),t("code",[e._v("name")]),e._v(" is stored within the Folder Entity's metadata JSON.")])])]),e._v(" "),t("li",[e._v("The Folder Entity's "),t("code",[e._v("Folder-Id")]),e._v(" must match the "),t("code",[e._v("rootFolderId")]),e._v(" previously created for the Drive Entity.")]),e._v(" "),t("li",[e._v("The Folder Entity's "),t("code",[e._v("Drive-Id")]),e._v(" must match the "),t("code",[e._v("Drive-Id")]),e._v(" previously created for the Drive Entity.")]),e._v(" "),t("li",[e._v("The Folder Entity must not include a "),t("code",[e._v("Parent-Folder-Id")]),e._v(" tag.\n"),t("ul",[t("li",[e._v("This is how it is determined to be the root folder for a drive.")])])]),e._v(" "),t("li",[e._v("Folder Entity metadata transactions must have "),t("code",[e._v("Entity-Type: 'folder'")]),e._v(".")]),e._v(" "),t("li",[e._v("The client gets the user's local time for the "),t("code",[e._v("Unix-Time")]),e._v(" tag, represented as seconds since Unix Epoch.")]),e._v(" "),t("li",[e._v("Public folders must have the content type "),t("code",[e._v('Content-Type: "application/json"')]),e._v(".")]),e._v(" "),t("li",[e._v("If the folder is private\n"),t("ul",[t("li",[e._v("Its "),t("code",[e._v("Cipher")]),e._v(" tag must be filled out with the correct encryption algorithm (currently "),t("code",[e._v("AES256-GCM")]),e._v(").")]),e._v(" "),t("li",[e._v("Its "),t("code",[e._v("Cipher-IV")]),e._v(" tag must be filled out with the generated Initialization Vector for the private folder.")]),e._v(" "),t("li",[e._v("Its content type must be "),t("code",[e._v('Content-Type: "application/octet-stream"')]),e._v(".")]),e._v(" "),t("li",[e._v("The ArFS client must encrypt the Drive Entity's metadata JSON using the assigned "),t("code",[e._v("Cipher")]),e._v(" and "),t("code",[e._v("Cipher-IV")]),e._v(".")])])])])])}),[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[17],{297:function(e,t,i){"use strict";i.r(t);var r=i(10),v=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"create-drive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-drive"}},[e._v("#")]),e._v(" Create Drive")]),e._v(" "),t("p",[e._v("To properly create a new drive, two new entities need to be created: a new Drive entity and a new Folder entity to serve as the root folder of that drive.")]),e._v(" "),t("h2",{attrs:{id:"new-drive-entity"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#new-drive-entity"}},[e._v("#")]),e._v(" New Drive Entity")]),e._v(" "),t("ul",[t("li",[e._v("The user must specify a "),t("code",[e._v("name")]),e._v(" of the drive which is stored within the Drive Entity's metadata JSON.")]),e._v(" "),t("li",[e._v("ArDrive generates a new unique uuidv4 for the drive entity's "),t("code",[e._v("Drive-Id")]),e._v(".")]),e._v(" "),t("li",[e._v("ArDrive also generates a new unique uuidv4 for the drive entity's "),t("code",[e._v("rootFolderId")]),e._v(", which will refer to the "),t("code",[e._v("Folder-Id")]),e._v(" of the new folder entity that will be created.\n"),t("ul",[t("li",[e._v("This "),t("code",[e._v("rootFolderId")]),e._v(" is stored within the Drive Entity's metadata JSON.")])])]),e._v(" "),t("li",[e._v("Drive Entity Metadata transactions must have "),t("code",[e._v('Entity-Type: "drive"')]),e._v(".")]),e._v(" "),t("li",[e._v("ArDrive will that the current local system time as seconds since Unix epoch for the Drive Entity's "),t("code",[e._v("Unix-Time")]),e._v(".")]),e._v(" "),t("li",[e._v("The Drive Entity's "),t("code",[e._v("Drive-Privacy")]),e._v(" must also be set to "),t("code",[e._v("public")]),e._v(" or "),t("code",[e._v("private")]),e._v(" in order for its subfolders and files to have the correct security settings.")]),e._v(" "),t("li",[e._v("If the drive is private:\n"),t("ul",[t("li",[e._v("Its "),t("code",[e._v("Cipher")]),e._v(" tag must be filled out with the correct encryption algorithm (currently "),t("code",[e._v("AES256-GCM")]),e._v(").")]),e._v(" "),t("li",[e._v("Its "),t("code",[e._v("Cipher-IV")]),e._v(" tag must be filled out with the generated Initialization Vector for the private drive.")]),e._v(" "),t("li",[e._v("The ArFS client must derive the Drive Key and encrypt the Drive Entity's metadata JSON using the assigned "),t("code",[e._v("Cipher")]),e._v(" and "),t("code",[e._v("Cipher-IV")]),e._v(".")])])])]),e._v(" "),t("h2",{attrs:{id:"new-root-folder-entity"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#new-root-folder-entity"}},[e._v("#")]),e._v(" New Root Folder Entity")]),e._v(" "),t("ul",[t("li",[e._v("The "),t("code",[e._v("name")]),e._v(" of the drive and folder entities must be the same.\n"),t("ul",[t("li",[e._v("This "),t("code",[e._v("name")]),e._v(" is stored within the Folder Entity's metadata JSON.")])])]),e._v(" "),t("li",[e._v("The Folder Entity's "),t("code",[e._v("Folder-Id")]),e._v(" must match the "),t("code",[e._v("rootFolderId")]),e._v(" previously created for the Drive Entity.")]),e._v(" "),t("li",[e._v("The Folder Entity's "),t("code",[e._v("Drive-Id")]),e._v(" must match the "),t("code",[e._v("Drive-Id")]),e._v(" previously created for the Drive Entity.")]),e._v(" "),t("li",[e._v("The Folder Entity must not include a "),t("code",[e._v("Parent-Folder-Id")]),e._v(" tag.\n"),t("ul",[t("li",[e._v("This is how it is determined to be the root folder for a drive.")])])]),e._v(" "),t("li",[e._v("Folder Entity metadata transactions must have "),t("code",[e._v("Entity-Type: 'folder'")]),e._v(".")]),e._v(" "),t("li",[e._v("The client gets the user's local time for the "),t("code",[e._v("Unix-Time")]),e._v(" tag, represented as seconds since Unix Epoch.")]),e._v(" "),t("li",[e._v("Public folders must have the content type "),t("code",[e._v('Content-Type: "application/json"')]),e._v(".")]),e._v(" "),t("li",[e._v("If the folder is private\n"),t("ul",[t("li",[e._v("Its "),t("code",[e._v("Cipher")]),e._v(" tag must be filled out with the correct encryption algorithm (currently "),t("code",[e._v("AES256-GCM")]),e._v(").")]),e._v(" "),t("li",[e._v("Its "),t("code",[e._v("Cipher-IV")]),e._v(" tag must be filled out with the generated Initialization Vector for the private folder.")]),e._v(" "),t("li",[e._v("Its content type must be "),t("code",[e._v('Content-Type: "application/octet-stream"')]),e._v(".")]),e._v(" "),t("li",[e._v("The ArFS client must encrypt the Drive Entity's metadata JSON using the assigned "),t("code",[e._v("Cipher")]),e._v(" and "),t("code",[e._v("Cipher-IV")]),e._v(".")])])])])])}),[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/assets/js/18.deda347f.js b/assets/js/18.f609ea5c.js similarity index 97% rename from assets/js/18.deda347f.js rename to assets/js/18.f609ea5c.js index 5393dd4..051f32a 100644 --- a/assets/js/18.deda347f.js +++ b/assets/js/18.f609ea5c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[18],{296:function(e,t,a){"use strict";a.r(t);var i=a(10),n=Object(i.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"create-file"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-file"}},[e._v("#")]),e._v(" Create File")]),e._v(" "),t("h2",{attrs:{id:"new-file-entity"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#new-file-entity"}},[e._v("#")]),e._v(" New File Entity")]),e._v(" "),t("ul",[t("li",[e._v("A new file metadata transaction and a separate data transaction are created when a user wants to create a new file.")]),e._v(" "),t("li",[e._v("Files can only be created in existing drives, and must have a valid Drive-Id.")]),e._v(" "),t("li",[e._v("Files can only be created in existing parent folders, and must have a valid Parent-Folder-Id.")]),e._v(" "),t("li",[e._v("The new File Entity Data transaction must only specify the file’s mime type aka Content-Type.")]),e._v(" "),t("li",[e._v("The new file metadata transaction must generate a new UUIDv4 for the File-Id.")]),e._v(" "),t("li",[e._v('File metadata transactions must have Entity-Type: "file".')]),e._v(" "),t("li",[e._v("The client gets the user’s local time for the Unix-Time tag, represented as Seconds Since Unix Epoch.\n"),t("ul",[t("li",[e._v("The client populates the File Entity Metadata Transaction Data JSON after creating the data transaction.")]),e._v(" "),t("li",[t("code",[e._v("name")]),e._v(" The name of the file including extension.")]),e._v(" "),t("li",[t("code",[e._v("size")]),e._v(" The size of the file on disk, in bytes as an integer.")]),e._v(" "),t("li",[t("code",[e._v("lastModifiedDate")]),e._v(" The file’s last time of modification as reported by the user’s operating system, in milliseconds since Unix epoch.")]),e._v(" "),t("li",[t("code",[e._v("dataTxId")]),e._v(" The Arweave transaction id of this File Entity’s Data Transaction.")]),e._v(" "),t("li",[t("code",[e._v("dataContentType")]),e._v(" The mime time of this File Entity’s data must be determined by the client.")]),e._v(" "),t("li",[t("code",[e._v("isHidden")]),e._v(" A boolean telling clients if they should display the file or not.")])])]),e._v(" "),t("li",[e._v("If the File is private:\n"),t("ul",[t("li",[e._v("Its "),t("code",[e._v("Cipher")]),e._v(" tag must be filled out with the respective encryption algorithm (currently "),t("code",[e._v("AES256-GCM")]),e._v(") for both the Metadata and Data transactions.")]),e._v(" "),t("li",[e._v("Its "),t("code",[e._v("Cipher-IV")]),e._v(" tag must be filled out with the generated Initialization Vector for both the Metadata and Data transactions. Each one has its own unique IV.")]),e._v(" "),t("li",[e._v("It must have the content type "),t("code",[e._v('Content-Type: "application/octet-stream"')]),e._v(" for both the Metadata and Data transactions.")]),e._v(" "),t("li",[e._v("The ArFS client must encrypt the File Entity’s Data and Metadata JSON using their assigned "),t("code",[e._v("Cipher")]),e._v(" and "),t("code",[e._v("Cipher-IV")])])])])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[18],{298:function(e,t,a){"use strict";a.r(t);var i=a(10),n=Object(i.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"create-file"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-file"}},[e._v("#")]),e._v(" Create File")]),e._v(" "),t("h2",{attrs:{id:"new-file-entity"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#new-file-entity"}},[e._v("#")]),e._v(" New File Entity")]),e._v(" "),t("ul",[t("li",[e._v("A new file metadata transaction and a separate data transaction are created when a user wants to create a new file.")]),e._v(" "),t("li",[e._v("Files can only be created in existing drives, and must have a valid Drive-Id.")]),e._v(" "),t("li",[e._v("Files can only be created in existing parent folders, and must have a valid Parent-Folder-Id.")]),e._v(" "),t("li",[e._v("The new File Entity Data transaction must only specify the file’s mime type aka Content-Type.")]),e._v(" "),t("li",[e._v("The new file metadata transaction must generate a new UUIDv4 for the File-Id.")]),e._v(" "),t("li",[e._v('File metadata transactions must have Entity-Type: "file".')]),e._v(" "),t("li",[e._v("The client gets the user’s local time for the Unix-Time tag, represented as Seconds Since Unix Epoch.\n"),t("ul",[t("li",[e._v("The client populates the File Entity Metadata Transaction Data JSON after creating the data transaction.")]),e._v(" "),t("li",[t("code",[e._v("name")]),e._v(" The name of the file including extension.")]),e._v(" "),t("li",[t("code",[e._v("size")]),e._v(" The size of the file on disk, in bytes as an integer.")]),e._v(" "),t("li",[t("code",[e._v("lastModifiedDate")]),e._v(" The file’s last time of modification as reported by the user’s operating system, in milliseconds since Unix epoch.")]),e._v(" "),t("li",[t("code",[e._v("dataTxId")]),e._v(" The Arweave transaction id of this File Entity’s Data Transaction.")]),e._v(" "),t("li",[t("code",[e._v("dataContentType")]),e._v(" The mime time of this File Entity’s data must be determined by the client.")]),e._v(" "),t("li",[t("code",[e._v("isHidden")]),e._v(" A boolean telling clients if they should display the file or not.")])])]),e._v(" "),t("li",[e._v("If the File is private:\n"),t("ul",[t("li",[e._v("Its "),t("code",[e._v("Cipher")]),e._v(" tag must be filled out with the respective encryption algorithm (currently "),t("code",[e._v("AES256-GCM")]),e._v(") for both the Metadata and Data transactions.")]),e._v(" "),t("li",[e._v("Its "),t("code",[e._v("Cipher-IV")]),e._v(" tag must be filled out with the generated Initialization Vector for both the Metadata and Data transactions. Each one has its own unique IV.")]),e._v(" "),t("li",[e._v("It must have the content type "),t("code",[e._v('Content-Type: "application/octet-stream"')]),e._v(" for both the Metadata and Data transactions.")]),e._v(" "),t("li",[e._v("The ArFS client must encrypt the File Entity’s Data and Metadata JSON using their assigned "),t("code",[e._v("Cipher")]),e._v(" and "),t("code",[e._v("Cipher-IV")])])])])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/19.22577e4b.js b/assets/js/19.0a458b86.js similarity index 97% rename from assets/js/19.22577e4b.js rename to assets/js/19.0a458b86.js index 561fcea..d1f7e34 100644 --- a/assets/js/19.22577e4b.js +++ b/assets/js/19.0a458b86.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[19],{297:function(e,t,a){"use strict";a.r(t);var r=a(10),n=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"create-folder"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-folder"}},[e._v("#")]),e._v(" Create Folder")]),e._v(" "),t("h2",{attrs:{id:"new-folder-entity"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#new-folder-entity"}},[e._v("#")]),e._v(" New Folder Entity")]),e._v(" "),t("p",[e._v("Folders can be created to organize files.")]),e._v(" "),t("ul",[t("li",[e._v("A new Folder Entity Metadata is created when a user wants to create a new folder.")]),e._v(" "),t("li",[e._v("Folders can only be created in existing drives, and must have a valid "),t("code",[e._v("Drive-Id")]),e._v(".")]),e._v(" "),t("li",[e._v("Folders can only be created in existing parent folders, and must have a valid "),t("code",[e._v("Parent-Folder-Id")]),e._v(".")]),e._v(" "),t("li",[e._v("The new folder metadata transaction must generate a new UUIDv4 for the "),t("code",[e._v("Folder-Id")]),e._v(".")]),e._v(" "),t("li",[e._v("Folder Entity Metadata transactions must have "),t("code",[e._v('Entity-Type: "folder"')]),e._v(".")]),e._v(" "),t("li",[e._v("The client gets the user’s local time for the "),t("code",[e._v("Unix-Time")]),e._v(" tag, represented as Seconds Since Unix Epoch.")]),e._v(" "),t("li",[e._v("The user defined folder name is added to the "),t("code",[e._v("name")]),e._v(" property in the folder’s metadata transaction Data JSON.")]),e._v(" "),t("li",[e._v("Public folders must have the content type "),t("code",[e._v('Content-Type: ""')]),e._v(".")]),e._v(" "),t("li",[e._v("If the folder is private:\n"),t("ul",[t("li",[e._v("Its "),t("code",[e._v("Cipher")]),e._v(" tag must be filled out with the respective encryption algorithm (currently "),t("code",[e._v("AES256-GCM")]),e._v(").")]),e._v(" "),t("li",[e._v("Its "),t("code",[e._v("Cipher-IV")]),e._v(" tag must be filled out with the generated Initialization Vector for the private folder.")]),e._v(" "),t("li",[e._v("It must have the content type "),t("code",[e._v('Content-Type: "application/octet-stream"')]),e._v(".")]),e._v(" "),t("li",[e._v("The ArFS client must encrypt the Folder entity’s metadata JSON using the assigned "),t("code",[e._v("Cipher")]),e._v(" and "),t("code",[e._v("Cipher-IV")]),e._v(".")])])])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[19],{299:function(e,t,a){"use strict";a.r(t);var r=a(10),n=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"create-folder"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-folder"}},[e._v("#")]),e._v(" Create Folder")]),e._v(" "),t("h2",{attrs:{id:"new-folder-entity"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#new-folder-entity"}},[e._v("#")]),e._v(" New Folder Entity")]),e._v(" "),t("p",[e._v("Folders can be created to organize files.")]),e._v(" "),t("ul",[t("li",[e._v("A new Folder Entity Metadata is created when a user wants to create a new folder.")]),e._v(" "),t("li",[e._v("Folders can only be created in existing drives, and must have a valid "),t("code",[e._v("Drive-Id")]),e._v(".")]),e._v(" "),t("li",[e._v("Folders can only be created in existing parent folders, and must have a valid "),t("code",[e._v("Parent-Folder-Id")]),e._v(".")]),e._v(" "),t("li",[e._v("The new folder metadata transaction must generate a new UUIDv4 for the "),t("code",[e._v("Folder-Id")]),e._v(".")]),e._v(" "),t("li",[e._v("Folder Entity Metadata transactions must have "),t("code",[e._v('Entity-Type: "folder"')]),e._v(".")]),e._v(" "),t("li",[e._v("The client gets the user’s local time for the "),t("code",[e._v("Unix-Time")]),e._v(" tag, represented as Seconds Since Unix Epoch.")]),e._v(" "),t("li",[e._v("The user defined folder name is added to the "),t("code",[e._v("name")]),e._v(" property in the folder’s metadata transaction Data JSON.")]),e._v(" "),t("li",[e._v("Public folders must have the content type "),t("code",[e._v('Content-Type: ""')]),e._v(".")]),e._v(" "),t("li",[e._v("If the folder is private:\n"),t("ul",[t("li",[e._v("Its "),t("code",[e._v("Cipher")]),e._v(" tag must be filled out with the respective encryption algorithm (currently "),t("code",[e._v("AES256-GCM")]),e._v(").")]),e._v(" "),t("li",[e._v("Its "),t("code",[e._v("Cipher-IV")]),e._v(" tag must be filled out with the generated Initialization Vector for the private folder.")]),e._v(" "),t("li",[e._v("It must have the content type "),t("code",[e._v('Content-Type: "application/octet-stream"')]),e._v(".")]),e._v(" "),t("li",[e._v("The ArFS client must encrypt the Folder entity’s metadata JSON using the assigned "),t("code",[e._v("Cipher")]),e._v(" and "),t("code",[e._v("Cipher-IV")]),e._v(".")])])])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/20.59dd276e.js b/assets/js/20.71afe113.js similarity index 77% rename from assets/js/20.59dd276e.js rename to assets/js/20.71afe113.js index 61ccd9d..1add422 100644 --- a/assets/js/20.59dd276e.js +++ b/assets/js/20.71afe113.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[20],{298:function(t,n,s){"use strict";s.r(n);var e=s(10),o=Object(e.a)({},(function(){return(0,this._self._c)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})}),[],!1,null,null,null);n.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[20],{300:function(t,n,s){"use strict";s.r(n);var e=s(10),o=Object(e.a)({},(function(){return(0,this._self._c)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})}),[],!1,null,null,null);n.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/21.d4a39ff3.js b/assets/js/21.655e9c3c.js similarity index 96% rename from assets/js/21.d4a39ff3.js rename to assets/js/21.655e9c3c.js index 1373fff..22a40fa 100644 --- a/assets/js/21.d4a39ff3.js +++ b/assets/js/21.655e9c3c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[21],{299:function(e,t,a){"use strict";a.r(t);var i=a(10),n=Object(i.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h2",{attrs:{id:"extending-schemas"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#extending-schemas"}},[e._v("#")]),e._v(" Extending Schemas")]),e._v(" "),t("p",[e._v("Web app and clients can extend the ArFS Schema as needed by adding additional tags into the File and Folder MetaData Transaction JSON. This gives Developers additional flexibility to support specific application needs, without breaking the overall data model or impacting privacy.")]),e._v(" "),t("p",[e._v("For example a Music Sharing App could use the following expanded File Metadata for specific music files.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('{\n "name": "",\n "size": ,\n "lastModifiedDate": \n "dataTxId": "",\n "dataContentType": ""\n "bandName": ""\n "bandAlbum": ""\n "albumSong": ""\n}\n')])])]),t("p",[e._v("Additionally, the above extended Metadata fields could be added directly as a transaction tag as well, in order to support GraphQL queries.")]),e._v(" "),t("h2",{staticStyle:{"border-bottom":"none"}},[e._v("Arweave Transaction Headers can only fit a maximum of 2048 bytes total, so this must be taken into account by clients writing custom GQL tags.")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[21],{303:function(e,t,a){"use strict";a.r(t);var i=a(10),n=Object(i.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h2",{attrs:{id:"extending-schemas"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#extending-schemas"}},[e._v("#")]),e._v(" Extending Schemas")]),e._v(" "),t("p",[e._v("Web app and clients can extend the ArFS Schema as needed by adding additional tags into the File and Folder MetaData Transaction JSON. This gives Developers additional flexibility to support specific application needs, without breaking the overall data model or impacting privacy.")]),e._v(" "),t("p",[e._v("For example a Music Sharing App could use the following expanded File Metadata for specific music files.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('{\n "name": "",\n "size": ,\n "lastModifiedDate": \n "dataTxId": "",\n "dataContentType": ""\n "bandName": ""\n "bandAlbum": ""\n "albumSong": ""\n}\n')])])]),t("p",[e._v("Additionally, the above extended Metadata fields could be added directly as a transaction tag as well, in order to support GraphQL queries.")]),e._v(" "),t("h2",{staticStyle:{"border-bottom":"none"}},[e._v("Arweave Transaction Headers can only fit a maximum of 2048 bytes total, so this must be taken into account by clients writing custom GQL tags.")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/23.5d08d49e.js b/assets/js/23.b5f1a450.js similarity index 98% rename from assets/js/23.5d08d49e.js rename to assets/js/23.b5f1a450.js index b604cbc..b20a703 100644 --- a/assets/js/23.5d08d49e.js +++ b/assets/js/23.b5f1a450.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[23],{303:function(a,e,t){"use strict";t.r(e);var r=t(10),s=Object(r.a)({},(function(){var a=this,e=a._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[e("h1",{attrs:{id:"all-ardrive-cli-commands"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#all-ardrive-cli-commands"}},[a._v("#")]),a._v(" All ArDrive CLI Commands")]),a._v(" "),e("div",{staticClass:"language-shell extra-class"},[e("pre",{pre:!0,attrs:{class:"language-shell"}},[e("code",[a._v(" █████╗ ██████╗ ██████╗ ██████╗ ██╗██╗ ██╗███████╗\n ██╔══██╗██╔══██╗██╔══██╗██╔══██╗██║██║ ██║██╔════╝\n ███████║██████╔╝██║ ██║██████╔╝██║██║ ██║█████╗\n ██╔══██║██╔══██╗██║ ██║██╔══██╗██║╚██╗ ██╔╝██╔══╝\n ██║ ██║██║ ██║██████╔╝██║ ██║██║ ╚████╔╝ ███████╗\n ╚═╝ ╚═╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚═╝ ╚═══╝ ╚══════╝\n ██████╗██╗ ██╗\n ██╔════╝██║ ██║\n ██║ ██║ ██║\n ██║ ██║ ██║\n ╚██████╗███████╗██║\n ╚═════╝╚══════╝╚═╝\n\n\nWrite ArFS\n"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("\ncreate-drive\ncreate-folder\nupload-file\ncreate-manifest\n\nmove-file\nmove-folder\n\nretry-tx\n\n\nRead ArFS\n"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("\nfile-info\nfolder-info\ndrive-info\n\nlist-folder\nlist-drive\nlist-all-drives\n\ndownload-file\ndownload-folder\ndownload-drive\n\nWallet Ops\n"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("\ngenerate-seedphrase\ngenerate-wallet\n\nget-address\nget-balance\nsend-ar\n\nget-drive-key\nget-file-key\n\nlast-tx\n\n\nArweave Ops\n"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("\nbase-reward\nget-mempool\ncreate-tx\nsend-tx\ntx-status\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Learn more about a command:")]),a._v("\nardrive "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("command"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--help")]),a._v("\n")])])])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[23],{301:function(a,e,t){"use strict";t.r(e);var r=t(10),s=Object(r.a)({},(function(){var a=this,e=a._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[e("h1",{attrs:{id:"all-ardrive-cli-commands"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#all-ardrive-cli-commands"}},[a._v("#")]),a._v(" All ArDrive CLI Commands")]),a._v(" "),e("div",{staticClass:"language-shell extra-class"},[e("pre",{pre:!0,attrs:{class:"language-shell"}},[e("code",[a._v(" █████╗ ██████╗ ██████╗ ██████╗ ██╗██╗ ██╗███████╗\n ██╔══██╗██╔══██╗██╔══██╗██╔══██╗██║██║ ██║██╔════╝\n ███████║██████╔╝██║ ██║██████╔╝██║██║ ██║█████╗\n ██╔══██║██╔══██╗██║ ██║██╔══██╗██║╚██╗ ██╔╝██╔══╝\n ██║ ██║██║ ██║██████╔╝██║ ██║██║ ╚████╔╝ ███████╗\n ╚═╝ ╚═╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚═╝ ╚═══╝ ╚══════╝\n ██████╗██╗ ██╗\n ██╔════╝██║ ██║\n ██║ ██║ ██║\n ██║ ██║ ██║\n ╚██████╗███████╗██║\n ╚═════╝╚══════╝╚═╝\n\n\nWrite ArFS\n"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("\ncreate-drive\ncreate-folder\nupload-file\ncreate-manifest\n\nmove-file\nmove-folder\n\nretry-tx\n\n\nRead ArFS\n"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("\nfile-info\nfolder-info\ndrive-info\n\nlist-folder\nlist-drive\nlist-all-drives\n\ndownload-file\ndownload-folder\ndownload-drive\n\nWallet Ops\n"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("\ngenerate-seedphrase\ngenerate-wallet\n\nget-address\nget-balance\nsend-ar\n\nget-drive-key\nget-file-key\n\nlast-tx\n\n\nArweave Ops\n"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("==")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("\nbase-reward\nget-mempool\ncreate-tx\nsend-tx\ntx-status\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Learn more about a command:")]),a._v("\nardrive "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("command"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--help")]),a._v("\n")])])])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/25.45565194.js b/assets/js/25.64356d41.js similarity index 99% rename from assets/js/25.45565194.js rename to assets/js/25.64356d41.js index 2e4ba3c..e22d739 100644 --- a/assets/js/25.45565194.js +++ b/assets/js/25.64356d41.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[25],{305:function(e,t,a){"use strict";a.r(t);var s=a(10),r=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"getting-started"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getting-started"}},[e._v("#")]),e._v(" Getting Started")]),e._v(" "),t("p",[e._v("To simply install the latest version of the CLI to your local system and get started, follow the "),t("a",{attrs:{href:"#quick-start"}},[e._v("Quick Start")]),e._v(" instructions. To build and/or develop the CLI from source, follow the "),t("a",{attrs:{href:"#build-from-source"}},[e._v("Build and Run from Source")]),e._v(" instructions. In either case, be sure to satisfy the requirements in the "),t("a",{attrs:{href:"#prerequisites"}},[e._v("Prerequisites")]),e._v(" section.")]),e._v(" "),t("h2",{attrs:{id:"prerequisites"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[e._v("#")]),e._v(" Prerequisites")]),e._v(" "),t("p",[e._v("The following tools must be installed whether performing a "),t("a",{attrs:{href:"#quick-start"}},[e._v("Quick Start")]),e._v(" or "),t("a",{attrs:{href:"#build-from-source"}},[e._v("Building from Source")]),e._v(":")]),e._v(" "),t("h3",{attrs:{id:"git"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#git"}},[e._v("#")]),e._v(" Git")]),e._v(" "),t("p",[e._v("Some of ArDrive's dependencies are transitively installed via Git. Install it, if necessary, and ensure that it's available within your terminal environment:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://git-scm.com/downloads",target:"_blank",rel:"noopener noreferrer"}},[e._v("Download Git"),t("OutboundLink")],1)]),e._v(" "),t("h3",{attrs:{id:"nvm-optional-recommended"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nvm-optional-recommended"}},[e._v("#")]),e._v(" NVM (Optional - Recommended)"),t("a",{attrs:{id:"nvm"}})]),e._v(" "),t("p",[e._v("This project uses the Node Version Manager (NVM) and an "),t("code",[e._v(".nvmrc")]),e._v(" file to lock the recommended Node version used by the latest version of "),t("code",[e._v("ardrive-core-js")]),e._v(".")]),e._v(" "),t("p",[t("strong",[e._v("Note for Windows: We recommend using WSL for setting up NVM on Windows using the "),t("a",{attrs:{href:"https://code.visualstudio.com/docs/remote/wsl",target:"_blank",rel:"noopener noreferrer"}},[e._v("instructions described here"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Follow these steps to get NVM up and running on your system:")]),e._v(" "),t("ol",[t("li",[e._v("Install NVM using "),t("a",{attrs:{href:"https://github.com/nvm-sh/nvm#installing-and-updating",target:"_blank",rel:"noopener noreferrer"}},[e._v("these installation instructions"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[e._v("Navigate to this project's root directory")]),e._v(" "),t("li",[e._v("Ensure that the correct version of Node is installed by performing: "),t("code",[e._v("nvm install")])]),e._v(" "),t("li",[e._v("Use the correct version of Node, by performing: "),t("code",[e._v("nvm use")])])]),e._v(" "),t("p",[t("strong",[e._v("IT IS STRONGLY RECOMMENDED THAT YOU AVOID GENERATING WALLETS VIA SEED PHRASE WITH THE CLI USING ANY NODE VERSION OTHER THAN THE ONE SPECIFIED IN "),t("code",[e._v(".nvmrc")]),e._v(".")])]),e._v(" "),t("h2",{attrs:{id:"quick-start"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#quick-start"}},[e._v("#")]),e._v(" Quick Start")]),e._v(" "),t("p",[e._v("Once you've satisfied any necessary "),t("a",{attrs:{href:"#prerequisites"}},[e._v("prerequisites")]),e._v(", the fastest way to get up and running is to globally install the latest version of the ArDrive CLI to your local system via NPM:")]),e._v(" "),t("h3",{attrs:{id:"installing-and-starting-the-cli-from-npm-package"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-and-starting-the-cli-from-npm-package"}},[e._v("#")]),e._v(" Installing and Starting the CLI From NPM Package"),t("a",{attrs:{id:"install-from-npm"}})]),e._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-g")]),e._v(" ardrive-cli\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# then invoke the CLI from anywhere on your system:")]),e._v("\nardrive\n")])])]),t("h3",{attrs:{id:"upgrading-to-the-latest-version"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#upgrading-to-the-latest-version"}},[e._v("#")]),e._v(" Upgrading to the Latest Version"),t("a",{attrs:{id:"upgrading"}})]),e._v(" "),t("p",[e._v("If you globally installed the CLI via NPM, then upgrade to the latest version by simply performing:")]),e._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" update "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-g")]),e._v(" ardrive-cli\n")])])]),t("h2",{attrs:{id:"build-and-run-from-source"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#build-and-run-from-source"}},[e._v("#")]),e._v(" Build and Run from Source"),t("a",{attrs:{id:"build-from-source"}})]),e._v(" "),t("h3",{attrs:{id:"install-yarn-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#install-yarn-3"}},[e._v("#")]),e._v(" Install Yarn 3"),t("a",{attrs:{id:"yarn3"}})]),e._v(" "),t("p",[e._v("Both the ArDrive CLI and ArDrive Core JS use Yarn 3 to manage dependencies and initiate workflows, so follow the "),t("a",{attrs:{href:"https://yarnpkg.com/getting-started/install",target:"_blank",rel:"noopener noreferrer"}},[e._v("yarn installation instructions"),t("OutboundLink")],1),e._v(" in order to get the latest version. In most cases:")]),e._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Brew (OSX):")]),e._v("\nbrew "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("yarn")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Or with NPM (all supported platforms):")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-g")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("yarn")]),e._v("\n")])])]),t("h3",{attrs:{id:"husky-developers-only"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#husky-developers-only"}},[e._v("#")]),e._v(" Husky (Developers Only)"),t("a",{attrs:{id:"husky"}})]),e._v(" "),t("p",[e._v("We use husky 6.x to manage the git commit hooks that help to improve the quality of our commits. Please run:")]),e._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("yarn")]),e._v(" husky "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v("\n")])])]),t("p",[e._v("to enable git hooks for your local checkout. Without doing so, you risk committing non-compliant code to the repository.")]),e._v(" "),t("h3",{attrs:{id:"using-a-custom-ardrive-core-js-optional"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-a-custom-ardrive-core-js-optional"}},[e._v("#")]),e._v(" Using a custom ArDrive-Core-JS (Optional)"),t("a",{attrs:{id:"custom-ardrive-core-js"}})]),e._v(" "),t("p",[e._v("To test a with a custom version of the "),t("code",[e._v("ardrive-core-js")]),e._v(" library on your local system, change the "),t("code",[e._v('"ardrive-core-js"')]),e._v(" line in "),t("code",[e._v("package.json")]),e._v(" to the root of your local "),t("code",[e._v("ardrive-core-js")]),e._v(" repo:")]),e._v(" "),t("div",{staticClass:"language-diff extra-class"},[t("pre",{pre:!0,attrs:{class:"language-diff"}},[t("code",[t("span",{pre:!0,attrs:{class:"token deleted-sign deleted"}},[t("span",{pre:!0,attrs:{class:"token prefix deleted"}},[e._v("-")]),t("span",{pre:!0,attrs:{class:"token line"}},[e._v(' "ardrive-core-js": "1.0.0"\n')])]),t("span",{pre:!0,attrs:{class:"token inserted-sign inserted"}},[t("span",{pre:!0,attrs:{class:"token prefix inserted"}},[e._v("+")]),t("span",{pre:!0,attrs:{class:"token line"}},[e._v(' "ardrive-core-js": "../ardrive-core-js/"\n')])])])])]),t("h3",{attrs:{id:"installing-and-starting-the-cli-from-source"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-and-starting-the-cli-from-source"}},[e._v("#")]),e._v(" Installing and Starting the CLI From Source"),t("a",{attrs:{id:"install-from-src"}})]),e._v(" "),t("p",[e._v("Now that your runtime and/or development environment is set up, to install the package simply run:")]),e._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("yarn")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("&&")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("yarn")]),e._v(" build\n")])])]),t("p",[e._v("And then start the CLI (always from the root of this repository):")]),e._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("yarn")]),e._v(" ardrive\n")])])]),t("p",[e._v("For convenience in the "),t("strong",[e._v("non-developer case")]),e._v(", you can install the CLI globally on your system by performing the following step:")]),e._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("yarn")]),e._v(" pack\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# then using the path generated by yarn from the step above:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" i "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-g")]),e._v(" /path/to/package.tgz\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# then invoke the CLI from anywhere on your system:")]),e._v("\nardrive\n")])])]),t("h3",{attrs:{id:"recommended-visual-studio-code-extensions-developers-only"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#recommended-visual-studio-code-extensions-developers-only"}},[e._v("#")]),e._v(" Recommended Visual Studio Code extensions (Developers Only)"),t("a",{attrs:{id:"vs-extensions"}})]),e._v(" "),t("p",[e._v("To ensure your environment is compatible, we also recommend the following VSCode extensions:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint",target:"_blank",rel:"noopener noreferrer"}},[e._v("ES-Lint"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig",target:"_blank",rel:"noopener noreferrer"}},[e._v("Editor-Config"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode",target:"_blank",rel:"noopener noreferrer"}},[e._v("Prettier"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=arcanis.vscode-zipfs",target:"_blank",rel:"noopener noreferrer"}},[e._v("ZipFS"),t("OutboundLink")],1)])]),e._v(" "),t("h2",{attrs:{id:"limitations"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#limitations"}},[e._v("#")]),e._v(" Limitations")]),e._v(" "),t("p",[t("strong",[e._v("Number of files in a bulk upload:")]),e._v(" Theoretically unlimited"),t("br"),e._v(" "),t("strong",[e._v("Max individual file size")]),e._v(": 2GB (Node.js limitation)"),t("br"),e._v(" "),t("strong",[e._v("Max file name length")]),e._v(": 255 bytes"),t("br"),e._v(" "),t("strong",[e._v("Max ANS-104 bundled transaction size:")]),e._v(" 500 MiB per bundle. App will handle creating multiple bundles."),t("br"),e._v(" "),t("strong",[e._v("Max ANS-104 data item counts per bundled transaction:")]),e._v(" 250 Files per bundle (500 Data Items).")])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[25],{306:function(e,t,a){"use strict";a.r(t);var s=a(10),r=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"getting-started"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getting-started"}},[e._v("#")]),e._v(" Getting Started")]),e._v(" "),t("p",[e._v("To simply install the latest version of the CLI to your local system and get started, follow the "),t("a",{attrs:{href:"#quick-start"}},[e._v("Quick Start")]),e._v(" instructions. To build and/or develop the CLI from source, follow the "),t("a",{attrs:{href:"#build-from-source"}},[e._v("Build and Run from Source")]),e._v(" instructions. In either case, be sure to satisfy the requirements in the "),t("a",{attrs:{href:"#prerequisites"}},[e._v("Prerequisites")]),e._v(" section.")]),e._v(" "),t("h2",{attrs:{id:"prerequisites"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[e._v("#")]),e._v(" Prerequisites")]),e._v(" "),t("p",[e._v("The following tools must be installed whether performing a "),t("a",{attrs:{href:"#quick-start"}},[e._v("Quick Start")]),e._v(" or "),t("a",{attrs:{href:"#build-from-source"}},[e._v("Building from Source")]),e._v(":")]),e._v(" "),t("h3",{attrs:{id:"git"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#git"}},[e._v("#")]),e._v(" Git")]),e._v(" "),t("p",[e._v("Some of ArDrive's dependencies are transitively installed via Git. Install it, if necessary, and ensure that it's available within your terminal environment:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://git-scm.com/downloads",target:"_blank",rel:"noopener noreferrer"}},[e._v("Download Git"),t("OutboundLink")],1)]),e._v(" "),t("h3",{attrs:{id:"nvm-optional-recommended"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nvm-optional-recommended"}},[e._v("#")]),e._v(" NVM (Optional - Recommended)"),t("a",{attrs:{id:"nvm"}})]),e._v(" "),t("p",[e._v("This project uses the Node Version Manager (NVM) and an "),t("code",[e._v(".nvmrc")]),e._v(" file to lock the recommended Node version used by the latest version of "),t("code",[e._v("ardrive-core-js")]),e._v(".")]),e._v(" "),t("p",[t("strong",[e._v("Note for Windows: We recommend using WSL for setting up NVM on Windows using the "),t("a",{attrs:{href:"https://code.visualstudio.com/docs/remote/wsl",target:"_blank",rel:"noopener noreferrer"}},[e._v("instructions described here"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Follow these steps to get NVM up and running on your system:")]),e._v(" "),t("ol",[t("li",[e._v("Install NVM using "),t("a",{attrs:{href:"https://github.com/nvm-sh/nvm#installing-and-updating",target:"_blank",rel:"noopener noreferrer"}},[e._v("these installation instructions"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[e._v("Navigate to this project's root directory")]),e._v(" "),t("li",[e._v("Ensure that the correct version of Node is installed by performing: "),t("code",[e._v("nvm install")])]),e._v(" "),t("li",[e._v("Use the correct version of Node, by performing: "),t("code",[e._v("nvm use")])])]),e._v(" "),t("p",[t("strong",[e._v("IT IS STRONGLY RECOMMENDED THAT YOU AVOID GENERATING WALLETS VIA SEED PHRASE WITH THE CLI USING ANY NODE VERSION OTHER THAN THE ONE SPECIFIED IN "),t("code",[e._v(".nvmrc")]),e._v(".")])]),e._v(" "),t("h2",{attrs:{id:"quick-start"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#quick-start"}},[e._v("#")]),e._v(" Quick Start")]),e._v(" "),t("p",[e._v("Once you've satisfied any necessary "),t("a",{attrs:{href:"#prerequisites"}},[e._v("prerequisites")]),e._v(", the fastest way to get up and running is to globally install the latest version of the ArDrive CLI to your local system via NPM:")]),e._v(" "),t("h3",{attrs:{id:"installing-and-starting-the-cli-from-npm-package"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-and-starting-the-cli-from-npm-package"}},[e._v("#")]),e._v(" Installing and Starting the CLI From NPM Package"),t("a",{attrs:{id:"install-from-npm"}})]),e._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-g")]),e._v(" ardrive-cli\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# then invoke the CLI from anywhere on your system:")]),e._v("\nardrive\n")])])]),t("h3",{attrs:{id:"upgrading-to-the-latest-version"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#upgrading-to-the-latest-version"}},[e._v("#")]),e._v(" Upgrading to the Latest Version"),t("a",{attrs:{id:"upgrading"}})]),e._v(" "),t("p",[e._v("If you globally installed the CLI via NPM, then upgrade to the latest version by simply performing:")]),e._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" update "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-g")]),e._v(" ardrive-cli\n")])])]),t("h2",{attrs:{id:"build-and-run-from-source"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#build-and-run-from-source"}},[e._v("#")]),e._v(" Build and Run from Source"),t("a",{attrs:{id:"build-from-source"}})]),e._v(" "),t("h3",{attrs:{id:"install-yarn-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#install-yarn-3"}},[e._v("#")]),e._v(" Install Yarn 3"),t("a",{attrs:{id:"yarn3"}})]),e._v(" "),t("p",[e._v("Both the ArDrive CLI and ArDrive Core JS use Yarn 3 to manage dependencies and initiate workflows, so follow the "),t("a",{attrs:{href:"https://yarnpkg.com/getting-started/install",target:"_blank",rel:"noopener noreferrer"}},[e._v("yarn installation instructions"),t("OutboundLink")],1),e._v(" in order to get the latest version. In most cases:")]),e._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Brew (OSX):")]),e._v("\nbrew "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("yarn")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Or with NPM (all supported platforms):")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-g")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("yarn")]),e._v("\n")])])]),t("h3",{attrs:{id:"husky-developers-only"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#husky-developers-only"}},[e._v("#")]),e._v(" Husky (Developers Only)"),t("a",{attrs:{id:"husky"}})]),e._v(" "),t("p",[e._v("We use husky 6.x to manage the git commit hooks that help to improve the quality of our commits. Please run:")]),e._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("yarn")]),e._v(" husky "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v("\n")])])]),t("p",[e._v("to enable git hooks for your local checkout. Without doing so, you risk committing non-compliant code to the repository.")]),e._v(" "),t("h3",{attrs:{id:"using-a-custom-ardrive-core-js-optional"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-a-custom-ardrive-core-js-optional"}},[e._v("#")]),e._v(" Using a custom ArDrive-Core-JS (Optional)"),t("a",{attrs:{id:"custom-ardrive-core-js"}})]),e._v(" "),t("p",[e._v("To test a with a custom version of the "),t("code",[e._v("ardrive-core-js")]),e._v(" library on your local system, change the "),t("code",[e._v('"ardrive-core-js"')]),e._v(" line in "),t("code",[e._v("package.json")]),e._v(" to the root of your local "),t("code",[e._v("ardrive-core-js")]),e._v(" repo:")]),e._v(" "),t("div",{staticClass:"language-diff extra-class"},[t("pre",{pre:!0,attrs:{class:"language-diff"}},[t("code",[t("span",{pre:!0,attrs:{class:"token deleted-sign deleted"}},[t("span",{pre:!0,attrs:{class:"token prefix deleted"}},[e._v("-")]),t("span",{pre:!0,attrs:{class:"token line"}},[e._v(' "ardrive-core-js": "1.0.0"\n')])]),t("span",{pre:!0,attrs:{class:"token inserted-sign inserted"}},[t("span",{pre:!0,attrs:{class:"token prefix inserted"}},[e._v("+")]),t("span",{pre:!0,attrs:{class:"token line"}},[e._v(' "ardrive-core-js": "../ardrive-core-js/"\n')])])])])]),t("h3",{attrs:{id:"installing-and-starting-the-cli-from-source"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-and-starting-the-cli-from-source"}},[e._v("#")]),e._v(" Installing and Starting the CLI From Source"),t("a",{attrs:{id:"install-from-src"}})]),e._v(" "),t("p",[e._v("Now that your runtime and/or development environment is set up, to install the package simply run:")]),e._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("yarn")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("&&")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("yarn")]),e._v(" build\n")])])]),t("p",[e._v("And then start the CLI (always from the root of this repository):")]),e._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("yarn")]),e._v(" ardrive\n")])])]),t("p",[e._v("For convenience in the "),t("strong",[e._v("non-developer case")]),e._v(", you can install the CLI globally on your system by performing the following step:")]),e._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("yarn")]),e._v(" pack\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# then using the path generated by yarn from the step above:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" i "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-g")]),e._v(" /path/to/package.tgz\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# then invoke the CLI from anywhere on your system:")]),e._v("\nardrive\n")])])]),t("h3",{attrs:{id:"recommended-visual-studio-code-extensions-developers-only"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#recommended-visual-studio-code-extensions-developers-only"}},[e._v("#")]),e._v(" Recommended Visual Studio Code extensions (Developers Only)"),t("a",{attrs:{id:"vs-extensions"}})]),e._v(" "),t("p",[e._v("To ensure your environment is compatible, we also recommend the following VSCode extensions:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint",target:"_blank",rel:"noopener noreferrer"}},[e._v("ES-Lint"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig",target:"_blank",rel:"noopener noreferrer"}},[e._v("Editor-Config"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode",target:"_blank",rel:"noopener noreferrer"}},[e._v("Prettier"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=arcanis.vscode-zipfs",target:"_blank",rel:"noopener noreferrer"}},[e._v("ZipFS"),t("OutboundLink")],1)])]),e._v(" "),t("h2",{attrs:{id:"limitations"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#limitations"}},[e._v("#")]),e._v(" Limitations")]),e._v(" "),t("p",[t("strong",[e._v("Number of files in a bulk upload:")]),e._v(" Theoretically unlimited"),t("br"),e._v(" "),t("strong",[e._v("Max individual file size")]),e._v(": 2GB (Node.js limitation)"),t("br"),e._v(" "),t("strong",[e._v("Max file name length")]),e._v(": 255 bytes"),t("br"),e._v(" "),t("strong",[e._v("Max ANS-104 bundled transaction size:")]),e._v(" 500 MiB per bundle. App will handle creating multiple bundles."),t("br"),e._v(" "),t("strong",[e._v("Max ANS-104 data item counts per bundled transaction:")]),e._v(" 250 Files per bundle (500 Data Items).")])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/26.62aee52c.js b/assets/js/26.9b18c13b.js similarity index 99% rename from assets/js/26.62aee52c.js rename to assets/js/26.9b18c13b.js index 0bd4767..9c0e170 100644 --- a/assets/js/26.62aee52c.js +++ b/assets/js/26.9b18c13b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{306:function(t,s,a){"use strict";a.r(s);var n=a(10),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"cli"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#cli"}},[t._v("#")]),t._v(" CLI")]),t._v(" "),s("p",[t._v("The "),s("em",[t._v("ArDrive Command Line Interface (CLI)")]),t._v(" is a Node.js application for terminal-based "),s("a",{attrs:{href:"https://ardrive.io",target:"_blank",rel:"noopener noreferrer"}},[t._v("ArDrive"),s("OutboundLink")],1),t._v(" workflows. It also offers utility operations for securely interacting with Arweave wallets and inspecting various "),s("a",{attrs:{href:"https://ardrive.io/what-is-arweave/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Arweave"),s("OutboundLink")],1),t._v(" blockchain conditions.")]),t._v(" "),s("p",[t._v("Create your first drive and permanently store your first file on the permaweb with a series of simple CLI commands like so:")]),t._v(" "),s("div",{staticClass:"language-shell extra-class"},[s("pre",{pre:!0,attrs:{class:"language-shell"}},[s("code",[t._v("ardrive create-drive --wallet-file /path/to/my/wallet.json --drive-name "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Teenage Love Poetry"')]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"created"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"drive"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"metadataTxId"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"giv2R8Xj0bbe6l5taBTQJk_38zwIrMH_g1-knSCisjU"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"entityId"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"898687ea-b678-4f86-b4e7-49560b190356"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bundledIn"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Vj2x4IBEAezBvhj5RgtA247W_q3S10suI6l0E30GPoE"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"entityName"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Teenage Love Poetry"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"folder"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"metadataTxId"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VljnttwUxRStnVuPYakF9e2whjhYJVWB0nSxD5dVyJ8"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"entityId"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"f0c58c11-430c-4383-8e54-4d864cc7e927"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bundledIn"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Vj2x4IBEAezBvhj5RgtA247W_q3S10suI6l0E30GPoE"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"entityName"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Teenage Love Poetry"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bundle"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bundleTxId"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Vj2x4IBEAezBvhj5RgtA247W_q3S10suI6l0E30GPoE"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tips"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"fees"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Vj2x4IBEAezBvhj5RgtA247W_q3S10suI6l0E30GPoE"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"44579472"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\nardrive upload-file --wallet-file /path/to/my/wallet.json --parent-folder-id "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"f0c58c11-430c-4383-8e54-4d864cc7e927"')]),t._v(" --local-path ./helloworld.txt --dest-file-name "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ode_to_ardrive.txt"')]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"created"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"entityName"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ode_to_ardrive.txt"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"entityId"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bd2ce978-6ede-4b0d-8f79-2d7bc235a0e0"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"dataTxId"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tSMcfvAQu_tKLUkdvRRbqdX93oAf3h6c9eJsSj8mXL4"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"metadataTxId"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"EvE06MmE9IKeUzFMnxSgY1M5tJX4uHU64-n8Pf_lZfU"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bundledIn"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"qjdHiQoWlSjCvhj5RgtA247W_q3S10suI6l0E30GPoE"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"sourceUri"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file://Users/BestArDriver/Uploads/helloworld.txt"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bundle"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bundleTxId"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"qjdHiQoWlSjCvhj5RgtA247W_q3S10suI6l0E30GPoE"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tips"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"txId"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"qjdHiQoWlSjCvhj5RgtA247W_q3S10suI6l0E30GPoE"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"recipient"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"address"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"i325n3L2UvgcavEM8UnFfY0OWBiyf2RrbNsLStPI73o"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"winston"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"10000000"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"fees"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"qjdHiQoWlSjCvhj5RgtA247W_q3S10suI6l0E30GPoE"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("44579472")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("p",[s("strong",[t._v("This project is in a state of active development. Use at your own risk!")])]),t._v(" "),s("h1",{attrs:{id:"ardrive"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#ardrive"}},[t._v("#")]),t._v(" ArDrive")]),t._v(" "),s("p",[s("a",{attrs:{href:"https://ardrive.io",target:"_blank",rel:"noopener noreferrer"}},[t._v("ArDrive"),s("OutboundLink")],1),t._v(" is a permanent storage platform whose "),s("a",{attrs:{href:"https://github.com/ardriveapp/",target:"_blank",rel:"noopener noreferrer"}},[t._v("applications and core libraries"),s("OutboundLink")],1),t._v(" offer hierarchical organization, privacy via complete end-to-end encryption, flexibility, extensibility, and access control over your most valuable data, all made possible by its innovative core technology, the "),s("a",{attrs:{href:"https://ardrive.atlassian.net/l/c/m6P1vJDo",target:"_blank",rel:"noopener noreferrer"}},[t._v("Arweave File System (ArFS) Protocol"),s("OutboundLink")],1),t._v(".")]),t._v(" "),s("h2",{attrs:{id:"arfs"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#arfs"}},[t._v("#")]),t._v(" ArFS")]),t._v(" "),s("p",[s("a",{attrs:{href:"https://ardrive.atlassian.net/l/c/m6P1vJDo",target:"_blank",rel:"noopener noreferrer"}},[t._v("ArFS"),s("OutboundLink")],1),t._v(" is a data modeling, storage, and retrieval protocol designed to emulate common file system operations and to provide aspects of mutability to your data hierarchy on "),s("a",{attrs:{href:"https://ardrive.io/what-is-arweave/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Arweave"),s("OutboundLink")],1),t._v("'s otherwise permanent, immutable data storage blockweave.")]),t._v(" "),s("h2",{attrs:{id:"data-portability"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#data-portability"}},[t._v("#")]),t._v(" Data Portability")]),t._v(" "),s("p",[t._v("Data uploaded via the ArDrive CLI, once indexed by Arweave's Gateways and sufficiently seeded across enough nodes on the network, can be accessed via all other ArDrive applications including the "),s("a",{attrs:{href:"https://app.ardrive.io",target:"_blank",rel:"noopener noreferrer"}},[t._v("ArDrive Web application"),s("OutboundLink")],1),t._v(" at https://app.ardrive.io.")]),t._v(" "),s("p",[t._v("All transactions successfully executed by ArDrive can always be inspected in the "),s("a",{attrs:{href:"https://viewblock.io/arweave/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Viewblock blockchain explorer"),s("OutboundLink")],1),t._v(".")]),t._v(" "),s("h2",{attrs:{id:"intended-audience"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#intended-audience"}},[t._v("#")]),t._v(" Intended Audience")]),t._v(" "),s("p",[t._v("This tool is intended for use by:")]),t._v(" "),s("ul",[s("li",[t._v("ArDrive power users with advanced workflows and resource efficiency in mind: bulk uploaders, those with larger storage demand, game developers, nft creators, storage/db admins, etc.")]),t._v(" "),s("li",[t._v("Automation tools")]),t._v(" "),s("li",[t._v("Services")]),t._v(" "),s("li",[t._v("Terminal aficionados")]),t._v(" "),s("li",[t._v("Extant and aspiring cypherpunks")])]),t._v(" "),s("p",[t._v("For deeper integrations with the "),s("a",{attrs:{href:"https://ardrive.io",target:"_blank",rel:"noopener noreferrer"}},[t._v("ArDrive"),s("OutboundLink")],1),t._v(" platform, consider using the "),s("a",{attrs:{href:"https://github.com/ardriveapp/ardrive-core-js",target:"_blank",rel:"noopener noreferrer"}},[t._v("ArDrive Core"),s("OutboundLink")],1),t._v(" (Node) library's configurable and intuitive class interfaces directly within your application.")])])}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{305:function(t,s,a){"use strict";a.r(s);var n=a(10),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"cli"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#cli"}},[t._v("#")]),t._v(" CLI")]),t._v(" "),s("p",[t._v("The "),s("em",[t._v("ArDrive Command Line Interface (CLI)")]),t._v(" is a Node.js application for terminal-based "),s("a",{attrs:{href:"https://ardrive.io",target:"_blank",rel:"noopener noreferrer"}},[t._v("ArDrive"),s("OutboundLink")],1),t._v(" workflows. It also offers utility operations for securely interacting with Arweave wallets and inspecting various "),s("a",{attrs:{href:"https://ardrive.io/what-is-arweave/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Arweave"),s("OutboundLink")],1),t._v(" blockchain conditions.")]),t._v(" "),s("p",[t._v("Create your first drive and permanently store your first file on the permaweb with a series of simple CLI commands like so:")]),t._v(" "),s("div",{staticClass:"language-shell extra-class"},[s("pre",{pre:!0,attrs:{class:"language-shell"}},[s("code",[t._v("ardrive create-drive --wallet-file /path/to/my/wallet.json --drive-name "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Teenage Love Poetry"')]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"created"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"drive"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"metadataTxId"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"giv2R8Xj0bbe6l5taBTQJk_38zwIrMH_g1-knSCisjU"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"entityId"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"898687ea-b678-4f86-b4e7-49560b190356"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bundledIn"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Vj2x4IBEAezBvhj5RgtA247W_q3S10suI6l0E30GPoE"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"entityName"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Teenage Love Poetry"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"folder"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"metadataTxId"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VljnttwUxRStnVuPYakF9e2whjhYJVWB0nSxD5dVyJ8"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"entityId"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"f0c58c11-430c-4383-8e54-4d864cc7e927"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bundledIn"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Vj2x4IBEAezBvhj5RgtA247W_q3S10suI6l0E30GPoE"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"entityName"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Teenage Love Poetry"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bundle"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bundleTxId"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Vj2x4IBEAezBvhj5RgtA247W_q3S10suI6l0E30GPoE"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tips"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"fees"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Vj2x4IBEAezBvhj5RgtA247W_q3S10suI6l0E30GPoE"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"44579472"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\nardrive upload-file --wallet-file /path/to/my/wallet.json --parent-folder-id "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"f0c58c11-430c-4383-8e54-4d864cc7e927"')]),t._v(" --local-path ./helloworld.txt --dest-file-name "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ode_to_ardrive.txt"')]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"created"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"entityName"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ode_to_ardrive.txt"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"entityId"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bd2ce978-6ede-4b0d-8f79-2d7bc235a0e0"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"dataTxId"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tSMcfvAQu_tKLUkdvRRbqdX93oAf3h6c9eJsSj8mXL4"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"metadataTxId"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"EvE06MmE9IKeUzFMnxSgY1M5tJX4uHU64-n8Pf_lZfU"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bundledIn"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"qjdHiQoWlSjCvhj5RgtA247W_q3S10suI6l0E30GPoE"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"sourceUri"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file://Users/BestArDriver/Uploads/helloworld.txt"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bundle"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bundleTxId"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"qjdHiQoWlSjCvhj5RgtA247W_q3S10suI6l0E30GPoE"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tips"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"txId"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"qjdHiQoWlSjCvhj5RgtA247W_q3S10suI6l0E30GPoE"')]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"recipient"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"address"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"i325n3L2UvgcavEM8UnFfY0OWBiyf2RrbNsLStPI73o"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"winston"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"10000000"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(",\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"fees"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"qjdHiQoWlSjCvhj5RgtA247W_q3S10suI6l0E30GPoE"')]),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("44579472")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("p",[s("strong",[t._v("This project is in a state of active development. Use at your own risk!")])]),t._v(" "),s("h1",{attrs:{id:"ardrive"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#ardrive"}},[t._v("#")]),t._v(" ArDrive")]),t._v(" "),s("p",[s("a",{attrs:{href:"https://ardrive.io",target:"_blank",rel:"noopener noreferrer"}},[t._v("ArDrive"),s("OutboundLink")],1),t._v(" is a permanent storage platform whose "),s("a",{attrs:{href:"https://github.com/ardriveapp/",target:"_blank",rel:"noopener noreferrer"}},[t._v("applications and core libraries"),s("OutboundLink")],1),t._v(" offer hierarchical organization, privacy via complete end-to-end encryption, flexibility, extensibility, and access control over your most valuable data, all made possible by its innovative core technology, the "),s("a",{attrs:{href:"https://ardrive.atlassian.net/l/c/m6P1vJDo",target:"_blank",rel:"noopener noreferrer"}},[t._v("Arweave File System (ArFS) Protocol"),s("OutboundLink")],1),t._v(".")]),t._v(" "),s("h2",{attrs:{id:"arfs"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#arfs"}},[t._v("#")]),t._v(" ArFS")]),t._v(" "),s("p",[s("a",{attrs:{href:"https://ardrive.atlassian.net/l/c/m6P1vJDo",target:"_blank",rel:"noopener noreferrer"}},[t._v("ArFS"),s("OutboundLink")],1),t._v(" is a data modeling, storage, and retrieval protocol designed to emulate common file system operations and to provide aspects of mutability to your data hierarchy on "),s("a",{attrs:{href:"https://ardrive.io/what-is-arweave/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Arweave"),s("OutboundLink")],1),t._v("'s otherwise permanent, immutable data storage blockweave.")]),t._v(" "),s("h2",{attrs:{id:"data-portability"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#data-portability"}},[t._v("#")]),t._v(" Data Portability")]),t._v(" "),s("p",[t._v("Data uploaded via the ArDrive CLI, once indexed by Arweave's Gateways and sufficiently seeded across enough nodes on the network, can be accessed via all other ArDrive applications including the "),s("a",{attrs:{href:"https://app.ardrive.io",target:"_blank",rel:"noopener noreferrer"}},[t._v("ArDrive Web application"),s("OutboundLink")],1),t._v(" at https://app.ardrive.io.")]),t._v(" "),s("p",[t._v("All transactions successfully executed by ArDrive can always be inspected in the "),s("a",{attrs:{href:"https://viewblock.io/arweave/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Viewblock blockchain explorer"),s("OutboundLink")],1),t._v(".")]),t._v(" "),s("h2",{attrs:{id:"intended-audience"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#intended-audience"}},[t._v("#")]),t._v(" Intended Audience")]),t._v(" "),s("p",[t._v("This tool is intended for use by:")]),t._v(" "),s("ul",[s("li",[t._v("ArDrive power users with advanced workflows and resource efficiency in mind: bulk uploaders, those with larger storage demand, game developers, nft creators, storage/db admins, etc.")]),t._v(" "),s("li",[t._v("Automation tools")]),t._v(" "),s("li",[t._v("Services")]),t._v(" "),s("li",[t._v("Terminal aficionados")]),t._v(" "),s("li",[t._v("Extant and aspiring cypherpunks")])]),t._v(" "),s("p",[t._v("For deeper integrations with the "),s("a",{attrs:{href:"https://ardrive.io",target:"_blank",rel:"noopener noreferrer"}},[t._v("ArDrive"),s("OutboundLink")],1),t._v(" platform, consider using the "),s("a",{attrs:{href:"https://github.com/ardriveapp/ardrive-core-js",target:"_blank",rel:"noopener noreferrer"}},[t._v("ArDrive Core"),s("OutboundLink")],1),t._v(" (Node) library's configurable and intuitive class interfaces directly within your application.")])])}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/assets/js/27.998725d5.js b/assets/js/27.bd4763c5.js similarity index 99% rename from assets/js/27.998725d5.js rename to assets/js/27.bd4763c5.js index 8027386..aff4d64 100644 --- a/assets/js/27.998725d5.js +++ b/assets/js/27.bd4763c5.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{312:function(a,t,e){"use strict";e.r(t);var s=e(10),n=Object(s.a)({},(function(){var a=this,t=a._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[t("h1",{attrs:{id:"using-the-cli"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-the-cli"}},[a._v("#")]),a._v(" Using the CLI")]),a._v(" "),t("h2",{attrs:{id:"cli-help"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#cli-help"}},[a._v("#")]),a._v(" CLI Help")]),a._v(" "),t("p",[a._v("Learn to use any command:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--help")]),a._v("\n")])])]),t("h2",{attrs:{id:"cli-version"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#cli-version"}},[a._v("#")]),a._v(" CLI Version")]),a._v(" "),t("p",[a._v("You can print out the version by running any of:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--version")]),a._v("\nardrive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-V")]),a._v("\n")])])]),t("h2",{attrs:{id:"wallet-operations"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#wallet-operations"}},[a._v("#")]),a._v(" Wallet Operations")]),a._v(" "),t("p",[a._v("Browsing of ArDrive public data is possible without the need for an "),t("a",{attrs:{href:"https://ardrive.atlassian.net/l/c/FpK8FuoQ",target:"_blank",rel:"noopener noreferrer"}},[a._v("Arweave wallet"),t("OutboundLink")],1),a._v(". However, for all write operations, or read operations without encryption/decryption keys, you'll need a wallet.")]),a._v(" "),t("p",[a._v("As you utilize the CLI, you can use either your wallet file or your seed phrase interchangeably. Consider the security implications of each approach for your particular use case carefully. If at any time you'd like to generate a new wallet altogether, start by generating a new seed phase. And if you'd like to use that seed phrase in the form of a wallet file, or if you'd like to recover an existing wallet via its seed phrase, use either or both of the following commands:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Generate seed-phrase")]),a._v("\nardrive generate-seedphrase\n"),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"this is an example twelve word seed phrase that you could use"')]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Generate/recover wallet file (with example output file path)")]),a._v("\nardrive generate-wallet "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-s")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"this is an example twelve word seed phrase that you could use"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" /path/to/wallet/file.json\n")])])]),t("p",[a._v("Public attributes of Arweave wallets can be retrieved via their 43-character Arweave wallet address. You can retrieve the wallet address associated with "),t("a",{attrs:{href:"https://ardrive.atlassian.net/l/c/FpK8FuoQ",target:"_blank",rel:"noopener noreferrer"}},[a._v("your wallet file or 12-word seed phrase"),t("OutboundLink")],1),a._v(" (e.g. wallets generated by "),t("a",{attrs:{href:"https://arconnect.io/",target:"_blank",rel:"noopener noreferrer"}},[a._v("ArConnect"),t("OutboundLink")],1),a._v(") like so:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Wallet file")]),a._v("\nardrive get-address "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet/file.json\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Seed Phrase (with sample output)")]),a._v("\nardrive get-address "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-s")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"this is an example twelve word seed phrase that you could use"')]),a._v("\nHTTn8F92tR32N8wuo-NIDkjmqPknrbl10JWo5MZ9x2k\n")])])]),t("p",[a._v("You'll need AR in your wallet for any write operations you perform in ArDrive. You can always check your wallet balance (in both AR and Winston units) by performing:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Getting the balance for your own wallet")]),a._v("\nardrive get-balance "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet/file.json\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Getting the balance for ANY wallet (with sample output)")]),a._v("\nardrive get-balance "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-a")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"HTTn8F92tR32N8wuo-NIDkjmqPknrbl10JWo5MZ9x2k"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1500000000000")]),a._v(" Winston\n"),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1.5")]),a._v(" AR\n")])])]),t("p",[a._v("If, at any time, you need to send AR out of your wallet to another wallet address, you may perform:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Using our previously generated wallet as the destination...")]),a._v("\nardrive send-ar "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet/file.json --dest-address "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"HTTn8F92tR32N8wuo-NIDkjmqPknrbl10JWo5MZ9x2k"')]),a._v(" --ar-amount "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("2.12345")]),a._v("\n")])])]),t("h2",{attrs:{id:"working-with-entities"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#working-with-entities"}},[a._v("#")]),a._v(" Working With Entities")]),a._v(" "),t("p",[t("a",{attrs:{href:"https://ardrive.io",target:"_blank",rel:"noopener noreferrer"}},[a._v("ArDrive"),t("OutboundLink")],1),a._v("'s "),t("a",{attrs:{href:"https://ardrive.atlassian.net/l/c/m6P1vJDo",target:"_blank",rel:"noopener noreferrer"}},[a._v("ArFS"),t("OutboundLink")],1),a._v(" integration provides for hierarchical organization of your file and folder data on Arweave.")]),a._v(" "),t("p",[a._v("The fundamental entity types specified by ArFS are:")]),a._v(" "),t("ul",[t("li",[a._v("Drives")]),a._v(" "),t("li",[a._v("Folders")]),a._v(" "),t("li",[a._v("Files")])]),a._v(" "),t("p",[a._v("Each instance of these entities have a Version 4 UUID entity ID that is commonly referred to by its entity type, i.e. drive ID, folder ID, and file ID.")]),a._v(" "),t("p",[a._v("When you execute write functions with the CLI, the JSON output will contain information about the Arweave Transaction IDs that were registered when writing your entities to the blockweave, any miner rewards or "),t("a",{attrs:{href:"https://ardrive.io/community/",target:"_blank",rel:"noopener noreferrer"}},[a._v("ArDrive Community"),t("OutboundLink")],1),a._v(" tips that were disbursed from your wallet, and any new entity IDs and, when applicable, encryption keys that were generated in the process of creating the entities. Typically, you'll want to keep track of those and get proficient with retrieving them in order to build your drive hierarchy to your liking. See "),t("a",{attrs:{href:"#understanding-drive-and-file-keys"}},[a._v("Understanding Drive and File Keys")]),a._v(" for more info.")]),a._v(" "),t("h3",{attrs:{id:"dry-run"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dry-run"}},[a._v("#")]),a._v(" Dry Run")]),a._v(" "),t("p",[a._v("An important feature of the ArDrive CLI is the "),t("code",[a._v("--dry-run")]),a._v(' flag. On each command that would write an ArFS entity, there is the option to run it as a "dry run". This will run all of the steps and print the outputs of a regular ArFS write, but will skip sending the actual transaction:')]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("my-command"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("other-options"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" --dry-run\n")])])]),t("p",[a._v("This can be very useful for gathering price estimations or to confirm that you've copy-pasted your entity IDs correctly before committing to an upload.")]),a._v(" "),t("h3",{attrs:{id:"uploading-to-turbo-beta"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#uploading-to-turbo-beta"}},[a._v("#")]),a._v(" Uploading to Turbo (BETA) "),t("a",{attrs:{id:"upload-to-turbo"}})]),a._v(" "),t("p",[a._v("Users can optionally choose to send each ArFS entities created to "),t("a",{attrs:{href:"https://ardrive.io/turbo/",target:"_blank",rel:"noopener noreferrer"}},[a._v("ArDrive Turbo"),t("OutboundLink")],1),a._v(" using the "),t("code",[a._v("--turbo")]),a._v(" flag. Instead of using AR from an Arweave wallet, you can use Turbo Credits or take advantage of free/discounted upload promotions.")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("my-command"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("other-options"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--turbo")]),a._v("\n")])])]),t("p",[a._v("This flag will skip any balance check on the CLI side. Turbo will check a user's balance and accept/reject a data item at the time of upload. The "),t("code",[a._v("--turbo")]),a._v(" flag by default will send your files to "),t("code",[a._v("upload.ardrive.io")]),a._v(" to be bundled. To change the Turbo destination, users can use the "),t("code",[a._v("--turbo-url")]),a._v(" flag.")]),a._v(" "),t("h2",{attrs:{id:"working-with-drives"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#working-with-drives"}},[a._v("#")]),a._v(" Working With Drives")]),a._v(" "),t("h3",{attrs:{id:"understanding-drive-hierarchies"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#understanding-drive-hierarchies"}},[a._v("#")]),a._v(" Understanding Drive Hierarchies")]),a._v(" "),t("p",[a._v('At the root of every data tree is a "Drive" entity. When a drive is created, a Root Folder is also created for it. The entity IDs for both are generated and returned when you create a new drive:')]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Use `tee` to keep a receipt of the full set of transactions info and `jq` to focus on the data of interest")]),a._v("\nardrive create-drive --wallet-file /path/to/my/wallet.json --drive-name "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Teenage Love Poetry"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("tee")]),a._v(" created_drive.json "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v("\njq "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'[.created[] | del(.metadataTxId, .entityName, .bundledIn)]'")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"type"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"drive"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6939b9e0-cc98-42cb-bae0-5888eca78885"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"type"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"folder"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"d1535126-fded-4990-809f-83a06f2a1118"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v("\n")])])]),t("p",[a._v("The relationship between the drive and its root folder is clearly visible when retrieving the drive's info:"),t("a",{attrs:{id:"drive-info"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive drive-info "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6939b9e0-cc98-42cb-bae0-5888eca78885"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" jq "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'{driveId, rootFolderId}'")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"driveId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6939b9e0-cc98-42cb-bae0-5888eca78885"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"rootFolderId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"d1535126-fded-4990-809f-83a06f2a1118"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n\n")])])]),t("p",[a._v('All file and folder entities in the drive will be anchored to it by a "Drive-ID" GQL Tag. And they\'ll each be anchored to a parent folder ID, tracked via the "Parent-Folder-ID" GQL tag, forming a tree structure whose base terminates at the Root Folder.')]),a._v(" "),t("h3",{attrs:{id:"understanding-drive-and-file-keys"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#understanding-drive-and-file-keys"}},[a._v("#")]),a._v(" Understanding Drive and File Keys")]),a._v(" "),t("p",[a._v('Private Drives achieve privacy via end-to-end encryption facilitated by hash-derived "Keys". Drive Keys encrypt/decrypt Drive and Folder data, and File Keys encrypt/decrypt File Data.')]),a._v(" "),t("p",[a._v("The relationships among your data and their keys is as follows:")]),a._v(" "),t("ul",[t("li",[a._v("Drive Key = functionOf(Wallet Signature, Randomly Generated Drive ID, User-specified Drive Password)")]),a._v(" "),t("li",[a._v("File Key = functionOf(Randomly Generated File ID, Drive Key)")])]),a._v(" "),t("p",[a._v("When you create private entities, the returned JSON data from the ArDrive CLI will contain the keys needed to decrypt the encrypted representation of your entity that is now securely and permanently stored on the blockweave.")]),a._v(" "),t("p",[a._v("To derive the drive key again for a drive, perform the following:"),t("a",{attrs:{id:"derive-drive-key"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Will throw an error if the wallet or password specified can't be used to decrypt the on-chain drive")]),a._v("\nardrive get-drive-key "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/my/wallet.json "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6939b9e0-cc98-42cb-bae0-5888eca78885"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v("\n")])])]),t("p",[a._v("To derive the file key again for a file, perform the following:"),t("a",{attrs:{id:"derive-file-key"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Will throw an error if the drive key or drive-key-derivation data specified can't be used to decrypt the on-chain file")]),a._v("\nardrive get-file-key --file-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"bd2ce978-6ede-4b0d-8f79-2d7bc235a0e0"')]),a._v(" --drive-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6939b9e0-cc98-42cb-bae0-5888eca78885"')]),a._v(" --drive-key "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"yHdCjpCK3EcuhQcKNx2d/NN5ReEjoKfZVqKunlCnPEo"')]),a._v("\n")])])]),t("h3",{attrs:{id:"managing-drive-passwords"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#managing-drive-passwords"}},[a._v("#")]),a._v(" Managing Drive Passwords")]),a._v(" "),t("p",[a._v("The ArDrive CLI's private drive and folder functions all require either a drive password OR a drive key. Private file functions require either the drive password or the file key. "),t("strong",[a._v("Keys and passwords are sensitive data, so manage the entry, display, storage, and transmission of them very carefully.")])]),a._v(" "),t("p",[a._v("Drive passwords are the most portable, and fundamental, encryption facet, so a few options are available during private drive operations for supplying them:")]),a._v(" "),t("ul",[t("li",[a._v("Environment Variable")]),a._v(" "),t("li",[a._v("STDIN")]),a._v(" "),t("li",[a._v("Secure Prompt")])]),a._v(" "),t("h4",{attrs:{id:"supplying-your-password-environment-variable"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#supplying-your-password-environment-variable"}},[a._v("#")]),a._v(" Supplying Your Password: Environment Variable"),t("a",{attrs:{id:"pw-environment-variable"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Securely type your password into a read prompt, store it to TMP_ARDRIVE_PW, and export it for the shell session")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("read")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-rs")]),a._v(" TMP_ARDRIVE_PW\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("export")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[a._v("ARDRIVE_DRIVE_PW")]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$(")]),a._v("TMP_ARDRIVE_PW"),t("span",{pre:!0,attrs:{class:"token variable"}},[a._v(")")])]),a._v("\nardrive "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("some private command"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v("\n")])])]),t("h4",{attrs:{id:"supplying-your-password-stdin"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#supplying-your-password-stdin"}},[a._v("#")]),a._v(" Supplying Your Password: STDIN"),t("a",{attrs:{id:"pw-stdin"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Pipe your drive password to the ArDrive CLI")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("cat")]),a._v(" /path/to/my/drive/password.txt "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" ardrive "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("some private command"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Redirect your drive password to the ArDrive CLI")]),a._v("\nardrive "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("some private command"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v(" /path/to/my/drive/password.txt\n")])])]),t("h4",{attrs:{id:"supplying-your-password-prompt"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#supplying-your-password-prompt"}},[a._v("#")]),a._v(" Supplying Your Password: Prompt"),t("a",{attrs:{id:"pw-prompt"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# When all other options fail, the CLI will prompt for your password (NOT COMPATIBLE WITH PIPES AND REDIRECTS!)")]),a._v("\nardrive "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("some private command"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v("\n? Enter drive password: › ********\n")])])]),t("h3",{attrs:{id:"creating-drives"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-drives"}},[a._v("#")]),a._v(" Creating Drives")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Public drive")]),a._v("\nardrive create-drive --wallet-file /path/to/my/wallet.json --drive-name "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"My Public Archive"')]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Private drive")]),a._v("\nardrive create-drive --wallet-file /path/to/my/wallet.json --drive-name "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Teenage Love Poetry"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v("\n")])])]),t("h3",{attrs:{id:"listing-drives-for-an-address"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#listing-drives-for-an-address"}},[a._v("#")]),a._v(" Listing Drives for an Address")]),a._v(" "),t("p",[a._v("You can list all the drives associated with any Arweave wallet address, though the details of private drives will be obfuscated from you unless you provide the necessary decryption data.")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# List all your own drives")]),a._v("\nardrive list-all-drives "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/my/wallet.json "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# List any address's drives")]),a._v("\nardrive list-all-drives "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--address")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"HTTn8F92tR32N8wuo-NIDkjmqPknrbl10JWo5MZ9x2k"')]),a._v("\n")])])]),t("h3",{attrs:{id:"listing-every-entity-in-a-drive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#listing-every-entity-in-a-drive"}},[a._v("#")]),a._v(" Listing Every Entity in a Drive"),t("a",{attrs:{id:"list-drive"}})]),a._v(" "),t("p",[a._v("Useful notes on listing the contents of drives:")]),a._v(" "),t("ul",[t("li",[a._v("Listing a drive is effectively the same as listing its root folder.")]),a._v(" "),t("li",[a._v("You can control the tree depth of the data returned.")]),a._v(" "),t("li",[a._v("path, txPath, and entityIdPath properties on entities can provide useful handholds for other forms of data navigation")])]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# List everything in a private drive")]),a._v("\nardrive list-drive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"c7f87712-b54e-4491-bc96-1c5fa7b1da50"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/my/wallet.json "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# List a private drive including the `fileKey` and/or `driveKey` of all listed entitites")]),a._v("\nardrive list-drive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"c7f87712-b54e-4491-bc96-1c5fa7b1da50"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/my/wallet.json "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v(" --with-keys\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# List the contents of a public drive up to and including those in the grandchild folders of the root folder")]),a._v("\nardrive list-drive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"c7f87712-b54e-4491-bc96-1c5fa7b1da50"')]),a._v(" --max-depth "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("2")]),a._v("\n")])])]),t("h3",{attrs:{id:"list-drive-pipeline-examples"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#list-drive-pipeline-examples"}},[a._v("#")]),a._v(" List Drive Pipeline Examples")]),a._v(" "),t("p",[a._v("You can utilize "),t("code",[a._v("jq")]),a._v(" and the list commands to reshape the commands' output data into useful forms and stats for many use cases. Here are a few examples:")]),a._v(" "),t("p",[t("a",{attrs:{id:"get-share-links"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Get share links for a PUBLIC drive")]),a._v("\nardrive list-drive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" a44482fd-592e-45fa-a08a-e526c31b87f1 "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" jq "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('\'.[] | select(.entityType == "file") | "https://app.ardrive.io/#/file/" + .entityId + "/view"\'')]),a._v("\n")])])]),t("p",[a._v("Example output:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://app.ardrive.io/#/file/1337babe-f000-dead-beef-ffffffffffff/view"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://app.ardrive.io/#/file/cdbc9ddd-1cab-41d9-acbd-fd4328929de3/view"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://app.ardrive.io/#/file/f19bc712-b57a-4e0d-8e5c-b7f1786b34a1/view"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://app.ardrive.io/#/file/4f8e081b-42f2-442d-be41-57f6f906e1c8/view"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://app.ardrive.io/#/file/0e02d254-c853-4ff0-9b6e-c4d23d2a95f5/view"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://app.ardrive.io/#/file/c098b869-29d1-4a86-960f-a9e10433f0b0/view"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://app.ardrive.io/#/file/4afc8cdf-4d27-408a-bfb9-0a2ec21eebf8/view"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://app.ardrive.io/#/file/85fe488d-fcf7-48ca-9df8-2b39958bbf15/view"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("..")]),a._v(".\n")])])]),t("p",[t("a",{attrs:{id:"get-total-size"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Get total size of all files within drive")]),a._v("\nardrive list-drive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" 13c3c232-6687-4d11-8ac1-35284102c7db "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" jq "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("' map(select(.entityType == \"file\") | .size) | add'")]),a._v("\n")])])]),t("p",[t("a",{attrs:{id:"get-file-count"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Get total number of files within drive")]),a._v("\nardrive list-drive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" 01ea6ba3-9e58-42e7-899d-622fd110211c "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" jq "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'[ .[] | select(.entityType == \"file\") ] | length'")]),a._v("\n")])])]),t("h2",{attrs:{id:"working-with-folders"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#working-with-folders"}},[a._v("#")]),a._v(" Working With Folders")]),a._v(" "),t("p",[a._v("As discussed previously, all folders in a drive are linked by way of parent folder references back to the root folder of a drive. Folders can be moved into any folder in the hierarchy that's not in their own subtree.")]),a._v(" "),t("h3",{attrs:{id:"creating-folders"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-folders"}},[a._v("#")]),a._v(" Creating Folders")]),a._v(" "),t("p",[a._v("Creating folders manually is straightforward:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive create-folder --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"63153bb3-2ca9-4d42-9106-0ce82e793321"')]),a._v(" --folder-name "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"My Awesome Folder"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("p",[a._v("Example output:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"created"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"type"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"folder"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"metadataTxId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"AYFMBVmwqhbg9y5Fbj3Iasy5oxUqhauOW7PcS1sl4Dk"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"d1b7c514-fb12-4603-aad8-002cf63015d3"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"key"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"yHdCjpCKD2cuhQcKNx2d/XF5ReEjoKfZVqKunlCnPEk"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityName"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"My Awesome Folder"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"tips"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"fees"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"AYFMBVmwqhbg9y5Fbj3Iasy5oxUqhauOW7PcS1sl4Dk"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1378052")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),t("p",[a._v("Note: Folders can also be created by supplying a folder as the --local-path of an upload-file command. In this case, the folder hierarchy on the local disk will be reconstructed on chain during the course of the recursive bulk upload.")]),a._v(" "),t("h3",{attrs:{id:"moving-folders"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#moving-folders"}},[a._v("#")]),a._v(" Moving Folders")]),a._v(" "),t("p",[a._v("Moving a folder is as simple as supplying a new parent folder ID. Note that naming collisions among entities within a folder are not allowed.")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive move-folder --folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"29850ab7-56d4-4e1f-a5be-cb86d5513921"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("h3",{attrs:{id:"renaming-folders"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#renaming-folders"}},[a._v("#")]),a._v(" Renaming Folders"),t("a",{attrs:{id:"rename-folder"}})]),a._v(" "),t("p",[a._v("In order to rename a folder you must provide a name different from its current one, and it must not create naming conflicts with its sibling entities.")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive rename-folder --folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"568d5eba-dbf3-4a49-8129-1c58f7fd35bc"')]),a._v(" --folder-name "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Folder with cool stuff"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"./wallet.json"')]),a._v("\n")])])]),t("h3",{attrs:{id:"viewing-folder-metadata"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#viewing-folder-metadata"}},[a._v("#")]),a._v(" Viewing Folder Metadata")]),a._v(" "),t("p",[a._v("To view the metadata of a folder, users can use the "),t("code",[a._v("folder-info")]),a._v(" command:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive folder-info --folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v("\n")])])]),t("h3",{attrs:{id:"listing-contents-of-a-folder"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#listing-contents-of-a-folder"}},[a._v("#")]),a._v(" Listing Contents of a Folder")]),a._v(" "),t("p",[a._v("Similar to drives, the "),t("code",[a._v("list-folder")]),a._v(" command can be used to fetch the metadata of each entity within a folder. But by default, the command will fetch only the immediate children of that folder ("),t("code",[a._v("--max-depth 0")]),a._v("):")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v('# List immediate children of folder "My Public Folder"')]),a._v("\nardrive list-folder --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"29850ab7-56d4-4e1f-a5be-cb86d5513940"')]),a._v("\n")])])]),t("p",[a._v("Example output:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appName"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ArDrive-CLI"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appVersion"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"2.0"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"arFS"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"0.11"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"contentType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"application/json"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"driveId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"01ea6ba3-9e58-42e7-899d-622fd110211a"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"folder"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"name"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"mytestfolder"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"HYiKyfLwY7PT9NleTQoTiM_-qPVUwf4ClDhx1sjUAEU"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"unixTime"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1635102772")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"parentFolderId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"29850ab7-56d4-4e1f-a5be-cb86d5513940"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"03df2929-1440-4ab4-bbf0-9dc776e1ed96"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"path"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/My Public Folder/mytestfolder"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txIdPath"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/09_x0X2eZ3flXXLS72WdTDq6uaa5g2LjsT-QH1m0zhU/HYiKyfLwY7PT9NleTQoTiM_-qPVUwf4ClDhx1sjUAEU"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityIdPath"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/29850ab7-56d4-4e1f-a5be-cb86d5513940/03df2929-1440-4ab4-bbf0-9dc776e1ed96"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appName"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ArDrive-CLI"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appVersion"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"2.0"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"arFS"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"0.11"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"contentType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"application/json"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"driveId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"01ea6ba3-9e58-42e7-899d-622fd110211a"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"folder"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"name"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Super sonic public folder"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"VUk1B_vo1va2-EHLtqjsotzy0Rdn6lU4hQo3RD2xoTI"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"unixTime"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1631283259")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"parentFolderId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"29850ab7-56d4-4e1f-a5be-cb86d5513940"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"452c6aec-43dc-4015-9abd-20083068d432"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"path"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/My Public Folder/Super sonic sub folder"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txIdPath"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/09_x0X2eZ3flXXLS72WdTDq6uaa5g2LjsT-QH1m0zhU/VUk1B_vo1va2-EHLtqjsotzy0Rdn6lU4hQo3RD2xoTI"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityIdPath"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/29850ab7-56d4-4e1f-a5be-cb86d5513940/452c6aec-43dc-4015-9abd-20083068d432"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appName"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ArDrive-CLI"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appVersion"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"2.0"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"arFS"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"0.11"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"contentType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"application/json"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"driveId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"01ea6ba3-9e58-42e7-899d-622fd110211a"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"name"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"test-number-twelve.txt"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"429zBqnd7ZBNzgukaix26RYz3g5SeXCCo_oIY6CPZLg"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"unixTime"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1631722234")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"size"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("47")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"lastModifiedDate"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1631722217028")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"dataTxId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"vA-BxAS7I6n90cH4Fzsk4cWS3EOPb1KOhj8yeI88dj0"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"dataContentType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"text/plain"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"parentFolderId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"29850ab7-56d4-4e1f-a5be-cb86d5513940"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"e5948327-d6de-4acf-a6fe-e091ecf78d71"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"path"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/My Public Folder/test-number-twelve.txt"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txIdPath"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/09_x0X2eZ3flXXLS72WdTDq6uaa5g2LjsT-QH1m0zhU/429zBqnd7ZBNzgukaix26RYz3g5SeXCCo_oIY6CPZLg"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityIdPath"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/29850ab7-56d4-4e1f-a5be-cb86d5513940/e5948327-d6de-4acf-a6fe-e091ecf78d71"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appName"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ArDrive-CLI"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appVersion"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"2.0"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"arFS"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"0.11"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"contentType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"application/json"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"driveId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"01ea6ba3-9e58-42e7-899d-622fd110211a"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"name"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"wonderful-test-file.txt"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6CokwlzB81Fx7dq-lB654VM0XQykdU6eYohDmEJ2gk4"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"unixTime"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1631671275")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"size"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("23")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"lastModifiedDate"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1631283389232")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"dataTxId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"UP8THwA_1gvyRqNRqYmTpWvU4-UzNWBN7SiX_AIihg4"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"dataContentType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"text/plain"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"parentFolderId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"29850ab7-56d4-4e1f-a5be-cb86d5513940"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"3274dae9-3487-41eb-94d5-8d5d3d8bc343"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"path"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/My Public Folder/wonderful-test-file.txt"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txIdPath"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/09_x0X2eZ3flXXLS72WdTDq6uaa5g2LjsT-QH1m0zhU/6CokwlzB81Fx7dq-lB654VM0XQykdU6eYohDmEJ2gk4"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityIdPath"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/29850ab7-56d4-4e1f-a5be-cb86d5513940/3274dae9-3487-41eb-94d5-8d5d3d8bc343"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v("\n")])])]),t("p",[a._v("To list further than the immediate children, you can make use of the flags: "),t("code",[a._v("--all")]),a._v(" and "),t("code",[a._v("--max-depth")]),a._v(".")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# List all contents of a public folder")]),a._v("\nardrive list-folder --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--all")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# List the contents of a public folder with custom depth")]),a._v("\nardrive list-folder --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" --max-depth "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("2")]),a._v("\n")])])]),t("p",[a._v("In the case of private entitites, the "),t("code",[a._v("--with-keys")]),a._v(" flag will make the command to include the keys in the output.")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# List all contents of a private folder including the `fileKey` and/or `driveKey` of all listed entitites")]),a._v("\nardrive list-folder --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"1b027047-4cfc-4eee-88a8-9af694f660c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /my/wallet.json --with-keys\n")])])]),t("h2",{attrs:{id:"working-with-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#working-with-files"}},[a._v("#")]),a._v(" Working With Files")]),a._v(" "),t("p",[a._v("Similar to folders, files are linked to a parent folder which ultimately chains the file back to the root folder of its parent drive. As such, a parent folder ID is required in order to upload files. Files can be freely moved to other folders within their original drive.")]),a._v(" "),t("p",[a._v("The important difference for file entities is that they also hold a reference to their data transaction ID, which is the "),t("code",[a._v("dataTxId")]),a._v(" as returned by the "),t("code",[a._v("file-info")]),a._v(" command. This is where your uploaded data lives on the permaweb.")]),a._v(" "),t("p",[t("strong",[a._v("NOTE: The CLI currently (v1.0.0) has progress logging on uploads DISABLED for producing clean JSON outputs that can be piped in the terminal. On larger uploads, remember to be patient. You can check your system's "),t("code",[a._v("node")]),a._v(" process to confirm the process is still uploading.")])]),a._v(" "),t("h3",{attrs:{id:"uploading-a-single-file"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#uploading-a-single-file"}},[a._v("#")]),a._v(" Uploading a Single File")]),a._v(" "),t("p",[a._v("To upload a file, you'll need a parent folder id, the file to upload's file path, and the path to your wallet:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Supply the parent folder ID to upload-file")]),a._v("\nardrive upload-file --local-path /path/to/file.txt --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("p",[a._v("Example output:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"created"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"type"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityName"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file.txt"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6613395a-cf19-4420-846a-f88b7b765c05"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"dataTxId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"l4iNWyBapfAIj7OU-nB8z9XrBhawyqzs5O9qhk-3EnI"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"metadataTxId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"YfdDXUyerPCpBbGTm_gv_x5hR3tu5fnz8bM-jPL__JE"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"bundledIn"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"1zwdfZAIV8E26YjBs2ZQ4xjjP_1ewalvRgD_GyYw7f8"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"sourceUri"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file:///path/to/file.txt"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"type"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"bundle"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"bundleTxId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"1zwdfZAIV8E26YjBs2ZQ4xjjP_1ewalvRgD_GyYw7f8"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"tips"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"1zwdfZAIV8E26YjBs2ZQ4xjjP_1ewalvRgD_GyYw7f8"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"recipient"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"address"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"3mxGJ4xLcQQNv6_TiKx0F0d5XVE0mNvONQI5GZXJXkt"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"winston"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"10000000"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"fees"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"1zwdfZAIV8E26YjBs2ZQ4xjjP_1ewalvRgD_GyYw7f8"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("42819829")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),t("p",[a._v("NOTE: To upload to the root of a drive, specify its root folder ID as the parent folder ID for the upload destination. You can retrieve it like so:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive drive-info "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"c7f87712-b54e-4491-bc96-1c5fa7b1da50"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" jq "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-r")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'.rootFolderId'")]),a._v("\n")])])]),t("h3",{attrs:{id:"ipfs-cid-tagging"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ipfs-cid-tagging"}},[a._v("#")]),a._v(" IPFS CID Tagging")]),a._v(" "),t("p",[a._v("Certain nodes on the Arweave network may be running the "),t("a",{attrs:{href:"https://arweave.medium.com/arweave-ipfs-persistence-for-the-interplanetary-file-system-9f12981c36c3",target:"_blank",rel:"noopener noreferrer"}},[a._v("IPFS+Arweave bridge"),t("OutboundLink")],1),a._v(". Tagging your file upload transaction with its IPFS v1 CID value in the 'IPFS-Add' tag may allow you to take advantage of this system. It can also be helpful for finding data on Arweave via GQL based on its CID. To include the CID tag on your "),t("strong",[a._v("PUBLIC")]),a._v(" file uploads, you may use the '--add-ipfs-tag' flag:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file --add-ipfs-tag --local-path /path/to/file.txt --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("h3",{attrs:{id:"progress-logging-of-transaction-uploads"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#progress-logging-of-transaction-uploads"}},[a._v("#")]),a._v(" Progress Logging of Transaction Uploads")]),a._v(" "),t("p",[a._v("Progress logging of transaction uploads to stderr can be enabled by setting the "),t("code",[a._v("ARDRIVE_PROGRESS_LOG")]),a._v(" environment variable to "),t("code",[a._v("1")]),a._v(":")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("Uploading "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("file")]),a._v(" transaction "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1")]),a._v(" of total "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("2")]),a._v(" transactions"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("..")]),a._v(".\nTransaction _GKQasQX194a364Hph8Oe-oku1AdfHwxWOw9_JC1yjc Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("0")]),a._v("%\nTransaction _GKQasQX194a364Hph8Oe-oku1AdfHwxWOw9_JC1yjc Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("35")]),a._v("%\nTransaction _GKQasQX194a364Hph8Oe-oku1AdfHwxWOw9_JC1yjc Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("66")]),a._v("%\nTransaction _GKQasQX194a364Hph8Oe-oku1AdfHwxWOw9_JC1yjc Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("100")]),a._v("%\nUploading "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("file")]),a._v(" transaction "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("2")]),a._v(" of total "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("2")]),a._v(" transactions"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("..")]),a._v(".\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("0")]),a._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("13")]),a._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("28")]),a._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("42")]),a._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("60")]),a._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("76")]),a._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("91")]),a._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("100")]),a._v("%\n")])])]),t("h3",{attrs:{id:"download-a-single-file-beta"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#download-a-single-file-beta"}},[a._v("#")]),a._v(" Download a Single file (BETA)"),t("a",{attrs:{id:"download-file"}})]),a._v(" "),t("p",[a._v("By using the "),t("code",[a._v("download-file")]),a._v(" command you can download a file on chain to a folder in your local storage specified by --local-path (or to your current working directory if not specified):")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive download-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json --file-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ff450770-a9cb-46a5-9234-89cbd9796610"')]),a._v(" --local-path /my_ardrive_downloads/\n")])])]),t("p",[a._v("Specify a filename in the --local-path if you'd like to use a different name than the one that's used in your drive:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive download-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json --file-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ff450770-a9cb-46a5-9234-89cbd9796610"')]),a._v(" --local-path /my_ardrive_downloads/my_pic.png\n")])])]),t("h3",{attrs:{id:"rename-a-single-file"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rename-a-single-file"}},[a._v("#")]),a._v(" Rename a Single File"),t("a",{attrs:{id:"rename-file"}})]),a._v(" "),t("p",[a._v("To rename an on-chain file you can make use of the "),t("code",[a._v("rename-file")]),a._v(" command. The required parameters are the file ID and the new name, as well as the owner wallet or seed phrase.")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive rename-file --file-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"290a3f9a-37b2-4f0f-a899-6fac983833b3"')]),a._v(" --file-name "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"My custom file name.txt"')]),a._v(" --wallet-file "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"wallet.json"')]),a._v("\n")])])]),t("h3",{attrs:{id:"uploading-a-folder-with-files-bulk-upload"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#uploading-a-folder-with-files-bulk-upload"}},[a._v("#")]),a._v(" Uploading a Folder with Files (Bulk Upload)"),t("a",{attrs:{id:"bulk-upload"}})]),a._v(" "),t("p",[a._v("Users can perform a bulk upload by using the upload-file command on a target folder. The command will reconstruct the folder hierarchy on local disk as ArFS folders on the permaweb and upload each file into their corresponding folders:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file --local-path /path/to/folder --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("h3",{attrs:{id:"downloading-a-folder-with-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#downloading-a-folder-with-files"}},[a._v("#")]),a._v(" Downloading a Folder with Files"),t("a",{attrs:{id:"download-folder"}})]),a._v(" "),t("p",[a._v("You can download a folder from ArDrive to your local machine with the "),t("code",[a._v("download-folder")]),a._v(' command. In the following examples, assume that a folder with ID "47f5bde9-61ba-49c7-b409-1aa4a9e250f6" exists in your drive and is named "MyArDriveFolder".')]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v('# Downloads "MyArDriveFolder" into the current working directory, i.e. ./MyArDriveFolder/')]),a._v("\nardrive download-folder "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"47f5bde9-61ba-49c7-b409-1aa4a9e250f6"')]),a._v("\n")])])]),t("p",[a._v("By specifying the "),t("code",[a._v("--local-path")]),a._v(" option, you can choose the local parent folder into which the on-chain folder will be downloaded. When the parameter is omitted, its value defaults to the current working directory (i.e. "),t("code",[a._v("./")]),a._v(").")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v('# Downloads "MyArDriveFolder" into /my_ardrive_downloads/MyArDriveFolder')]),a._v("\nardrive download-folder "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"47f5bde9-61ba-49c7-b409-1aa4a9e250f6"')]),a._v(" --local-path /my_ardrive_downloads/\n")])])]),t("p",[a._v("The "),t("code",[a._v("--max-depth")]),a._v(" parameter lets you to choose a custom folder depth to download. When omitted, the entire subtree of the folder will be downloaded. In the following example, only the immediate children of the folder will be downloaded:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive download-folder "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"47f5bde9-61ba-49c7-b409-1aa4a9e250f6"')]),a._v(" --max-depth "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("0")]),a._v("\n")])])]),t("p",[a._v("The behaviors of "),t("code",[a._v("--local-path")]),a._v(" are similar to those of "),t("code",[a._v("cp")]),a._v(" and "),t("code",[a._v("mv")]),a._v(" in Unix systems, e.g.:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v('# folder downloaded to "/existing_folder/MyArDriveFolder"')]),a._v("\nardrive download-folder "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"47f5bde9-61ba-49c7-b409-1aa4a9e250f6"')]),a._v(" --local-path "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/existing_folder"')]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v('# folder downloaded to "/existing_folder/MyArDriveFolder/MyArDriveFolder" as "/existing_folder/MyArDriveFolder" already exists')]),a._v("\nardrive download-folder "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"47f5bde9-61ba-49c7-b409-1aa4a9e250f6"')]),a._v(" --local-path "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/existing_folder/MyArDriveFolder"')]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v('# folder downloaded to "/existing_folder/non_existent_folder"')]),a._v("\nardrive download-folder "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"47f5bde9-61ba-49c7-b409-1aa4a9e250f6"')]),a._v(" --local-path "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/existing_folder/non_existent_folder"')]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# ERROR!")]),a._v("\nardrive download-folder "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"47f5bde9-61ba-49c7-b409-1aa4a9e250f6"')]),a._v(" --local-path "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/non_existent_folder_1/non_existent_folder_2"')]),a._v("\n")])])]),t("h3",{attrs:{id:"downloading-a-drive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#downloading-a-drive"}},[a._v("#")]),a._v(" Downloading a Drive"),t("a",{attrs:{id:"download-drive"}})]),a._v(" "),t("p",[a._v("To download the whole drive you can use the "),t("code",[a._v("download-drive")]),a._v(" command.")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive download-drive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"c0c8ba1c-efc5-420d-a07c-a755dc67f6b2"')]),a._v("\n")])])]),t("p",[a._v("This is equivalent to running the "),t("code",[a._v("download-folder")]),a._v(" command against the root folder of the drive.")]),a._v(" "),t("h3",{attrs:{id:"uploading-multiple-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#uploading-multiple-files"}},[a._v("#")]),a._v(" Uploading Multiple Files"),t("a",{attrs:{id:"multi-file-upload"}})]),a._v(" "),t("p",[a._v("To upload an arbitrary number of files or folders, pass a space-separated list of paths to "),t("code",[a._v("--local-paths")]),a._v(":")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Specifying a mixed set of file and folder paths")]),a._v("\nardrive upload-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" wallet.json "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-F")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6939b9e0-cc98-42cb-bae0-5888eca78885"')]),a._v(" --local-paths ./image.png ~/backups/ "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("..")]),a._v("/another_file.txt\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Example using glob expansion to upload all .json files in the current folder")]),a._v("\nardrive upload-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" wallet.json "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-F")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6939b9e0-cc98-42cb-bae0-5888eca78885"')]),a._v(" --local-paths ./*.json\n")])])]),t("h3",{attrs:{id:"name-conflict-resolution-on-upload"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#name-conflict-resolution-on-upload"}},[a._v("#")]),a._v(" Name Conflict Resolution on Upload"),t("a",{attrs:{id:"conflict-resolution"}})]),a._v(" "),t("p",[a._v("By default, the "),t("code",[a._v("upload-file")]),a._v(" command will use the upsert behavior if existing entities are encountered in the destination folder tree that would cause naming conflicts.")]),a._v(" "),t("p",[a._v("Expect the behaviors from the following table for each of these resolution settings:")]),a._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("table",{staticClass:"inline-table"},[t("tr",[t("th",[a._v("Source Type")]),a._v(" "),t("th",[a._v("Conflict at Dest")]),a._v(" "),t("th",[a._v("`skip`")]),a._v(" "),t("th",[a._v("`replace`")]),a._v(" "),t("th",[a._v("`upsert` (default)")])]),a._v(" "),t("tr",[t("td",[a._v("File")]),a._v(" "),t("td",[a._v("None")]),a._v(" "),t("td",[a._v("Insert")]),a._v(" "),t("td",[a._v("Insert")]),a._v(" "),t("td",[a._v("Insert")])]),a._v(" "),t("tr",[t("td",[a._v("File")]),a._v(" "),t("td",[a._v("Matching File")]),a._v(" "),t("td",[a._v("Skip")]),a._v(" "),t("td",[a._v("Update")]),a._v(" "),t("td",[a._v("Skip")])]),a._v(" "),t("tr",[t("td",[a._v("File")]),a._v(" "),t("td",[a._v("Different File")]),a._v(" "),t("td",[a._v("Skip")]),a._v(" "),t("td",[a._v("Update")]),a._v(" "),t("td",[a._v("Update")])]),a._v(" "),t("tr",[t("td",[a._v("File")]),a._v(" "),t("td",[a._v("Folder")]),a._v(" "),t("td",[a._v("Skip")]),a._v(" "),t("td",[a._v("Fail")]),a._v(" "),t("td",[a._v("Fail")])]),a._v(" "),t("tr",[t("td",[a._v("Folder")]),a._v(" "),t("td",[a._v("None")]),a._v(" "),t("td",[a._v("Insert")]),a._v(" "),t("td",[a._v("Insert")]),a._v(" "),t("td",[a._v("Insert")])]),a._v(" "),t("tr",[t("td",[a._v("Folder")]),a._v(" "),t("td",[a._v("File")]),a._v(" "),t("td",[a._v("Skip")]),a._v(" "),t("td",[a._v("Fail")]),a._v(" "),t("td",[a._v("Fail")])]),a._v(" "),t("tr",[t("td",[a._v("Folder")]),a._v(" "),t("td",[a._v("Folder")]),a._v(" "),t("td",[a._v("Re-use")]),a._v(" "),t("td",[a._v("Re-use")]),a._v(" "),t("td",[a._v("Re-use")])])])]),a._v(" "),t("p",[a._v("The default upsert behavior will check the destination folder for a file with a conflicting name. If no conflicts are found, it will insert (upload) the file.")]),a._v(" "),t("p",[a._v("In the case that there is a FILE to FILE name conflict found, it will only update it if necessary. To determine if an update is necessary, upsert will compare the last modified dates of conflicting file and the file being uploaded. When they are matching, the upload will be skipped. Otherwise the file will be updated as a new revision.")]),a._v(" "),t("p",[a._v("To override the upsert behavior, use the "),t("code",[a._v("--replace")]),a._v(" option to always make new revisions of a file or the "),t("code",[a._v("--skip")]),a._v(" option to always skip the upload on name conflicts:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--replace")]),a._v(" --local-path /path/to/file.txt --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--skip")]),a._v(" --local-path /path/to/file.txt --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("p",[a._v("Alternatively, the upload-file commands now also supports the "),t("code",[a._v("--ask")]),a._v(" conflict resolution option. This setting will always provide an interactive prompt on name conflicts that allows users to decide how to resolve each conflict found:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--ask")]),a._v(" --local-file-path /path/to/file.txt --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n\nDestination folder has a "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("file")]),a._v(" to "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("file")]),a._v(" name conflict"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("!")]),a._v("\n\nFile name: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("2")]),a._v(".png\nFile ID: efbc0370-b69f-44d9-812c-0d272b019027\nThis "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("file")]),a._v(" has a DIFFERENT last modified "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("date")]),a._v("\n\nPlease "),t("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("select")]),a._v(" how to proceed:\n › - Use arrow-keys. Return to submit.\n❯ Replace as new "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("file")]),a._v(" revision\n Upload with a different "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("file")]),a._v(" name\n Skip this "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("file")]),a._v(" upload\n")])])]),t("h3",{attrs:{id:"understanding-bundled-transactions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#understanding-bundled-transactions"}},[a._v("#")]),a._v(" Understanding Bundled Transactions"),t("a",{attrs:{id:"bundles"}})]),a._v(" "),t("p",[a._v("The ArDrive CLI currently uses two different methods for uploading transactions to the Arweave network: standard transactions and Direct to Network (D2N) bundled transactions. By default, the CLI will send a D2N bundled transaction for any action that would result in multiple transactions. This bundling functionality is currently used on the "),t("code",[a._v("upload-file")]),a._v(" and "),t("code",[a._v("create-drive")]),a._v(" commands.")]),a._v(" "),t("p",[a._v("D2N bundled transactions come with several benefits and implications:")]),a._v(" "),t("ul",[t("li",[a._v("Bundling saves AR and enhances ArFS reliability by sending associated ArFS transactions up as one atomic bundle.")]),a._v(" "),t("li",[a._v('Bundled transactions are treated as a single data transaction by the Arweave network, but can be presented as separate transactions by the Arweave Gateway once they have been "unbundled".')]),a._v(" "),t("li",[a._v("Un-bundling can take anywhere from a few minutes up to an hour. During that time, the files in the bundle will neither appear in list- commands nor be downloadable. Similarly, they will not appear in the web app after syncs until un-bundling is complete. "),t("strong",[a._v("This can negatively affect the accuracy of upsert operations")]),a._v(", so it's best to wait before retrying bulk uploads.")]),a._v(" "),t("li",[a._v("Bundling reliability on the gateway side degrades once bundles reach either 500 data items (or ~250 files) or 500 MiB, so the CLI will create and upload multiple bundles as necessary, or will send files that are simply too large for reliable bundling as unbundled txs.")])]),a._v(" "),t("h3",{attrs:{id:"uploading-a-non-bundled-transaction-not-recommended"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#uploading-a-non-bundled-transaction-not-recommended"}},[a._v("#")]),a._v(" Uploading a Non-Bundled Transaction (NOT RECOMMENDED)"),t("a",{attrs:{id:"no-bundle"}})]),a._v(" "),t("p",[a._v("While not recommended, the CLI does provide the option to forcibly send all transactions as standard transactions rather than attempting to bundle them together. To do this, simply add the "),t("code",[a._v("--no-bundle")]),a._v(" flag to the "),t("code",[a._v("upload-file")]),a._v(" or "),t("code",[a._v("create-drive")]),a._v(" command:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file --no-bundle --local-path /path/to/file --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("h3",{attrs:{id:"fetching-the-metadata-of-a-file-entity"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#fetching-the-metadata-of-a-file-entity"}},[a._v("#")]),a._v(" Fetching the Metadata of a File Entity")]),a._v(" "),t("p",[a._v("Simply perform the file-info command to retrieve the metadata of a file:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive file-info --file-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"e5ebc14c-5b2d-4462-8f59-7f4a62e7770f"')]),a._v("\n")])])]),t("p",[a._v("Example output:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appName"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ArDrive-Web"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appVersion"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"0.1.0"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"arFS"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"0.11"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"contentType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"application/json"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"driveId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"51062487-2e8b-4af7-bd81-4345dc28ea5d"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"name"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"2_depth.png"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"CZKdjqwnmxbWchGA1hjSO5ZH--4OYodIGWzI-FmX28U"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"unixTime"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1633625081")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"size"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("41946")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"lastModifiedDate"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1605157729000")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"parentFolderId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"a2c8a0cb-0ca7-4dbb-8bf8-93f75f308e63"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"e5ebc14c-5b2d-4462-8f59-7f4a62e7770f"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"fileId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"e5ebc14c-5b2d-4462-8f59-7f4a62e7770f"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"dataTxId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Jz0WsWyAGVc0aE3UzACo-YJqG8OPrN3UucmDdt8Fbjc"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"dataContentType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"image/png"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),t("h3",{attrs:{id:"retrying-a-failed-file-data-transaction-public-unbundled-files-only"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#retrying-a-failed-file-data-transaction-public-unbundled-files-only"}},[a._v("#")]),a._v(" Retrying a Failed File Data Transaction (Public Unbundled Files Only)"),t("a",{attrs:{id:"retry-tx"}})]),a._v(" "),t("p",[a._v("Arweave data upload transactions are split into two phases: transaction posting and chunks uploading. Once the transaction post phase has been completed, you've effectively \"paid\" the network for storage of the data chunks that you'll send in the next stage.")]),a._v(" "),t("p",[a._v("If your system encounters an error while posting the transaction, you can retry posting the transaction for as long as your tx_anchor is valid ("),t("a",{attrs:{href:"https://docs.arweave.org/developers/server/http-api#field-definitions",target:"_blank",rel:"noopener noreferrer"}},[a._v("learn more about tx_anchors here"),t("OutboundLink")],1),a._v("). You may retry and/or resume posting chunks at any time after your transaction has posted. The ArDrive CLI allows you to take advantage of this Arweave protocol capability.")]),a._v(" "),t("p",[a._v("Using the CLI, when the transaction post has succeeded but the chunk upload step fails, the data transaction's ID could be lost. There are a few options to recover this ID. If the failed transaction is the most recent one sent from a wallet, the transaction ID can be recovered with the "),t("code",[a._v("ardrive last-tx -w /path/to/wallet")]),a._v(" command AFTER the transaction's headers have been mined (It can take 5-10 minutes for the tx-id to become available with the last-tx approach). Other options for finding the partially uploaded transaction's ID include:")]),a._v(" "),t("ul",[t("li",[a._v("Using an Arweave gateway GQL http endpoint to search for transactions that belong to the wallet. See this "),t("a",{attrs:{href:"https://gql-guide.vercel.app/#owners",target:"_blank",rel:"noopener noreferrer"}},[a._v("Arweave GQL Guide"),t("OutboundLink")],1),a._v(" for more info.")]),a._v(" "),t("li",[a._v("Browse the recent transactions associated with the wallet via a block explorer tool like "),t("a",{attrs:{href:"https://viewblock.io/arweave/",target:"_blank",rel:"noopener noreferrer"}},[a._v("ViewBlock"),t("OutboundLink")],1),a._v(".")])]),a._v(" "),t("p",[a._v("In order to re-seed the chunks for an unbundled ArFS data transaction, a user must have the data transaction ID, the original file data, and either a destination folder ID or a valid file ID for the file. Supply that information to the "),t("code",[a._v("retry-tx")]),a._v(" command like so:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive retry-tx --tx-id "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v(" Data Transaction ID "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(" --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v(" Destination Folder ID "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(" --local-path /path/to/file --wallet-file /path/to/wallet\n")])])]),t("p",[t("strong",[a._v("Note: Retry feature is currently only available for PUBLIC unbundled file transactions. It is also perfectly safe to mistakenly re-seed the chunks of a healthy transaction, the transaction will remain stable and the wallet balance will not be affected.")])]),a._v(" "),t("h3",{attrs:{id:"moving-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#moving-files"}},[a._v("#")]),a._v(" Moving Files"),t("a",{attrs:{id:"moving-files"}})]),a._v(" "),t("p",[a._v("Files can be moved from one folder to another within the same drive. Moving a file is simply the process of uploading a new file metadata revision with an updated File ID <> Parent Folder ID relationship. The following command will move a file from its current location in a public drive to a new parent folder in that drive:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive move-file --file-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"e5ebc14c-5b2d-4462-8f59-7f4a62e7770f"')]),a._v(" --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"a2c8a0cb-0ca7-4dbb-8bf8-93f75f308e63"')]),a._v("\n")])])]),t("h3",{attrs:{id:"uploading-manifests"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#uploading-manifests"}},[a._v("#")]),a._v(" Uploading Manifests")]),a._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/ArweaveTeam/arweave/wiki/Path-Manifests",target:"_blank",rel:"noopener noreferrer"}},[a._v("Arweave Path Manifests"),t("OutboundLink")],1),a._v(" are are special "),t("code",[a._v(".json")]),a._v(" files that instruct Arweave Gateways to map file data associated with specific, unique transaction IDs to customized, hosted paths relative to that of the manifest file itself. So if, for example, your manifest file had an arweave.net URL like:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("https://arweave.net/"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("manifest tx id"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),t("p",[a._v("Then, all the mapped transactions and paths in the manifest file would be addressable at URLs like:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("https://arweave.net/"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("manifest tx id"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("/foo.txt\nhttps://arweave.net/"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("manifest tx id"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("/bar/baz.png\n")])])]),t("p",[a._v("ArDrive supports the creation of these Arweave manifests using any of your PUBLIC folders. The generated manifest paths will be links to each of the file entities within the specified folder. The manifest file entity will be created at the root of the folder.")]),a._v(" "),t("p",[a._v("To create a manifest of an entire public drive, specify the root folder of that drive:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive create-manifest "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"bc9af866-6421-40f1-ac89-202bddb5c487"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/path/to/wallet"')]),a._v("\n")])])]),t("p",[a._v("You can also create a manifest of a folder's file entities at a custom depth by using the "),t("code",[a._v("--max-depth")]),a._v(" option:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Create manifest of a folder's local file contents, excluding all sub-folders")]),a._v("\nardrive create-manifest --max-depth "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("0")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"867228d8-4413-4c0e-a499-e1decbf2ea38"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/path/to/wallet"')]),a._v("\n")])])]),t("p",[a._v("Creating a "),t("code",[a._v(".json")]),a._v(" file of your manifest links output can be accomplished here with some "),t("code",[a._v("jq")]),a._v(" parsing and piping to a file:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive create-manifest "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6c312b3e-4778-4a18-8243-f2b346f5e7cb"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" jq "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'{links}'")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" links.json\n")])])]),t("p",[a._v("If you'd like to preview the contents of your manifest before uploading, you can perform a dry run and do some lightweight post processing to isolate the data:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive create-manifest "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6c312b3e-4778-4a18-8243-f2b346f5e7cb"')]),a._v(" --dry-run "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" jq "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'{manifest}.manifest'")]),a._v("\n")])])]),t("p",[t("a",{attrs:{id:"manifest-json"}})]),a._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"manifest"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"arweave/paths"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"version"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"0.1.0"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"index"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"path"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"index.html"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"paths"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"hello_world.txt"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"id"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Y7GFF8r9y0MEU_oi1aZeD87vrmai97JdRQ2L0cbGJ68"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"index.html"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"id"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"pELonjVebHyBsdxVymvxbGTmHD96v9PuuUXj8GUHGoY"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),t("p",[a._v("The manifest data transaction is tagged with a unique content-type, "),t("code",[a._v("application/x.arweave-manifest+json")]),a._v(", which tells the gateway to treat this file as a manifest. The manifest file itself is a "),t("code",[a._v(".json")]),a._v(" file that holds the paths (the data transaction ids) to each file within the specified folder.")]),a._v(" "),t("p",[a._v("When your folder is later changed by adding files or updating them with new revisions, the original manifest will NOT be updated on its own. A manifest is a permanent record of your files in their current state.")]),a._v(" "),t("p",[a._v("However, creating a subsequent manifest with the same manifest name will create a new revision of that manifest in its new current state. Manifests follow the same name conflict resolution as outlined for files above (upsert by default).")]),a._v(" "),t("h4",{attrs:{id:"hosting-a-webpage-with-manifest"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hosting-a-webpage-with-manifest"}},[a._v("#")]),a._v(" Hosting a Webpage with Manifest")]),a._v(" "),t("p",[a._v("When creating a manifest, it is possible to host a webpage or web app. You can do this by creating a manifest on a folder that has an "),t("code",[a._v("index.html")]),a._v(" file in its root.")]),a._v(" "),t("p",[a._v("Using generated build folders from popular frameworks works as well. One requirement here to note is that the "),t("code",[a._v("href=")]),a._v(" paths from your generated "),t("code",[a._v("index.html")]),a._v(" file must not have leading a "),t("code",[a._v("/")]),a._v(". This means that the manifest will not resolve a path of "),t("code",[a._v("/dist/index.js")]),a._v(" but it will resolve "),t("code",[a._v("dist/index.js")]),a._v(" or "),t("code",[a._v("./dist/index.js")]),a._v(".")]),a._v(" "),t("p",[a._v("As an example, here is a flow of creating a React app and hosting it with an ArDrive Manifest. First, generate a React app:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[a._v("yarn")]),a._v(" create react-app my-app\n")])])]),t("p",[a._v("Next, add this field to the generated "),t("code",[a._v("package.json")]),a._v(" so that the paths will resolve correctly:")]),a._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"homepage"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"."')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n")])])]),t("p",[a._v("Then, create an optimized production build from within the app's directory:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[a._v("yarn")]),a._v(" build\n")])])]),t("p",[a._v("Now, we can create and upload that produced build folder on ArDrive to any of your existing ArFS folder entities:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-l")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/build"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/path/to/wallet"')]),a._v(" --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"bc9af866-6421-40f1-ac89-202bddb5c487"')]),a._v("\n")])])]),t("p",[a._v("And finally, create the manifest using the generated Folder ID from the build folder creation:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Create manifest using the Folder ID of the `/build` folder")]),a._v("\nardrive create-manifest "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"41759f05-614d-45ad-846b-63f3767504a4"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/path/to/wallet"')]),a._v("\n")])])]),t("p",[a._v("In the return output, the top link will be a link to the deployed web app:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"links"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://arweave.net/0MK68J8TqGhaaOpPe713Zn0jdpczMt2NGS2CtRYiuAg"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://arweave.net/0MK68J8TqGhaaOpPe713Zn0jdpczMt2NGS2CtRYiuAg/asset-manifest.json"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://arweave.net/0MK68J8TqGhaaOpPe713Zn0jdpczMt2NGS2CtRYiuAg/favicon.ico"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://arweave.net/0MK68J8TqGhaaOpPe713Zn0jdpczMt2NGS2CtRYiuAg/index.html"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# ...")]),a._v("\n")])])]),t("p",[a._v("This is effectively hosting a web app with ArDrive. Check out the ArDrive Price Calculator React App hosted as an "),t("a",{attrs:{href:"https://arweave.net/qozq9YIUPEHfZhoTp9DkBpJuA_KNULBnfLiMroj5pZI",target:"_blank",rel:"noopener noreferrer"}},[a._v("ArDrive Manifest"),t("OutboundLink")],1),a._v(".")]),a._v(" "),t("h3",{attrs:{id:"uploading-with-a-custom-content-type"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#uploading-with-a-custom-content-type"}},[a._v("#")]),a._v(" Uploading With a Custom Content Type"),t("a",{attrs:{id:"custom-content-type"}})]),a._v(" "),t("p",[a._v("Each file uploaded to the Arweave network receives a "),t("code",[a._v('"Content-Type"')]),a._v(" GraphQL tag that contains the MIME type for the file. The gateway will use this content type to determine how to serve that file's data transaction at the "),t("code",[a._v("arweave.net/{data tx id}")]),a._v(" endpoint.")]),a._v(" "),t("p",[a._v("By default, the CLI will attempt to derive this content type from the file extension of the provided file. In most cases, the content type that is derived will be correct and the gateway will properly serve the file.")]),a._v(" "),t("p",[a._v("The CLI also provides the option for users to upload files with a custom content type using the "),t("code",[a._v("--content-type")]),a._v(" flag:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file --content-type "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"application/json"')]),a._v(" --local-path /path/to/file --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("p",[a._v("It is currently possible to set this value to any given string, but the gateway will still only serve valid content types. Check out this list of commonly used MIME types to ensure you're providing a valid content type: "),t("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types",target:"_blank",rel:"noopener noreferrer"}},[a._v("Common MIME types"),t("OutboundLink")],1),a._v(".")]),a._v(" "),t("p",[a._v("Note: In the case of multi-file uploads or recursive folder uploads, setting this "),t("code",[a._v("--content-type")]),a._v(" flag will set the provided custom content type on EVERY file entity within a given upload.")]),a._v(" "),t("h3",{attrs:{id:"uploading-from-a-remote-url"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#uploading-from-a-remote-url"}},[a._v("#")]),a._v(" Uploading From a Remote URL"),t("a",{attrs:{id:"remote-path"}})]),a._v(" "),t("p",[a._v("You can upload a file from an existing url using the "),t("code",[a._v("--remote-path")]),a._v(" flag. This must be used in conjunction with "),t("code",[a._v("--dest-file-name")]),a._v(".")]),a._v(" "),t("p",[a._v("You can use a custom content type using the "),t("code",[a._v("--content-type")]),a._v(" flag, but if this isn't used the app will use the content type from the response header of the request for the remote data.")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file --remote-path "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://url/to/file"')]),a._v(" --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"example.jpg"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("h3",{attrs:{id:"uploading-a-custom-manifest"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#uploading-a-custom-manifest"}},[a._v("#")]),a._v(" Uploading a Custom Manifest"),t("a",{attrs:{id:"custom-manifest"}})]),a._v(" "),t("p",[a._v("Using the custom content type feature, it is possible for users to upload their own custom manifests. The Arweave gateways use this special content type in order to identify an uploaded file as a manifest:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("application/x.arweave-manifest+json\n")])])]),t("p",[a._v("In addition to this content type, the manifest must also adhere to the "),t("a",{attrs:{href:"#manifest-json"}},[a._v("correct JSON structure")]),a._v(" of an Arweave manifest. A user can create their own manifest from scratch, or start by piping a generated manifest to a JSON file and editing it to their specifications:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive create-manifest "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6c312b3e-4778-4a18-8243-f2b346f5e7cb"')]),a._v(" --dry-run "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" jq "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'{manifest}.manifest'")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" my-custom-manifest.json\n")])])]),t("p",[a._v("After editing the generated manifest, simply perform an "),t("code",[a._v("upload-file")]),a._v(" command with the custom Arweave manifest content type to any PUBLIC folder:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file --content-type "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"application/x.arweave-manifest+json"')]),a._v(" --local-path my-custom-manifest.json --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("p",[a._v("The returned "),t("code",[a._v("dataTxId")]),a._v(" field on the created "),t("code",[a._v("file")]),a._v(" entity will be the endpoint that the manifest can be found on Arweave, just as explained in the "),t("a",{attrs:{href:"#uploading-manifests"}},[a._v("manifest sections")]),a._v(" above:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("https://arweave.net/"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("dataTxId"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\nhttps://arweave.net/"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("dataTxId"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("/custom-file-1\nhttps://arweave.net/"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("dataTxId"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("/custom-file-2\n")])])]),t("h3",{attrs:{id:"uploading-files-with-custom-metadata"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#uploading-files-with-custom-metadata"}},[a._v("#")]),a._v(" Uploading Files with Custom MetaData")]),a._v(" "),t("p",[a._v("ArDrive CLI has the capability of attaching custom metadata to ArFS File and Folder MetaData Transactions during the "),t("code",[a._v("upload-file")]),a._v(" command. This metadata can be applied to either the GQL tags on the MetaData Transaction and/or into the MetaData Transaction's Data JSON.")]),a._v(" "),t("p",[a._v("All custom metadata applied must ultimately adhere to the following JSON shapes:")]),a._v(" "),t("div",{staticClass:"language-ts extra-class"},[t("pre",{pre:!0,attrs:{class:"language-ts"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("// GQL Tags")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("type")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token class-name"}},[a._v("CustomMetaDataGqlTags")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v(" Record"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),t("span",{pre:!0,attrs:{class:"token builtin"}},[a._v("string")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token builtin"}},[a._v("string")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token builtin"}},[a._v("string")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(";")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("// Data JSON Fields")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("type")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token class-name"}},[a._v("CustomMetaDataJsonFields")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v(" Record"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),t("span",{pre:!0,attrs:{class:"token builtin"}},[a._v("string")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v(" JsonSerializable"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(";")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("export")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("type")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token class-name"}},[a._v("JsonSerializable")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token builtin"}},[a._v("string")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token builtin"}},[a._v("number")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token builtin"}},[a._v("boolean")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("null")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),a._v("member"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token builtin"}},[a._v("string")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" JsonSerializable "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" JsonSerializable"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(";")]),a._v("\n")])])]),t("p",[a._v("e.g:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v(" IPFS-Add: "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'MY_HASH'")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# or")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'Custom Name'")]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'Val 1'")]),a._v(", "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'Val 2'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),t("p",[a._v("When the custom metadata is attached to the MetaData Transaction's GQL tags, they will become visible on any Arweave GQL gateway and also third party tools that read GQL data.")]),a._v(" "),t("p",[a._v("When these tags are added to the MetaData Transaction's Data JSON they can be read by downloading the JSON data directly from "),t("code",[a._v("https://arweave.net/METADATA_TX_ID")]),a._v(".")]),a._v(" "),t("p",[a._v("To add this custom metadata to your file metadata transactions, CLI users can pass custom metadata these parameters:")]),a._v(" "),t("ul",[t("li",[t("code",[a._v("--metadata-file path/to/json/schema")])]),a._v(" "),t("li",[t("code",[a._v('--metadata-json \'{"key": "val", "key-2": true, "key-3": 420, "key-4": ["more", 1337]}\'')])]),a._v(" "),t("li",[t("code",[a._v('--metadata-gql-tags "Tag-Name" "Tag Val"')])])]),a._v(" "),t("p",[a._v("The "),t("code",[a._v("--metadata-file")]),a._v(" will accept a file path to JSON file containing custom metadata:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file --metadata-file path/to/metadata/json "),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# ...")]),a._v("\n")])])]),t("p",[a._v("This JSON schema object must contain instructions on where to put this metadata with the "),t("code",[a._v("metaDataJson")]),a._v(" and "),t("code",[a._v("metaDataGqlTags")]),a._v(" keys. e.g:")]),a._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"metaDataJson"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"Tag-Name"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Value-1"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Value-2"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"metaDataGqlTags"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"GQL Tag Name"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Tag Value"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),t("p",[a._v("The "),t("code",[a._v("--metadata-gql-tags")]),a._v(" parameter accepts an array of string values to be applied to the MetaData Tx GQL Tags. This method of CLI input does not support multiple tag values for a given tag name and the input must be an EVEN number of string values. (Known bug: String values starting with the "),t("code",[a._v('"-"')]),a._v(" character are currently not supported. Use --metadata-file parameter instead.) e.g:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("upload-file --metadata-gql-tags "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Custom Tag Name"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Custom Value"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# ...")]),a._v("\n")])])]),t("p",[a._v("And the "),t("code",[a._v("--metadata-json")]),a._v(" parameter will accept a stringified JSON input. It will apply all declared JSON fields directly to the MetaData Tx's Data JSON. e.g:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v(" upload-file --metadata-json "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('\' { "json field": "value", "another fields": false } \'')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# ...")]),a._v("\n")])])]),t("p",[a._v("Custom metadata applied to files and/or folders during the "),t("code",[a._v("upload-file")]),a._v(" command will be read back through all existing read commands. e.g:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive file-info "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" 067c4008-9cbe-422e-b697-05442f73da2b\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appName"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ArDrive-CLI"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appVersion"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"1.17.0"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"arFS"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"0.11"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"contentType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"application/json"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"driveId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"967215ca-a489-494b-97ec-0dd428d7be34"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"name"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"unique-name-9718"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"sxg8bNu6_bbaHkJTxAINVVoz_F-LiFe6s7OnxzoJJk4"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"unixTime"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1657655070")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"size"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("262148")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"lastModifiedDate"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1655409872705")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"dataTxId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ublZcIff77ejl3m0uEA8lXEfnTWmSBOFoz-HibqKeyk"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"dataContentType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"text/plain"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"parentFolderId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"97bc4fb5-aca4-4ffe-938f-1285153d98ca"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"067c4008-9cbe-422e-b697-05442f73da2b"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"fileId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"067c4008-9cbe-422e-b697-05442f73da2b"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"IPFS-Add"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"MY_HASH"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Tag-1"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Val"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Tag-2"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Val"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Tag-3"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Val"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Boost"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"1.05"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),t("h4",{attrs:{id:"applying-unique-custom-metadata-during-bulk-workflows"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#applying-unique-custom-metadata-during-bulk-workflows"}},[a._v("#")]),a._v(" Applying Unique Custom MetaData During Bulk Workflows")]),a._v(" "),t("p",[a._v("With some custom scripting and the "),t("code",[a._v("--metadata-file")]),a._v(" parameter, the ArDrive CLI can be used to apply custom metadata to each file individually in a bulk workflow. For example, if you choose a numbered file naming pattern you can make use of a "),t("code",[a._v("for")]),a._v(" loop:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("for")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token for-or-select variable"}},[a._v("i")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("in")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("..")]),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("5")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("do")]),a._v("\nardrive upload-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-F")]),a._v(" f0c58c11-430c-4383-8e54-4d864cc7e927 --local-path "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"../uploads/test-file-'),t("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$i")]),a._v('.txt"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/path/to/wallet.json"')]),a._v(" --metadata-file "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"../custom/metadata-'),t("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$i")]),a._v('.json"')]),a._v(" --dry-run "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file-result-'),t("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$i")]),a._v('.json"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("done")]),a._v("\n")])])]),t("h2",{attrs:{id:"other-utility-operations"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#other-utility-operations"}},[a._v("#")]),a._v(" Other Utility Operations")]),a._v(" "),t("h3",{attrs:{id:"monitoring-transactions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#monitoring-transactions"}},[a._v("#")]),a._v(" Monitoring Transactions")]),a._v(" "),t("p",[a._v("Block time on Arweave is typically between 2-3 minutes in duration, so transactions can be mined within that time frame when "),t("a",{attrs:{href:"#dealing-with-network-congestion"}},[a._v("network congestion")]),a._v(" is low. Transactions, in the general case, proceed through the following set of states:")]),a._v(" "),t("ul",[t("li",[a._v('Pending: the transaction is waiting the "mempool" to be mined')]),a._v(" "),t("li",[a._v("Confirming: the transaction was mined on an Arweave Node, but has not yet been confirmed by at least 15 total nodes on the network")]),a._v(" "),t("li",[a._v("Confirmed: the transaction was mined on an Arweave Node and confirmed by at least 15 total nodes on the network")]),a._v(" "),t("li",[a._v("Not Found: the transaction is not available for any of the following reasons:\n"),t("ul",[t("li",[a._v("Insufficient reward to join the mempool")]),a._v(" "),t("li",[a._v("Insufficient reward to be mined within 50 blocks during a period of network congestion")]),a._v(" "),t("li",[a._v("Transaction is transitioning between states")]),a._v(" "),t("li",[a._v("Transaction ID is invalid")])])])]),a._v(" "),t("p",[a._v("Monitor any Arweave transaction's status via its transaction ID by performing:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Peek at the status:")]),a._v("\nardrive tx-status "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-t")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ekSMckikdRJ8RGIkFa-X3xq3427tvM7J9adv8HP3Bzs"')]),a._v("\n")])])]),t("p",[a._v("Example output:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ekSMckikdRJ8RGIkFa-X3xq3427tvM7J9adv8HP3Bzs: Mined at block height "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("775810")]),a._v(" with "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("22439")]),a._v(" confirmations\n")])])]),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Reprint the status every 10 seconds:")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("watch")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-n")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("10")]),a._v(" ardrive tx-status "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-t")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ekSMckikdRJ8RGIkFa-X3xq3427tvM7J9adv8HP3Bzs"')]),a._v("\n")])])]),t("h3",{attrs:{id:"dealing-with-network-congestion"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dealing-with-network-congestion"}},[a._v("#")]),a._v(" Dealing With Network Congestion")]),a._v(" "),t("p",[a._v("Currently, Arweave blocks hold up to 1000 transactions per block. The \"mempool\", where pending transactions reside until they've been included into a block, will only hold a transaction for 50 blocks (~100-150 minutes) before it's discarded by the network resulting in no fees or data being transacted. During periods of network congestion (i.e. those where the mempool contains 1000 or more pending transactions), it may make sense to either:")]),a._v(" "),t("p",[a._v("a) wait for congestion to dissipate before attempting your transactions.")]),a._v(" "),t("p",[a._v("b) apply the fee boost multiplier to your transactions rewards with the --boost parameter during write operations in order to front-run some of the congestion.")]),a._v(" "),t("h4",{attrs:{id:"check-for-network-congestion-before-uploading"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#check-for-network-congestion-before-uploading"}},[a._v("#")]),a._v(" Check for network congestion before uploading"),t("a",{attrs:{id:"check-congestion"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# See all the transactions in the mempool")]),a._v("\nardrive get-mempool\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Return the count of the transactions in the mempool")]),a._v("\nardrive get-mempool "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" jq "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'length'")]),a._v("\n")])])]),t("h4",{attrs:{id:"front-run-congestion-by-boosting-miner-rewards"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#front-run-congestion-by-boosting-miner-rewards"}},[a._v("#")]),a._v(" Front-run Congestion By Boosting Miner Rewards"),t("a",{attrs:{id:"boost"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Increase the miner reward on your transactions by 50%")]),a._v("\nardrive upload-file --wallet-file /path/to/my/wallet.json --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"f0c58c11-430c-4383-8e54-4d864cc7e927"')]),a._v(" --local-path ./helloworld.txt "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--boost")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1.5")]),a._v("\n")])])]),t("h4",{attrs:{id:"send-ar-transactions-from-a-cold-wallet"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-ar-transactions-from-a-cold-wallet"}},[a._v("#")]),a._v(" Send AR Transactions From a Cold Wallet"),t("a",{attrs:{id:"cold-tx"}})]),a._v(" "),t("p",[a._v("The best cold wallet storage never exposes your seed phrase and/or private keys to the Internet or a compromised system interface. You can use the ArDrive CLI to facilitate cold storage and transfer of AR.")]),a._v(" "),t("p",[a._v("If you need a new cold AR wallet, generate one from an air-gapped machine capable of running the ArDrive CLI by following the instructions in the "),t("a",{attrs:{href:"#wallet-operations"}},[a._v("Wallet Operations")]),a._v(" section. Fund your cold wallet from whatever external sources you'd like. NOTE: Your cold wallet won't appear on chain until it has received AR.")]),a._v(" "),t("p",[a._v("The workflow to send the AR out from your cold wallet requires you to generate a signed transaction with your cold wallet on your air-gapped machine via the ArDrive CLI, and then to transfer the signed transaction (e.g. by a file on a clean thumb drive) to an Internet-connected machine and send the transaction to the network via the ArDrive CLI. You'll need two inputs from the Internet-connected machine:")]),a._v(" "),t("ul",[t("li",[a._v("the last transaction sent OUT from the cold wallet (or an empty string if none has ever been sent out)")]),a._v(" "),t("li",[a._v("the base fee for an Arweave transaction (i.e. a zero bye transaction). Note that this value could change if a sufficient amount of time passes between the time you fetch this value, create the transaction, and send the transaction.")])]),a._v(" "),t("p",[a._v("To get the last transaction sent from your cold wallet, use the "),t("code",[a._v("last-tx")]),a._v(" command and specify your wallet address e.g.:")]),a._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v("ardrive last-tx -a \n")])])]),t("p",[a._v("To get the base transaction reward required for an AR transaction, use the "),t("code",[a._v("base-reward")]),a._v(" function, optionally applying a reward boost multiple if you're looking to front-run network congestion:")]),a._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v("ardrive base-reward --boost 1.5\n")])])]),t("p",[a._v("Write down or securely copy the values you derived from the Internet-connected machine and run the following commands on the airgapped machine, piping the outputted signed transaction data to a file in the process, e.g. "),t("code",[a._v("sendme.json")]),a._v(" (if that's your signed transaction transfer medium preference):")]),a._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v('ardrive create-tx -w /path/to/wallet/file.json -d -a --last-tx --reward "" > sendme.json\n')])])]),t("p",[a._v("Transport your signed transaction to the Internet-connected machine and run the following command to send your transaction to the Arweave network:")]),a._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v("ardrive send-tx -x /path/to/sendme.json\n")])])]),t("h3",{attrs:{id:"using-a-custom-arweave-gateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-a-custom-arweave-gateway"}},[a._v("#")]),a._v(" Using a Custom Arweave Gateway")]),a._v(" "),t("p",[a._v("On each command that uses a gateway, it is possible to supply your own custom Arweave gateway using the flag "),t("code",[a._v("--gateway")]),a._v(" or by setting an environment variable named "),t("code",[a._v("ARWEAVE_GATEWAY")]),a._v(".")]),a._v(" "),t("p",[a._v("For example, you could test out that your ArFS transactions are working as expected on a local test network such as "),t("a",{attrs:{href:"https://github.com/textury/arlocal",target:"_blank",rel:"noopener noreferrer"}},[a._v("ArLocal"),t("OutboundLink")],1),a._v(" with this flow:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Setup ArLocal instance on port 1984")]),a._v("\nnpx arlocal\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# In another terminal, fund your wallet with AR")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" http://localhost:1984/mint/"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v(" your public wallet address "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("/99999999999999\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Create drive and root folder on ArLocal using `--gateway` flag")]),a._v("\nardrive create-drive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--gateway")]),a._v(" http://127.0.0.1:1984 "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-n")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'my-test-drive'")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Setup ARWEAVE_GATEWAY as ENV variable")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("export")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[a._v("ARWEAVE_GATEWAY")]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"http://localhost:1984"')]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Mine block with drive + root folder transactions")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$ARWEAVE_GATEWAY")]),a._v('/mine"')]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Upload file to ArLocal with ENV var")]),a._v("\nardrive upload-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-F")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v(" root folder "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("id")]),a._v(" from create drive "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-l")]),a._v(" /path/to/file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Mine block with file transaction")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$ARWEAVE_GATEWAY")]),a._v('/mine"')]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Inspect meta data of created entities")]),a._v("\nardrive list-drive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v(" drive "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("id")]),a._v(" from create drive "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Download file to verify integrity")]),a._v("\nardrive download-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("file")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("id")]),a._v(" from upload "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("file")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),t("h3",{attrs:{id:"persistent-caching-of-arfs-entity-metadata"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#persistent-caching-of-arfs-entity-metadata"}},[a._v("#")]),a._v(" Persistent Caching of ArFS Entity Metadata"),t("a",{attrs:{id:"metadata-caching"}})]),a._v(" "),t("p",[a._v("To avoid redundant requests to the Arweave network for immutable ArFS entity metadata, a persistent file cache is created and maintained at:")]),a._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v("Windows: /ardrive-caches/metadata\nNon-Windows: /.ardrive/caches/metadata\n")])])]),t("p",[a._v("The "),t("code",[a._v("XDG_CACHE_HOME")]),a._v(" environment variable is honored, where applicable, and will be used in place of "),t("code",[a._v("os.homedir()")]),a._v(" in the scenarios described above.")]),a._v(" "),t("p",[a._v("Metadata cache logging to stderr can be enabled by setting the "),t("code",[a._v("ARDRIVE_CACHE_LOG")]),a._v(" environment variable to "),t("code",[a._v("1")]),a._v(".")]),a._v(" "),t("p",[a._v("Cache performance is UNDEFINED for multi-process scenarios, but is presumed to be generally usable.")]),a._v(" "),t("p",[a._v("The cache can be manually cleared safely at any time that any integrating app is not in operation.")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{308:function(a,t,e){"use strict";e.r(t);var s=e(10),n=Object(s.a)({},(function(){var a=this,t=a._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[t("h1",{attrs:{id:"using-the-cli"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-the-cli"}},[a._v("#")]),a._v(" Using the CLI")]),a._v(" "),t("h2",{attrs:{id:"cli-help"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#cli-help"}},[a._v("#")]),a._v(" CLI Help")]),a._v(" "),t("p",[a._v("Learn to use any command:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--help")]),a._v("\n")])])]),t("h2",{attrs:{id:"cli-version"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#cli-version"}},[a._v("#")]),a._v(" CLI Version")]),a._v(" "),t("p",[a._v("You can print out the version by running any of:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--version")]),a._v("\nardrive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-V")]),a._v("\n")])])]),t("h2",{attrs:{id:"wallet-operations"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#wallet-operations"}},[a._v("#")]),a._v(" Wallet Operations")]),a._v(" "),t("p",[a._v("Browsing of ArDrive public data is possible without the need for an "),t("a",{attrs:{href:"https://ardrive.atlassian.net/l/c/FpK8FuoQ",target:"_blank",rel:"noopener noreferrer"}},[a._v("Arweave wallet"),t("OutboundLink")],1),a._v(". However, for all write operations, or read operations without encryption/decryption keys, you'll need a wallet.")]),a._v(" "),t("p",[a._v("As you utilize the CLI, you can use either your wallet file or your seed phrase interchangeably. Consider the security implications of each approach for your particular use case carefully. If at any time you'd like to generate a new wallet altogether, start by generating a new seed phase. And if you'd like to use that seed phrase in the form of a wallet file, or if you'd like to recover an existing wallet via its seed phrase, use either or both of the following commands:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Generate seed-phrase")]),a._v("\nardrive generate-seedphrase\n"),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"this is an example twelve word seed phrase that you could use"')]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Generate/recover wallet file (with example output file path)")]),a._v("\nardrive generate-wallet "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-s")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"this is an example twelve word seed phrase that you could use"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" /path/to/wallet/file.json\n")])])]),t("p",[a._v("Public attributes of Arweave wallets can be retrieved via their 43-character Arweave wallet address. You can retrieve the wallet address associated with "),t("a",{attrs:{href:"https://ardrive.atlassian.net/l/c/FpK8FuoQ",target:"_blank",rel:"noopener noreferrer"}},[a._v("your wallet file or 12-word seed phrase"),t("OutboundLink")],1),a._v(" (e.g. wallets generated by "),t("a",{attrs:{href:"https://arconnect.io/",target:"_blank",rel:"noopener noreferrer"}},[a._v("ArConnect"),t("OutboundLink")],1),a._v(") like so:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Wallet file")]),a._v("\nardrive get-address "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet/file.json\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Seed Phrase (with sample output)")]),a._v("\nardrive get-address "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-s")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"this is an example twelve word seed phrase that you could use"')]),a._v("\nHTTn8F92tR32N8wuo-NIDkjmqPknrbl10JWo5MZ9x2k\n")])])]),t("p",[a._v("You'll need AR in your wallet for any write operations you perform in ArDrive. You can always check your wallet balance (in both AR and Winston units) by performing:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Getting the balance for your own wallet")]),a._v("\nardrive get-balance "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet/file.json\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Getting the balance for ANY wallet (with sample output)")]),a._v("\nardrive get-balance "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-a")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"HTTn8F92tR32N8wuo-NIDkjmqPknrbl10JWo5MZ9x2k"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1500000000000")]),a._v(" Winston\n"),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1.5")]),a._v(" AR\n")])])]),t("p",[a._v("If, at any time, you need to send AR out of your wallet to another wallet address, you may perform:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Using our previously generated wallet as the destination...")]),a._v("\nardrive send-ar "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet/file.json --dest-address "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"HTTn8F92tR32N8wuo-NIDkjmqPknrbl10JWo5MZ9x2k"')]),a._v(" --ar-amount "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("2.12345")]),a._v("\n")])])]),t("h2",{attrs:{id:"working-with-entities"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#working-with-entities"}},[a._v("#")]),a._v(" Working With Entities")]),a._v(" "),t("p",[t("a",{attrs:{href:"https://ardrive.io",target:"_blank",rel:"noopener noreferrer"}},[a._v("ArDrive"),t("OutboundLink")],1),a._v("'s "),t("a",{attrs:{href:"https://ardrive.atlassian.net/l/c/m6P1vJDo",target:"_blank",rel:"noopener noreferrer"}},[a._v("ArFS"),t("OutboundLink")],1),a._v(" integration provides for hierarchical organization of your file and folder data on Arweave.")]),a._v(" "),t("p",[a._v("The fundamental entity types specified by ArFS are:")]),a._v(" "),t("ul",[t("li",[a._v("Drives")]),a._v(" "),t("li",[a._v("Folders")]),a._v(" "),t("li",[a._v("Files")])]),a._v(" "),t("p",[a._v("Each instance of these entities have a Version 4 UUID entity ID that is commonly referred to by its entity type, i.e. drive ID, folder ID, and file ID.")]),a._v(" "),t("p",[a._v("When you execute write functions with the CLI, the JSON output will contain information about the Arweave Transaction IDs that were registered when writing your entities to the blockweave, any miner rewards or "),t("a",{attrs:{href:"https://ardrive.io/community/",target:"_blank",rel:"noopener noreferrer"}},[a._v("ArDrive Community"),t("OutboundLink")],1),a._v(" tips that were disbursed from your wallet, and any new entity IDs and, when applicable, encryption keys that were generated in the process of creating the entities. Typically, you'll want to keep track of those and get proficient with retrieving them in order to build your drive hierarchy to your liking. See "),t("a",{attrs:{href:"#understanding-drive-and-file-keys"}},[a._v("Understanding Drive and File Keys")]),a._v(" for more info.")]),a._v(" "),t("h3",{attrs:{id:"dry-run"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dry-run"}},[a._v("#")]),a._v(" Dry Run")]),a._v(" "),t("p",[a._v("An important feature of the ArDrive CLI is the "),t("code",[a._v("--dry-run")]),a._v(' flag. On each command that would write an ArFS entity, there is the option to run it as a "dry run". This will run all of the steps and print the outputs of a regular ArFS write, but will skip sending the actual transaction:')]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("my-command"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("other-options"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" --dry-run\n")])])]),t("p",[a._v("This can be very useful for gathering price estimations or to confirm that you've copy-pasted your entity IDs correctly before committing to an upload.")]),a._v(" "),t("h3",{attrs:{id:"uploading-to-turbo-beta"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#uploading-to-turbo-beta"}},[a._v("#")]),a._v(" Uploading to Turbo (BETA) "),t("a",{attrs:{id:"upload-to-turbo"}})]),a._v(" "),t("p",[a._v("Users can optionally choose to send each ArFS entities created to "),t("a",{attrs:{href:"https://ardrive.io/turbo/",target:"_blank",rel:"noopener noreferrer"}},[a._v("ArDrive Turbo"),t("OutboundLink")],1),a._v(" using the "),t("code",[a._v("--turbo")]),a._v(" flag. Instead of using AR from an Arweave wallet, you can use Turbo Credits or take advantage of free/discounted upload promotions.")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("my-command"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("other-options"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--turbo")]),a._v("\n")])])]),t("p",[a._v("This flag will skip any balance check on the CLI side. Turbo will check a user's balance and accept/reject a data item at the time of upload. The "),t("code",[a._v("--turbo")]),a._v(" flag by default will send your files to "),t("code",[a._v("upload.ardrive.io")]),a._v(" to be bundled. To change the Turbo destination, users can use the "),t("code",[a._v("--turbo-url")]),a._v(" flag.")]),a._v(" "),t("h2",{attrs:{id:"working-with-drives"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#working-with-drives"}},[a._v("#")]),a._v(" Working With Drives")]),a._v(" "),t("h3",{attrs:{id:"understanding-drive-hierarchies"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#understanding-drive-hierarchies"}},[a._v("#")]),a._v(" Understanding Drive Hierarchies")]),a._v(" "),t("p",[a._v('At the root of every data tree is a "Drive" entity. When a drive is created, a Root Folder is also created for it. The entity IDs for both are generated and returned when you create a new drive:')]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Use `tee` to keep a receipt of the full set of transactions info and `jq` to focus on the data of interest")]),a._v("\nardrive create-drive --wallet-file /path/to/my/wallet.json --drive-name "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Teenage Love Poetry"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("tee")]),a._v(" created_drive.json "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v("\njq "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'[.created[] | del(.metadataTxId, .entityName, .bundledIn)]'")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"type"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"drive"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6939b9e0-cc98-42cb-bae0-5888eca78885"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"type"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"folder"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"d1535126-fded-4990-809f-83a06f2a1118"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v("\n")])])]),t("p",[a._v("The relationship between the drive and its root folder is clearly visible when retrieving the drive's info:"),t("a",{attrs:{id:"drive-info"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive drive-info "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6939b9e0-cc98-42cb-bae0-5888eca78885"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" jq "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'{driveId, rootFolderId}'")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"driveId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6939b9e0-cc98-42cb-bae0-5888eca78885"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"rootFolderId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"d1535126-fded-4990-809f-83a06f2a1118"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n\n")])])]),t("p",[a._v('All file and folder entities in the drive will be anchored to it by a "Drive-ID" GQL Tag. And they\'ll each be anchored to a parent folder ID, tracked via the "Parent-Folder-ID" GQL tag, forming a tree structure whose base terminates at the Root Folder.')]),a._v(" "),t("h3",{attrs:{id:"understanding-drive-and-file-keys"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#understanding-drive-and-file-keys"}},[a._v("#")]),a._v(" Understanding Drive and File Keys")]),a._v(" "),t("p",[a._v('Private Drives achieve privacy via end-to-end encryption facilitated by hash-derived "Keys". Drive Keys encrypt/decrypt Drive and Folder data, and File Keys encrypt/decrypt File Data.')]),a._v(" "),t("p",[a._v("The relationships among your data and their keys is as follows:")]),a._v(" "),t("ul",[t("li",[a._v("Drive Key = functionOf(Wallet Signature, Randomly Generated Drive ID, User-specified Drive Password)")]),a._v(" "),t("li",[a._v("File Key = functionOf(Randomly Generated File ID, Drive Key)")])]),a._v(" "),t("p",[a._v("When you create private entities, the returned JSON data from the ArDrive CLI will contain the keys needed to decrypt the encrypted representation of your entity that is now securely and permanently stored on the blockweave.")]),a._v(" "),t("p",[a._v("To derive the drive key again for a drive, perform the following:"),t("a",{attrs:{id:"derive-drive-key"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Will throw an error if the wallet or password specified can't be used to decrypt the on-chain drive")]),a._v("\nardrive get-drive-key "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/my/wallet.json "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6939b9e0-cc98-42cb-bae0-5888eca78885"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v("\n")])])]),t("p",[a._v("To derive the file key again for a file, perform the following:"),t("a",{attrs:{id:"derive-file-key"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Will throw an error if the drive key or drive-key-derivation data specified can't be used to decrypt the on-chain file")]),a._v("\nardrive get-file-key --file-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"bd2ce978-6ede-4b0d-8f79-2d7bc235a0e0"')]),a._v(" --drive-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6939b9e0-cc98-42cb-bae0-5888eca78885"')]),a._v(" --drive-key "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"yHdCjpCK3EcuhQcKNx2d/NN5ReEjoKfZVqKunlCnPEo"')]),a._v("\n")])])]),t("h3",{attrs:{id:"managing-drive-passwords"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#managing-drive-passwords"}},[a._v("#")]),a._v(" Managing Drive Passwords")]),a._v(" "),t("p",[a._v("The ArDrive CLI's private drive and folder functions all require either a drive password OR a drive key. Private file functions require either the drive password or the file key. "),t("strong",[a._v("Keys and passwords are sensitive data, so manage the entry, display, storage, and transmission of them very carefully.")])]),a._v(" "),t("p",[a._v("Drive passwords are the most portable, and fundamental, encryption facet, so a few options are available during private drive operations for supplying them:")]),a._v(" "),t("ul",[t("li",[a._v("Environment Variable")]),a._v(" "),t("li",[a._v("STDIN")]),a._v(" "),t("li",[a._v("Secure Prompt")])]),a._v(" "),t("h4",{attrs:{id:"supplying-your-password-environment-variable"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#supplying-your-password-environment-variable"}},[a._v("#")]),a._v(" Supplying Your Password: Environment Variable"),t("a",{attrs:{id:"pw-environment-variable"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Securely type your password into a read prompt, store it to TMP_ARDRIVE_PW, and export it for the shell session")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("read")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-rs")]),a._v(" TMP_ARDRIVE_PW\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("export")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[a._v("ARDRIVE_DRIVE_PW")]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$(")]),a._v("TMP_ARDRIVE_PW"),t("span",{pre:!0,attrs:{class:"token variable"}},[a._v(")")])]),a._v("\nardrive "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("some private command"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v("\n")])])]),t("h4",{attrs:{id:"supplying-your-password-stdin"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#supplying-your-password-stdin"}},[a._v("#")]),a._v(" Supplying Your Password: STDIN"),t("a",{attrs:{id:"pw-stdin"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Pipe your drive password to the ArDrive CLI")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("cat")]),a._v(" /path/to/my/drive/password.txt "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" ardrive "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("some private command"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Redirect your drive password to the ArDrive CLI")]),a._v("\nardrive "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("some private command"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v(" /path/to/my/drive/password.txt\n")])])]),t("h4",{attrs:{id:"supplying-your-password-prompt"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#supplying-your-password-prompt"}},[a._v("#")]),a._v(" Supplying Your Password: Prompt"),t("a",{attrs:{id:"pw-prompt"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# When all other options fail, the CLI will prompt for your password (NOT COMPATIBLE WITH PIPES AND REDIRECTS!)")]),a._v("\nardrive "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("some private command"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v("\n? Enter drive password: › ********\n")])])]),t("h3",{attrs:{id:"creating-drives"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-drives"}},[a._v("#")]),a._v(" Creating Drives")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Public drive")]),a._v("\nardrive create-drive --wallet-file /path/to/my/wallet.json --drive-name "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"My Public Archive"')]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Private drive")]),a._v("\nardrive create-drive --wallet-file /path/to/my/wallet.json --drive-name "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Teenage Love Poetry"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v("\n")])])]),t("h3",{attrs:{id:"listing-drives-for-an-address"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#listing-drives-for-an-address"}},[a._v("#")]),a._v(" Listing Drives for an Address")]),a._v(" "),t("p",[a._v("You can list all the drives associated with any Arweave wallet address, though the details of private drives will be obfuscated from you unless you provide the necessary decryption data.")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# List all your own drives")]),a._v("\nardrive list-all-drives "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/my/wallet.json "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# List any address's drives")]),a._v("\nardrive list-all-drives "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--address")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"HTTn8F92tR32N8wuo-NIDkjmqPknrbl10JWo5MZ9x2k"')]),a._v("\n")])])]),t("h3",{attrs:{id:"listing-every-entity-in-a-drive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#listing-every-entity-in-a-drive"}},[a._v("#")]),a._v(" Listing Every Entity in a Drive"),t("a",{attrs:{id:"list-drive"}})]),a._v(" "),t("p",[a._v("Useful notes on listing the contents of drives:")]),a._v(" "),t("ul",[t("li",[a._v("Listing a drive is effectively the same as listing its root folder.")]),a._v(" "),t("li",[a._v("You can control the tree depth of the data returned.")]),a._v(" "),t("li",[a._v("path, txPath, and entityIdPath properties on entities can provide useful handholds for other forms of data navigation")])]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# List everything in a private drive")]),a._v("\nardrive list-drive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"c7f87712-b54e-4491-bc96-1c5fa7b1da50"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/my/wallet.json "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# List a private drive including the `fileKey` and/or `driveKey` of all listed entitites")]),a._v("\nardrive list-drive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"c7f87712-b54e-4491-bc96-1c5fa7b1da50"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/my/wallet.json "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v(" --with-keys\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# List the contents of a public drive up to and including those in the grandchild folders of the root folder")]),a._v("\nardrive list-drive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"c7f87712-b54e-4491-bc96-1c5fa7b1da50"')]),a._v(" --max-depth "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("2")]),a._v("\n")])])]),t("h3",{attrs:{id:"list-drive-pipeline-examples"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#list-drive-pipeline-examples"}},[a._v("#")]),a._v(" List Drive Pipeline Examples")]),a._v(" "),t("p",[a._v("You can utilize "),t("code",[a._v("jq")]),a._v(" and the list commands to reshape the commands' output data into useful forms and stats for many use cases. Here are a few examples:")]),a._v(" "),t("p",[t("a",{attrs:{id:"get-share-links"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Get share links for a PUBLIC drive")]),a._v("\nardrive list-drive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" a44482fd-592e-45fa-a08a-e526c31b87f1 "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" jq "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('\'.[] | select(.entityType == "file") | "https://app.ardrive.io/#/file/" + .entityId + "/view"\'')]),a._v("\n")])])]),t("p",[a._v("Example output:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://app.ardrive.io/#/file/1337babe-f000-dead-beef-ffffffffffff/view"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://app.ardrive.io/#/file/cdbc9ddd-1cab-41d9-acbd-fd4328929de3/view"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://app.ardrive.io/#/file/f19bc712-b57a-4e0d-8e5c-b7f1786b34a1/view"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://app.ardrive.io/#/file/4f8e081b-42f2-442d-be41-57f6f906e1c8/view"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://app.ardrive.io/#/file/0e02d254-c853-4ff0-9b6e-c4d23d2a95f5/view"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://app.ardrive.io/#/file/c098b869-29d1-4a86-960f-a9e10433f0b0/view"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://app.ardrive.io/#/file/4afc8cdf-4d27-408a-bfb9-0a2ec21eebf8/view"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://app.ardrive.io/#/file/85fe488d-fcf7-48ca-9df8-2b39958bbf15/view"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("..")]),a._v(".\n")])])]),t("p",[t("a",{attrs:{id:"get-total-size"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Get total size of all files within drive")]),a._v("\nardrive list-drive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" 13c3c232-6687-4d11-8ac1-35284102c7db "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" jq "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("' map(select(.entityType == \"file\") | .size) | add'")]),a._v("\n")])])]),t("p",[t("a",{attrs:{id:"get-file-count"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Get total number of files within drive")]),a._v("\nardrive list-drive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" 01ea6ba3-9e58-42e7-899d-622fd110211c "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" jq "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'[ .[] | select(.entityType == \"file\") ] | length'")]),a._v("\n")])])]),t("h2",{attrs:{id:"working-with-folders"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#working-with-folders"}},[a._v("#")]),a._v(" Working With Folders")]),a._v(" "),t("p",[a._v("As discussed previously, all folders in a drive are linked by way of parent folder references back to the root folder of a drive. Folders can be moved into any folder in the hierarchy that's not in their own subtree.")]),a._v(" "),t("h3",{attrs:{id:"creating-folders"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-folders"}},[a._v("#")]),a._v(" Creating Folders")]),a._v(" "),t("p",[a._v("Creating folders manually is straightforward:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive create-folder --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"63153bb3-2ca9-4d42-9106-0ce82e793321"')]),a._v(" --folder-name "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"My Awesome Folder"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("p",[a._v("Example output:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"created"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"type"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"folder"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"metadataTxId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"AYFMBVmwqhbg9y5Fbj3Iasy5oxUqhauOW7PcS1sl4Dk"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"d1b7c514-fb12-4603-aad8-002cf63015d3"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"key"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"yHdCjpCKD2cuhQcKNx2d/XF5ReEjoKfZVqKunlCnPEk"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityName"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"My Awesome Folder"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"tips"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"fees"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"AYFMBVmwqhbg9y5Fbj3Iasy5oxUqhauOW7PcS1sl4Dk"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1378052")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),t("p",[a._v("Note: Folders can also be created by supplying a folder as the --local-path of an upload-file command. In this case, the folder hierarchy on the local disk will be reconstructed on chain during the course of the recursive bulk upload.")]),a._v(" "),t("h3",{attrs:{id:"moving-folders"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#moving-folders"}},[a._v("#")]),a._v(" Moving Folders")]),a._v(" "),t("p",[a._v("Moving a folder is as simple as supplying a new parent folder ID. Note that naming collisions among entities within a folder are not allowed.")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive move-folder --folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"29850ab7-56d4-4e1f-a5be-cb86d5513921"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("h3",{attrs:{id:"renaming-folders"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#renaming-folders"}},[a._v("#")]),a._v(" Renaming Folders"),t("a",{attrs:{id:"rename-folder"}})]),a._v(" "),t("p",[a._v("In order to rename a folder you must provide a name different from its current one, and it must not create naming conflicts with its sibling entities.")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive rename-folder --folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"568d5eba-dbf3-4a49-8129-1c58f7fd35bc"')]),a._v(" --folder-name "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Folder with cool stuff"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"./wallet.json"')]),a._v("\n")])])]),t("h3",{attrs:{id:"viewing-folder-metadata"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#viewing-folder-metadata"}},[a._v("#")]),a._v(" Viewing Folder Metadata")]),a._v(" "),t("p",[a._v("To view the metadata of a folder, users can use the "),t("code",[a._v("folder-info")]),a._v(" command:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive folder-info --folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v("\n")])])]),t("h3",{attrs:{id:"listing-contents-of-a-folder"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#listing-contents-of-a-folder"}},[a._v("#")]),a._v(" Listing Contents of a Folder")]),a._v(" "),t("p",[a._v("Similar to drives, the "),t("code",[a._v("list-folder")]),a._v(" command can be used to fetch the metadata of each entity within a folder. But by default, the command will fetch only the immediate children of that folder ("),t("code",[a._v("--max-depth 0")]),a._v("):")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v('# List immediate children of folder "My Public Folder"')]),a._v("\nardrive list-folder --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"29850ab7-56d4-4e1f-a5be-cb86d5513940"')]),a._v("\n")])])]),t("p",[a._v("Example output:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appName"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ArDrive-CLI"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appVersion"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"2.0"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"arFS"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"0.11"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"contentType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"application/json"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"driveId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"01ea6ba3-9e58-42e7-899d-622fd110211a"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"folder"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"name"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"mytestfolder"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"HYiKyfLwY7PT9NleTQoTiM_-qPVUwf4ClDhx1sjUAEU"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"unixTime"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1635102772")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"parentFolderId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"29850ab7-56d4-4e1f-a5be-cb86d5513940"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"03df2929-1440-4ab4-bbf0-9dc776e1ed96"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"path"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/My Public Folder/mytestfolder"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txIdPath"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/09_x0X2eZ3flXXLS72WdTDq6uaa5g2LjsT-QH1m0zhU/HYiKyfLwY7PT9NleTQoTiM_-qPVUwf4ClDhx1sjUAEU"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityIdPath"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/29850ab7-56d4-4e1f-a5be-cb86d5513940/03df2929-1440-4ab4-bbf0-9dc776e1ed96"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appName"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ArDrive-CLI"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appVersion"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"2.0"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"arFS"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"0.11"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"contentType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"application/json"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"driveId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"01ea6ba3-9e58-42e7-899d-622fd110211a"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"folder"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"name"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Super sonic public folder"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"VUk1B_vo1va2-EHLtqjsotzy0Rdn6lU4hQo3RD2xoTI"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"unixTime"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1631283259")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"parentFolderId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"29850ab7-56d4-4e1f-a5be-cb86d5513940"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"452c6aec-43dc-4015-9abd-20083068d432"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"path"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/My Public Folder/Super sonic sub folder"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txIdPath"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/09_x0X2eZ3flXXLS72WdTDq6uaa5g2LjsT-QH1m0zhU/VUk1B_vo1va2-EHLtqjsotzy0Rdn6lU4hQo3RD2xoTI"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityIdPath"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/29850ab7-56d4-4e1f-a5be-cb86d5513940/452c6aec-43dc-4015-9abd-20083068d432"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appName"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ArDrive-CLI"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appVersion"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"2.0"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"arFS"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"0.11"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"contentType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"application/json"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"driveId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"01ea6ba3-9e58-42e7-899d-622fd110211a"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"name"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"test-number-twelve.txt"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"429zBqnd7ZBNzgukaix26RYz3g5SeXCCo_oIY6CPZLg"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"unixTime"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1631722234")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"size"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("47")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"lastModifiedDate"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1631722217028")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"dataTxId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"vA-BxAS7I6n90cH4Fzsk4cWS3EOPb1KOhj8yeI88dj0"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"dataContentType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"text/plain"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"parentFolderId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"29850ab7-56d4-4e1f-a5be-cb86d5513940"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"e5948327-d6de-4acf-a6fe-e091ecf78d71"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"path"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/My Public Folder/test-number-twelve.txt"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txIdPath"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/09_x0X2eZ3flXXLS72WdTDq6uaa5g2LjsT-QH1m0zhU/429zBqnd7ZBNzgukaix26RYz3g5SeXCCo_oIY6CPZLg"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityIdPath"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/29850ab7-56d4-4e1f-a5be-cb86d5513940/e5948327-d6de-4acf-a6fe-e091ecf78d71"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appName"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ArDrive-CLI"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appVersion"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"2.0"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"arFS"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"0.11"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"contentType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"application/json"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"driveId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"01ea6ba3-9e58-42e7-899d-622fd110211a"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"name"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"wonderful-test-file.txt"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6CokwlzB81Fx7dq-lB654VM0XQykdU6eYohDmEJ2gk4"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"unixTime"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1631671275")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"size"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("23")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"lastModifiedDate"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1631283389232")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"dataTxId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"UP8THwA_1gvyRqNRqYmTpWvU4-UzNWBN7SiX_AIihg4"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"dataContentType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"text/plain"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"parentFolderId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"29850ab7-56d4-4e1f-a5be-cb86d5513940"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"3274dae9-3487-41eb-94d5-8d5d3d8bc343"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"path"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/My Public Folder/wonderful-test-file.txt"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txIdPath"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/09_x0X2eZ3flXXLS72WdTDq6uaa5g2LjsT-QH1m0zhU/6CokwlzB81Fx7dq-lB654VM0XQykdU6eYohDmEJ2gk4"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityIdPath"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/29850ab7-56d4-4e1f-a5be-cb86d5513940/3274dae9-3487-41eb-94d5-8d5d3d8bc343"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v("\n")])])]),t("p",[a._v("To list further than the immediate children, you can make use of the flags: "),t("code",[a._v("--all")]),a._v(" and "),t("code",[a._v("--max-depth")]),a._v(".")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# List all contents of a public folder")]),a._v("\nardrive list-folder --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--all")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# List the contents of a public folder with custom depth")]),a._v("\nardrive list-folder --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" --max-depth "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("2")]),a._v("\n")])])]),t("p",[a._v("In the case of private entitites, the "),t("code",[a._v("--with-keys")]),a._v(" flag will make the command to include the keys in the output.")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# List all contents of a private folder including the `fileKey` and/or `driveKey` of all listed entitites")]),a._v("\nardrive list-folder --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"1b027047-4cfc-4eee-88a8-9af694f660c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /my/wallet.json --with-keys\n")])])]),t("h2",{attrs:{id:"working-with-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#working-with-files"}},[a._v("#")]),a._v(" Working With Files")]),a._v(" "),t("p",[a._v("Similar to folders, files are linked to a parent folder which ultimately chains the file back to the root folder of its parent drive. As such, a parent folder ID is required in order to upload files. Files can be freely moved to other folders within their original drive.")]),a._v(" "),t("p",[a._v("The important difference for file entities is that they also hold a reference to their data transaction ID, which is the "),t("code",[a._v("dataTxId")]),a._v(" as returned by the "),t("code",[a._v("file-info")]),a._v(" command. This is where your uploaded data lives on the permaweb.")]),a._v(" "),t("p",[t("strong",[a._v("NOTE: The CLI currently (v1.0.0) has progress logging on uploads DISABLED for producing clean JSON outputs that can be piped in the terminal. On larger uploads, remember to be patient. You can check your system's "),t("code",[a._v("node")]),a._v(" process to confirm the process is still uploading.")])]),a._v(" "),t("h3",{attrs:{id:"uploading-a-single-file"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#uploading-a-single-file"}},[a._v("#")]),a._v(" Uploading a Single File")]),a._v(" "),t("p",[a._v("To upload a file, you'll need a parent folder id, the file to upload's file path, and the path to your wallet:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Supply the parent folder ID to upload-file")]),a._v("\nardrive upload-file --local-path /path/to/file.txt --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("p",[a._v("Example output:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"created"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"type"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityName"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file.txt"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6613395a-cf19-4420-846a-f88b7b765c05"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"dataTxId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"l4iNWyBapfAIj7OU-nB8z9XrBhawyqzs5O9qhk-3EnI"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"metadataTxId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"YfdDXUyerPCpBbGTm_gv_x5hR3tu5fnz8bM-jPL__JE"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"bundledIn"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"1zwdfZAIV8E26YjBs2ZQ4xjjP_1ewalvRgD_GyYw7f8"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"sourceUri"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file:///path/to/file.txt"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"type"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"bundle"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"bundleTxId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"1zwdfZAIV8E26YjBs2ZQ4xjjP_1ewalvRgD_GyYw7f8"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"tips"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"1zwdfZAIV8E26YjBs2ZQ4xjjP_1ewalvRgD_GyYw7f8"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"recipient"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"address"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"3mxGJ4xLcQQNv6_TiKx0F0d5XVE0mNvONQI5GZXJXkt"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"winston"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"10000000"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"fees"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"1zwdfZAIV8E26YjBs2ZQ4xjjP_1ewalvRgD_GyYw7f8"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("42819829")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),t("p",[a._v("NOTE: To upload to the root of a drive, specify its root folder ID as the parent folder ID for the upload destination. You can retrieve it like so:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive drive-info "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"c7f87712-b54e-4491-bc96-1c5fa7b1da50"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" jq "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-r")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'.rootFolderId'")]),a._v("\n")])])]),t("h3",{attrs:{id:"ipfs-cid-tagging"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ipfs-cid-tagging"}},[a._v("#")]),a._v(" IPFS CID Tagging")]),a._v(" "),t("p",[a._v("Certain nodes on the Arweave network may be running the "),t("a",{attrs:{href:"https://arweave.medium.com/arweave-ipfs-persistence-for-the-interplanetary-file-system-9f12981c36c3",target:"_blank",rel:"noopener noreferrer"}},[a._v("IPFS+Arweave bridge"),t("OutboundLink")],1),a._v(". Tagging your file upload transaction with its IPFS v1 CID value in the 'IPFS-Add' tag may allow you to take advantage of this system. It can also be helpful for finding data on Arweave via GQL based on its CID. To include the CID tag on your "),t("strong",[a._v("PUBLIC")]),a._v(" file uploads, you may use the '--add-ipfs-tag' flag:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file --add-ipfs-tag --local-path /path/to/file.txt --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("h3",{attrs:{id:"progress-logging-of-transaction-uploads"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#progress-logging-of-transaction-uploads"}},[a._v("#")]),a._v(" Progress Logging of Transaction Uploads")]),a._v(" "),t("p",[a._v("Progress logging of transaction uploads to stderr can be enabled by setting the "),t("code",[a._v("ARDRIVE_PROGRESS_LOG")]),a._v(" environment variable to "),t("code",[a._v("1")]),a._v(":")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("Uploading "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("file")]),a._v(" transaction "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1")]),a._v(" of total "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("2")]),a._v(" transactions"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("..")]),a._v(".\nTransaction _GKQasQX194a364Hph8Oe-oku1AdfHwxWOw9_JC1yjc Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("0")]),a._v("%\nTransaction _GKQasQX194a364Hph8Oe-oku1AdfHwxWOw9_JC1yjc Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("35")]),a._v("%\nTransaction _GKQasQX194a364Hph8Oe-oku1AdfHwxWOw9_JC1yjc Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("66")]),a._v("%\nTransaction _GKQasQX194a364Hph8Oe-oku1AdfHwxWOw9_JC1yjc Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("100")]),a._v("%\nUploading "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("file")]),a._v(" transaction "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("2")]),a._v(" of total "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("2")]),a._v(" transactions"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("..")]),a._v(".\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("0")]),a._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("13")]),a._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("28")]),a._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("42")]),a._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("60")]),a._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("76")]),a._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("91")]),a._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("100")]),a._v("%\n")])])]),t("h3",{attrs:{id:"download-a-single-file-beta"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#download-a-single-file-beta"}},[a._v("#")]),a._v(" Download a Single file (BETA)"),t("a",{attrs:{id:"download-file"}})]),a._v(" "),t("p",[a._v("By using the "),t("code",[a._v("download-file")]),a._v(" command you can download a file on chain to a folder in your local storage specified by --local-path (or to your current working directory if not specified):")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive download-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json --file-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ff450770-a9cb-46a5-9234-89cbd9796610"')]),a._v(" --local-path /my_ardrive_downloads/\n")])])]),t("p",[a._v("Specify a filename in the --local-path if you'd like to use a different name than the one that's used in your drive:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive download-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json --file-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ff450770-a9cb-46a5-9234-89cbd9796610"')]),a._v(" --local-path /my_ardrive_downloads/my_pic.png\n")])])]),t("h3",{attrs:{id:"rename-a-single-file"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rename-a-single-file"}},[a._v("#")]),a._v(" Rename a Single File"),t("a",{attrs:{id:"rename-file"}})]),a._v(" "),t("p",[a._v("To rename an on-chain file you can make use of the "),t("code",[a._v("rename-file")]),a._v(" command. The required parameters are the file ID and the new name, as well as the owner wallet or seed phrase.")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive rename-file --file-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"290a3f9a-37b2-4f0f-a899-6fac983833b3"')]),a._v(" --file-name "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"My custom file name.txt"')]),a._v(" --wallet-file "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"wallet.json"')]),a._v("\n")])])]),t("h3",{attrs:{id:"uploading-a-folder-with-files-bulk-upload"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#uploading-a-folder-with-files-bulk-upload"}},[a._v("#")]),a._v(" Uploading a Folder with Files (Bulk Upload)"),t("a",{attrs:{id:"bulk-upload"}})]),a._v(" "),t("p",[a._v("Users can perform a bulk upload by using the upload-file command on a target folder. The command will reconstruct the folder hierarchy on local disk as ArFS folders on the permaweb and upload each file into their corresponding folders:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file --local-path /path/to/folder --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("h3",{attrs:{id:"downloading-a-folder-with-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#downloading-a-folder-with-files"}},[a._v("#")]),a._v(" Downloading a Folder with Files"),t("a",{attrs:{id:"download-folder"}})]),a._v(" "),t("p",[a._v("You can download a folder from ArDrive to your local machine with the "),t("code",[a._v("download-folder")]),a._v(' command. In the following examples, assume that a folder with ID "47f5bde9-61ba-49c7-b409-1aa4a9e250f6" exists in your drive and is named "MyArDriveFolder".')]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v('# Downloads "MyArDriveFolder" into the current working directory, i.e. ./MyArDriveFolder/')]),a._v("\nardrive download-folder "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"47f5bde9-61ba-49c7-b409-1aa4a9e250f6"')]),a._v("\n")])])]),t("p",[a._v("By specifying the "),t("code",[a._v("--local-path")]),a._v(" option, you can choose the local parent folder into which the on-chain folder will be downloaded. When the parameter is omitted, its value defaults to the current working directory (i.e. "),t("code",[a._v("./")]),a._v(").")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v('# Downloads "MyArDriveFolder" into /my_ardrive_downloads/MyArDriveFolder')]),a._v("\nardrive download-folder "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"47f5bde9-61ba-49c7-b409-1aa4a9e250f6"')]),a._v(" --local-path /my_ardrive_downloads/\n")])])]),t("p",[a._v("The "),t("code",[a._v("--max-depth")]),a._v(" parameter lets you to choose a custom folder depth to download. When omitted, the entire subtree of the folder will be downloaded. In the following example, only the immediate children of the folder will be downloaded:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive download-folder "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"47f5bde9-61ba-49c7-b409-1aa4a9e250f6"')]),a._v(" --max-depth "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("0")]),a._v("\n")])])]),t("p",[a._v("The behaviors of "),t("code",[a._v("--local-path")]),a._v(" are similar to those of "),t("code",[a._v("cp")]),a._v(" and "),t("code",[a._v("mv")]),a._v(" in Unix systems, e.g.:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v('# folder downloaded to "/existing_folder/MyArDriveFolder"')]),a._v("\nardrive download-folder "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"47f5bde9-61ba-49c7-b409-1aa4a9e250f6"')]),a._v(" --local-path "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/existing_folder"')]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v('# folder downloaded to "/existing_folder/MyArDriveFolder/MyArDriveFolder" as "/existing_folder/MyArDriveFolder" already exists')]),a._v("\nardrive download-folder "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"47f5bde9-61ba-49c7-b409-1aa4a9e250f6"')]),a._v(" --local-path "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/existing_folder/MyArDriveFolder"')]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v('# folder downloaded to "/existing_folder/non_existent_folder"')]),a._v("\nardrive download-folder "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"47f5bde9-61ba-49c7-b409-1aa4a9e250f6"')]),a._v(" --local-path "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/existing_folder/non_existent_folder"')]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# ERROR!")]),a._v("\nardrive download-folder "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"47f5bde9-61ba-49c7-b409-1aa4a9e250f6"')]),a._v(" --local-path "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/non_existent_folder_1/non_existent_folder_2"')]),a._v("\n")])])]),t("h3",{attrs:{id:"downloading-a-drive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#downloading-a-drive"}},[a._v("#")]),a._v(" Downloading a Drive"),t("a",{attrs:{id:"download-drive"}})]),a._v(" "),t("p",[a._v("To download the whole drive you can use the "),t("code",[a._v("download-drive")]),a._v(" command.")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive download-drive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"c0c8ba1c-efc5-420d-a07c-a755dc67f6b2"')]),a._v("\n")])])]),t("p",[a._v("This is equivalent to running the "),t("code",[a._v("download-folder")]),a._v(" command against the root folder of the drive.")]),a._v(" "),t("h3",{attrs:{id:"uploading-multiple-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#uploading-multiple-files"}},[a._v("#")]),a._v(" Uploading Multiple Files"),t("a",{attrs:{id:"multi-file-upload"}})]),a._v(" "),t("p",[a._v("To upload an arbitrary number of files or folders, pass a space-separated list of paths to "),t("code",[a._v("--local-paths")]),a._v(":")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Specifying a mixed set of file and folder paths")]),a._v("\nardrive upload-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" wallet.json "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-F")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6939b9e0-cc98-42cb-bae0-5888eca78885"')]),a._v(" --local-paths ./image.png ~/backups/ "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("..")]),a._v("/another_file.txt\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Example using glob expansion to upload all .json files in the current folder")]),a._v("\nardrive upload-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" wallet.json "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-F")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6939b9e0-cc98-42cb-bae0-5888eca78885"')]),a._v(" --local-paths ./*.json\n")])])]),t("h3",{attrs:{id:"name-conflict-resolution-on-upload"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#name-conflict-resolution-on-upload"}},[a._v("#")]),a._v(" Name Conflict Resolution on Upload"),t("a",{attrs:{id:"conflict-resolution"}})]),a._v(" "),t("p",[a._v("By default, the "),t("code",[a._v("upload-file")]),a._v(" command will use the upsert behavior if existing entities are encountered in the destination folder tree that would cause naming conflicts.")]),a._v(" "),t("p",[a._v("Expect the behaviors from the following table for each of these resolution settings:")]),a._v(" "),t("div",{staticStyle:{"text-align":"center"}},[t("table",{staticClass:"inline-table"},[t("tr",[t("th",[a._v("Source Type")]),a._v(" "),t("th",[a._v("Conflict at Dest")]),a._v(" "),t("th",[a._v("`skip`")]),a._v(" "),t("th",[a._v("`replace`")]),a._v(" "),t("th",[a._v("`upsert` (default)")])]),a._v(" "),t("tr",[t("td",[a._v("File")]),a._v(" "),t("td",[a._v("None")]),a._v(" "),t("td",[a._v("Insert")]),a._v(" "),t("td",[a._v("Insert")]),a._v(" "),t("td",[a._v("Insert")])]),a._v(" "),t("tr",[t("td",[a._v("File")]),a._v(" "),t("td",[a._v("Matching File")]),a._v(" "),t("td",[a._v("Skip")]),a._v(" "),t("td",[a._v("Update")]),a._v(" "),t("td",[a._v("Skip")])]),a._v(" "),t("tr",[t("td",[a._v("File")]),a._v(" "),t("td",[a._v("Different File")]),a._v(" "),t("td",[a._v("Skip")]),a._v(" "),t("td",[a._v("Update")]),a._v(" "),t("td",[a._v("Update")])]),a._v(" "),t("tr",[t("td",[a._v("File")]),a._v(" "),t("td",[a._v("Folder")]),a._v(" "),t("td",[a._v("Skip")]),a._v(" "),t("td",[a._v("Fail")]),a._v(" "),t("td",[a._v("Fail")])]),a._v(" "),t("tr",[t("td",[a._v("Folder")]),a._v(" "),t("td",[a._v("None")]),a._v(" "),t("td",[a._v("Insert")]),a._v(" "),t("td",[a._v("Insert")]),a._v(" "),t("td",[a._v("Insert")])]),a._v(" "),t("tr",[t("td",[a._v("Folder")]),a._v(" "),t("td",[a._v("File")]),a._v(" "),t("td",[a._v("Skip")]),a._v(" "),t("td",[a._v("Fail")]),a._v(" "),t("td",[a._v("Fail")])]),a._v(" "),t("tr",[t("td",[a._v("Folder")]),a._v(" "),t("td",[a._v("Folder")]),a._v(" "),t("td",[a._v("Re-use")]),a._v(" "),t("td",[a._v("Re-use")]),a._v(" "),t("td",[a._v("Re-use")])])])]),a._v(" "),t("p",[a._v("The default upsert behavior will check the destination folder for a file with a conflicting name. If no conflicts are found, it will insert (upload) the file.")]),a._v(" "),t("p",[a._v("In the case that there is a FILE to FILE name conflict found, it will only update it if necessary. To determine if an update is necessary, upsert will compare the last modified dates of conflicting file and the file being uploaded. When they are matching, the upload will be skipped. Otherwise the file will be updated as a new revision.")]),a._v(" "),t("p",[a._v("To override the upsert behavior, use the "),t("code",[a._v("--replace")]),a._v(" option to always make new revisions of a file or the "),t("code",[a._v("--skip")]),a._v(" option to always skip the upload on name conflicts:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--replace")]),a._v(" --local-path /path/to/file.txt --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--skip")]),a._v(" --local-path /path/to/file.txt --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("p",[a._v("Alternatively, the upload-file commands now also supports the "),t("code",[a._v("--ask")]),a._v(" conflict resolution option. This setting will always provide an interactive prompt on name conflicts that allows users to decide how to resolve each conflict found:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--ask")]),a._v(" --local-file-path /path/to/file.txt --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n\nDestination folder has a "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("file")]),a._v(" to "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("file")]),a._v(" name conflict"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("!")]),a._v("\n\nFile name: "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("2")]),a._v(".png\nFile ID: efbc0370-b69f-44d9-812c-0d272b019027\nThis "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("file")]),a._v(" has a DIFFERENT last modified "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("date")]),a._v("\n\nPlease "),t("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("select")]),a._v(" how to proceed:\n › - Use arrow-keys. Return to submit.\n❯ Replace as new "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("file")]),a._v(" revision\n Upload with a different "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("file")]),a._v(" name\n Skip this "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("file")]),a._v(" upload\n")])])]),t("h3",{attrs:{id:"understanding-bundled-transactions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#understanding-bundled-transactions"}},[a._v("#")]),a._v(" Understanding Bundled Transactions"),t("a",{attrs:{id:"bundles"}})]),a._v(" "),t("p",[a._v("The ArDrive CLI currently uses two different methods for uploading transactions to the Arweave network: standard transactions and Direct to Network (D2N) bundled transactions. By default, the CLI will send a D2N bundled transaction for any action that would result in multiple transactions. This bundling functionality is currently used on the "),t("code",[a._v("upload-file")]),a._v(" and "),t("code",[a._v("create-drive")]),a._v(" commands.")]),a._v(" "),t("p",[a._v("D2N bundled transactions come with several benefits and implications:")]),a._v(" "),t("ul",[t("li",[a._v("Bundling saves AR and enhances ArFS reliability by sending associated ArFS transactions up as one atomic bundle.")]),a._v(" "),t("li",[a._v('Bundled transactions are treated as a single data transaction by the Arweave network, but can be presented as separate transactions by the Arweave Gateway once they have been "unbundled".')]),a._v(" "),t("li",[a._v("Un-bundling can take anywhere from a few minutes up to an hour. During that time, the files in the bundle will neither appear in list- commands nor be downloadable. Similarly, they will not appear in the web app after syncs until un-bundling is complete. "),t("strong",[a._v("This can negatively affect the accuracy of upsert operations")]),a._v(", so it's best to wait before retrying bulk uploads.")]),a._v(" "),t("li",[a._v("Bundling reliability on the gateway side degrades once bundles reach either 500 data items (or ~250 files) or 500 MiB, so the CLI will create and upload multiple bundles as necessary, or will send files that are simply too large for reliable bundling as unbundled txs.")])]),a._v(" "),t("h3",{attrs:{id:"uploading-a-non-bundled-transaction-not-recommended"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#uploading-a-non-bundled-transaction-not-recommended"}},[a._v("#")]),a._v(" Uploading a Non-Bundled Transaction (NOT RECOMMENDED)"),t("a",{attrs:{id:"no-bundle"}})]),a._v(" "),t("p",[a._v("While not recommended, the CLI does provide the option to forcibly send all transactions as standard transactions rather than attempting to bundle them together. To do this, simply add the "),t("code",[a._v("--no-bundle")]),a._v(" flag to the "),t("code",[a._v("upload-file")]),a._v(" or "),t("code",[a._v("create-drive")]),a._v(" command:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file --no-bundle --local-path /path/to/file --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("h3",{attrs:{id:"fetching-the-metadata-of-a-file-entity"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#fetching-the-metadata-of-a-file-entity"}},[a._v("#")]),a._v(" Fetching the Metadata of a File Entity")]),a._v(" "),t("p",[a._v("Simply perform the file-info command to retrieve the metadata of a file:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive file-info --file-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"e5ebc14c-5b2d-4462-8f59-7f4a62e7770f"')]),a._v("\n")])])]),t("p",[a._v("Example output:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appName"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ArDrive-Web"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appVersion"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"0.1.0"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"arFS"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"0.11"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"contentType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"application/json"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"driveId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"51062487-2e8b-4af7-bd81-4345dc28ea5d"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"name"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"2_depth.png"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"CZKdjqwnmxbWchGA1hjSO5ZH--4OYodIGWzI-FmX28U"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"unixTime"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1633625081")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"size"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("41946")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"lastModifiedDate"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1605157729000")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"parentFolderId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"a2c8a0cb-0ca7-4dbb-8bf8-93f75f308e63"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"e5ebc14c-5b2d-4462-8f59-7f4a62e7770f"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"fileId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"e5ebc14c-5b2d-4462-8f59-7f4a62e7770f"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"dataTxId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Jz0WsWyAGVc0aE3UzACo-YJqG8OPrN3UucmDdt8Fbjc"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"dataContentType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"image/png"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),t("h3",{attrs:{id:"retrying-a-failed-file-data-transaction-public-unbundled-files-only"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#retrying-a-failed-file-data-transaction-public-unbundled-files-only"}},[a._v("#")]),a._v(" Retrying a Failed File Data Transaction (Public Unbundled Files Only)"),t("a",{attrs:{id:"retry-tx"}})]),a._v(" "),t("p",[a._v("Arweave data upload transactions are split into two phases: transaction posting and chunks uploading. Once the transaction post phase has been completed, you've effectively \"paid\" the network for storage of the data chunks that you'll send in the next stage.")]),a._v(" "),t("p",[a._v("If your system encounters an error while posting the transaction, you can retry posting the transaction for as long as your tx_anchor is valid ("),t("a",{attrs:{href:"https://docs.arweave.org/developers/server/http-api#field-definitions",target:"_blank",rel:"noopener noreferrer"}},[a._v("learn more about tx_anchors here"),t("OutboundLink")],1),a._v("). You may retry and/or resume posting chunks at any time after your transaction has posted. The ArDrive CLI allows you to take advantage of this Arweave protocol capability.")]),a._v(" "),t("p",[a._v("Using the CLI, when the transaction post has succeeded but the chunk upload step fails, the data transaction's ID could be lost. There are a few options to recover this ID. If the failed transaction is the most recent one sent from a wallet, the transaction ID can be recovered with the "),t("code",[a._v("ardrive last-tx -w /path/to/wallet")]),a._v(" command AFTER the transaction's headers have been mined (It can take 5-10 minutes for the tx-id to become available with the last-tx approach). Other options for finding the partially uploaded transaction's ID include:")]),a._v(" "),t("ul",[t("li",[a._v("Using an Arweave gateway GQL http endpoint to search for transactions that belong to the wallet. See this "),t("a",{attrs:{href:"https://gql-guide.vercel.app/#owners",target:"_blank",rel:"noopener noreferrer"}},[a._v("Arweave GQL Guide"),t("OutboundLink")],1),a._v(" for more info.")]),a._v(" "),t("li",[a._v("Browse the recent transactions associated with the wallet via a block explorer tool like "),t("a",{attrs:{href:"https://viewblock.io/arweave/",target:"_blank",rel:"noopener noreferrer"}},[a._v("ViewBlock"),t("OutboundLink")],1),a._v(".")])]),a._v(" "),t("p",[a._v("In order to re-seed the chunks for an unbundled ArFS data transaction, a user must have the data transaction ID, the original file data, and either a destination folder ID or a valid file ID for the file. Supply that information to the "),t("code",[a._v("retry-tx")]),a._v(" command like so:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive retry-tx --tx-id "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v(" Data Transaction ID "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(" --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v(" Destination Folder ID "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(" --local-path /path/to/file --wallet-file /path/to/wallet\n")])])]),t("p",[t("strong",[a._v("Note: Retry feature is currently only available for PUBLIC unbundled file transactions. It is also perfectly safe to mistakenly re-seed the chunks of a healthy transaction, the transaction will remain stable and the wallet balance will not be affected.")])]),a._v(" "),t("h3",{attrs:{id:"moving-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#moving-files"}},[a._v("#")]),a._v(" Moving Files"),t("a",{attrs:{id:"moving-files"}})]),a._v(" "),t("p",[a._v("Files can be moved from one folder to another within the same drive. Moving a file is simply the process of uploading a new file metadata revision with an updated File ID <> Parent Folder ID relationship. The following command will move a file from its current location in a public drive to a new parent folder in that drive:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive move-file --file-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"e5ebc14c-5b2d-4462-8f59-7f4a62e7770f"')]),a._v(" --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"a2c8a0cb-0ca7-4dbb-8bf8-93f75f308e63"')]),a._v("\n")])])]),t("h3",{attrs:{id:"uploading-manifests"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#uploading-manifests"}},[a._v("#")]),a._v(" Uploading Manifests")]),a._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/ArweaveTeam/arweave/wiki/Path-Manifests",target:"_blank",rel:"noopener noreferrer"}},[a._v("Arweave Path Manifests"),t("OutboundLink")],1),a._v(" are are special "),t("code",[a._v(".json")]),a._v(" files that instruct Arweave Gateways to map file data associated with specific, unique transaction IDs to customized, hosted paths relative to that of the manifest file itself. So if, for example, your manifest file had an arweave.net URL like:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("https://arweave.net/"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("manifest tx id"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),t("p",[a._v("Then, all the mapped transactions and paths in the manifest file would be addressable at URLs like:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("https://arweave.net/"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("manifest tx id"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("/foo.txt\nhttps://arweave.net/"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("manifest tx id"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("/bar/baz.png\n")])])]),t("p",[a._v("ArDrive supports the creation of these Arweave manifests using any of your PUBLIC folders. The generated manifest paths will be links to each of the file entities within the specified folder. The manifest file entity will be created at the root of the folder.")]),a._v(" "),t("p",[a._v("To create a manifest of an entire public drive, specify the root folder of that drive:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive create-manifest "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"bc9af866-6421-40f1-ac89-202bddb5c487"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/path/to/wallet"')]),a._v("\n")])])]),t("p",[a._v("You can also create a manifest of a folder's file entities at a custom depth by using the "),t("code",[a._v("--max-depth")]),a._v(" option:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Create manifest of a folder's local file contents, excluding all sub-folders")]),a._v("\nardrive create-manifest --max-depth "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("0")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"867228d8-4413-4c0e-a499-e1decbf2ea38"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/path/to/wallet"')]),a._v("\n")])])]),t("p",[a._v("Creating a "),t("code",[a._v(".json")]),a._v(" file of your manifest links output can be accomplished here with some "),t("code",[a._v("jq")]),a._v(" parsing and piping to a file:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive create-manifest "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6c312b3e-4778-4a18-8243-f2b346f5e7cb"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" jq "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'{links}'")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" links.json\n")])])]),t("p",[a._v("If you'd like to preview the contents of your manifest before uploading, you can perform a dry run and do some lightweight post processing to isolate the data:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive create-manifest "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6c312b3e-4778-4a18-8243-f2b346f5e7cb"')]),a._v(" --dry-run "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" jq "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'{manifest}.manifest'")]),a._v("\n")])])]),t("p",[t("a",{attrs:{id:"manifest-json"}})]),a._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"manifest"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"arweave/paths"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"version"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"0.1.0"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"index"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"path"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"index.html"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"paths"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"hello_world.txt"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"id"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Y7GFF8r9y0MEU_oi1aZeD87vrmai97JdRQ2L0cbGJ68"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"index.html"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"id"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"pELonjVebHyBsdxVymvxbGTmHD96v9PuuUXj8GUHGoY"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),t("p",[a._v("The manifest data transaction is tagged with a unique content-type, "),t("code",[a._v("application/x.arweave-manifest+json")]),a._v(", which tells the gateway to treat this file as a manifest. The manifest file itself is a "),t("code",[a._v(".json")]),a._v(" file that holds the paths (the data transaction ids) to each file within the specified folder.")]),a._v(" "),t("p",[a._v("When your folder is later changed by adding files or updating them with new revisions, the original manifest will NOT be updated on its own. A manifest is a permanent record of your files in their current state.")]),a._v(" "),t("p",[a._v("However, creating a subsequent manifest with the same manifest name will create a new revision of that manifest in its new current state. Manifests follow the same name conflict resolution as outlined for files above (upsert by default).")]),a._v(" "),t("h4",{attrs:{id:"hosting-a-webpage-with-manifest"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hosting-a-webpage-with-manifest"}},[a._v("#")]),a._v(" Hosting a Webpage with Manifest")]),a._v(" "),t("p",[a._v("When creating a manifest, it is possible to host a webpage or web app. You can do this by creating a manifest on a folder that has an "),t("code",[a._v("index.html")]),a._v(" file in its root.")]),a._v(" "),t("p",[a._v("Using generated build folders from popular frameworks works as well. One requirement here to note is that the "),t("code",[a._v("href=")]),a._v(" paths from your generated "),t("code",[a._v("index.html")]),a._v(" file must not have leading a "),t("code",[a._v("/")]),a._v(". This means that the manifest will not resolve a path of "),t("code",[a._v("/dist/index.js")]),a._v(" but it will resolve "),t("code",[a._v("dist/index.js")]),a._v(" or "),t("code",[a._v("./dist/index.js")]),a._v(".")]),a._v(" "),t("p",[a._v("As an example, here is a flow of creating a React app and hosting it with an ArDrive Manifest. First, generate a React app:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[a._v("yarn")]),a._v(" create react-app my-app\n")])])]),t("p",[a._v("Next, add this field to the generated "),t("code",[a._v("package.json")]),a._v(" so that the paths will resolve correctly:")]),a._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"homepage"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"."')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n")])])]),t("p",[a._v("Then, create an optimized production build from within the app's directory:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[a._v("yarn")]),a._v(" build\n")])])]),t("p",[a._v("Now, we can create and upload that produced build folder on ArDrive to any of your existing ArFS folder entities:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-l")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/build"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/path/to/wallet"')]),a._v(" --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"bc9af866-6421-40f1-ac89-202bddb5c487"')]),a._v("\n")])])]),t("p",[a._v("And finally, create the manifest using the generated Folder ID from the build folder creation:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Create manifest using the Folder ID of the `/build` folder")]),a._v("\nardrive create-manifest "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"41759f05-614d-45ad-846b-63f3767504a4"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/path/to/wallet"')]),a._v("\n")])])]),t("p",[a._v("In the return output, the top link will be a link to the deployed web app:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"links"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://arweave.net/0MK68J8TqGhaaOpPe713Zn0jdpczMt2NGS2CtRYiuAg"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://arweave.net/0MK68J8TqGhaaOpPe713Zn0jdpczMt2NGS2CtRYiuAg/asset-manifest.json"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://arweave.net/0MK68J8TqGhaaOpPe713Zn0jdpczMt2NGS2CtRYiuAg/favicon.ico"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://arweave.net/0MK68J8TqGhaaOpPe713Zn0jdpczMt2NGS2CtRYiuAg/index.html"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# ...")]),a._v("\n")])])]),t("p",[a._v("This is effectively hosting a web app with ArDrive. Check out the ArDrive Price Calculator React App hosted as an "),t("a",{attrs:{href:"https://arweave.net/qozq9YIUPEHfZhoTp9DkBpJuA_KNULBnfLiMroj5pZI",target:"_blank",rel:"noopener noreferrer"}},[a._v("ArDrive Manifest"),t("OutboundLink")],1),a._v(".")]),a._v(" "),t("h3",{attrs:{id:"uploading-with-a-custom-content-type"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#uploading-with-a-custom-content-type"}},[a._v("#")]),a._v(" Uploading With a Custom Content Type"),t("a",{attrs:{id:"custom-content-type"}})]),a._v(" "),t("p",[a._v("Each file uploaded to the Arweave network receives a "),t("code",[a._v('"Content-Type"')]),a._v(" GraphQL tag that contains the MIME type for the file. The gateway will use this content type to determine how to serve that file's data transaction at the "),t("code",[a._v("arweave.net/{data tx id}")]),a._v(" endpoint.")]),a._v(" "),t("p",[a._v("By default, the CLI will attempt to derive this content type from the file extension of the provided file. In most cases, the content type that is derived will be correct and the gateway will properly serve the file.")]),a._v(" "),t("p",[a._v("The CLI also provides the option for users to upload files with a custom content type using the "),t("code",[a._v("--content-type")]),a._v(" flag:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file --content-type "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"application/json"')]),a._v(" --local-path /path/to/file --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("p",[a._v("It is currently possible to set this value to any given string, but the gateway will still only serve valid content types. Check out this list of commonly used MIME types to ensure you're providing a valid content type: "),t("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types",target:"_blank",rel:"noopener noreferrer"}},[a._v("Common MIME types"),t("OutboundLink")],1),a._v(".")]),a._v(" "),t("p",[a._v("Note: In the case of multi-file uploads or recursive folder uploads, setting this "),t("code",[a._v("--content-type")]),a._v(" flag will set the provided custom content type on EVERY file entity within a given upload.")]),a._v(" "),t("h3",{attrs:{id:"uploading-from-a-remote-url"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#uploading-from-a-remote-url"}},[a._v("#")]),a._v(" Uploading From a Remote URL"),t("a",{attrs:{id:"remote-path"}})]),a._v(" "),t("p",[a._v("You can upload a file from an existing url using the "),t("code",[a._v("--remote-path")]),a._v(" flag. This must be used in conjunction with "),t("code",[a._v("--dest-file-name")]),a._v(".")]),a._v(" "),t("p",[a._v("You can use a custom content type using the "),t("code",[a._v("--content-type")]),a._v(" flag, but if this isn't used the app will use the content type from the response header of the request for the remote data.")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file --remote-path "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"https://url/to/file"')]),a._v(" --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"example.jpg"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("h3",{attrs:{id:"uploading-a-custom-manifest"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#uploading-a-custom-manifest"}},[a._v("#")]),a._v(" Uploading a Custom Manifest"),t("a",{attrs:{id:"custom-manifest"}})]),a._v(" "),t("p",[a._v("Using the custom content type feature, it is possible for users to upload their own custom manifests. The Arweave gateways use this special content type in order to identify an uploaded file as a manifest:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("application/x.arweave-manifest+json\n")])])]),t("p",[a._v("In addition to this content type, the manifest must also adhere to the "),t("a",{attrs:{href:"#manifest-json"}},[a._v("correct JSON structure")]),a._v(" of an Arweave manifest. A user can create their own manifest from scratch, or start by piping a generated manifest to a JSON file and editing it to their specifications:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive create-manifest "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"6c312b3e-4778-4a18-8243-f2b346f5e7cb"')]),a._v(" --dry-run "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" jq "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'{manifest}.manifest'")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" my-custom-manifest.json\n")])])]),t("p",[a._v("After editing the generated manifest, simply perform an "),t("code",[a._v("upload-file")]),a._v(" command with the custom Arweave manifest content type to any PUBLIC folder:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file --content-type "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"application/x.arweave-manifest+json"')]),a._v(" --local-path my-custom-manifest.json --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"9af694f6-4cfc-4eee-88a8-1b02704760c0"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet.json\n")])])]),t("p",[a._v("The returned "),t("code",[a._v("dataTxId")]),a._v(" field on the created "),t("code",[a._v("file")]),a._v(" entity will be the endpoint that the manifest can be found on Arweave, just as explained in the "),t("a",{attrs:{href:"#uploading-manifests"}},[a._v("manifest sections")]),a._v(" above:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("https://arweave.net/"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("dataTxId"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\nhttps://arweave.net/"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("dataTxId"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("/custom-file-1\nhttps://arweave.net/"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("dataTxId"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("/custom-file-2\n")])])]),t("h3",{attrs:{id:"uploading-files-with-custom-metadata"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#uploading-files-with-custom-metadata"}},[a._v("#")]),a._v(" Uploading Files with Custom MetaData")]),a._v(" "),t("p",[a._v("ArDrive CLI has the capability of attaching custom metadata to ArFS File and Folder MetaData Transactions during the "),t("code",[a._v("upload-file")]),a._v(" command. This metadata can be applied to either the GQL tags on the MetaData Transaction and/or into the MetaData Transaction's Data JSON.")]),a._v(" "),t("p",[a._v("All custom metadata applied must ultimately adhere to the following JSON shapes:")]),a._v(" "),t("div",{staticClass:"language-ts extra-class"},[t("pre",{pre:!0,attrs:{class:"language-ts"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("// GQL Tags")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("type")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token class-name"}},[a._v("CustomMetaDataGqlTags")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v(" Record"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),t("span",{pre:!0,attrs:{class:"token builtin"}},[a._v("string")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token builtin"}},[a._v("string")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token builtin"}},[a._v("string")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(";")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("// Data JSON Fields")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("type")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token class-name"}},[a._v("CustomMetaDataJsonFields")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v(" Record"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),t("span",{pre:!0,attrs:{class:"token builtin"}},[a._v("string")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v(" JsonSerializable"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(";")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("export")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("type")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token class-name"}},[a._v("JsonSerializable")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token builtin"}},[a._v("string")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token builtin"}},[a._v("number")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token builtin"}},[a._v("boolean")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("null")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),a._v("member"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token builtin"}},[a._v("string")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" JsonSerializable "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" JsonSerializable"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(";")]),a._v("\n")])])]),t("p",[a._v("e.g:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v(" IPFS-Add: "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'MY_HASH'")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# or")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'Custom Name'")]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'Val 1'")]),a._v(", "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'Val 2'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),t("p",[a._v("When the custom metadata is attached to the MetaData Transaction's GQL tags, they will become visible on any Arweave GQL gateway and also third party tools that read GQL data.")]),a._v(" "),t("p",[a._v("When these tags are added to the MetaData Transaction's Data JSON they can be read by downloading the JSON data directly from "),t("code",[a._v("https://arweave.net/METADATA_TX_ID")]),a._v(".")]),a._v(" "),t("p",[a._v("To add this custom metadata to your file metadata transactions, CLI users can pass custom metadata these parameters:")]),a._v(" "),t("ul",[t("li",[t("code",[a._v("--metadata-file path/to/json/schema")])]),a._v(" "),t("li",[t("code",[a._v('--metadata-json \'{"key": "val", "key-2": true, "key-3": 420, "key-4": ["more", 1337]}\'')])]),a._v(" "),t("li",[t("code",[a._v('--metadata-gql-tags "Tag-Name" "Tag Val"')])])]),a._v(" "),t("p",[a._v("The "),t("code",[a._v("--metadata-file")]),a._v(" will accept a file path to JSON file containing custom metadata:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive upload-file --metadata-file path/to/metadata/json "),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# ...")]),a._v("\n")])])]),t("p",[a._v("This JSON schema object must contain instructions on where to put this metadata with the "),t("code",[a._v("metaDataJson")]),a._v(" and "),t("code",[a._v("metaDataGqlTags")]),a._v(" keys. e.g:")]),a._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"metaDataJson"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"Tag-Name"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Value-1"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Value-2"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"metaDataGqlTags"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"GQL Tag Name"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Tag Value"')]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),t("p",[a._v("The "),t("code",[a._v("--metadata-gql-tags")]),a._v(" parameter accepts an array of string values to be applied to the MetaData Tx GQL Tags. This method of CLI input does not support multiple tag values for a given tag name and the input must be an EVEN number of string values. (Known bug: String values starting with the "),t("code",[a._v('"-"')]),a._v(" character are currently not supported. Use --metadata-file parameter instead.) e.g:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("upload-file --metadata-gql-tags "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Custom Tag Name"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Custom Value"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# ...")]),a._v("\n")])])]),t("p",[a._v("And the "),t("code",[a._v("--metadata-json")]),a._v(" parameter will accept a stringified JSON input. It will apply all declared JSON fields directly to the MetaData Tx's Data JSON. e.g:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v(" upload-file --metadata-json "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('\' { "json field": "value", "another fields": false } \'')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# ...")]),a._v("\n")])])]),t("p",[a._v("Custom metadata applied to files and/or folders during the "),t("code",[a._v("upload-file")]),a._v(" command will be read back through all existing read commands. e.g:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ardrive file-info "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" 067c4008-9cbe-422e-b697-05442f73da2b\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appName"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ArDrive-CLI"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"appVersion"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"1.17.0"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"arFS"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"0.11"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"contentType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"application/json"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"driveId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"967215ca-a489-494b-97ec-0dd428d7be34"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"name"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"unique-name-9718"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"txId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"sxg8bNu6_bbaHkJTxAINVVoz_F-LiFe6s7OnxzoJJk4"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"unixTime"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1657655070")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"size"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("262148")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"lastModifiedDate"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1655409872705")]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"dataTxId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ublZcIff77ejl3m0uEA8lXEfnTWmSBOFoz-HibqKeyk"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"dataContentType"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"text/plain"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"parentFolderId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"97bc4fb5-aca4-4ffe-938f-1285153d98ca"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"entityId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"067c4008-9cbe-422e-b697-05442f73da2b"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"fileId"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"067c4008-9cbe-422e-b697-05442f73da2b"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"IPFS-Add"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"MY_HASH"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Tag-1"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Val"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Tag-2"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Val"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Tag-3"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Val"')]),a._v(",\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Boost"')]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"1.05"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),t("h4",{attrs:{id:"applying-unique-custom-metadata-during-bulk-workflows"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#applying-unique-custom-metadata-during-bulk-workflows"}},[a._v("#")]),a._v(" Applying Unique Custom MetaData During Bulk Workflows")]),a._v(" "),t("p",[a._v("With some custom scripting and the "),t("code",[a._v("--metadata-file")]),a._v(" parameter, the ArDrive CLI can be used to apply custom metadata to each file individually in a bulk workflow. For example, if you choose a numbered file naming pattern you can make use of a "),t("code",[a._v("for")]),a._v(" loop:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("for")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token for-or-select variable"}},[a._v("i")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("in")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("..")]),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("5")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("do")]),a._v("\nardrive upload-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-F")]),a._v(" f0c58c11-430c-4383-8e54-4d864cc7e927 --local-path "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"../uploads/test-file-'),t("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$i")]),a._v('.txt"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"/path/to/wallet.json"')]),a._v(" --metadata-file "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"../custom/metadata-'),t("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$i")]),a._v('.json"')]),a._v(" --dry-run "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file-result-'),t("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$i")]),a._v('.json"')]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("done")]),a._v("\n")])])]),t("h2",{attrs:{id:"other-utility-operations"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#other-utility-operations"}},[a._v("#")]),a._v(" Other Utility Operations")]),a._v(" "),t("h3",{attrs:{id:"monitoring-transactions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#monitoring-transactions"}},[a._v("#")]),a._v(" Monitoring Transactions")]),a._v(" "),t("p",[a._v("Block time on Arweave is typically between 2-3 minutes in duration, so transactions can be mined within that time frame when "),t("a",{attrs:{href:"#dealing-with-network-congestion"}},[a._v("network congestion")]),a._v(" is low. Transactions, in the general case, proceed through the following set of states:")]),a._v(" "),t("ul",[t("li",[a._v('Pending: the transaction is waiting the "mempool" to be mined')]),a._v(" "),t("li",[a._v("Confirming: the transaction was mined on an Arweave Node, but has not yet been confirmed by at least 15 total nodes on the network")]),a._v(" "),t("li",[a._v("Confirmed: the transaction was mined on an Arweave Node and confirmed by at least 15 total nodes on the network")]),a._v(" "),t("li",[a._v("Not Found: the transaction is not available for any of the following reasons:\n"),t("ul",[t("li",[a._v("Insufficient reward to join the mempool")]),a._v(" "),t("li",[a._v("Insufficient reward to be mined within 50 blocks during a period of network congestion")]),a._v(" "),t("li",[a._v("Transaction is transitioning between states")]),a._v(" "),t("li",[a._v("Transaction ID is invalid")])])])]),a._v(" "),t("p",[a._v("Monitor any Arweave transaction's status via its transaction ID by performing:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Peek at the status:")]),a._v("\nardrive tx-status "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-t")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ekSMckikdRJ8RGIkFa-X3xq3427tvM7J9adv8HP3Bzs"')]),a._v("\n")])])]),t("p",[a._v("Example output:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[a._v("ekSMckikdRJ8RGIkFa-X3xq3427tvM7J9adv8HP3Bzs: Mined at block height "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("775810")]),a._v(" with "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("22439")]),a._v(" confirmations\n")])])]),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Reprint the status every 10 seconds:")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("watch")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-n")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("10")]),a._v(" ardrive tx-status "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-t")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ekSMckikdRJ8RGIkFa-X3xq3427tvM7J9adv8HP3Bzs"')]),a._v("\n")])])]),t("h3",{attrs:{id:"dealing-with-network-congestion"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dealing-with-network-congestion"}},[a._v("#")]),a._v(" Dealing With Network Congestion")]),a._v(" "),t("p",[a._v("Currently, Arweave blocks hold up to 1000 transactions per block. The \"mempool\", where pending transactions reside until they've been included into a block, will only hold a transaction for 50 blocks (~100-150 minutes) before it's discarded by the network resulting in no fees or data being transacted. During periods of network congestion (i.e. those where the mempool contains 1000 or more pending transactions), it may make sense to either:")]),a._v(" "),t("p",[a._v("a) wait for congestion to dissipate before attempting your transactions.")]),a._v(" "),t("p",[a._v("b) apply the fee boost multiplier to your transactions rewards with the --boost parameter during write operations in order to front-run some of the congestion.")]),a._v(" "),t("h4",{attrs:{id:"check-for-network-congestion-before-uploading"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#check-for-network-congestion-before-uploading"}},[a._v("#")]),a._v(" Check for network congestion before uploading"),t("a",{attrs:{id:"check-congestion"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# See all the transactions in the mempool")]),a._v("\nardrive get-mempool\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Return the count of the transactions in the mempool")]),a._v("\nardrive get-mempool "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" jq "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'length'")]),a._v("\n")])])]),t("h4",{attrs:{id:"front-run-congestion-by-boosting-miner-rewards"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#front-run-congestion-by-boosting-miner-rewards"}},[a._v("#")]),a._v(" Front-run Congestion By Boosting Miner Rewards"),t("a",{attrs:{id:"boost"}})]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Increase the miner reward on your transactions by 50%")]),a._v("\nardrive upload-file --wallet-file /path/to/my/wallet.json --parent-folder-id "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"f0c58c11-430c-4383-8e54-4d864cc7e927"')]),a._v(" --local-path ./helloworld.txt "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--boost")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1.5")]),a._v("\n")])])]),t("h4",{attrs:{id:"send-ar-transactions-from-a-cold-wallet"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#send-ar-transactions-from-a-cold-wallet"}},[a._v("#")]),a._v(" Send AR Transactions From a Cold Wallet"),t("a",{attrs:{id:"cold-tx"}})]),a._v(" "),t("p",[a._v("The best cold wallet storage never exposes your seed phrase and/or private keys to the Internet or a compromised system interface. You can use the ArDrive CLI to facilitate cold storage and transfer of AR.")]),a._v(" "),t("p",[a._v("If you need a new cold AR wallet, generate one from an air-gapped machine capable of running the ArDrive CLI by following the instructions in the "),t("a",{attrs:{href:"#wallet-operations"}},[a._v("Wallet Operations")]),a._v(" section. Fund your cold wallet from whatever external sources you'd like. NOTE: Your cold wallet won't appear on chain until it has received AR.")]),a._v(" "),t("p",[a._v("The workflow to send the AR out from your cold wallet requires you to generate a signed transaction with your cold wallet on your air-gapped machine via the ArDrive CLI, and then to transfer the signed transaction (e.g. by a file on a clean thumb drive) to an Internet-connected machine and send the transaction to the network via the ArDrive CLI. You'll need two inputs from the Internet-connected machine:")]),a._v(" "),t("ul",[t("li",[a._v("the last transaction sent OUT from the cold wallet (or an empty string if none has ever been sent out)")]),a._v(" "),t("li",[a._v("the base fee for an Arweave transaction (i.e. a zero bye transaction). Note that this value could change if a sufficient amount of time passes between the time you fetch this value, create the transaction, and send the transaction.")])]),a._v(" "),t("p",[a._v("To get the last transaction sent from your cold wallet, use the "),t("code",[a._v("last-tx")]),a._v(" command and specify your wallet address e.g.:")]),a._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v("ardrive last-tx -a \n")])])]),t("p",[a._v("To get the base transaction reward required for an AR transaction, use the "),t("code",[a._v("base-reward")]),a._v(" function, optionally applying a reward boost multiple if you're looking to front-run network congestion:")]),a._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v("ardrive base-reward --boost 1.5\n")])])]),t("p",[a._v("Write down or securely copy the values you derived from the Internet-connected machine and run the following commands on the airgapped machine, piping the outputted signed transaction data to a file in the process, e.g. "),t("code",[a._v("sendme.json")]),a._v(" (if that's your signed transaction transfer medium preference):")]),a._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v('ardrive create-tx -w /path/to/wallet/file.json -d -a --last-tx --reward "" > sendme.json\n')])])]),t("p",[a._v("Transport your signed transaction to the Internet-connected machine and run the following command to send your transaction to the Arweave network:")]),a._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v("ardrive send-tx -x /path/to/sendme.json\n")])])]),t("h3",{attrs:{id:"using-a-custom-arweave-gateway"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-a-custom-arweave-gateway"}},[a._v("#")]),a._v(" Using a Custom Arweave Gateway")]),a._v(" "),t("p",[a._v("On each command that uses a gateway, it is possible to supply your own custom Arweave gateway using the flag "),t("code",[a._v("--gateway")]),a._v(" or by setting an environment variable named "),t("code",[a._v("ARWEAVE_GATEWAY")]),a._v(".")]),a._v(" "),t("p",[a._v("For example, you could test out that your ArFS transactions are working as expected on a local test network such as "),t("a",{attrs:{href:"https://github.com/textury/arlocal",target:"_blank",rel:"noopener noreferrer"}},[a._v("ArLocal"),t("OutboundLink")],1),a._v(" with this flow:")]),a._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Setup ArLocal instance on port 1984")]),a._v("\nnpx arlocal\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# In another terminal, fund your wallet with AR")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" http://localhost:1984/mint/"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v(" your public wallet address "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("/99999999999999\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Create drive and root folder on ArLocal using `--gateway` flag")]),a._v("\nardrive create-drive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--gateway")]),a._v(" http://127.0.0.1:1984 "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-n")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'my-test-drive'")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Setup ARWEAVE_GATEWAY as ENV variable")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("export")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[a._v("ARWEAVE_GATEWAY")]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"http://localhost:1984"')]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Mine block with drive + root folder transactions")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$ARWEAVE_GATEWAY")]),a._v('/mine"')]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Upload file to ArLocal with ENV var")]),a._v("\nardrive upload-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-F")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v(" root folder "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("id")]),a._v(" from create drive "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-l")]),a._v(" /path/to/file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-w")]),a._v(" /path/to/wallet\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Mine block with file transaction")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$ARWEAVE_GATEWAY")]),a._v('/mine"')]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Inspect meta data of created entities")]),a._v("\nardrive list-drive "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v(" drive "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("id")]),a._v(" from create drive "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Download file to verify integrity")]),a._v("\nardrive download-file "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("file")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("id")]),a._v(" from upload "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("file")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),t("h3",{attrs:{id:"persistent-caching-of-arfs-entity-metadata"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#persistent-caching-of-arfs-entity-metadata"}},[a._v("#")]),a._v(" Persistent Caching of ArFS Entity Metadata"),t("a",{attrs:{id:"metadata-caching"}})]),a._v(" "),t("p",[a._v("To avoid redundant requests to the Arweave network for immutable ArFS entity metadata, a persistent file cache is created and maintained at:")]),a._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v("Windows: /ardrive-caches/metadata\nNon-Windows: /.ardrive/caches/metadata\n")])])]),t("p",[a._v("The "),t("code",[a._v("XDG_CACHE_HOME")]),a._v(" environment variable is honored, where applicable, and will be used in place of "),t("code",[a._v("os.homedir()")]),a._v(" in the scenarios described above.")]),a._v(" "),t("p",[a._v("Metadata cache logging to stderr can be enabled by setting the "),t("code",[a._v("ARDRIVE_CACHE_LOG")]),a._v(" environment variable to "),t("code",[a._v("1")]),a._v(".")]),a._v(" "),t("p",[a._v("Cache performance is UNDEFINED for multi-process scenarios, but is presumed to be generally usable.")]),a._v(" "),t("p",[a._v("The cache can be manually cleared safely at any time that any integrating app is not in operation.")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/28.478b5652.js b/assets/js/28.d4be7657.js similarity index 99% rename from assets/js/28.478b5652.js rename to assets/js/28.d4be7657.js index 74c1c5f..ceb2d54 100644 --- a/assets/js/28.478b5652.js +++ b/assets/js/28.d4be7657.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[28],{309:function(t,a,s){"use strict";s.r(a);var e=s(10),n=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h2",{attrs:{id:"overview"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#overview"}},[t._v("#")]),t._v(" Overview")]),t._v(" "),a("p",[t._v("ArDrive Core is a TypeScript library that contains the essential back end application features to support the ArDrive CLI and Desktop apps, such as file management, Permaweb upload/download, wallet management, and other common functions.")]),t._v(" "),a("p",[t._v("Engage with the community in "),a("a",{attrs:{href:"https://discord.gg/7RuTBckX",target:"_blank",rel:"noopener noreferrer"}},[t._v("Discord"),a("OutboundLink")],1),t._v(" for more information.")]),t._v(" "),a("h2",{attrs:{id:"integrating-with-ardrive-core"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#integrating-with-ardrive-core"}},[t._v("#")]),t._v(" Integrating with ArDrive Core")]),t._v(" "),a("p",[t._v("To add the ArDrive Core library to your project, simply add it as a dependency:")]),t._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("yarn")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("add")]),t._v(" ardrive-core-js\n")])])]),a("p",[t._v("The recommended approach for integrating with ArDrive Core as a dependency in your project is to construct and use the methods provided on the "),a("code",[t._v("ArDrive")]),t._v(" class. Developers can use the convenience function "),a("code",[t._v("arDriveFactory")]),t._v(" to construct the "),a("code",[t._v("ArDrive")]),t._v(" class.")]),t._v(" "),a("p",[t._v("Below are a few common examples of interacting with Core:")]),t._v(" "),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" readJWKFile"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" arDriveFactory "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ardrive-core-js'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Read wallet from file")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myWallet "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("readJWKFile")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'/path/to/wallet'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Construct ArDrive class")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")])]),t._v(" arDrive "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("arDriveFactory")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" wallet"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" myWallet "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create a public drive and its root folder")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" createDriveResult "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" arDrive"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("createPublicDrive")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" driveName"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'My-Drive'")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" wrapFileOrFolder"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("EID")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ardrive-core-js'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Wrap file for upload")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" wrappedEntity "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("wrapFileOrFolder")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'path/to/file'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Construct a safe Entity ID Type")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" destFolderId "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("EID")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10108b54a-eb5e-4134-8ae2-a3946a428ec7'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Upload a public file to destination folder")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" uploadFileResult "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" arDrive"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("uploadAllEntities")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n entitiesToUpload"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" wrappedEntity"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" destFolderId "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" deriveDriveKey "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ardrive-core-js'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Derive a private drive key from password, wallet, and drive ID")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" driveKey "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("deriveDriveKey")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'mySecretPassWord'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'12345674a-eb5e-4134-8ae2-a3946a428ec7'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("JSON")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringify")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("myWallet "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("as")]),t._v(" JWKWallet"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getPrivateKey")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create a private folder")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" createFolderResult "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" arDrive"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("createPrivateFolder")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n folderName"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'My New Private Folder'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n driveKey"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n parentFolderId"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("EID")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'47162534a-eb5e-4134-8ae2-a3946a428ec7'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" wrapFileOrFolder"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" EntityKey"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("EID")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ardrive-core-js'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Derive a private drive key from raw drive key string")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" driveKey "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("EntityKey")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Buffer"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("from")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MyAwesomeDriveKeyZZZZZZZZZZZZZZZZZZZZFAKE/s'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'base64'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Wrap folder and all of its contents for upload")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" wrappedFolder "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("wrapFileOrFolder")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'path/to/folder'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Upload a private folder and all its contents")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" uploadFileResult "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" arDrive"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("uploadAllEntities")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n entitiesToUpload"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n wrappedEntity"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" wrappedFolder"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n destFolderId"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("EID")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'76543214a-eb5e-4134-8ae2-a3946a428ec7'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n driveKey\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// And some other public file to a different destination 🤯")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n wrappedEntity"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" someOtherWrappedFile\n destFolderId"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("EID")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'675489321-eb5e-4134-8ae2-a3946a428ec7'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Upload ArFS Entities To Turbo (BETA)")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// The presence of `turboSettings` in `arDriveFactory` enables sending to Turbo")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" arDrive "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("arDriveFactory")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" wallet"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" myWallet"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" turboSettings"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" uploadFileResult "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" arDrive"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("uploadAllEntities")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n entitiesToUpload"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" wrappedEntity"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" destFolderId "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"development-environment-setup"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#development-environment-setup"}},[t._v("#")]),t._v(" Development Environment Setup")]),t._v(" "),a("p",[t._v("We use nvm to manage our Node engine version and, if necessary, to install an npm version that we can then use to install Yarn.")]),t._v(" "),a("p",[t._v("Note for Windows: "),a("strong",[t._v("We recommend using WSL")]),t._v(" for setting up NVM on Windows using the "),a("a",{attrs:{href:"https://code.visualstudio.com/docs/remote/wsl",target:"_blank",rel:"noopener noreferrer"}},[t._v("instructions described here"),a("OutboundLink")],1),t._v(" then continue the steps below.")]),t._v(" "),a("ol",[a("li",[a("p",[t._v("Install nvm "),a("a",{attrs:{href:"https://github.com/nvm-sh/nvm#installing-and-updating",target:"_blank",rel:"noopener noreferrer"}},[t._v("using their instructions"),a("OutboundLink")],1),t._v(".")])]),t._v(" "),a("li",[a("p",[t._v("We use Node 18.x -- ensure that the correct Node version is installed and activated by performing "),a("code",[t._v("nvm install")]),t._v(" and then "),a("code",[t._v("nvm use")])])]),t._v(" "),a("li",[a("p",[t._v("We use Yarn 3.x please "),a("a",{attrs:{href:"https://yarnpkg.com/getting-started/install",target:"_blank",rel:"noopener noreferrer"}},[t._v("follow the installation guidelines here"),a("OutboundLink")],1)])]),t._v(" "),a("li",[a("p",[t._v("We use husky 6.x to manage the git commit hooks that help to improve the quality of our commits. Please run:\n"),a("code",[t._v("yarn husky install")]),t._v("\nto enable git hooks for this local repository. Without doing so, you risk committing non-compliant code to the repository.")])]),t._v(" "),a("li",[a("p",[t._v("Install all node package dependencies by running "),a("code",[t._v("yarn install --check-cache")])])])]),t._v(" "),a("h3",{attrs:{id:"recommended-visual-studio-code-extensions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#recommended-visual-studio-code-extensions"}},[t._v("#")]),t._v(" Recommended Visual Studio Code extensions")]),t._v(" "),a("p",[t._v("To ensure your environment is compatible, we also recommend the following VSCode extensions:")]),t._v(" "),a("ul",[a("li",[a("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint",target:"_blank",rel:"noopener noreferrer"}},[t._v("ES-Lint"),a("OutboundLink")],1)]),t._v(" "),a("li",[a("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig",target:"_blank",rel:"noopener noreferrer"}},[t._v("Editor-Config"),a("OutboundLink")],1)]),t._v(" "),a("li",[a("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode",target:"_blank",rel:"noopener noreferrer"}},[t._v("Prettier"),a("OutboundLink")],1)]),t._v(" "),a("li",[a("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=arcanis.vscode-zipfs",target:"_blank",rel:"noopener noreferrer"}},[t._v("ZipFS"),a("OutboundLink")],1)])]),t._v(" "),a("h2",{attrs:{id:"building-the-library"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#building-the-library"}},[t._v("#")]),t._v(" Building the Library")]),t._v(" "),a("p",[t._v("Simply run "),a("code",[t._v("yarn build")]),t._v(". This will clean the project and compile the TypeScript library.")]),t._v(" "),a("h2",{attrs:{id:"testing-the-library"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#testing-the-library"}},[t._v("#")]),t._v(" Testing the Library")]),t._v(" "),a("p",[t._v("This library is setup for "),a("a",{attrs:{href:"https://github.com/mochajs/mocha",target:"_blank",rel:"noopener noreferrer"}},[t._v("Mocha"),a("OutboundLink")],1),t._v(" testing with "),a("a",{attrs:{href:"https://github.com/chaijs/chai",target:"_blank",rel:"noopener noreferrer"}},[t._v("Chai"),a("OutboundLink")],1),t._v(" and "),a("a",{attrs:{href:"https://github.com/sinonjs/sinon",target:"_blank",rel:"noopener noreferrer"}},[t._v("Sinon"),a("OutboundLink")],1),t._v(". Configuration for Mocha can be found in "),a("code",[t._v(".mocharc.js")])]),t._v(" "),a("p",[t._v("To run all of the tests use:")]),t._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("yarn")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("test")]),t._v("\n")])])]),a("p",[t._v("To run a specific test, use Mocha's "),a("a",{attrs:{href:"https://mochajs.org/#-grep-regexp-g-regexp",target:"_blank",rel:"noopener noreferrer"}},[t._v("grep"),a("OutboundLink")],1),t._v(" command. This will cause Mocha to only run the tests that contain the provided RegExp.")]),t._v(" "),a("p",[t._v("The "),a("code",[t._v("-g")]),t._v(" command will "),a("strong",[t._v("only")]),t._v(" match the characters used in the "),a("code",[t._v("describe()")]),t._v(" and "),a("code",[t._v("it()")]),t._v(" title arguments. It will "),a("strong",[t._v("not")]),t._v(" match files names or folders.")]),t._v(" "),a("p",[t._v("For example:")]),t._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("yarn")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("test")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-g")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'My specific unit test'")]),t._v("\n")])])]),a("p",[t._v("Will run this test:")]),t._v(" "),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("describe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'My specific unit test'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("it")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'functions correctly'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ...")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h3",{attrs:{id:"coverage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#coverage"}},[t._v("#")]),t._v(" Coverage")]),t._v(" "),a("p",[a("a",{attrs:{href:"https://github.com/istanbuljs/nyc",target:"_blank",rel:"noopener noreferrer"}},[t._v("Istanbul.js (nyc)"),a("OutboundLink")],1),t._v(" has been added for code coverage reporting. Configuration for the nyc package can be found in "),a("code",[t._v("nyc.config.js")])]),t._v(" "),a("p",[t._v("On each "),a("code",[t._v("yarn test")]),t._v(" command, nyc will output a code coverage summary in the terminal. In addition, a more detailed HTML version will output to the "),a("code",[t._v("/coverage")]),t._v(" directory. Simply run "),a("code",[t._v("/coverage/index.html")]),t._v(" in your browser to view the HTML version.")]),t._v(" "),a("p",[t._v("Alternatively, you can view a verbose coverage output in the terminal by running:")]),t._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("yarn")]),t._v(" coverage\n")])])]),a("h3",{attrs:{id:"adding-tests"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#adding-tests"}},[t._v("#")]),t._v(" Adding tests")]),t._v(" "),a("p",[t._v("There are many different syntax options available with the Chai library, which can be found in their "),a("a",{attrs:{href:"https://www.chaijs.com/api/bdd/",target:"_blank",rel:"noopener noreferrer"}},[t._v("documentation"),a("OutboundLink")],1),t._v(". For examples on unit testing, visit "),a("code",[t._v("src/example.test.ts")]),t._v(", and for integration testing: "),a("code",[t._v("tests/example.test.ts")]),t._v(".")]),t._v(" "),a("p",[t._v("Unit tests should be located adjacent (or right next to) the file they are referencing. They should also be named the same with the "),a("code",[t._v(".test.ts")]),t._v(" extension. In contrast, integration tests will live in the "),a("code",[t._v("/tests")]),t._v(" directory.")]),t._v(" "),a("p",[t._v("For example:")]),t._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[t._v("ardrive-core-js/\n├── src\n│ ├── fileToTest.ts\n│ └── fileToTest.test.ts "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("-- Unit "),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("test")]),t._v("\n└── tests\n └── bestApi.test.ts "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("----- Integration "),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("test")]),t._v("\n")])])]),a("h3",{attrs:{id:"using-sinon"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#using-sinon"}},[t._v("#")]),t._v(" Using Sinon")]),t._v(" "),a("p",[t._v("Sinon can be used to create spies, mocks, fakes, stubs, and more. There are some basic examples of using the library shown in the example test files shared above.")]),t._v(" "),a("p",[t._v("For more information on what you can do with Sinon, visit their "),a("a",{attrs:{href:"https://sinonjs.org/releases/latest",target:"_blank",rel:"noopener noreferrer"}},[t._v("documentation"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("h3",{attrs:{id:"debugging-with-power-assert"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#debugging-with-power-assert"}},[t._v("#")]),t._v(" Debugging with Power-Assert")]),t._v(" "),a("p",[a("a",{attrs:{href:"https://github.com/power-assert-js/power-assert",target:"_blank",rel:"noopener noreferrer"}},[t._v("Power-Assert"),a("OutboundLink")],1),t._v(" is setup as another testing tool. The library can be used to provide a very detailed output of your failing test cases. This can become super useful while debugging a test.")]),t._v(" "),a("p",[t._v("To use this tool, it must be imported using this syntax:")]),t._v(" "),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" assert "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("require")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'assert'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("Then use "),a("code",[t._v("assert")]),t._v(" in your error throwing test case. Commenting out the Chai assertion will produce a cleaner output:")]),t._v(" "),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// expect(failingOutput).to.equal(expectedOutput);")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("assert")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("failingOutput "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" expectedOutput"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("And finally, to view the detailed error messages in your terminal:")]),t._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("yarn")]),t._v(" power-assert "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-g")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'My test case'")]),t._v("\n")])])]),a("h3",{attrs:{id:"progress-logging-of-transaction-uploads"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#progress-logging-of-transaction-uploads"}},[t._v("#")]),t._v(" Progress Logging of Transaction Uploads")]),t._v(" "),a("p",[t._v("Progress logging of transaction uploads to stderr can be enabled by setting the "),a("code",[t._v("ARDRIVE_PROGRESS_LOG")]),t._v(" environment variable to "),a("code",[t._v("1")]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[t._v("Uploading "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("file")]),t._v(" transaction "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" of total "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),t._v(" transactions"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("..")]),t._v(".\nTransaction _GKQasQX194a364Hph8Oe-oku1AdfHwxWOw9_JC1yjc Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v("%\nTransaction _GKQasQX194a364Hph8Oe-oku1AdfHwxWOw9_JC1yjc Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("35")]),t._v("%\nTransaction _GKQasQX194a364Hph8Oe-oku1AdfHwxWOw9_JC1yjc Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("66")]),t._v("%\nTransaction _GKQasQX194a364Hph8Oe-oku1AdfHwxWOw9_JC1yjc Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),t._v("%\nUploading "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("file")]),t._v(" transaction "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),t._v(" of total "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),t._v(" transactions"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("..")]),t._v(".\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("13")]),t._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("28")]),t._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("42")]),t._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("60")]),t._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("76")]),t._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("91")]),t._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),t._v("%\n")])])]),a("h3",{attrs:{id:"persistent-caching-of-arfs-entity-metadata"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#persistent-caching-of-arfs-entity-metadata"}},[t._v("#")]),t._v(" Persistent Caching of ArFS Entity Metadata")]),t._v(" "),a("p",[t._v("To avoid redundant requests to the Arweave network for immutable ArFS entity metadata, a persistent file cache is created and maintained at:")]),t._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[t._v("Windows: "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("os.homedir"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v("/ardrive-caches/metadata\nNon-Windows: "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("os.homedir"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v("/.ardrive/caches/metadata\n")])])]),a("p",[t._v("The "),a("code",[t._v("XDG_CACHE_HOME")]),t._v(" environment variable is honored, where applicable, and will be used in place of "),a("code",[t._v("os.homedir()")]),t._v(" in the scenarios described above.")]),t._v(" "),a("p",[t._v("Metadata cache logging to stderr can be enabled by setting the "),a("code",[t._v("ARDRIVE_CACHE_LOG")]),t._v(" environment variable to "),a("code",[t._v("1")]),t._v(".")]),t._v(" "),a("p",[t._v("Cache performance is UNDEFINED for multi-process scenarios, but is presumed to be generally usable.")]),t._v(" "),a("p",[t._v("The cache can be manually cleared safely at any time that any integrating app is not in operation.")]),t._v(" "),a("h3",{attrs:{id:"applying-custom-metadata-to-arfs-file-transactions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#applying-custom-metadata-to-arfs-file-transactions"}},[t._v("#")]),t._v(" Applying Custom MetaData to ArFS File Transactions")]),t._v(" "),a("p",[t._v("Custom metadata can be attached to ArFS File Transactions. Metadata can be applied to either the GQL tags on the MetaData Transaction, the MetaData Transaction's Data JSON, or both.")]),t._v(" "),a("p",[t._v("All custom tags can be accessed by using by using "),a("code",[t._v("ArDrive")]),t._v(" class read methods such as "),a("code",[t._v("getPublicFile")]),t._v(", "),a("code",[t._v("getPrivateFile")]),t._v(", "),a("code",[t._v("listPrivateFolder")]),t._v(", etc.")]),t._v(" "),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" arDrive "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("arDriveAnonymousFactory")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" fileInfo "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" arDrive"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getPublicFile")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" fileId "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myMetaDataGqlTags "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" fileInfo"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("customMetaDataGqlTags"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myMetaDataJsonFields "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" fileInfo"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("customMetaDataJson"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("When the custom metadata is attached to the MetaData Transaction's GQL tags, they will become visible on any Arweave GQL gateway and also third party tools that read GQL data.")]),t._v(" "),a("p",[t._v("When these tags are added to the MetaData Transaction's Data JSON they can be read by downloading the JSON data directly from "),a("code",[t._v("https://arweave.net/")]),t._v(".")]),t._v(" "),a("p",[t._v("To add this custom metadata to your file metadata transactions, users can pass an object containing custom tags when wrapping content to upload:")]),t._v(" "),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" fileToUpload "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("wrapFileOrFolder")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'path/to/file/on/system'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// File or Folder Path")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'application/custom-content-type'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Custom Content Type")]),t._v("\n customMetaData"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Custom MetaData")]),t._v("\n metaDataJson"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'My-Custom-Tag-Name'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Single-Custom-Value'")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n metaDataGqlTags"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Another-Custom-Tag'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'First-Custom-Value'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Second-Custom-Value'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Third-Custom-Value'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[28],{307:function(t,a,s){"use strict";s.r(a);var e=s(10),n=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h2",{attrs:{id:"overview"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#overview"}},[t._v("#")]),t._v(" Overview")]),t._v(" "),a("p",[t._v("ArDrive Core is a TypeScript library that contains the essential back end application features to support the ArDrive CLI and Desktop apps, such as file management, Permaweb upload/download, wallet management, and other common functions.")]),t._v(" "),a("p",[t._v("Engage with the community in "),a("a",{attrs:{href:"https://discord.gg/7RuTBckX",target:"_blank",rel:"noopener noreferrer"}},[t._v("Discord"),a("OutboundLink")],1),t._v(" for more information.")]),t._v(" "),a("h2",{attrs:{id:"integrating-with-ardrive-core"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#integrating-with-ardrive-core"}},[t._v("#")]),t._v(" Integrating with ArDrive Core")]),t._v(" "),a("p",[t._v("To add the ArDrive Core library to your project, simply add it as a dependency:")]),t._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("yarn")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("add")]),t._v(" ardrive-core-js\n")])])]),a("p",[t._v("The recommended approach for integrating with ArDrive Core as a dependency in your project is to construct and use the methods provided on the "),a("code",[t._v("ArDrive")]),t._v(" class. Developers can use the convenience function "),a("code",[t._v("arDriveFactory")]),t._v(" to construct the "),a("code",[t._v("ArDrive")]),t._v(" class.")]),t._v(" "),a("p",[t._v("Below are a few common examples of interacting with Core:")]),t._v(" "),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" readJWKFile"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" arDriveFactory "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ardrive-core-js'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Read wallet from file")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myWallet "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("readJWKFile")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'/path/to/wallet'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Construct ArDrive class")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token class-name"}},[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")])]),t._v(" arDrive "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("arDriveFactory")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" wallet"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" myWallet "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create a public drive and its root folder")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" createDriveResult "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" arDrive"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("createPublicDrive")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" driveName"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'My-Drive'")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" wrapFileOrFolder"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("EID")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ardrive-core-js'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Wrap file for upload")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" wrappedEntity "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("wrapFileOrFolder")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'path/to/file'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Construct a safe Entity ID Type")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" destFolderId "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("EID")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10108b54a-eb5e-4134-8ae2-a3946a428ec7'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Upload a public file to destination folder")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" uploadFileResult "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" arDrive"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("uploadAllEntities")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n entitiesToUpload"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" wrappedEntity"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" destFolderId "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" deriveDriveKey "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ardrive-core-js'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Derive a private drive key from password, wallet, and drive ID")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" driveKey "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("deriveDriveKey")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'mySecretPassWord'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'12345674a-eb5e-4134-8ae2-a3946a428ec7'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("JSON")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringify")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("myWallet "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("as")]),t._v(" JWKWallet"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getPrivateKey")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create a private folder")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" createFolderResult "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" arDrive"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("createPrivateFolder")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n folderName"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'My New Private Folder'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n driveKey"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n parentFolderId"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("EID")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'47162534a-eb5e-4134-8ae2-a3946a428ec7'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" wrapFileOrFolder"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" EntityKey"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("EID")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ardrive-core-js'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Derive a private drive key from raw drive key string")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" driveKey "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("EntityKey")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Buffer"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("from")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MyAwesomeDriveKeyZZZZZZZZZZZZZZZZZZZZFAKE/s'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'base64'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Wrap folder and all of its contents for upload")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" wrappedFolder "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("wrapFileOrFolder")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'path/to/folder'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Upload a private folder and all its contents")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" uploadFileResult "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" arDrive"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("uploadAllEntities")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n entitiesToUpload"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n wrappedEntity"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" wrappedFolder"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n destFolderId"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("EID")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'76543214a-eb5e-4134-8ae2-a3946a428ec7'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n driveKey\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// And some other public file to a different destination 🤯")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n wrappedEntity"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" someOtherWrappedFile\n destFolderId"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("EID")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'675489321-eb5e-4134-8ae2-a3946a428ec7'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Upload ArFS Entities To Turbo (BETA)")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// The presence of `turboSettings` in `arDriveFactory` enables sending to Turbo")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" arDrive "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("arDriveFactory")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" wallet"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" myWallet"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" turboSettings"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" uploadFileResult "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" arDrive"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("uploadAllEntities")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n entitiesToUpload"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" wrappedEntity"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" destFolderId "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"development-environment-setup"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#development-environment-setup"}},[t._v("#")]),t._v(" Development Environment Setup")]),t._v(" "),a("p",[t._v("We use nvm to manage our Node engine version and, if necessary, to install an npm version that we can then use to install Yarn.")]),t._v(" "),a("p",[t._v("Note for Windows: "),a("strong",[t._v("We recommend using WSL")]),t._v(" for setting up NVM on Windows using the "),a("a",{attrs:{href:"https://code.visualstudio.com/docs/remote/wsl",target:"_blank",rel:"noopener noreferrer"}},[t._v("instructions described here"),a("OutboundLink")],1),t._v(" then continue the steps below.")]),t._v(" "),a("ol",[a("li",[a("p",[t._v("Install nvm "),a("a",{attrs:{href:"https://github.com/nvm-sh/nvm#installing-and-updating",target:"_blank",rel:"noopener noreferrer"}},[t._v("using their instructions"),a("OutboundLink")],1),t._v(".")])]),t._v(" "),a("li",[a("p",[t._v("We use Node 18.x -- ensure that the correct Node version is installed and activated by performing "),a("code",[t._v("nvm install")]),t._v(" and then "),a("code",[t._v("nvm use")])])]),t._v(" "),a("li",[a("p",[t._v("We use Yarn 3.x please "),a("a",{attrs:{href:"https://yarnpkg.com/getting-started/install",target:"_blank",rel:"noopener noreferrer"}},[t._v("follow the installation guidelines here"),a("OutboundLink")],1)])]),t._v(" "),a("li",[a("p",[t._v("We use husky 6.x to manage the git commit hooks that help to improve the quality of our commits. Please run:\n"),a("code",[t._v("yarn husky install")]),t._v("\nto enable git hooks for this local repository. Without doing so, you risk committing non-compliant code to the repository.")])]),t._v(" "),a("li",[a("p",[t._v("Install all node package dependencies by running "),a("code",[t._v("yarn install --check-cache")])])])]),t._v(" "),a("h3",{attrs:{id:"recommended-visual-studio-code-extensions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#recommended-visual-studio-code-extensions"}},[t._v("#")]),t._v(" Recommended Visual Studio Code extensions")]),t._v(" "),a("p",[t._v("To ensure your environment is compatible, we also recommend the following VSCode extensions:")]),t._v(" "),a("ul",[a("li",[a("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint",target:"_blank",rel:"noopener noreferrer"}},[t._v("ES-Lint"),a("OutboundLink")],1)]),t._v(" "),a("li",[a("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig",target:"_blank",rel:"noopener noreferrer"}},[t._v("Editor-Config"),a("OutboundLink")],1)]),t._v(" "),a("li",[a("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode",target:"_blank",rel:"noopener noreferrer"}},[t._v("Prettier"),a("OutboundLink")],1)]),t._v(" "),a("li",[a("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=arcanis.vscode-zipfs",target:"_blank",rel:"noopener noreferrer"}},[t._v("ZipFS"),a("OutboundLink")],1)])]),t._v(" "),a("h2",{attrs:{id:"building-the-library"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#building-the-library"}},[t._v("#")]),t._v(" Building the Library")]),t._v(" "),a("p",[t._v("Simply run "),a("code",[t._v("yarn build")]),t._v(". This will clean the project and compile the TypeScript library.")]),t._v(" "),a("h2",{attrs:{id:"testing-the-library"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#testing-the-library"}},[t._v("#")]),t._v(" Testing the Library")]),t._v(" "),a("p",[t._v("This library is setup for "),a("a",{attrs:{href:"https://github.com/mochajs/mocha",target:"_blank",rel:"noopener noreferrer"}},[t._v("Mocha"),a("OutboundLink")],1),t._v(" testing with "),a("a",{attrs:{href:"https://github.com/chaijs/chai",target:"_blank",rel:"noopener noreferrer"}},[t._v("Chai"),a("OutboundLink")],1),t._v(" and "),a("a",{attrs:{href:"https://github.com/sinonjs/sinon",target:"_blank",rel:"noopener noreferrer"}},[t._v("Sinon"),a("OutboundLink")],1),t._v(". Configuration for Mocha can be found in "),a("code",[t._v(".mocharc.js")])]),t._v(" "),a("p",[t._v("To run all of the tests use:")]),t._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("yarn")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("test")]),t._v("\n")])])]),a("p",[t._v("To run a specific test, use Mocha's "),a("a",{attrs:{href:"https://mochajs.org/#-grep-regexp-g-regexp",target:"_blank",rel:"noopener noreferrer"}},[t._v("grep"),a("OutboundLink")],1),t._v(" command. This will cause Mocha to only run the tests that contain the provided RegExp.")]),t._v(" "),a("p",[t._v("The "),a("code",[t._v("-g")]),t._v(" command will "),a("strong",[t._v("only")]),t._v(" match the characters used in the "),a("code",[t._v("describe()")]),t._v(" and "),a("code",[t._v("it()")]),t._v(" title arguments. It will "),a("strong",[t._v("not")]),t._v(" match files names or folders.")]),t._v(" "),a("p",[t._v("For example:")]),t._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("yarn")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("test")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-g")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'My specific unit test'")]),t._v("\n")])])]),a("p",[t._v("Will run this test:")]),t._v(" "),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("describe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'My specific unit test'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("it")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'functions correctly'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ...")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h3",{attrs:{id:"coverage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#coverage"}},[t._v("#")]),t._v(" Coverage")]),t._v(" "),a("p",[a("a",{attrs:{href:"https://github.com/istanbuljs/nyc",target:"_blank",rel:"noopener noreferrer"}},[t._v("Istanbul.js (nyc)"),a("OutboundLink")],1),t._v(" has been added for code coverage reporting. Configuration for the nyc package can be found in "),a("code",[t._v("nyc.config.js")])]),t._v(" "),a("p",[t._v("On each "),a("code",[t._v("yarn test")]),t._v(" command, nyc will output a code coverage summary in the terminal. In addition, a more detailed HTML version will output to the "),a("code",[t._v("/coverage")]),t._v(" directory. Simply run "),a("code",[t._v("/coverage/index.html")]),t._v(" in your browser to view the HTML version.")]),t._v(" "),a("p",[t._v("Alternatively, you can view a verbose coverage output in the terminal by running:")]),t._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("yarn")]),t._v(" coverage\n")])])]),a("h3",{attrs:{id:"adding-tests"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#adding-tests"}},[t._v("#")]),t._v(" Adding tests")]),t._v(" "),a("p",[t._v("There are many different syntax options available with the Chai library, which can be found in their "),a("a",{attrs:{href:"https://www.chaijs.com/api/bdd/",target:"_blank",rel:"noopener noreferrer"}},[t._v("documentation"),a("OutboundLink")],1),t._v(". For examples on unit testing, visit "),a("code",[t._v("src/example.test.ts")]),t._v(", and for integration testing: "),a("code",[t._v("tests/example.test.ts")]),t._v(".")]),t._v(" "),a("p",[t._v("Unit tests should be located adjacent (or right next to) the file they are referencing. They should also be named the same with the "),a("code",[t._v(".test.ts")]),t._v(" extension. In contrast, integration tests will live in the "),a("code",[t._v("/tests")]),t._v(" directory.")]),t._v(" "),a("p",[t._v("For example:")]),t._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[t._v("ardrive-core-js/\n├── src\n│ ├── fileToTest.ts\n│ └── fileToTest.test.ts "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("-- Unit "),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("test")]),t._v("\n└── tests\n └── bestApi.test.ts "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("----- Integration "),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("test")]),t._v("\n")])])]),a("h3",{attrs:{id:"using-sinon"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#using-sinon"}},[t._v("#")]),t._v(" Using Sinon")]),t._v(" "),a("p",[t._v("Sinon can be used to create spies, mocks, fakes, stubs, and more. There are some basic examples of using the library shown in the example test files shared above.")]),t._v(" "),a("p",[t._v("For more information on what you can do with Sinon, visit their "),a("a",{attrs:{href:"https://sinonjs.org/releases/latest",target:"_blank",rel:"noopener noreferrer"}},[t._v("documentation"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("h3",{attrs:{id:"debugging-with-power-assert"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#debugging-with-power-assert"}},[t._v("#")]),t._v(" Debugging with Power-Assert")]),t._v(" "),a("p",[a("a",{attrs:{href:"https://github.com/power-assert-js/power-assert",target:"_blank",rel:"noopener noreferrer"}},[t._v("Power-Assert"),a("OutboundLink")],1),t._v(" is setup as another testing tool. The library can be used to provide a very detailed output of your failing test cases. This can become super useful while debugging a test.")]),t._v(" "),a("p",[t._v("To use this tool, it must be imported using this syntax:")]),t._v(" "),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" assert "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("require")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'assert'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("Then use "),a("code",[t._v("assert")]),t._v(" in your error throwing test case. Commenting out the Chai assertion will produce a cleaner output:")]),t._v(" "),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// expect(failingOutput).to.equal(expectedOutput);")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("assert")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("failingOutput "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" expectedOutput"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("And finally, to view the detailed error messages in your terminal:")]),t._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("yarn")]),t._v(" power-assert "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-g")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'My test case'")]),t._v("\n")])])]),a("h3",{attrs:{id:"progress-logging-of-transaction-uploads"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#progress-logging-of-transaction-uploads"}},[t._v("#")]),t._v(" Progress Logging of Transaction Uploads")]),t._v(" "),a("p",[t._v("Progress logging of transaction uploads to stderr can be enabled by setting the "),a("code",[t._v("ARDRIVE_PROGRESS_LOG")]),t._v(" environment variable to "),a("code",[t._v("1")]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[t._v("Uploading "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("file")]),t._v(" transaction "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" of total "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),t._v(" transactions"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("..")]),t._v(".\nTransaction _GKQasQX194a364Hph8Oe-oku1AdfHwxWOw9_JC1yjc Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v("%\nTransaction _GKQasQX194a364Hph8Oe-oku1AdfHwxWOw9_JC1yjc Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("35")]),t._v("%\nTransaction _GKQasQX194a364Hph8Oe-oku1AdfHwxWOw9_JC1yjc Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("66")]),t._v("%\nTransaction _GKQasQX194a364Hph8Oe-oku1AdfHwxWOw9_JC1yjc Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),t._v("%\nUploading "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("file")]),t._v(" transaction "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),t._v(" of total "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),t._v(" transactions"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("..")]),t._v(".\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("13")]),t._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("28")]),t._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("42")]),t._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("60")]),t._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("76")]),t._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("91")]),t._v("%\nTransaction nA1stCdTkuf290k0qsqvmJ78isEC0bwgrAi3D8Cl1LU Upload Progress: "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),t._v("%\n")])])]),a("h3",{attrs:{id:"persistent-caching-of-arfs-entity-metadata"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#persistent-caching-of-arfs-entity-metadata"}},[t._v("#")]),t._v(" Persistent Caching of ArFS Entity Metadata")]),t._v(" "),a("p",[t._v("To avoid redundant requests to the Arweave network for immutable ArFS entity metadata, a persistent file cache is created and maintained at:")]),t._v(" "),a("div",{staticClass:"language-shell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-shell"}},[a("code",[t._v("Windows: "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("os.homedir"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v("/ardrive-caches/metadata\nNon-Windows: "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("os.homedir"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v("/.ardrive/caches/metadata\n")])])]),a("p",[t._v("The "),a("code",[t._v("XDG_CACHE_HOME")]),t._v(" environment variable is honored, where applicable, and will be used in place of "),a("code",[t._v("os.homedir()")]),t._v(" in the scenarios described above.")]),t._v(" "),a("p",[t._v("Metadata cache logging to stderr can be enabled by setting the "),a("code",[t._v("ARDRIVE_CACHE_LOG")]),t._v(" environment variable to "),a("code",[t._v("1")]),t._v(".")]),t._v(" "),a("p",[t._v("Cache performance is UNDEFINED for multi-process scenarios, but is presumed to be generally usable.")]),t._v(" "),a("p",[t._v("The cache can be manually cleared safely at any time that any integrating app is not in operation.")]),t._v(" "),a("h3",{attrs:{id:"applying-custom-metadata-to-arfs-file-transactions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#applying-custom-metadata-to-arfs-file-transactions"}},[t._v("#")]),t._v(" Applying Custom MetaData to ArFS File Transactions")]),t._v(" "),a("p",[t._v("Custom metadata can be attached to ArFS File Transactions. Metadata can be applied to either the GQL tags on the MetaData Transaction, the MetaData Transaction's Data JSON, or both.")]),t._v(" "),a("p",[t._v("All custom tags can be accessed by using by using "),a("code",[t._v("ArDrive")]),t._v(" class read methods such as "),a("code",[t._v("getPublicFile")]),t._v(", "),a("code",[t._v("getPrivateFile")]),t._v(", "),a("code",[t._v("listPrivateFolder")]),t._v(", etc.")]),t._v(" "),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" arDrive "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("arDriveAnonymousFactory")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" fileInfo "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" arDrive"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getPublicFile")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" fileId "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myMetaDataGqlTags "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" fileInfo"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("customMetaDataGqlTags"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myMetaDataJsonFields "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" fileInfo"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("customMetaDataJson"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("When the custom metadata is attached to the MetaData Transaction's GQL tags, they will become visible on any Arweave GQL gateway and also third party tools that read GQL data.")]),t._v(" "),a("p",[t._v("When these tags are added to the MetaData Transaction's Data JSON they can be read by downloading the JSON data directly from "),a("code",[t._v("https://arweave.net/")]),t._v(".")]),t._v(" "),a("p",[t._v("To add this custom metadata to your file metadata transactions, users can pass an object containing custom tags when wrapping content to upload:")]),t._v(" "),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" fileToUpload "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("wrapFileOrFolder")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'path/to/file/on/system'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// File or Folder Path")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'application/custom-content-type'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Custom Content Type")]),t._v("\n customMetaData"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Custom MetaData")]),t._v("\n metaDataJson"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'My-Custom-Tag-Name'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Single-Custom-Value'")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n metaDataGqlTags"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Another-Custom-Tag'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'First-Custom-Value'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Second-Custom-Value'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Third-Custom-Value'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/29.ecebea02.js b/assets/js/29.d7450a84.js similarity index 98% rename from assets/js/29.ecebea02.js rename to assets/js/29.d7450a84.js index 5151b1d..629fa88 100644 --- a/assets/js/29.ecebea02.js +++ b/assets/js/29.d7450a84.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[29],{307:function(e,t,a){"use strict";a.r(t);var o=a(10),r=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"deploying-your-dapp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#deploying-your-dapp"}},[e._v("#")]),e._v(" Deploying your dApp")]),e._v(" "),t("h2",{attrs:{id:"overview"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#overview"}},[e._v("#")]),e._v(" Overview")]),e._v(" "),t("p",[e._v("This guide will outline the steps needed to deploy your dApp onto the Arweave blockchain using the ArDrive web app. It assumes you have already prepared your dApp to use hash routing and relative file paths, and built static files for any dApp in a language or framework that requires it (like React).")]),e._v(" "),t("h2",{attrs:{id:"deploying"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#deploying"}},[e._v("#")]),e._v(" Deploying")]),e._v(" "),t("h3",{attrs:{id:"step-1-log-into-ardrive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#step-1-log-into-ardrive"}},[e._v("#")]),e._v(" Step 1: Log into ArDrive")]),e._v(" "),t("p",[e._v("Go to the "),t("a",{attrs:{href:"https://app.ardrive.io/#/sign-in",target:"_blank",rel:"noopener noreferrer"}},[e._v("ArDrive web app"),t("OutboundLink")],1),e._v(" and log in using the method of your choosing. If you don't already have an account, you will need to follow the instructions to set one up.")]),e._v(" "),t("h3",{attrs:{id:"step-2-select-or-create-a-drive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#step-2-select-or-create-a-drive"}},[e._v("#")]),e._v(" Step 2: Select or Create a Drive")]),e._v(" "),t("p",[e._v('Once logged in, navigate to the drive where you want your project to be hosted. If you haven\'t created a drive yet, or if you want a new one specifically for this project, click the big red "New" button at the top left and create a new drive. Remember, the drive needs to be set to public for your dApp to be accessible to others.')]),e._v(" "),t("h3",{attrs:{id:"step-3-upload-your-project"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#step-3-upload-your-project"}},[e._v("#")]),e._v(" Step 3: Upload your project")]),e._v(" "),t("p",[e._v('With your drive selected, click the big red "New" button again, but this time, select "Upload Folder". Navigate to your project\'s root directory, or the built directory if required, and select it. This will upload the entire directory, maintaining your project\'s file structure.')]),e._v(" "),t("h3",{attrs:{id:"step-4-confirm-upload"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#step-4-confirm-upload"}},[e._v("#")]),e._v(" Step 4: Confirm Upload")]),e._v(" "),t("p",[e._v('You\'ll be given a chance to review the upload and the associated cost. If everything looks right, click "Confirm". Remember, uploading to Arweave isnt free, but the cost is usually quite small and the benefits of having your dApp hosted on the permaweb are significant.')]),e._v(" "),t("h3",{attrs:{id:"step-5-create-the-manifest"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#step-5-create-the-manifest"}},[e._v("#")]),e._v(" Step 5: Create the Manifest")]),e._v(" "),t("p",[e._v('While ArDrive displays your uploaded files as a traditional file structure, with files and folders inside other folders, thats not how they actually exist on Arweave. The manifest acts as a map to all the files your dApp needs to function. After you confirm your upload, navigate into your newly created folder by double clicking on it. Click the big red "New" button again and select "Create manifest". You\'ll be prompted to name the manifest and choose where to save it. Be sure to save it inside the folder you just created.')]),e._v(" "),t("h3",{attrs:{id:"step-6-get-the-data-tx-id"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#step-6-get-the-data-tx-id"}},[e._v("#")]),e._v(" Step 6: Get the Data TX ID")]),e._v(" "),t("p",[e._v('Once the manifest is created, click on it to expand its details. On the bottom right, there\'s a line labeled "Data TX ID". This is the unique identifier for your uploaded dApp on Arweave. Copy this value.')]),e._v(" "),t("h3",{attrs:{id:"step-7-view-and-share-your-dapp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#step-7-view-and-share-your-dapp"}},[e._v("#")]),e._v(" Step 7: View and Share your dApp")]),e._v(" "),t("p",[e._v("Your dApp is now available on the permaweb forever! Append the Data TX ID you just copied to the end of an Arweave gateway URL, like "),t("code",[e._v("https://arweave.net/")]),e._v(" . It might take a few minutes for all of your files to finish propagating through the network, but once they do your dApp will be accessible to anyone, anywhere, at any time.")]),e._v(" "),t("h2",{attrs:{id:"updating-your-dapp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#updating-your-dapp"}},[e._v("#")]),e._v(" Updating your dApp")]),e._v(" "),t("p",[e._v("Files uploaded to Arweave are permanent and immutable. They cannot be changed. However, the "),t("RouterLink",{attrs:{to:"/docs/arfs/overview.html"}},[e._v("Arweave File System (ArFS)")]),e._v(' protocol used (and created) by ArDrive lets you "replace" them with new versions while still being able to access the old ones. You can do this with entire dApps as well. The old files won\'t be displayed in the ArDrive web app unless you click on a file to view its history.')],1),e._v(" "),t("p",[e._v('Once you have made changes to your dApp, and built the static directory for it, you can upload the entire folder again to the same location where you uploaded the original. Follow all the same steps listed above for uploading your dApp. You will need to create a new manifest to correctly point to the updated files. Give it the same name as the old manifest in order to "replace" it. Creating the new manifest will generate a new TX ID used to view the updated dApp.')]),e._v(" "),t("p",[e._v("The old version of the dApp will always be available to anyone who has the correct TX ID")])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[29],{309:function(e,t,a){"use strict";a.r(t);var o=a(10),r=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"deploying-your-dapp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#deploying-your-dapp"}},[e._v("#")]),e._v(" Deploying your dApp")]),e._v(" "),t("h2",{attrs:{id:"overview"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#overview"}},[e._v("#")]),e._v(" Overview")]),e._v(" "),t("p",[e._v("This guide will outline the steps needed to deploy your dApp onto the Arweave blockchain using the ArDrive web app. It assumes you have already prepared your dApp to use hash routing and relative file paths, and built static files for any dApp in a language or framework that requires it (like React).")]),e._v(" "),t("h2",{attrs:{id:"deploying"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#deploying"}},[e._v("#")]),e._v(" Deploying")]),e._v(" "),t("h3",{attrs:{id:"step-1-log-into-ardrive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#step-1-log-into-ardrive"}},[e._v("#")]),e._v(" Step 1: Log into ArDrive")]),e._v(" "),t("p",[e._v("Go to the "),t("a",{attrs:{href:"https://app.ardrive.io/#/sign-in",target:"_blank",rel:"noopener noreferrer"}},[e._v("ArDrive web app"),t("OutboundLink")],1),e._v(" and log in using the method of your choosing. If you don't already have an account, you will need to follow the instructions to set one up.")]),e._v(" "),t("h3",{attrs:{id:"step-2-select-or-create-a-drive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#step-2-select-or-create-a-drive"}},[e._v("#")]),e._v(" Step 2: Select or Create a Drive")]),e._v(" "),t("p",[e._v('Once logged in, navigate to the drive where you want your project to be hosted. If you haven\'t created a drive yet, or if you want a new one specifically for this project, click the big red "New" button at the top left and create a new drive. Remember, the drive needs to be set to public for your dApp to be accessible to others.')]),e._v(" "),t("h3",{attrs:{id:"step-3-upload-your-project"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#step-3-upload-your-project"}},[e._v("#")]),e._v(" Step 3: Upload your project")]),e._v(" "),t("p",[e._v('With your drive selected, click the big red "New" button again, but this time, select "Upload Folder". Navigate to your project\'s root directory, or the built directory if required, and select it. This will upload the entire directory, maintaining your project\'s file structure.')]),e._v(" "),t("h3",{attrs:{id:"step-4-confirm-upload"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#step-4-confirm-upload"}},[e._v("#")]),e._v(" Step 4: Confirm Upload")]),e._v(" "),t("p",[e._v('You\'ll be given a chance to review the upload and the associated cost. If everything looks right, click "Confirm". Remember, uploading to Arweave isnt free, but the cost is usually quite small and the benefits of having your dApp hosted on the permaweb are significant.')]),e._v(" "),t("h3",{attrs:{id:"step-5-create-the-manifest"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#step-5-create-the-manifest"}},[e._v("#")]),e._v(" Step 5: Create the Manifest")]),e._v(" "),t("p",[e._v('While ArDrive displays your uploaded files as a traditional file structure, with files and folders inside other folders, thats not how they actually exist on Arweave. The manifest acts as a map to all the files your dApp needs to function. After you confirm your upload, navigate into your newly created folder by double clicking on it. Click the big red "New" button again and select "Create manifest". You\'ll be prompted to name the manifest and choose where to save it. Be sure to save it inside the folder you just created.')]),e._v(" "),t("h3",{attrs:{id:"step-6-get-the-data-tx-id"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#step-6-get-the-data-tx-id"}},[e._v("#")]),e._v(" Step 6: Get the Data TX ID")]),e._v(" "),t("p",[e._v('Once the manifest is created, click on it to expand its details. On the bottom right, there\'s a line labeled "Data TX ID". This is the unique identifier for your uploaded dApp on Arweave. Copy this value.')]),e._v(" "),t("h3",{attrs:{id:"step-7-view-and-share-your-dapp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#step-7-view-and-share-your-dapp"}},[e._v("#")]),e._v(" Step 7: View and Share your dApp")]),e._v(" "),t("p",[e._v("Your dApp is now available on the permaweb forever! Append the Data TX ID you just copied to the end of an Arweave gateway URL, like "),t("code",[e._v("https://arweave.net/")]),e._v(" . It might take a few minutes for all of your files to finish propagating through the network, but once they do your dApp will be accessible to anyone, anywhere, at any time.")]),e._v(" "),t("h2",{attrs:{id:"updating-your-dapp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#updating-your-dapp"}},[e._v("#")]),e._v(" Updating your dApp")]),e._v(" "),t("p",[e._v("Files uploaded to Arweave are permanent and immutable. They cannot be changed. However, the "),t("RouterLink",{attrs:{to:"/docs/arfs/overview.html"}},[e._v("Arweave File System (ArFS)")]),e._v(' protocol used (and created) by ArDrive lets you "replace" them with new versions while still being able to access the old ones. You can do this with entire dApps as well. The old files won\'t be displayed in the ArDrive web app unless you click on a file to view its history.')],1),e._v(" "),t("p",[e._v('Once you have made changes to your dApp, and built the static directory for it, you can upload the entire folder again to the same location where you uploaded the original. Follow all the same steps listed above for uploading your dApp. You will need to create a new manifest to correctly point to the updated files. Give it the same name as the old manifest in order to "replace" it. Creating the new manifest will generate a new TX ID used to view the updated dApp.')]),e._v(" "),t("p",[e._v("The old version of the dApp will always be available to anyone who has the correct TX ID")])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/30.f2a32b70.js b/assets/js/30.3be995ed.js similarity index 97% rename from assets/js/30.f2a32b70.js rename to assets/js/30.3be995ed.js index 118e3ac..484b818 100644 --- a/assets/js/30.f2a32b70.js +++ b/assets/js/30.3be995ed.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[30],{308:function(e,t,r){"use strict";r.r(t);var a=r(10),s=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"examples"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#examples"}},[e._v("#")]),e._v(" Examples")]),e._v(" "),t("p",[e._v("Below are some basic websites built with different languages or frameworks that provide more detailed information on how to configure your dApp for that framework. Each one has been deployed to Arweave itself to show that it functions correctly, and can be accessed through any Arweave gateway by using its TX ID. These are all very basic examples, but if you follow the principles explained, your dApp will function correctly when deployed to the permaweb no matter how big or complex it becomes.")]),e._v(" "),t("h2",{attrs:{id:"basic-html"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#basic-html"}},[e._v("#")]),e._v(" Basic HTML")]),e._v(" "),t("p",[e._v("A basic HTML website with a javascript script to facilitate hash routing:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://arweave.net/GPOX8dgUpFpt8IVUyyfBMiPpfWZ9eXHZjNi42W4-_50",target:"_blank",rel:"noopener noreferrer"}},[e._v("GPOX8dgUpFpt8IVUyyfBMiPpfWZ9eXHZjNi42W4-_50"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"react"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#react"}},[e._v("#")]),e._v(" React")]),e._v(" "),t("p",[e._v("A React dApp created using Create-React-App:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://arweave.net/BTjZhINTpCtWiE0PcfpAQ8a3QhL-1AwXfNJ9lhbaJj0",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTjZhINTpCtWiE0PcfpAQ8a3QhL-1AwXfNJ9lhbaJj0"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"next"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#next"}},[e._v("#")]),e._v(" Next")]),e._v(" "),t("p",[e._v("A Nextjs dApp created using Create-Next-App:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://arweave.net/01hMcPNA_TEXh1S7p4f6jop7r4lrElF1mIlAwkzhJ_s",target:"_blank",rel:"noopener noreferrer"}},[e._v("01hMcPNA_TEXh1S7p4f6jop7r4lrElF1mIlAwkzhJ_s"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"wordpress"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#wordpress"}},[e._v("#")]),e._v(" WordPress")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://arweave.net/ilP8KEFm0jGAhjEP6e7ZlS7s6BV1NgGJnlw7OfiD5kU",target:"_blank",rel:"noopener noreferrer"}},[e._v("ilP8KEFm0jGAhjEP6e7ZlS7s6BV1NgGJnlw7OfiD5kU"),t("OutboundLink")],1)])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[30],{310:function(e,t,r){"use strict";r.r(t);var a=r(10),s=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"examples"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#examples"}},[e._v("#")]),e._v(" Examples")]),e._v(" "),t("p",[e._v("Below are some basic websites built with different languages or frameworks that provide more detailed information on how to configure your dApp for that framework. Each one has been deployed to Arweave itself to show that it functions correctly, and can be accessed through any Arweave gateway by using its TX ID. These are all very basic examples, but if you follow the principles explained, your dApp will function correctly when deployed to the permaweb no matter how big or complex it becomes.")]),e._v(" "),t("h2",{attrs:{id:"basic-html"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#basic-html"}},[e._v("#")]),e._v(" Basic HTML")]),e._v(" "),t("p",[e._v("A basic HTML website with a javascript script to facilitate hash routing:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://arweave.net/GPOX8dgUpFpt8IVUyyfBMiPpfWZ9eXHZjNi42W4-_50",target:"_blank",rel:"noopener noreferrer"}},[e._v("GPOX8dgUpFpt8IVUyyfBMiPpfWZ9eXHZjNi42W4-_50"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"react"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#react"}},[e._v("#")]),e._v(" React")]),e._v(" "),t("p",[e._v("A React dApp created using Create-React-App:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://arweave.net/BTjZhINTpCtWiE0PcfpAQ8a3QhL-1AwXfNJ9lhbaJj0",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTjZhINTpCtWiE0PcfpAQ8a3QhL-1AwXfNJ9lhbaJj0"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"next"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#next"}},[e._v("#")]),e._v(" Next")]),e._v(" "),t("p",[e._v("A Nextjs dApp created using Create-Next-App:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://arweave.net/01hMcPNA_TEXh1S7p4f6jop7r4lrElF1mIlAwkzhJ_s",target:"_blank",rel:"noopener noreferrer"}},[e._v("01hMcPNA_TEXh1S7p4f6jop7r4lrElF1mIlAwkzhJ_s"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"wordpress"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#wordpress"}},[e._v("#")]),e._v(" WordPress")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://arweave.net/ilP8KEFm0jGAhjEP6e7ZlS7s6BV1NgGJnlw7OfiD5kU",target:"_blank",rel:"noopener noreferrer"}},[e._v("ilP8KEFm0jGAhjEP6e7ZlS7s6BV1NgGJnlw7OfiD5kU"),t("OutboundLink")],1)])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/31.e7ba423f.js b/assets/js/31.2ba5cc6f.js similarity index 98% rename from assets/js/31.e7ba423f.js rename to assets/js/31.2ba5cc6f.js index c3dbc59..114cf20 100644 --- a/assets/js/31.e7ba423f.js +++ b/assets/js/31.2ba5cc6f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[31],{311:function(e,t,a){"use strict";a.r(t);var i=a(10),r=Object(i.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"file-paths"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#file-paths"}},[e._v("#")]),e._v(" File Paths")]),e._v(" "),t("h2",{attrs:{id:"overview"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#overview"}},[e._v("#")]),e._v(" Overview")]),e._v(" "),t("p",[e._v("File paths are needed to locate resources in your file system or on a server. There are two types of file paths: absolute and relative. Because there is no way to know exactly from where a user will access a dApp deployed on Arweave, all file paths used need to be relative.")]),e._v(" "),t("h2",{attrs:{id:"absolute-vs-relative"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#absolute-vs-relative"}},[e._v("#")]),e._v(" Absolute Vs. Relative")]),e._v(" "),t("p",[e._v("An absolute path is the full URL to a resource, starting from the root. For example, "),t("code",[e._v("http://www.example.com/images/myImage.jpg")]),e._v(" is an absolute path. It points directly to the image no matter where the code referencing it is located.")]),e._v(" "),t("p",[e._v("A relative path is a path relative to the current location. If you have an HTML file in the root directory (folder) and an image in a subdirectory called 'images', you could use the relative path "),t("code",[e._v("images/myImage.jpg")]),e._v(" to reference the image.")]),e._v(" "),t("h2",{attrs:{id:"why-relative-paths"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#why-relative-paths"}},[e._v("#")]),e._v(" Why Relative Paths")]),e._v(" "),t("p",[e._v("When deploying dApps on Arweave, relative paths are essential because:")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("Domain agnostic")]),e._v(": Arweave permaweb dApps can be accessed from various gateways, not just one domain. Absolute paths tied to a specific domain will not work.")]),e._v(" "),t("li",[t("strong",[e._v("Decentralized")]),e._v(": Arweave is a decentralized network. There is no root directory or server configuration to reference. All file paths must be relative to the file trying to find an asset, or your dApp wont be able to find it.")])]),e._v(" "),t("h2",{attrs:{id:"identifying-relative-and-absolute-paths"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#identifying-relative-and-absolute-paths"}},[e._v("#")]),e._v(" Identifying Relative and Absolute Paths")]),e._v(" "),t("p",[e._v("The key difference between relative and absolute file paths is where they start from:")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("Absolute Paths")]),e._v(" start with a slash (/) or a full URL (including the protocol, such as "),t("code",[e._v("http://")]),e._v("). For example, "),t("code",[e._v("/images/myImage.jpg")]),e._v(" or "),t("code",[e._v("http://www.example.com/images/myImage.jpg")]),e._v(" are absolute paths.")]),e._v(" "),t("li",[t("strong",[e._v("Relative Paths")]),e._v(" do not start with a slash. They are relative to the current directory. For example, "),t("code",[e._v("images/myImage.jpg")]),e._v(" or "),t("code",[e._v("../myImage.jpg")]),e._v(" are relative paths.")])]),e._v(" "),t("h2",{attrs:{id:"navigating-with-relative-paths"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#navigating-with-relative-paths"}},[e._v("#")]),e._v(" Navigating with Relative Paths")]),e._v(" "),t("p",[e._v("You can navigate around the files of your project with relative paths by following these principles:")]),e._v(" "),t("ul",[t("li",[t("p",[t("strong",[e._v("Same Directory")]),e._v(": If the file you're trying to reference is in the same directory as the current file, you can just use the filename. For example, if "),t("code",[e._v("index.html")]),e._v(" and "),t("code",[e._v("about.html")]),e._v(" are in the same directory, you can link to "),t("code",[e._v("about.html")]),e._v(" just using "),t("code",[e._v("about.html")]),e._v(".")])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Subdirectory")]),e._v(": If the file is in a subdirectory, you can use the directory name followed by the filename. For example, "),t("code",[e._v("images/myImage.jpg")]),e._v(" will point to the "),t("code",[e._v("myImage.jpg")]),e._v(" file in the "),t("code",[e._v("images")]),e._v(" subdirectory.")])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Parent Directory")]),e._v(": If the file is in a parent directory, you can use "),t("code",[e._v("../")]),e._v(" to go up one level. For example, "),t("code",[e._v("../index.html")]),e._v(" will point to "),t("code",[e._v("index.html")]),e._v(" in the parent directory. You can use multiple "),t("code",[e._v("../")]),e._v(" to go up multiple levels, like "),t("code",[e._v("../../index.html")]),e._v(".")])])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[31],{314:function(e,t,a){"use strict";a.r(t);var i=a(10),r=Object(i.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"file-paths"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#file-paths"}},[e._v("#")]),e._v(" File Paths")]),e._v(" "),t("h2",{attrs:{id:"overview"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#overview"}},[e._v("#")]),e._v(" Overview")]),e._v(" "),t("p",[e._v("File paths are needed to locate resources in your file system or on a server. There are two types of file paths: absolute and relative. Because there is no way to know exactly from where a user will access a dApp deployed on Arweave, all file paths used need to be relative.")]),e._v(" "),t("h2",{attrs:{id:"absolute-vs-relative"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#absolute-vs-relative"}},[e._v("#")]),e._v(" Absolute Vs. Relative")]),e._v(" "),t("p",[e._v("An absolute path is the full URL to a resource, starting from the root. For example, "),t("code",[e._v("http://www.example.com/images/myImage.jpg")]),e._v(" is an absolute path. It points directly to the image no matter where the code referencing it is located.")]),e._v(" "),t("p",[e._v("A relative path is a path relative to the current location. If you have an HTML file in the root directory (folder) and an image in a subdirectory called 'images', you could use the relative path "),t("code",[e._v("images/myImage.jpg")]),e._v(" to reference the image.")]),e._v(" "),t("h2",{attrs:{id:"why-relative-paths"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#why-relative-paths"}},[e._v("#")]),e._v(" Why Relative Paths")]),e._v(" "),t("p",[e._v("When deploying dApps on Arweave, relative paths are essential because:")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("Domain agnostic")]),e._v(": Arweave permaweb dApps can be accessed from various gateways, not just one domain. Absolute paths tied to a specific domain will not work.")]),e._v(" "),t("li",[t("strong",[e._v("Decentralized")]),e._v(": Arweave is a decentralized network. There is no root directory or server configuration to reference. All file paths must be relative to the file trying to find an asset, or your dApp wont be able to find it.")])]),e._v(" "),t("h2",{attrs:{id:"identifying-relative-and-absolute-paths"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#identifying-relative-and-absolute-paths"}},[e._v("#")]),e._v(" Identifying Relative and Absolute Paths")]),e._v(" "),t("p",[e._v("The key difference between relative and absolute file paths is where they start from:")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("Absolute Paths")]),e._v(" start with a slash (/) or a full URL (including the protocol, such as "),t("code",[e._v("http://")]),e._v("). For example, "),t("code",[e._v("/images/myImage.jpg")]),e._v(" or "),t("code",[e._v("http://www.example.com/images/myImage.jpg")]),e._v(" are absolute paths.")]),e._v(" "),t("li",[t("strong",[e._v("Relative Paths")]),e._v(" do not start with a slash. They are relative to the current directory. For example, "),t("code",[e._v("images/myImage.jpg")]),e._v(" or "),t("code",[e._v("../myImage.jpg")]),e._v(" are relative paths.")])]),e._v(" "),t("h2",{attrs:{id:"navigating-with-relative-paths"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#navigating-with-relative-paths"}},[e._v("#")]),e._v(" Navigating with Relative Paths")]),e._v(" "),t("p",[e._v("You can navigate around the files of your project with relative paths by following these principles:")]),e._v(" "),t("ul",[t("li",[t("p",[t("strong",[e._v("Same Directory")]),e._v(": If the file you're trying to reference is in the same directory as the current file, you can just use the filename. For example, if "),t("code",[e._v("index.html")]),e._v(" and "),t("code",[e._v("about.html")]),e._v(" are in the same directory, you can link to "),t("code",[e._v("about.html")]),e._v(" just using "),t("code",[e._v("about.html")]),e._v(".")])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Subdirectory")]),e._v(": If the file is in a subdirectory, you can use the directory name followed by the filename. For example, "),t("code",[e._v("images/myImage.jpg")]),e._v(" will point to the "),t("code",[e._v("myImage.jpg")]),e._v(" file in the "),t("code",[e._v("images")]),e._v(" subdirectory.")])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Parent Directory")]),e._v(": If the file is in a parent directory, you can use "),t("code",[e._v("../")]),e._v(" to go up one level. For example, "),t("code",[e._v("../index.html")]),e._v(" will point to "),t("code",[e._v("index.html")]),e._v(" in the parent directory. You can use multiple "),t("code",[e._v("../")]),e._v(" to go up multiple levels, like "),t("code",[e._v("../../index.html")]),e._v(".")])])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/32.53261034.js b/assets/js/32.ae676860.js similarity index 95% rename from assets/js/32.53261034.js rename to assets/js/32.ae676860.js index ce7647d..b0520b4 100644 --- a/assets/js/32.53261034.js +++ b/assets/js/32.ae676860.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[32],{310:function(e,t,r){"use strict";r.r(t);var o=r(10),n=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"preparing-your-dapp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#preparing-your-dapp"}},[e._v("#")]),e._v(" Preparing Your dApp")]),e._v(" "),t("p",[e._v("To make sure dApps work correctly on the Arweave blockchain, they need to be set up in a specific manner. This is because, unlike traditional web hosting, there are no centralized servers for browsers to request files from. Your dApp needs to be able to handle navigation inside the client's browser instead of relying on communication between the client and a server, and not rely on a server as a point of origin for file paths. This is done by ensuring the following:")]),e._v(" "),t("ul",[t("li",[e._v("Your dApp must use "),t("RouterLink",{attrs:{to:"/docs/misc/deploy/routing.html"}},[e._v("hash routing")])],1),e._v(" "),t("li",[e._v("All internal links in your dApp must use "),t("RouterLink",{attrs:{to:"/docs/misc/deploy/paths.html"}},[e._v("relative file paths")]),e._v(".")],1)]),e._v(" "),t("p",[e._v("Failure to properly implement either will result in your dApp not working the way it should once it is deployed onto Arweave.")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[32],{311:function(e,t,r){"use strict";r.r(t);var o=r(10),n=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"preparing-your-dapp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#preparing-your-dapp"}},[e._v("#")]),e._v(" Preparing Your dApp")]),e._v(" "),t("p",[e._v("To make sure dApps work correctly on the Arweave blockchain, they need to be set up in a specific manner. This is because, unlike traditional web hosting, there are no centralized servers for browsers to request files from. Your dApp needs to be able to handle navigation inside the client's browser instead of relying on communication between the client and a server, and not rely on a server as a point of origin for file paths. This is done by ensuring the following:")]),e._v(" "),t("ul",[t("li",[e._v("Your dApp must use "),t("RouterLink",{attrs:{to:"/docs/misc/deploy/routing.html"}},[e._v("hash routing")])],1),e._v(" "),t("li",[e._v("All internal links in your dApp must use "),t("RouterLink",{attrs:{to:"/docs/misc/deploy/paths.html"}},[e._v("relative file paths")]),e._v(".")],1)]),e._v(" "),t("p",[e._v("Failure to properly implement either will result in your dApp not working the way it should once it is deployed onto Arweave.")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/33.fca37d1f.js b/assets/js/33.71e942e2.js similarity index 97% rename from assets/js/33.fca37d1f.js rename to assets/js/33.71e942e2.js index 5f10a4d..322897d 100644 --- a/assets/js/33.fca37d1f.js +++ b/assets/js/33.71e942e2.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{313:function(e,t,a){"use strict";a.r(t);var r=a(10),s=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"hash-routing"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hash-routing"}},[e._v("#")]),e._v(" Hash Routing")]),e._v(" "),t("h2",{attrs:{id:"overview"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#overview"}},[e._v("#")]),e._v(" Overview")]),e._v(" "),t("p",[e._v('Hash routing is a popular technique in single page applications (SPAs) where the site navigation is handled using JavaScript. The "hash" in hash routing refers to the hash symbol (#) inserted into the URL. The part of the URL after the hash symbol is used to determine which "page" to show.')]),e._v(" "),t("p",[e._v('For example, if your URL is "http://www.example.com/#about", the part after the hash (about) would be used to show an app\'s "about" page.')]),e._v(" "),t("h2",{attrs:{id:"hash-routing-vs-history-routing"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hash-routing-vs-history-routing"}},[e._v("#")]),e._v(" Hash Routing Vs. History Routing")]),e._v(" "),t("p",[e._v('Traditional web apps use history routing, where each unique URL represents a different source or asset contained in a server. The URL "http://www.example.com/about" would fetch the "about" page from the app\'s server and display it for a user. History routing requires a server be available to provide the correct files every time a user navigates around an app.')]),e._v(" "),t("p",[e._v("In contrast, with hash routing, all navigation is handled by the client's browser, so no server is needed for navigation.")]),e._v(" "),t("h2",{attrs:{id:"why-hash-routing-for-dapps"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#why-hash-routing-for-dapps"}},[e._v("#")]),e._v(" Why Hash Routing for dApps")]),e._v(" "),t("p",[e._v("Hash routing is particularly useful for apps deployed on Arweave for several reasons:")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("Serverless")]),e._v(": Arweave is a decentralized storage network. There's no server to process requests, so routing cannot be handled by a server.")]),e._v(" "),t("li",[t("strong",[e._v("Persistence")]),e._v(': Once data is stored on Arweave, it can\'t be changed. Hash routing allows you to have "dynamic" content within this immutable structure.')]),e._v(" "),t("li",[t("strong",[e._v("Performance")]),e._v(": With hash routing, all the necessary code is loaded once, reducing the number of network requests and improving performance.")])])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{312:function(e,t,a){"use strict";a.r(t);var r=a(10),s=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"hash-routing"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hash-routing"}},[e._v("#")]),e._v(" Hash Routing")]),e._v(" "),t("h2",{attrs:{id:"overview"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#overview"}},[e._v("#")]),e._v(" Overview")]),e._v(" "),t("p",[e._v('Hash routing is a popular technique in single page applications (SPAs) where the site navigation is handled using JavaScript. The "hash" in hash routing refers to the hash symbol (#) inserted into the URL. The part of the URL after the hash symbol is used to determine which "page" to show.')]),e._v(" "),t("p",[e._v('For example, if your URL is "http://www.example.com/#about", the part after the hash (about) would be used to show an app\'s "about" page.')]),e._v(" "),t("h2",{attrs:{id:"hash-routing-vs-history-routing"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hash-routing-vs-history-routing"}},[e._v("#")]),e._v(" Hash Routing Vs. History Routing")]),e._v(" "),t("p",[e._v('Traditional web apps use history routing, where each unique URL represents a different source or asset contained in a server. The URL "http://www.example.com/about" would fetch the "about" page from the app\'s server and display it for a user. History routing requires a server be available to provide the correct files every time a user navigates around an app.')]),e._v(" "),t("p",[e._v("In contrast, with hash routing, all navigation is handled by the client's browser, so no server is needed for navigation.")]),e._v(" "),t("h2",{attrs:{id:"why-hash-routing-for-dapps"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#why-hash-routing-for-dapps"}},[e._v("#")]),e._v(" Why Hash Routing for dApps")]),e._v(" "),t("p",[e._v("Hash routing is particularly useful for apps deployed on Arweave for several reasons:")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("Serverless")]),e._v(": Arweave is a decentralized storage network. There's no server to process requests, so routing cannot be handled by a server.")]),e._v(" "),t("li",[t("strong",[e._v("Persistence")]),e._v(': Once data is stored on Arweave, it can\'t be changed. Hash routing allows you to have "dynamic" content within this immutable structure.')]),e._v(" "),t("li",[t("strong",[e._v("Performance")]),e._v(": With hash routing, all the necessary code is loaded once, reducing the number of network requests and improving performance.")])])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/34.85e10a92.js b/assets/js/34.ddf8b0d8.js similarity index 99% rename from assets/js/34.85e10a92.js rename to assets/js/34.ddf8b0d8.js index 29aae77..38f4607 100644 --- a/assets/js/34.85e10a92.js +++ b/assets/js/34.ddf8b0d8.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[34],{314:function(e,t,a){"use strict";a.r(t);var r=a(10),s=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"how-to-save-a-website-permanently"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-save-a-website-permanently"}},[e._v("#")]),e._v(" How to Save a Website Permanently")]),e._v(" "),t("h2",{attrs:{id:"overview"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#overview"}},[e._v("#")]),e._v(" Overview")]),e._v(" "),t("p",[e._v("ArDrive offers the ability to save working copies of static websites permanently on "),t("a",{attrs:{href:"https://www.arweave.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Arweave"),t("OutboundLink")],1),e._v(". This means that websites made on WordPress, Wix, SquareSpace and other CMS platforms can now be archived for hundreds of years without the need to pay for ongoing data storage.")]),e._v(" "),t("p",[e._v("Resources like the "),t("a",{attrs:{href:"https://archive.org/web/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Wayback Machine"),t("OutboundLink")],1),e._v(" are useful to research the past life of old websites. But the Wayback Machine’s archives are not comprehensive and often only capture partial copies of historic sites. By leveraging the utility of Arweave manifests, ArDrive offers the ability to save full working copies of websites in an unchanging, permanent state without needing to code.")]),e._v(" "),t("p",[e._v("The process to make a ‘permasite’ takes 10 steps which are outlined below. Advanced users can accomplish similar results by using manifests within the "),t("RouterLink",{attrs:{to:"/docs/cli/intro.html"}},[e._v("ArDrive CLI")]),e._v(".")],1),e._v(" "),t("p",[e._v("You can view a permasite version of this information at "),t("a",{attrs:{href:"https://permasite.arweave.dev",target:"_blank",rel:"noopener noreferrer"}},[e._v("permasite.arweave.dev"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"_1-download-static-site-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_1-download-static-site-files"}},[e._v("#")]),e._v(" 1. Download Static Site Files")]),e._v(" "),t("p",[e._v("ArDrive allows you to preserve full working copies of the static content of existing websites but there are a few limitations to be aware of:")]),e._v(" "),t("ul",[t("li",[e._v("Permanent sites will not enable backend interaction with your website’s CMS,")]),e._v(" "),t("li",[e._v("nor allow you to make further changes to the content of your site,")]),e._v(" "),t("li",[e._v("nor support dynamic functionality like contact forms and eCommerce.")])]),e._v(" "),t("p",[e._v("To generate your static site files, we recommend:")]),e._v(" "),t("h3",{attrs:{id:"windows-users"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#windows-users"}},[e._v("#")]),e._v(" Windows Users")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.cyotek.com/cyotek-webcopy",target:"_blank",rel:"noopener noreferrer"}},[e._v("WebCopy"),t("OutboundLink")],1),e._v(" and "),t("a",{attrs:{href:"https://www.httrack.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("HtTrack"),t("OutboundLink")],1),e._v(" enable Windows users to download static copies of entire websites.")]),e._v(" "),t("h3",{attrs:{id:"mac-users"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#mac-users"}},[e._v("#")]),e._v(" Mac Users")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://apps.apple.com/us/app/offline-pages-pro/id391462107",target:"_blank",rel:"noopener noreferrer"}},[e._v("Offline Pages Pro"),t("OutboundLink")],1),e._v(" (Mac users only), which creates files that work well with this process. After saving your site with Offline Pages Pro, go to File > Export > Local Website to download the local static files."),t("br"),e._v(" "),t("a",{attrs:{href:"https://ricks-apps.com/osx/sitesucker/index.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("SiteSucker"),t("OutboundLink")],1),e._v(" is another option for Mac users.")]),e._v(" "),t("h3",{attrs:{id:"command-line-utility"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#command-line-utility"}},[e._v("#")]),e._v(" Command Line Utility")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.gnu.org/software/wget/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Wget"),t("OutboundLink")],1),e._v(" is a free tool that helps capture static versions of websites. While Wget isn't a traditional static site generator, it's great for downloading whole websites for offline use. It offers a simple way to save your site's current look and feel as static files at no cost.")]),e._v(" "),t("h3",{attrs:{id:"wordpress"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#wordpress"}},[e._v("#")]),e._v(" WordPress")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://wordpress.org/plugins/simply-static/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Simply Static"),t("OutboundLink")],1),e._v(" is a plugin that generates static files for WordPress websites. Some users note that Simply Static fails to properly associate CSS and JS files with your static site, but others have had success with this free WordPress plugin.")]),e._v(" "),t("h2",{attrs:{id:"_2-create-an-account-on-ardrive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_2-create-an-account-on-ardrive"}},[e._v("#")]),e._v(" 2. Create an Account on ArDrive")]),e._v(" "),t("p",[e._v("Account creation is free as are uploads of small files (currently up to 500 KB). Remember that ArDrive empowers you to be in control of your data; no one else has your password but you. Therefore, it is very important that you safely record your password and seed phrase as they cannot be recovered later.")]),e._v(" "),t("h2",{attrs:{id:"_3-create-a-new-public-drive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_3-create-a-new-public-drive"}},[e._v("#")]),e._v(" 3. Create a New Public Drive")]),e._v(" "),t("p",[e._v("Click on the red +New button and create a Drive. Name your Drive and set it as “Public”. ArDrive also offers “Private” file storage; however, permanent websites must be public in order to maintain functionality.")]),e._v(" "),t("h2",{attrs:{id:"_4-top-up"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_4-top-up"}},[e._v("#")]),e._v(" 4. Top Up")]),e._v(" "),t("p",[e._v("To pay for permanent storage on the Arweave network you must either purchase ArDrive Turbo credits with a credit card or (or the advanced option) ensure your wallet has $AR, the native token of the Arweave ecosystem. Most websites will cost less than $1 to save permanently. "),t("a",{attrs:{href:"https://ardrive.io/pricing/",target:"_blank",rel:"noopener noreferrer"}},[e._v("See current prices"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"_5-upload-static-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_5-upload-static-files"}},[e._v("#")]),e._v(" 5. Upload Static Files")]),e._v(" "),t("p",[e._v("Upload the static files to your new Public Drive. Offline Pages Pro will generate an index.html file that is "),t("em",[e._v("separate")]),e._v(" from a large folder of assets (images, css, fonts, etc). Simply Static will add the index.html file to the rest of your assets. Either way, upload all the files you receive from your static site generator to your new Public Drive.")]),e._v(" "),t("h2",{attrs:{id:"_6-wait"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_6-wait"}},[e._v("#")]),e._v(" 6. Wait")]),e._v(" "),t("p",[e._v("Permanence takes patience. Once static files have been uploaded, they need to be sent to the Arweave network before being assembled together. This process can take as little as 5 seconds (when using Turbo credits) or up to 30 minutes or more (when using $AR). Make sure to keep your browser tab open and do not refresh your browser while you wait.")]),e._v(" "),t("p",[e._v("To check on the status of your files, you can click the refresh icon in the top right of ArDrive. You’ll know your file is ready when the light on the icon turns from yellow to green. (Pro Tip: some files uploaded with Turbo are ready before they are green.)")]),e._v(" "),t("h2",{attrs:{id:"_7-create-a-manifest"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_7-create-a-manifest"}},[e._v("#")]),e._v(" 7. Create a Manifest")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://ardrive.io/manifests/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Manifests"),t("OutboundLink")],1),e._v(" are special "),t("code",[e._v(".json")]),e._v(" files that instruct Arweave Gateways to map file data associated with specific, unique transaction IDs to customized, hosted paths relative to that of the manifest file itself. In other words, they are the secret sauce that brings a permasite together.")]),e._v(" "),t("p",[e._v("Click on the red +New button and select Advanced > New Manifest. Select the location for your manifest, ensuring it is in the same place as your index.html file.")]),e._v(" "),t("p",[e._v("Give your Manifest a name like “permasite”, it will be the main way you access your permanent website from ArDrive.")]),e._v(" "),t("h2",{attrs:{id:"_8-wait-again"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_8-wait-again"}},[e._v("#")]),e._v(" 8. Wait Again")]),e._v(" "),t("p",[e._v("Now the manifest needs to be sent to the Arweave network. Again, this process can take just a few seconds or up to 30 minutes or more.")]),e._v(" "),t("p",[e._v("After a bit, you can refresh your Drive by clicking on the icon in the upper right – and see if your manifest icon turns from yellow to green.")]),e._v(" "),t("h2",{attrs:{id:"_9-preview-the-manifest"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_9-preview-the-manifest"}},[e._v("#")]),e._v(" 9. Preview the Manifest")]),e._v(" "),t("p",[e._v("Got a green light? You’re ready to go. Click on your manifest file and you will see a panel of options appear on the right side of your screen. Click on the Preview icon in the top right and it will open a new tab with your permasite.")]),e._v(" "),t("p",[e._v("If a website appears with a long, random-looking URL in the browser bar, then congrats, you made a permasite!")]),e._v(" "),t("p",[e._v("Try clicking around and make sure all your pages are preserved. If they are not it could be a limitation of your static site generator or an issue with the manifest (see Notes below).")]),e._v(" "),t("h2",{attrs:{id:"_10-add-a-redirect-or-domain-masking"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_10-add-a-redirect-or-domain-masking"}},[e._v("#")]),e._v(" 10. Add a Redirect or Domain Masking")]),e._v(" "),t("p",[e._v("You’ll notice that your permasite has a long, random-looking URL generated by Arweave. These long URLs are designed to remain for decades, but they also are not very memorable.")]),e._v(" "),t("p",[e._v("Try redirecting another domain to your permasite, or mask your permasite domain with a domain of your choosing. You can also acquire an "),t("a",{attrs:{href:"https://ar.io/docs/arns/",target:"_blank",rel:"noopener noreferrer"}},[e._v("ArNS name"),t("OutboundLink")],1),e._v(" that enables you to create a custom, permanent name for your permasite.")]),e._v(" "),t("h2",{attrs:{id:"notes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#notes"}},[e._v("#")]),e._v(" Notes")]),e._v(" "),t("ul",[t("li",[t("p",[e._v("There’s no delete button with Arweave. Once your permasite is up, it’s up forever. Make sure your content is something you want future humanity to have.")])]),e._v(" "),t("li",[t("p",[e._v("Only static sites can become permasites through the ArDrive web app. Advanced functionality is available for developers who use the "),t("a",{attrs:{href:"https://app.ardrive.io",target:"_blank",rel:"noopener noreferrer"}},[e._v("ArDrive CLI"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("li",[t("p",[e._v("Links to content on external websites will not be permanent (unless they are also permasites) and if that external content becomes inaccessible or moves, you will not be able to update the links within your permasite.")])]),e._v(" "),t("li",[t("p",[e._v("Non-English characters in the URLs of your permasite can be problematic for ArDrive manifests, but non-English characters should work well on the permasite itself.")])])]),e._v(" "),t("h2",{attrs:{id:"other-use-cases"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#other-use-cases"}},[e._v("#")]),e._v(" Other Use Cases")]),e._v(" "),t("p",[e._v("Permasites can be used to archive web content before it disappears from the internet. Or they can be used to create working copies of websites before it a particular site is replaced by new versions.")]),e._v(" "),t("p",[e._v("Manifests can also be used to make reliable perma-backups. Many web hosts offer good daily backups and some offer reliable offsite backups as well. Permasites enable you to have decentralized, highly-redundant backups of your website’s content for a very low cost.")]),e._v(" "),t("h2",{attrs:{id:"example"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#example"}},[e._v("#")]),e._v(" Example")]),e._v(" "),t("p",[e._v("You can view a permasite version of this information at "),t("a",{attrs:{href:"https://permasite.arweave.dev",target:"_blank",rel:"noopener noreferrer"}},[e._v("permasite.arweave.dev"),t("OutboundLink")],1)])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[34],{313:function(e,t,a){"use strict";a.r(t);var r=a(10),s=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"how-to-save-a-website-permanently"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-save-a-website-permanently"}},[e._v("#")]),e._v(" How to Save a Website Permanently")]),e._v(" "),t("h2",{attrs:{id:"overview"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#overview"}},[e._v("#")]),e._v(" Overview")]),e._v(" "),t("p",[e._v("ArDrive offers the ability to save working copies of static websites permanently on "),t("a",{attrs:{href:"https://www.arweave.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Arweave"),t("OutboundLink")],1),e._v(". This means that websites made on WordPress, Wix, SquareSpace and other CMS platforms can now be archived for hundreds of years without the need to pay for ongoing data storage.")]),e._v(" "),t("p",[e._v("Resources like the "),t("a",{attrs:{href:"https://archive.org/web/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Wayback Machine"),t("OutboundLink")],1),e._v(" are useful to research the past life of old websites. But the Wayback Machine’s archives are not comprehensive and often only capture partial copies of historic sites. By leveraging the utility of Arweave manifests, ArDrive offers the ability to save full working copies of websites in an unchanging, permanent state without needing to code.")]),e._v(" "),t("p",[e._v("The process to make a ‘permasite’ takes 10 steps which are outlined below. Advanced users can accomplish similar results by using manifests within the "),t("RouterLink",{attrs:{to:"/docs/cli/intro.html"}},[e._v("ArDrive CLI")]),e._v(".")],1),e._v(" "),t("p",[e._v("You can view a permasite version of this information at "),t("a",{attrs:{href:"https://permasite.arweave.dev",target:"_blank",rel:"noopener noreferrer"}},[e._v("permasite.arweave.dev"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"_1-download-static-site-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_1-download-static-site-files"}},[e._v("#")]),e._v(" 1. Download Static Site Files")]),e._v(" "),t("p",[e._v("ArDrive allows you to preserve full working copies of the static content of existing websites but there are a few limitations to be aware of:")]),e._v(" "),t("ul",[t("li",[e._v("Permanent sites will not enable backend interaction with your website’s CMS,")]),e._v(" "),t("li",[e._v("nor allow you to make further changes to the content of your site,")]),e._v(" "),t("li",[e._v("nor support dynamic functionality like contact forms and eCommerce.")])]),e._v(" "),t("p",[e._v("To generate your static site files, we recommend:")]),e._v(" "),t("h3",{attrs:{id:"windows-users"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#windows-users"}},[e._v("#")]),e._v(" Windows Users")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.cyotek.com/cyotek-webcopy",target:"_blank",rel:"noopener noreferrer"}},[e._v("WebCopy"),t("OutboundLink")],1),e._v(" and "),t("a",{attrs:{href:"https://www.httrack.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("HtTrack"),t("OutboundLink")],1),e._v(" enable Windows users to download static copies of entire websites.")]),e._v(" "),t("h3",{attrs:{id:"mac-users"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#mac-users"}},[e._v("#")]),e._v(" Mac Users")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://apps.apple.com/us/app/offline-pages-pro/id391462107",target:"_blank",rel:"noopener noreferrer"}},[e._v("Offline Pages Pro"),t("OutboundLink")],1),e._v(" (Mac users only), which creates files that work well with this process. After saving your site with Offline Pages Pro, go to File > Export > Local Website to download the local static files."),t("br"),e._v(" "),t("a",{attrs:{href:"https://ricks-apps.com/osx/sitesucker/index.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("SiteSucker"),t("OutboundLink")],1),e._v(" is another option for Mac users.")]),e._v(" "),t("h3",{attrs:{id:"command-line-utility"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#command-line-utility"}},[e._v("#")]),e._v(" Command Line Utility")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.gnu.org/software/wget/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Wget"),t("OutboundLink")],1),e._v(" is a free tool that helps capture static versions of websites. While Wget isn't a traditional static site generator, it's great for downloading whole websites for offline use. It offers a simple way to save your site's current look and feel as static files at no cost.")]),e._v(" "),t("h3",{attrs:{id:"wordpress"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#wordpress"}},[e._v("#")]),e._v(" WordPress")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://wordpress.org/plugins/simply-static/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Simply Static"),t("OutboundLink")],1),e._v(" is a plugin that generates static files for WordPress websites. Some users note that Simply Static fails to properly associate CSS and JS files with your static site, but others have had success with this free WordPress plugin.")]),e._v(" "),t("h2",{attrs:{id:"_2-create-an-account-on-ardrive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_2-create-an-account-on-ardrive"}},[e._v("#")]),e._v(" 2. Create an Account on ArDrive")]),e._v(" "),t("p",[e._v("Account creation is free as are uploads of small files (currently up to 500 KB). Remember that ArDrive empowers you to be in control of your data; no one else has your password but you. Therefore, it is very important that you safely record your password and seed phrase as they cannot be recovered later.")]),e._v(" "),t("h2",{attrs:{id:"_3-create-a-new-public-drive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_3-create-a-new-public-drive"}},[e._v("#")]),e._v(" 3. Create a New Public Drive")]),e._v(" "),t("p",[e._v("Click on the red +New button and create a Drive. Name your Drive and set it as “Public”. ArDrive also offers “Private” file storage; however, permanent websites must be public in order to maintain functionality.")]),e._v(" "),t("h2",{attrs:{id:"_4-top-up"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_4-top-up"}},[e._v("#")]),e._v(" 4. Top Up")]),e._v(" "),t("p",[e._v("To pay for permanent storage on the Arweave network you must either purchase ArDrive Turbo credits with a credit card or (or the advanced option) ensure your wallet has $AR, the native token of the Arweave ecosystem. Most websites will cost less than $1 to save permanently. "),t("a",{attrs:{href:"https://ardrive.io/pricing/",target:"_blank",rel:"noopener noreferrer"}},[e._v("See current prices"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"_5-upload-static-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_5-upload-static-files"}},[e._v("#")]),e._v(" 5. Upload Static Files")]),e._v(" "),t("p",[e._v("Upload the static files to your new Public Drive. Offline Pages Pro will generate an index.html file that is "),t("em",[e._v("separate")]),e._v(" from a large folder of assets (images, css, fonts, etc). Simply Static will add the index.html file to the rest of your assets. Either way, upload all the files you receive from your static site generator to your new Public Drive.")]),e._v(" "),t("h2",{attrs:{id:"_6-wait"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_6-wait"}},[e._v("#")]),e._v(" 6. Wait")]),e._v(" "),t("p",[e._v("Permanence takes patience. Once static files have been uploaded, they need to be sent to the Arweave network before being assembled together. This process can take as little as 5 seconds (when using Turbo credits) or up to 30 minutes or more (when using $AR). Make sure to keep your browser tab open and do not refresh your browser while you wait.")]),e._v(" "),t("p",[e._v("To check on the status of your files, you can click the refresh icon in the top right of ArDrive. You’ll know your file is ready when the light on the icon turns from yellow to green. (Pro Tip: some files uploaded with Turbo are ready before they are green.)")]),e._v(" "),t("h2",{attrs:{id:"_7-create-a-manifest"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_7-create-a-manifest"}},[e._v("#")]),e._v(" 7. Create a Manifest")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://ardrive.io/manifests/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Manifests"),t("OutboundLink")],1),e._v(" are special "),t("code",[e._v(".json")]),e._v(" files that instruct Arweave Gateways to map file data associated with specific, unique transaction IDs to customized, hosted paths relative to that of the manifest file itself. In other words, they are the secret sauce that brings a permasite together.")]),e._v(" "),t("p",[e._v("Click on the red +New button and select Advanced > New Manifest. Select the location for your manifest, ensuring it is in the same place as your index.html file.")]),e._v(" "),t("p",[e._v("Give your Manifest a name like “permasite”, it will be the main way you access your permanent website from ArDrive.")]),e._v(" "),t("h2",{attrs:{id:"_8-wait-again"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_8-wait-again"}},[e._v("#")]),e._v(" 8. Wait Again")]),e._v(" "),t("p",[e._v("Now the manifest needs to be sent to the Arweave network. Again, this process can take just a few seconds or up to 30 minutes or more.")]),e._v(" "),t("p",[e._v("After a bit, you can refresh your Drive by clicking on the icon in the upper right – and see if your manifest icon turns from yellow to green.")]),e._v(" "),t("h2",{attrs:{id:"_9-preview-the-manifest"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_9-preview-the-manifest"}},[e._v("#")]),e._v(" 9. Preview the Manifest")]),e._v(" "),t("p",[e._v("Got a green light? You’re ready to go. Click on your manifest file and you will see a panel of options appear on the right side of your screen. Click on the Preview icon in the top right and it will open a new tab with your permasite.")]),e._v(" "),t("p",[e._v("If a website appears with a long, random-looking URL in the browser bar, then congrats, you made a permasite!")]),e._v(" "),t("p",[e._v("Try clicking around and make sure all your pages are preserved. If they are not it could be a limitation of your static site generator or an issue with the manifest (see Notes below).")]),e._v(" "),t("h2",{attrs:{id:"_10-add-a-redirect-or-domain-masking"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_10-add-a-redirect-or-domain-masking"}},[e._v("#")]),e._v(" 10. Add a Redirect or Domain Masking")]),e._v(" "),t("p",[e._v("You’ll notice that your permasite has a long, random-looking URL generated by Arweave. These long URLs are designed to remain for decades, but they also are not very memorable.")]),e._v(" "),t("p",[e._v("Try redirecting another domain to your permasite, or mask your permasite domain with a domain of your choosing. You can also acquire an "),t("a",{attrs:{href:"https://ar.io/docs/arns/",target:"_blank",rel:"noopener noreferrer"}},[e._v("ArNS name"),t("OutboundLink")],1),e._v(" that enables you to create a custom, permanent name for your permasite.")]),e._v(" "),t("h2",{attrs:{id:"notes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#notes"}},[e._v("#")]),e._v(" Notes")]),e._v(" "),t("ul",[t("li",[t("p",[e._v("There’s no delete button with Arweave. Once your permasite is up, it’s up forever. Make sure your content is something you want future humanity to have.")])]),e._v(" "),t("li",[t("p",[e._v("Only static sites can become permasites through the ArDrive web app. Advanced functionality is available for developers who use the "),t("a",{attrs:{href:"https://app.ardrive.io",target:"_blank",rel:"noopener noreferrer"}},[e._v("ArDrive CLI"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("li",[t("p",[e._v("Links to content on external websites will not be permanent (unless they are also permasites) and if that external content becomes inaccessible or moves, you will not be able to update the links within your permasite.")])]),e._v(" "),t("li",[t("p",[e._v("Non-English characters in the URLs of your permasite can be problematic for ArDrive manifests, but non-English characters should work well on the permasite itself.")])])]),e._v(" "),t("h2",{attrs:{id:"other-use-cases"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#other-use-cases"}},[e._v("#")]),e._v(" Other Use Cases")]),e._v(" "),t("p",[e._v("Permasites can be used to archive web content before it disappears from the internet. Or they can be used to create working copies of websites before it a particular site is replaced by new versions.")]),e._v(" "),t("p",[e._v("Manifests can also be used to make reliable perma-backups. Many web hosts offer good daily backups and some offer reliable offsite backups as well. Permasites enable you to have decentralized, highly-redundant backups of your website’s content for a very low cost.")]),e._v(" "),t("h2",{attrs:{id:"example"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#example"}},[e._v("#")]),e._v(" Example")]),e._v(" "),t("p",[e._v("You can view a permasite version of this information at "),t("a",{attrs:{href:"https://permasite.arweave.dev",target:"_blank",rel:"noopener noreferrer"}},[e._v("permasite.arweave.dev"),t("OutboundLink")],1)])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/35.5091c8e4.js b/assets/js/35.fdb54256.js similarity index 99% rename from assets/js/35.5091c8e4.js rename to assets/js/35.fdb54256.js index cdd9bac..d060710 100644 --- a/assets/js/35.5091c8e4.js +++ b/assets/js/35.fdb54256.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[35],{316:function(e,t,r){"use strict";r.r(t);var a=r(10),s=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"ardrive-price-calculator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ardrive-price-calculator"}},[e._v("#")]),e._v(" ArDrive Price Calculator")]),e._v(" "),t("h2",{attrs:{id:"overview"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#overview"}},[e._v("#")]),e._v(" Overview")]),e._v(" "),t("p",[e._v("The "),t("a",{attrs:{href:"https://ardrive.io/pricing/",target:"_blank",rel:"noopener noreferrer"}},[e._v("ArDrive Price Calculator website"),t("OutboundLink")],1),e._v(" is open source, and its code can be viewed "),t("a",{attrs:{href:"https://github.com/ardriveapp/price-calculator",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("This website is intended to calculate the cost, in a wide variety of denominations and cryptocurrencies, of uploading data to Arweave. You can spin up your own version by cloning the code from Github and following these steps.")]),e._v(" "),t("h2",{attrs:{id:"developer-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#developer-setup"}},[e._v("#")]),e._v(" Developer Setup")]),e._v(" "),t("p",[e._v("Follow these steps to get the developer environment up and running:")]),e._v(" "),t("h3",{attrs:{id:"install-yarn-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#install-yarn-2"}},[e._v("#")]),e._v(" Install Yarn 2")]),e._v(" "),t("p",[e._v("The ArDrive Price Calculator uses Yarn 2, so install the latest version with the "),t("a",{attrs:{href:"https://yarnpkg.com/getting-started/install",target:"_blank",rel:"noopener noreferrer"}},[e._v("yarn installation instructions"),t("OutboundLink")],1),e._v(". In most cases:")]),e._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Brew:")]),e._v("\nbrew "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("yarn")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Or with NPM:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-g")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("yarn")]),e._v("\n")])])]),t("p",[e._v("We also use husky to manage the git commit hooks that help to improve the quality of our commits. Without installing husky, you risk committing non-compliant code to the repository.")]),e._v(" "),t("p",[e._v("Using husky triggers two pre-commit hooks. The first will run "),t("code",[e._v("lint-staged")]),e._v(" on each staged file, which includes running prettier to format, eslint for linting, and also tsc-files for quickly checking that TypeScript can compile the code. The second hook will test the codebase prior to committing, ensuring that all tests must pass.")]),e._v(" "),t("p",[e._v("To enable hooks locally, you will need to run:")]),e._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("yarn")]),e._v(" husky "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v("\n")])])]),t("h3",{attrs:{id:"nvm"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nvm"}},[e._v("#")]),e._v(" NVM")]),e._v(" "),t("p",[e._v("This repository uses NVM and an "),t("code",[e._v(".nvmrc")]),e._v(" file to lock the Node version to the current version used by "),t("code",[e._v("ardrive-core-js")]),e._v(".")]),e._v(" "),t("p",[e._v("Note for Windows: "),t("strong",[e._v("We recommend using WSL")]),e._v(" for setting up NVM on Windows using the "),t("a",{attrs:{href:"https://code.visualstudio.com/docs/remote/wsl",target:"_blank",rel:"noopener noreferrer"}},[e._v("instructions described here"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("Follow these steps to get NVM up and running on your system:")]),e._v(" "),t("ol",[t("li",[e._v("Install NVM using "),t("a",{attrs:{href:"https://github.com/nvm-sh/nvm#installing-and-updating",target:"_blank",rel:"noopener noreferrer"}},[e._v("these installation instructions"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[e._v("Navigate to this project's root directory")]),e._v(" "),t("li",[e._v("Ensure that the correct version of Node is installed by performing: "),t("code",[e._v("nvm install")])]),e._v(" "),t("li",[t("strong",[e._v("Every time you start a new terminal session or switch to this project from another NPM project")]),e._v(", you should set the correct version of Node by running: "),t("code",[e._v("nvm use")])])]),e._v(" "),t("h3",{attrs:{id:"recommended-visual-studio-code-extensions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#recommended-visual-studio-code-extensions"}},[e._v("#")]),e._v(" Recommended Visual Studio Code extensions")]),e._v(" "),t("p",[e._v("To ensure your environment is compatible, we also recommend the following VSCode extensions:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint",target:"_blank",rel:"noopener noreferrer"}},[e._v("ES-Lint"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig",target:"_blank",rel:"noopener noreferrer"}},[e._v("Editor-Config"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode",target:"_blank",rel:"noopener noreferrer"}},[e._v("Prettier"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=arcanis.vscode-zipfs",target:"_blank",rel:"noopener noreferrer"}},[e._v("ZipFS"),t("OutboundLink")],1)])]),e._v(" "),t("h2",{attrs:{id:"available-scripts"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#available-scripts"}},[e._v("#")]),e._v(" Available Scripts")]),e._v(" "),t("h3",{attrs:{id:"yarn-start"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#yarn-start"}},[e._v("#")]),e._v(" yarn start")]),e._v(" "),t("p",[e._v("Runs the app in the development mode.\nOpen http://localhost:8080 to view it in the browser.")]),e._v(" "),t("p",[e._v("The page will reload if you make edits.\nYou will also see any lint errors in the console.")]),e._v(" "),t("h3",{attrs:{id:"yarn-build"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#yarn-build"}},[e._v("#")]),e._v(" yarn build")]),e._v(" "),t("p",[e._v("Builds a static copy of your site to the "),t("code",[e._v("build/")]),e._v(" folder.\nYour app is ready to be deployed!")]),e._v(" "),t("h3",{attrs:{id:"yarn-test"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#yarn-test"}},[e._v("#")]),e._v(" yarn test")]),e._v(" "),t("p",[e._v("Launches the application test runner.\nRun with the "),t("code",[e._v("--watch")]),e._v(" flag ("),t("code",[e._v("yarn test -- --watch")]),e._v(") to run in interactive watch mode.")]),e._v(" "),t("h3",{attrs:{id:"yarn-run-prod"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#yarn-run-prod"}},[e._v("#")]),e._v(" yarn run:prod")]),e._v(" "),t("p",[e._v("Builds a fresh snowpack production build to the "),t("code",[e._v("build/")]),e._v(" folder\nThen launches that copy with "),t("code",[e._v("http-server-spa")]),e._v(" for local testing\nThe build will be available for preview at: "),t("a",{attrs:{href:"http://localhost:8080",target:"_blank",rel:"noopener noreferrer"}},[e._v("http://localhost:8080"),t("OutboundLink")],1)])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[35],{315:function(e,t,r){"use strict";r.r(t);var a=r(10),s=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"ardrive-price-calculator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ardrive-price-calculator"}},[e._v("#")]),e._v(" ArDrive Price Calculator")]),e._v(" "),t("h2",{attrs:{id:"overview"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#overview"}},[e._v("#")]),e._v(" Overview")]),e._v(" "),t("p",[e._v("The "),t("a",{attrs:{href:"https://ardrive.io/pricing/",target:"_blank",rel:"noopener noreferrer"}},[e._v("ArDrive Price Calculator website"),t("OutboundLink")],1),e._v(" is open source, and its code can be viewed "),t("a",{attrs:{href:"https://github.com/ardriveapp/price-calculator",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("This website is intended to calculate the cost, in a wide variety of denominations and cryptocurrencies, of uploading data to Arweave. You can spin up your own version by cloning the code from Github and following these steps.")]),e._v(" "),t("h2",{attrs:{id:"developer-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#developer-setup"}},[e._v("#")]),e._v(" Developer Setup")]),e._v(" "),t("p",[e._v("Follow these steps to get the developer environment up and running:")]),e._v(" "),t("h3",{attrs:{id:"install-yarn-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#install-yarn-2"}},[e._v("#")]),e._v(" Install Yarn 2")]),e._v(" "),t("p",[e._v("The ArDrive Price Calculator uses Yarn 2, so install the latest version with the "),t("a",{attrs:{href:"https://yarnpkg.com/getting-started/install",target:"_blank",rel:"noopener noreferrer"}},[e._v("yarn installation instructions"),t("OutboundLink")],1),e._v(". In most cases:")]),e._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Brew:")]),e._v("\nbrew "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("yarn")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Or with NPM:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-g")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("yarn")]),e._v("\n")])])]),t("p",[e._v("We also use husky to manage the git commit hooks that help to improve the quality of our commits. Without installing husky, you risk committing non-compliant code to the repository.")]),e._v(" "),t("p",[e._v("Using husky triggers two pre-commit hooks. The first will run "),t("code",[e._v("lint-staged")]),e._v(" on each staged file, which includes running prettier to format, eslint for linting, and also tsc-files for quickly checking that TypeScript can compile the code. The second hook will test the codebase prior to committing, ensuring that all tests must pass.")]),e._v(" "),t("p",[e._v("To enable hooks locally, you will need to run:")]),e._v(" "),t("div",{staticClass:"language-shell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-shell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("yarn")]),e._v(" husky "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v("\n")])])]),t("h3",{attrs:{id:"nvm"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nvm"}},[e._v("#")]),e._v(" NVM")]),e._v(" "),t("p",[e._v("This repository uses NVM and an "),t("code",[e._v(".nvmrc")]),e._v(" file to lock the Node version to the current version used by "),t("code",[e._v("ardrive-core-js")]),e._v(".")]),e._v(" "),t("p",[e._v("Note for Windows: "),t("strong",[e._v("We recommend using WSL")]),e._v(" for setting up NVM on Windows using the "),t("a",{attrs:{href:"https://code.visualstudio.com/docs/remote/wsl",target:"_blank",rel:"noopener noreferrer"}},[e._v("instructions described here"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("Follow these steps to get NVM up and running on your system:")]),e._v(" "),t("ol",[t("li",[e._v("Install NVM using "),t("a",{attrs:{href:"https://github.com/nvm-sh/nvm#installing-and-updating",target:"_blank",rel:"noopener noreferrer"}},[e._v("these installation instructions"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[e._v("Navigate to this project's root directory")]),e._v(" "),t("li",[e._v("Ensure that the correct version of Node is installed by performing: "),t("code",[e._v("nvm install")])]),e._v(" "),t("li",[t("strong",[e._v("Every time you start a new terminal session or switch to this project from another NPM project")]),e._v(", you should set the correct version of Node by running: "),t("code",[e._v("nvm use")])])]),e._v(" "),t("h3",{attrs:{id:"recommended-visual-studio-code-extensions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#recommended-visual-studio-code-extensions"}},[e._v("#")]),e._v(" Recommended Visual Studio Code extensions")]),e._v(" "),t("p",[e._v("To ensure your environment is compatible, we also recommend the following VSCode extensions:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint",target:"_blank",rel:"noopener noreferrer"}},[e._v("ES-Lint"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig",target:"_blank",rel:"noopener noreferrer"}},[e._v("Editor-Config"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode",target:"_blank",rel:"noopener noreferrer"}},[e._v("Prettier"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://marketplace.visualstudio.com/items?itemName=arcanis.vscode-zipfs",target:"_blank",rel:"noopener noreferrer"}},[e._v("ZipFS"),t("OutboundLink")],1)])]),e._v(" "),t("h2",{attrs:{id:"available-scripts"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#available-scripts"}},[e._v("#")]),e._v(" Available Scripts")]),e._v(" "),t("h3",{attrs:{id:"yarn-start"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#yarn-start"}},[e._v("#")]),e._v(" yarn start")]),e._v(" "),t("p",[e._v("Runs the app in the development mode.\nOpen http://localhost:8080 to view it in the browser.")]),e._v(" "),t("p",[e._v("The page will reload if you make edits.\nYou will also see any lint errors in the console.")]),e._v(" "),t("h3",{attrs:{id:"yarn-build"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#yarn-build"}},[e._v("#")]),e._v(" yarn build")]),e._v(" "),t("p",[e._v("Builds a static copy of your site to the "),t("code",[e._v("build/")]),e._v(" folder.\nYour app is ready to be deployed!")]),e._v(" "),t("h3",{attrs:{id:"yarn-test"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#yarn-test"}},[e._v("#")]),e._v(" yarn test")]),e._v(" "),t("p",[e._v("Launches the application test runner.\nRun with the "),t("code",[e._v("--watch")]),e._v(" flag ("),t("code",[e._v("yarn test -- --watch")]),e._v(") to run in interactive watch mode.")]),e._v(" "),t("h3",{attrs:{id:"yarn-run-prod"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#yarn-run-prod"}},[e._v("#")]),e._v(" yarn run:prod")]),e._v(" "),t("p",[e._v("Builds a fresh snowpack production build to the "),t("code",[e._v("build/")]),e._v(" folder\nThen launches that copy with "),t("code",[e._v("http-server-spa")]),e._v(" for local testing\nThe build will be available for preview at: "),t("a",{attrs:{href:"http://localhost:8080",target:"_blank",rel:"noopener noreferrer"}},[e._v("http://localhost:8080"),t("OutboundLink")],1)])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/36.40c32257.js b/assets/js/36.4d70737f.js similarity index 88% rename from assets/js/36.40c32257.js rename to assets/js/36.4d70737f.js index ed03a5c..52f468e 100644 --- a/assets/js/36.40c32257.js +++ b/assets/js/36.4d70737f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[36],{315:function(t,e,s){"use strict";s.r(e);var i=s(10),a=Object(i.a)({},(function(){var t=this._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("h1",{attrs:{id:"placeholder"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#placeholder"}},[this._v("#")]),this._v(" placeholder")]),this._v(" "),t("p",[this._v("Exercitation proident duis qui est veniam duis ullamco proident et veniam.")])])}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[36],{316:function(t,e,s){"use strict";s.r(e);var i=s(10),a=Object(i.a)({},(function(){var t=this._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("h1",{attrs:{id:"placeholder"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#placeholder"}},[this._v("#")]),this._v(" placeholder")]),this._v(" "),t("p",[this._v("Exercitation proident duis qui est veniam duis ullamco proident et veniam.")])])}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/37.4db136a4.js b/assets/js/37.9d454746.js similarity index 99% rename from assets/js/37.4db136a4.js rename to assets/js/37.9d454746.js index d7e54bb..dbcfae5 100644 --- a/assets/js/37.4db136a4.js +++ b/assets/js/37.9d454746.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[37],{317:function(n,a,e){"use strict";e.r(a);var t=e(10),r=Object(t.a)({},(function(){var n=this,a=n._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[a("h1",{attrs:{id:"payment-api"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#payment-api"}},[n._v("#")]),n._v(" Payment API")]),n._v(" "),a("h2",{attrs:{id:"overview"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#overview"}},[n._v("#")]),n._v(" Overview")]),n._v(" "),a("p",[n._v('ArDrive offers several API endpoints to help manage and determine costs associated with converting currencies into Turbo credits. The below endpoints offer access to useful information that can help stay in control when uploading data to Arweave using Turbo. "winc" refers to "winston credits", the smallest denomination of a Turbo credit.')]),n._v(" "),a("p",[a("strong",[n._v("Note")]),n._v(": This service is still evolving and the information provided below may be out of date. You can view the most up to date information about the available endpoints "),a("a",{attrs:{href:"https://payment.ardrive.io/api-docs",target:"_blank",rel:"noopener noreferrer"}},[n._v("here"),a("OutboundLink")],1),n._v(", or view the raw json for that documentation "),a("a",{attrs:{href:"https://payment.ardrive.io/openapi.json",target:"_blank",rel:"noopener noreferrer"}},[n._v("here"),a("OutboundLink")],1),n._v(".")]),n._v(" "),a("h2",{attrs:{id:"endpoints"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#endpoints"}},[n._v("#")]),n._v(" Endpoints")]),n._v(" "),a("p",[n._v("The host url for all below endpoints is:")]),n._v(" "),a("p",[a("code",[n._v("https://payment.ardrive.io/v1")])]),n._v(" "),a("p",[n._v("All of these endpoints use GET requests")]),n._v(" "),a("h3",{attrs:{id:"get-amount-of-credits-for-byte-count"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-amount-of-credits-for-byte-count"}},[n._v("#")]),n._v(" Get Amount of Credits for Byte Count")]),n._v(" "),a("p",[n._v("Returns the current amount of winc it will cost to upload a provided byte count worth of data.")]),n._v(" "),a("p",[a("code",[n._v("/price/bytes/{byteCount}")])]),n._v(" "),a("h4",{attrs:{id:"parameters"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[n._v("#")]),n._v(" Parameters")]),n._v(" "),a("p",[a("code",[n._v("byteCount")]),n._v("*: integer - (path)")]),n._v(" "),a("h4",{attrs:{id:"example"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example"}},[n._v("#")]),n._v(" Example")]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v("https://payment.ardrive.io/v1/price/bytes/5242880\n")])])]),a("details",[a("summary",[n._v("Response Body (JSON)")]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v('{\n "winc": "1676650364",\n "adjustments": [\n {\n "name": "FWD Research July 2023 Subsidy",\n "description": "A 60% discount for uploads over 500KiB",\n "operator": "multiply",\n "value": 0.6,\n "adjustmentAmount": "-2514975546"\n }\n ]\n}\n')])])])]),n._v(" "),a("h3",{attrs:{id:"get-winc-for-payment-type-and-amount"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-winc-for-payment-type-and-amount"}},[n._v("#")]),n._v(" Get winc for Payment Type and Amount")]),n._v(" "),a("p",[n._v("Returns the current amount of winc Turbo will quote for a given payment type and amount.")]),n._v(" "),a("p",[a("code",[n._v("/price/{type}/{amount}")])]),n._v(" "),a("h4",{attrs:{id:"parameters-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[n._v("#")]),n._v(" Parameters")]),n._v(" "),a("p",[a("code",[n._v("type")]),n._v('*: string - must match a supported currency, such as "usd" - (path)')]),n._v(" "),a("p",[a("code",[n._v("amount")]),n._v("*: integer - (path)")]),n._v(" "),a("h4",{attrs:{id:"example-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-2"}},[n._v("#")]),n._v(" Example")]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v("https://payment.ardrive.io/v1/price/usd/1000\n")])])]),a("details",[a("summary",[n._v("Response Body (JSON)")]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v('{\n "winc": "1365248226950"\n}\n')])])])]),n._v(" "),a("h3",{attrs:{id:"get-current-balance-of-winc"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-current-balance-of-winc"}},[n._v("#")]),n._v(" Get Current Balance of winc")]),n._v(" "),a("p",[n._v("use a signed request of a previously obtained JWT to get the signing wallet's current service balance in winc.")]),n._v(" "),a("p",[a("code",[n._v("/balance")])]),n._v(" "),a("h4",{attrs:{id:"parameters-3"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[n._v("#")]),n._v(" Parameters")]),n._v(" "),a("p",[a("code",[n._v("x-signature")]),n._v("*: string - (header)")]),n._v(" "),a("p",[a("code",[n._v("x-nonce")]),n._v("*: string - (header)")]),n._v(" "),a("p",[a("code",[n._v("x-public-key")]),n._v("*: string - (header)")]),n._v(" "),a("h3",{attrs:{id:"get-quote-for-credits"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-quote-for-credits"}},[n._v("#")]),n._v(" Get Quote for Credits")]),n._v(" "),a("p",[n._v("Gets a quote and payment session for a given payment method, destination address, currency type, and payment amount")]),n._v(" "),a("p",[a("code",[n._v("/top-up/{method}/{address}/{currency}/{amount}")])]),n._v(" "),a("h4",{attrs:{id:"parameters-4"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[n._v("#")]),n._v(" Parameters")]),n._v(" "),a("p",[a("code",[n._v("method")]),n._v("*: string - payment-intent | checkout-session - (path)")]),n._v(" "),a("p",[a("code",[n._v("address")]),n._v("*: string - public address of wallet - (path)")]),n._v(" "),a("p",[a("code",[n._v("currency")]),n._v("*: string - must match supported currency, such as usd - (path)")]),n._v(" "),a("p",[a("code",[n._v("amount")]),n._v("*: integer - amount of the currency to convert to winc, usd has a minimum transaction amount of 1000 ($10.00) - (path)")]),n._v(" "),a("h4",{attrs:{id:"example-3"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-3"}},[n._v("#")]),n._v(" Example")]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v("https://payment.ardrive.io/v1/top-up/checkout-session/cF0H0SKdnaDTqWKY9iJKBktTpdEWgb3GnlndE7ABv0Q/usd/1000\n")])])]),a("details",[a("summary",[a("b",[n._v("Response Body (JSON)")])]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v('{\n "topUpQuote": {\n "topUpQuoteId": "54f57b67-4fcf-47fb-85e6-85d4a8c96f25",\n "destinationAddressType": "arweave",\n "paymentAmount": 1000,\n "winstonCreditAmount": "1360424028269",\n "destinationAddress": "cF0H0SKdnaDTqWKY9iJKBktTpdEWgb3GnlndE7ABv0Q",\n "currencyType": "usd",\n "quoteExpirationDate": "2023-07-27T01:56:26.436Z",\n "paymentProvider": "stripe"\n },\n "paymentSession": {\n "id": "cs_live_a1p47UpvijHGe7sI8AI1kScZdd5qKzdyaHUWRaeuFVvVvDHXeuck68Pf51",\n "object": "checkout.session",\n "after_expiration": null,\n "allow_promotion_codes": null,\n "amount_subtotal": 1000,\n "amount_total": 1000,\n "automatic_tax": {\n "enabled": false,\n "status": null\n },\n "billing_address_collection": null,\n "cancel_url": "https://app.ardrive.io",\n "client_reference_id": null,\n "consent": null,\n "consent_collection": null,\n "created": 1690422686,\n "currency": "usd",\n "currency_conversion": null,\n "custom_fields": [],\n "custom_text": {\n "shipping_address": null,\n "submit": null\n },\n "customer": null,\n "customer_creation": "if_required",\n "customer_details": null,\n "customer_email": null,\n "expires_at": 1690509086,\n "invoice": null,\n "invoice_creation": {\n "enabled": false,\n "invoice_data": {\n "account_tax_ids": null,\n "custom_fields": null,\n "description": null,\n "footer": null,\n "metadata": {},\n "rendering_options": null\n }\n },\n "livemode": true,\n "locale": null,\n "metadata": {},\n "mode": "payment",\n "payment_intent": null,\n "payment_link": null,\n "payment_method_collection": "always",\n "payment_method_options": {},\n "payment_method_types": [\n "card"\n ],\n "payment_status": "unpaid",\n "phone_number_collection": {\n "enabled": false\n },\n "recovered_from": null,\n "setup_intent": null,\n "shipping_address_collection": null,\n "shipping_cost": null,\n "shipping_details": null,\n "shipping_options": [],\n "status": "open",\n "submit_type": null,\n "subscription": null,\n "success_url": "https://app.ardrive.io",\n "total_details": {\n "amount_discount": 0,\n "amount_shipping": 0,\n "amount_tax": 0\n },\n "url": "https://checkout.stripe.com/c/pay/cs_live_a1p47UpvijHGe7sI8AI1kScZdd5qKzdyaHUWRaeuFVvVvDHXeuck68Pf51#fidkdWxOYHwnPyd1blppbHNgWjA0T1BEcXJGPWR1VUpSbkFJSFR0S0M8dlV1Y2tgS1ZVa3JdPVxfPXw0Q0tBaTNzPDFtX0xyf2JDVlxpNzJnUkAxSmp2PUZJdHBwa1B2ck53TmZkQW1BSjNoNTU3XG88RGBObycpJ2N3amhWYHdzYHcnP3F3cGApJ2lkfGpwcVF8dWAnPyd2bGtiaWBabHFgaCcpJ2BrZGdpYFVpZGZgbWppYWB3dic%2FcXdwYHgl"\n }\n}\n')])])])]),n._v(" "),a("h3",{attrs:{id:"get-supported-currencies"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-supported-currencies"}},[n._v("#")]),n._v(" Get Supported Currencies")]),n._v(" "),a("p",[n._v("Returns a list of currency types supported by Turbo")]),n._v(" "),a("p",[a("code",[n._v("/currencies")])]),n._v(" "),a("h4",{attrs:{id:"parameters-5"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[n._v("#")]),n._v(" Parameters")]),n._v(" "),a("p",[n._v("None")]),n._v(" "),a("h4",{attrs:{id:"example-4"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-4"}},[n._v("#")]),n._v(" Example")]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v("https://payment.ardrive.io/v1/currencies\n")])])]),a("details",[a("summary",[a("b",[n._v("Response Body (JSON)")])]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v('{\n "supportedCurrencies": [\n "aud",\n "brl",\n "cad",\n "eur",\n "gbp",\n "hkd",\n "inr",\n "jpy",\n "sgd",\n "usd"\n ],\n "limits": {\n "aud": {\n "maximumPaymentAmount": 1500000,\n "minimumPaymentAmount": 1500,\n "suggestedPaymentAmounts": [\n 2500,\n 7500,\n 15000\n ],\n "zeroDecimalCurrency": false\n },\n "brl": {\n "maximumPaymentAmount": 5000000,\n "minimumPaymentAmount": 5000,\n "suggestedPaymentAmounts": [\n 12500,\n 25000,\n 50000\n ],\n "zeroDecimalCurrency": false\n },\n "cad": {\n "maximumPaymentAmount": 1300000,\n "minimumPaymentAmount": 1400,\n "suggestedPaymentAmounts": [\n 2500,\n 5000,\n 10000\n ],\n "zeroDecimalCurrency": false\n },\n "eur": {\n "maximumPaymentAmount": 1000000,\n "minimumPaymentAmount": 1000,\n "suggestedPaymentAmounts": [\n 2500,\n 5000,\n 10000\n ],\n "zeroDecimalCurrency": false\n },\n "gbp": {\n "maximumPaymentAmount": 770000,\n "minimumPaymentAmount": 780,\n "suggestedPaymentAmounts": [\n 2000,\n 4000,\n 8000\n ],\n "zeroDecimalCurrency": false\n },\n "hkd": {\n "maximumPaymentAmount": 7800000,\n "minimumPaymentAmount": 7900,\n "suggestedPaymentAmounts": [\n 20000,\n 40000,\n 80000\n ],\n "zeroDecimalCurrency": false\n },\n "inr": {\n "maximumPaymentAmount": 90000000,\n "minimumPaymentAmount": 83000,\n "suggestedPaymentAmounts": [\n 200000,\n 400000,\n 800000\n ],\n "zeroDecimalCurrency": false\n },\n "jpy": {\n "maximumPaymentAmount": 1500000,\n "minimumPaymentAmount": 1500,\n "suggestedPaymentAmounts": [\n 3500,\n 6500,\n 15000\n ],\n "zeroDecimalCurrency": true\n },\n "sgd": {\n "maximumPaymentAmount": 1300000,\n "minimumPaymentAmount": 1500,\n "suggestedPaymentAmounts": [\n 2500,\n 7500,\n 15000\n ],\n "zeroDecimalCurrency": false\n },\n "usd": {\n "maximumPaymentAmount": 1000000,\n "minimumPaymentAmount": 1000,\n "suggestedPaymentAmounts": [\n 2500,\n 5000,\n 10000\n ],\n "zeroDecimalCurrency": false\n }\n }\n}\n')])])])]),n._v(" "),a("h3",{attrs:{id:"get-supported-countries"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-supported-countries"}},[n._v("#")]),n._v(" Get Supported Countries")]),n._v(" "),a("p",[n._v("Returns a list of countries where Turbo is available")]),n._v(" "),a("p",[a("code",[n._v("/countries")])]),n._v(" "),a("h4",{attrs:{id:"parameters-6"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[n._v("#")]),n._v(" Parameters")]),n._v(" "),a("p",[n._v("None")]),n._v(" "),a("h4",{attrs:{id:"example-5"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-5"}},[n._v("#")]),n._v(" Example")]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v("https://payment.ardrive.io/v1/countries\n")])])]),a("details",[a("summary",[a("b",[n._v("Response Body (JSON)")])]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v('[\n "United States",\n "United Kingdom",\n "Afghanistan",\n "Albania",\n "Algeria",\n "Andorra",\n "Angola",\n "Antigua and Barbuda",\n "Argentina",\n "Armenia",\n "Australia",\n "Austria",\n "Azerbaijan",\n "Bahamas",\n "Bahrain",\n "Bangladesh",\n "Barbados",\n "Belarus",\n "Belgium",\n "Belize",\n "Benin",\n "Bhutan",\n "Bolivia",\n "Bosnia and Herzegovina",\n "Botswana",\n "Brazil",\n "Brunei",\n "Bulgaria",\n "Burkina Faso",\n "Burundi",\n "Cabo Verde",\n "Cambodia",\n "Cameroon",\n "Canada",\n "Central African Republic",\n "Chad",\n "Chile",\n "China",\n "Colombia",\n "Comoros",\n "Congo",\n "Costa Rica",\n "Cote d\'Ivoire",\n "Croatia",\n "Cyprus",\n "Czech Republic",\n "Democratic Republic of the Congo",\n "Denmark",\n "Djibouti",\n "Dominica",\n "Dominican Republic",\n "East Timor",\n "Ecuador",\n "Egypt",\n "El Salvador",\n "Equatorial Guinea",\n "Eritrea",\n "Estonia",\n "Eswatini",\n "Ethiopia",\n "Fiji",\n "Finland",\n "France",\n "Gabon",\n "Gambia",\n "Georgia",\n "Germany",\n "Ghana",\n "Greece",\n "Grenada",\n "Guatemala",\n "Guinea",\n "Guinea-Bissau",\n "Guyana",\n "Haiti",\n "Honduras",\n "Hungary",\n "Iceland",\n "India",\n "Indonesia",\n "Iraq",\n "Ireland",\n "Israel",\n "Italy",\n "Jamaica",\n "Japan",\n "Jordan",\n "Kazakhstan",\n "Kenya",\n "Kiribati",\n "Kuwait",\n "Kyrgyzstan",\n "Laos",\n "Latvia",\n "Lebanon",\n "Lesotho",\n "Liberia",\n "Libya",\n "Liechtenstein",\n "Lithuania",\n "Luxembourg",\n "Madagascar",\n "Malawi",\n "Malaysia",\n "Maldives",\n "Mali",\n "Malta",\n "Marshall Islands",\n "Mauritania",\n "Mauritius",\n "Mexico",\n "Micronesia",\n "Moldova",\n "Monaco",\n "Mongolia",\n "Montenegro",\n "Morocco",\n "Mozambique",\n "Myanmar",\n "Namibia",\n "Nauru",\n "Nepal",\n "Netherlands",\n "New Zealand",\n "Nicaragua",\n "Niger",\n "Nigeria",\n "North Macedonia",\n "Norway",\n "Oman",\n "Pakistan",\n "Palau",\n "Palestine",\n "Panama",\n "Papua New Guinea",\n "Paraguay",\n "Peru",\n "Philippines",\n "Poland",\n "Portugal",\n "Qatar",\n "Romania",\n "Russia",\n "Rwanda",\n "Saint Kitts and Nevis",\n "Saint Lucia",\n "Saint Vincent and the Grenadines",\n "Samoa",\n "San Marino",\n "Sao Tome and Principe",\n "Saudi Arabia",\n "Senegal",\n "Serbia",\n "Seychelles",\n "Sierra Leone",\n "Singapore",\n "Slovakia",\n "Slovenia",\n "Solomon Islands",\n "Somalia",\n "South Africa",\n "South Korea",\n "South Sudan",\n "Spain",\n "Sri Lanka",\n "Sudan",\n "Suriname",\n "Sweden",\n "Switzerland",\n "Taiwan",\n "Tajikistan",\n "Tanzania",\n "Thailand",\n "Togo",\n "Tonga",\n "Trinidad and Tobago",\n "Tunisia",\n "Turkey",\n "Turkmenistan",\n "Tuvalu",\n "Uganda",\n "Ukraine",\n "United Arab Emirates",\n "Uruguay",\n "Uzbekistan",\n "Vanuatu",\n "Vatican City",\n "Venezuela",\n "Vietnam",\n "Yemen",\n "Zambia",\n "Zimbabwe"\n]\n')])])])]),n._v(" "),a("h3",{attrs:{id:"get-conversion-rates"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-conversion-rates"}},[n._v("#")]),n._v(" Get Conversion Rates")]),n._v(" "),a("p",[n._v("Returns supported fiat conversion rates for 1GB of storage based on current market prices")]),n._v(" "),a("p",[a("code",[n._v("/rates")])]),n._v(" "),a("h4",{attrs:{id:"parameters-7"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[n._v("#")]),n._v(" Parameters")]),n._v(" "),a("p",[n._v("None")]),n._v(" "),a("h4",{attrs:{id:"example-6"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-6"}},[n._v("#")]),n._v(" Example")]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v("https://payment.ardrive.io/v1/rates\n")])])]),a("details",[a("summary",[a("b",[n._v("Response Body (JSON)")])]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v('{\n "winc": "343168912867",\n "fiat": {\n "aud": 3.52873729722864,\n "brl": 11.34598786477272,\n "cad": 3.15729126594135,\n "eur": 2.1569195680425,\n "gbp": 1.8487882011791101,\n "hkd": 18.66938404981161,\n "inr": 196.24591287088242,\n "jpy": 334.744630809484,\n "sgd": 3.16995419882613,\n "usd": 2.39329431522465\n },\n "adjustments": [\n {\n "name": "FWD Research July 2023 Subsidy",\n "description": "A 60% discount for uploads over 500KiB",\n "operator": "multiply",\n "value": 0.6,\n "adjustmentAmount": "-514753369299"\n }\n ]\n}\n')])])])]),n._v(" "),a("p",[n._v("* required")])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[37],{321:function(n,a,e){"use strict";e.r(a);var t=e(10),r=Object(t.a)({},(function(){var n=this,a=n._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[a("h1",{attrs:{id:"payment-api"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#payment-api"}},[n._v("#")]),n._v(" Payment API")]),n._v(" "),a("h2",{attrs:{id:"overview"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#overview"}},[n._v("#")]),n._v(" Overview")]),n._v(" "),a("p",[n._v('ArDrive offers several API endpoints to help manage and determine costs associated with converting currencies into Turbo credits. The below endpoints offer access to useful information that can help stay in control when uploading data to Arweave using Turbo. "winc" refers to "winston credits", the smallest denomination of a Turbo credit.')]),n._v(" "),a("p",[a("strong",[n._v("Note")]),n._v(": This service is still evolving and the information provided below may be out of date. You can view the most up to date information about the available endpoints "),a("a",{attrs:{href:"https://payment.ardrive.io/api-docs",target:"_blank",rel:"noopener noreferrer"}},[n._v("here"),a("OutboundLink")],1),n._v(", or view the raw json for that documentation "),a("a",{attrs:{href:"https://payment.ardrive.io/openapi.json",target:"_blank",rel:"noopener noreferrer"}},[n._v("here"),a("OutboundLink")],1),n._v(".")]),n._v(" "),a("h2",{attrs:{id:"endpoints"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#endpoints"}},[n._v("#")]),n._v(" Endpoints")]),n._v(" "),a("p",[n._v("The host url for all below endpoints is:")]),n._v(" "),a("p",[a("code",[n._v("https://payment.ardrive.io/v1")])]),n._v(" "),a("p",[n._v("All of these endpoints use GET requests")]),n._v(" "),a("h3",{attrs:{id:"get-amount-of-credits-for-byte-count"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-amount-of-credits-for-byte-count"}},[n._v("#")]),n._v(" Get Amount of Credits for Byte Count")]),n._v(" "),a("p",[n._v("Returns the current amount of winc it will cost to upload a provided byte count worth of data.")]),n._v(" "),a("p",[a("code",[n._v("/price/bytes/{byteCount}")])]),n._v(" "),a("h4",{attrs:{id:"parameters"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[n._v("#")]),n._v(" Parameters")]),n._v(" "),a("p",[a("code",[n._v("byteCount")]),n._v("*: integer - (path)")]),n._v(" "),a("h4",{attrs:{id:"example"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example"}},[n._v("#")]),n._v(" Example")]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v("https://payment.ardrive.io/v1/price/bytes/5242880\n")])])]),a("details",[a("summary",[n._v("Response Body (JSON)")]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v('{\n "winc": "1676650364",\n "adjustments": [\n {\n "name": "FWD Research July 2023 Subsidy",\n "description": "A 60% discount for uploads over 500KiB",\n "operator": "multiply",\n "value": 0.6,\n "adjustmentAmount": "-2514975546"\n }\n ]\n}\n')])])])]),n._v(" "),a("h3",{attrs:{id:"get-winc-for-payment-type-and-amount"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-winc-for-payment-type-and-amount"}},[n._v("#")]),n._v(" Get winc for Payment Type and Amount")]),n._v(" "),a("p",[n._v("Returns the current amount of winc Turbo will quote for a given payment type and amount.")]),n._v(" "),a("p",[a("code",[n._v("/price/{type}/{amount}")])]),n._v(" "),a("h4",{attrs:{id:"parameters-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[n._v("#")]),n._v(" Parameters")]),n._v(" "),a("p",[a("code",[n._v("type")]),n._v('*: string - must match a supported currency, such as "usd" - (path)')]),n._v(" "),a("p",[a("code",[n._v("amount")]),n._v("*: integer - (path)")]),n._v(" "),a("h4",{attrs:{id:"example-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-2"}},[n._v("#")]),n._v(" Example")]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v("https://payment.ardrive.io/v1/price/usd/1000\n")])])]),a("details",[a("summary",[n._v("Response Body (JSON)")]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v('{\n "winc": "1365248226950"\n}\n')])])])]),n._v(" "),a("h3",{attrs:{id:"get-current-balance-of-winc"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-current-balance-of-winc"}},[n._v("#")]),n._v(" Get Current Balance of winc")]),n._v(" "),a("p",[n._v("use a signed request of a previously obtained JWT to get the signing wallet's current service balance in winc.")]),n._v(" "),a("p",[a("code",[n._v("/balance")])]),n._v(" "),a("h4",{attrs:{id:"parameters-3"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[n._v("#")]),n._v(" Parameters")]),n._v(" "),a("p",[a("code",[n._v("x-signature")]),n._v("*: string - (header)")]),n._v(" "),a("p",[a("code",[n._v("x-nonce")]),n._v("*: string - (header)")]),n._v(" "),a("p",[a("code",[n._v("x-public-key")]),n._v("*: string - (header)")]),n._v(" "),a("h3",{attrs:{id:"get-quote-for-credits"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-quote-for-credits"}},[n._v("#")]),n._v(" Get Quote for Credits")]),n._v(" "),a("p",[n._v("Gets a quote and payment session for a given payment method, destination address, currency type, and payment amount")]),n._v(" "),a("p",[a("code",[n._v("/top-up/{method}/{address}/{currency}/{amount}")])]),n._v(" "),a("h4",{attrs:{id:"parameters-4"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[n._v("#")]),n._v(" Parameters")]),n._v(" "),a("p",[a("code",[n._v("method")]),n._v("*: string - payment-intent | checkout-session - (path)")]),n._v(" "),a("p",[a("code",[n._v("address")]),n._v("*: string - public address of wallet - (path)")]),n._v(" "),a("p",[a("code",[n._v("currency")]),n._v("*: string - must match supported currency, such as usd - (path)")]),n._v(" "),a("p",[a("code",[n._v("amount")]),n._v("*: integer - amount of the currency to convert to winc, usd has a minimum transaction amount of 1000 ($10.00) - (path)")]),n._v(" "),a("h4",{attrs:{id:"example-3"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-3"}},[n._v("#")]),n._v(" Example")]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v("https://payment.ardrive.io/v1/top-up/checkout-session/cF0H0SKdnaDTqWKY9iJKBktTpdEWgb3GnlndE7ABv0Q/usd/1000\n")])])]),a("details",[a("summary",[a("b",[n._v("Response Body (JSON)")])]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v('{\n "topUpQuote": {\n "topUpQuoteId": "54f57b67-4fcf-47fb-85e6-85d4a8c96f25",\n "destinationAddressType": "arweave",\n "paymentAmount": 1000,\n "winstonCreditAmount": "1360424028269",\n "destinationAddress": "cF0H0SKdnaDTqWKY9iJKBktTpdEWgb3GnlndE7ABv0Q",\n "currencyType": "usd",\n "quoteExpirationDate": "2023-07-27T01:56:26.436Z",\n "paymentProvider": "stripe"\n },\n "paymentSession": {\n "id": "cs_live_a1p47UpvijHGe7sI8AI1kScZdd5qKzdyaHUWRaeuFVvVvDHXeuck68Pf51",\n "object": "checkout.session",\n "after_expiration": null,\n "allow_promotion_codes": null,\n "amount_subtotal": 1000,\n "amount_total": 1000,\n "automatic_tax": {\n "enabled": false,\n "status": null\n },\n "billing_address_collection": null,\n "cancel_url": "https://app.ardrive.io",\n "client_reference_id": null,\n "consent": null,\n "consent_collection": null,\n "created": 1690422686,\n "currency": "usd",\n "currency_conversion": null,\n "custom_fields": [],\n "custom_text": {\n "shipping_address": null,\n "submit": null\n },\n "customer": null,\n "customer_creation": "if_required",\n "customer_details": null,\n "customer_email": null,\n "expires_at": 1690509086,\n "invoice": null,\n "invoice_creation": {\n "enabled": false,\n "invoice_data": {\n "account_tax_ids": null,\n "custom_fields": null,\n "description": null,\n "footer": null,\n "metadata": {},\n "rendering_options": null\n }\n },\n "livemode": true,\n "locale": null,\n "metadata": {},\n "mode": "payment",\n "payment_intent": null,\n "payment_link": null,\n "payment_method_collection": "always",\n "payment_method_options": {},\n "payment_method_types": [\n "card"\n ],\n "payment_status": "unpaid",\n "phone_number_collection": {\n "enabled": false\n },\n "recovered_from": null,\n "setup_intent": null,\n "shipping_address_collection": null,\n "shipping_cost": null,\n "shipping_details": null,\n "shipping_options": [],\n "status": "open",\n "submit_type": null,\n "subscription": null,\n "success_url": "https://app.ardrive.io",\n "total_details": {\n "amount_discount": 0,\n "amount_shipping": 0,\n "amount_tax": 0\n },\n "url": "https://checkout.stripe.com/c/pay/cs_live_a1p47UpvijHGe7sI8AI1kScZdd5qKzdyaHUWRaeuFVvVvDHXeuck68Pf51#fidkdWxOYHwnPyd1blppbHNgWjA0T1BEcXJGPWR1VUpSbkFJSFR0S0M8dlV1Y2tgS1ZVa3JdPVxfPXw0Q0tBaTNzPDFtX0xyf2JDVlxpNzJnUkAxSmp2PUZJdHBwa1B2ck53TmZkQW1BSjNoNTU3XG88RGBObycpJ2N3amhWYHdzYHcnP3F3cGApJ2lkfGpwcVF8dWAnPyd2bGtiaWBabHFgaCcpJ2BrZGdpYFVpZGZgbWppYWB3dic%2FcXdwYHgl"\n }\n}\n')])])])]),n._v(" "),a("h3",{attrs:{id:"get-supported-currencies"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-supported-currencies"}},[n._v("#")]),n._v(" Get Supported Currencies")]),n._v(" "),a("p",[n._v("Returns a list of currency types supported by Turbo")]),n._v(" "),a("p",[a("code",[n._v("/currencies")])]),n._v(" "),a("h4",{attrs:{id:"parameters-5"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[n._v("#")]),n._v(" Parameters")]),n._v(" "),a("p",[n._v("None")]),n._v(" "),a("h4",{attrs:{id:"example-4"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-4"}},[n._v("#")]),n._v(" Example")]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v("https://payment.ardrive.io/v1/currencies\n")])])]),a("details",[a("summary",[a("b",[n._v("Response Body (JSON)")])]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v('{\n "supportedCurrencies": [\n "aud",\n "brl",\n "cad",\n "eur",\n "gbp",\n "hkd",\n "inr",\n "jpy",\n "sgd",\n "usd"\n ],\n "limits": {\n "aud": {\n "maximumPaymentAmount": 1500000,\n "minimumPaymentAmount": 1500,\n "suggestedPaymentAmounts": [\n 2500,\n 7500,\n 15000\n ],\n "zeroDecimalCurrency": false\n },\n "brl": {\n "maximumPaymentAmount": 5000000,\n "minimumPaymentAmount": 5000,\n "suggestedPaymentAmounts": [\n 12500,\n 25000,\n 50000\n ],\n "zeroDecimalCurrency": false\n },\n "cad": {\n "maximumPaymentAmount": 1300000,\n "minimumPaymentAmount": 1400,\n "suggestedPaymentAmounts": [\n 2500,\n 5000,\n 10000\n ],\n "zeroDecimalCurrency": false\n },\n "eur": {\n "maximumPaymentAmount": 1000000,\n "minimumPaymentAmount": 1000,\n "suggestedPaymentAmounts": [\n 2500,\n 5000,\n 10000\n ],\n "zeroDecimalCurrency": false\n },\n "gbp": {\n "maximumPaymentAmount": 770000,\n "minimumPaymentAmount": 780,\n "suggestedPaymentAmounts": [\n 2000,\n 4000,\n 8000\n ],\n "zeroDecimalCurrency": false\n },\n "hkd": {\n "maximumPaymentAmount": 7800000,\n "minimumPaymentAmount": 7900,\n "suggestedPaymentAmounts": [\n 20000,\n 40000,\n 80000\n ],\n "zeroDecimalCurrency": false\n },\n "inr": {\n "maximumPaymentAmount": 90000000,\n "minimumPaymentAmount": 83000,\n "suggestedPaymentAmounts": [\n 200000,\n 400000,\n 800000\n ],\n "zeroDecimalCurrency": false\n },\n "jpy": {\n "maximumPaymentAmount": 1500000,\n "minimumPaymentAmount": 1500,\n "suggestedPaymentAmounts": [\n 3500,\n 6500,\n 15000\n ],\n "zeroDecimalCurrency": true\n },\n "sgd": {\n "maximumPaymentAmount": 1300000,\n "minimumPaymentAmount": 1500,\n "suggestedPaymentAmounts": [\n 2500,\n 7500,\n 15000\n ],\n "zeroDecimalCurrency": false\n },\n "usd": {\n "maximumPaymentAmount": 1000000,\n "minimumPaymentAmount": 1000,\n "suggestedPaymentAmounts": [\n 2500,\n 5000,\n 10000\n ],\n "zeroDecimalCurrency": false\n }\n }\n}\n')])])])]),n._v(" "),a("h3",{attrs:{id:"get-supported-countries"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-supported-countries"}},[n._v("#")]),n._v(" Get Supported Countries")]),n._v(" "),a("p",[n._v("Returns a list of countries where Turbo is available")]),n._v(" "),a("p",[a("code",[n._v("/countries")])]),n._v(" "),a("h4",{attrs:{id:"parameters-6"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[n._v("#")]),n._v(" Parameters")]),n._v(" "),a("p",[n._v("None")]),n._v(" "),a("h4",{attrs:{id:"example-5"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-5"}},[n._v("#")]),n._v(" Example")]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v("https://payment.ardrive.io/v1/countries\n")])])]),a("details",[a("summary",[a("b",[n._v("Response Body (JSON)")])]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v('[\n "United States",\n "United Kingdom",\n "Afghanistan",\n "Albania",\n "Algeria",\n "Andorra",\n "Angola",\n "Antigua and Barbuda",\n "Argentina",\n "Armenia",\n "Australia",\n "Austria",\n "Azerbaijan",\n "Bahamas",\n "Bahrain",\n "Bangladesh",\n "Barbados",\n "Belarus",\n "Belgium",\n "Belize",\n "Benin",\n "Bhutan",\n "Bolivia",\n "Bosnia and Herzegovina",\n "Botswana",\n "Brazil",\n "Brunei",\n "Bulgaria",\n "Burkina Faso",\n "Burundi",\n "Cabo Verde",\n "Cambodia",\n "Cameroon",\n "Canada",\n "Central African Republic",\n "Chad",\n "Chile",\n "China",\n "Colombia",\n "Comoros",\n "Congo",\n "Costa Rica",\n "Cote d\'Ivoire",\n "Croatia",\n "Cyprus",\n "Czech Republic",\n "Democratic Republic of the Congo",\n "Denmark",\n "Djibouti",\n "Dominica",\n "Dominican Republic",\n "East Timor",\n "Ecuador",\n "Egypt",\n "El Salvador",\n "Equatorial Guinea",\n "Eritrea",\n "Estonia",\n "Eswatini",\n "Ethiopia",\n "Fiji",\n "Finland",\n "France",\n "Gabon",\n "Gambia",\n "Georgia",\n "Germany",\n "Ghana",\n "Greece",\n "Grenada",\n "Guatemala",\n "Guinea",\n "Guinea-Bissau",\n "Guyana",\n "Haiti",\n "Honduras",\n "Hungary",\n "Iceland",\n "India",\n "Indonesia",\n "Iraq",\n "Ireland",\n "Israel",\n "Italy",\n "Jamaica",\n "Japan",\n "Jordan",\n "Kazakhstan",\n "Kenya",\n "Kiribati",\n "Kuwait",\n "Kyrgyzstan",\n "Laos",\n "Latvia",\n "Lebanon",\n "Lesotho",\n "Liberia",\n "Libya",\n "Liechtenstein",\n "Lithuania",\n "Luxembourg",\n "Madagascar",\n "Malawi",\n "Malaysia",\n "Maldives",\n "Mali",\n "Malta",\n "Marshall Islands",\n "Mauritania",\n "Mauritius",\n "Mexico",\n "Micronesia",\n "Moldova",\n "Monaco",\n "Mongolia",\n "Montenegro",\n "Morocco",\n "Mozambique",\n "Myanmar",\n "Namibia",\n "Nauru",\n "Nepal",\n "Netherlands",\n "New Zealand",\n "Nicaragua",\n "Niger",\n "Nigeria",\n "North Macedonia",\n "Norway",\n "Oman",\n "Pakistan",\n "Palau",\n "Palestine",\n "Panama",\n "Papua New Guinea",\n "Paraguay",\n "Peru",\n "Philippines",\n "Poland",\n "Portugal",\n "Qatar",\n "Romania",\n "Russia",\n "Rwanda",\n "Saint Kitts and Nevis",\n "Saint Lucia",\n "Saint Vincent and the Grenadines",\n "Samoa",\n "San Marino",\n "Sao Tome and Principe",\n "Saudi Arabia",\n "Senegal",\n "Serbia",\n "Seychelles",\n "Sierra Leone",\n "Singapore",\n "Slovakia",\n "Slovenia",\n "Solomon Islands",\n "Somalia",\n "South Africa",\n "South Korea",\n "South Sudan",\n "Spain",\n "Sri Lanka",\n "Sudan",\n "Suriname",\n "Sweden",\n "Switzerland",\n "Taiwan",\n "Tajikistan",\n "Tanzania",\n "Thailand",\n "Togo",\n "Tonga",\n "Trinidad and Tobago",\n "Tunisia",\n "Turkey",\n "Turkmenistan",\n "Tuvalu",\n "Uganda",\n "Ukraine",\n "United Arab Emirates",\n "Uruguay",\n "Uzbekistan",\n "Vanuatu",\n "Vatican City",\n "Venezuela",\n "Vietnam",\n "Yemen",\n "Zambia",\n "Zimbabwe"\n]\n')])])])]),n._v(" "),a("h3",{attrs:{id:"get-conversion-rates"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-conversion-rates"}},[n._v("#")]),n._v(" Get Conversion Rates")]),n._v(" "),a("p",[n._v("Returns supported fiat conversion rates for 1GB of storage based on current market prices")]),n._v(" "),a("p",[a("code",[n._v("/rates")])]),n._v(" "),a("h4",{attrs:{id:"parameters-7"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[n._v("#")]),n._v(" Parameters")]),n._v(" "),a("p",[n._v("None")]),n._v(" "),a("h4",{attrs:{id:"example-6"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-6"}},[n._v("#")]),n._v(" Example")]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v("https://payment.ardrive.io/v1/rates\n")])])]),a("details",[a("summary",[a("b",[n._v("Response Body (JSON)")])]),n._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[n._v('{\n "winc": "343168912867",\n "fiat": {\n "aud": 3.52873729722864,\n "brl": 11.34598786477272,\n "cad": 3.15729126594135,\n "eur": 2.1569195680425,\n "gbp": 1.8487882011791101,\n "hkd": 18.66938404981161,\n "inr": 196.24591287088242,\n "jpy": 334.744630809484,\n "sgd": 3.16995419882613,\n "usd": 2.39329431522465\n },\n "adjustments": [\n {\n "name": "FWD Research July 2023 Subsidy",\n "description": "A 60% discount for uploads over 500KiB",\n "operator": "multiply",\n "value": 0.6,\n "adjustmentAmount": "-514753369299"\n }\n ]\n}\n')])])])]),n._v(" "),a("p",[n._v("* required")])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/39.cd700cca.js b/assets/js/39.97331bb6.js similarity index 99% rename from assets/js/39.cd700cca.js rename to assets/js/39.97331bb6.js index 9e9bf52..379852a 100644 --- a/assets/js/39.cd700cca.js +++ b/assets/js/39.97331bb6.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[39],{319:function(t,a,s){"use strict";s.r(a);var e=s(10),n=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"migrating-to-turbo-from-irys"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#migrating-to-turbo-from-irys"}},[t._v("#")]),t._v(" Migrating to Turbo From Irys")]),t._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[t._v("Irys Version Management")]),t._v(" "),a("p",[t._v("This was tested using Irys SDK v0.1.1 Future versions of the Irys SDK, and by extension the Irys CLI, may introduce breaking changes. It is suggested that developers lock their version.")])]),t._v(" "),a("h2",{attrs:{id:"overview"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#overview"}},[t._v("#")]),t._v(" Overview")]),t._v(" "),a("p",[t._v("In the interest of maintaining robust and decentralized infrastructure throughout the Arweave community, it is important to provide options and alternatives to single points of potential failure. With this in mind, ArDrive Turbo provides an Irys-compatible API, allowing for simple migrations across services if desired.")]),t._v(" "),a("h2",{attrs:{id:"using-irys-sdk-with-turbo"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#using-irys-sdk-with-turbo"}},[t._v("#")]),t._v(" Using Irys SDK with Turbo")]),t._v(" "),a("p",[t._v("ArDrive Turbo can be selected as the upload method for projects that currently use the Irys SDK by setting the "),a("code",[t._v("url")]),t._v(" value to "),a("code",[t._v("https://up.arweave.net")]),t._v(" when instantiating the Irys instance:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// import Irys as normal")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Irys "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"@irys/sdk"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" fs "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"fs"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// load Arweave wallet")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" wallet "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("JSON")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("parse")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n fs\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("readFileSync")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Keyfile.json"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("init")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" token "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"arweave"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" irys "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Irys")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("url")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://up.arweave.net"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// URL of the node you want to connect to, https://up.arweave.net will facilitate upload using ArDrive Turbo.")]),t._v("\n token"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Token used for payment and signing")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("key")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" wallet"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Arweave wallet")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" receipt "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" irys"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("upload")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file/to/upload"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("receipt"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"using-irys-cli-with-turbo"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#using-irys-cli-with-turbo"}},[t._v("#")]),t._v(" Using Irys CLI with Turbo")]),t._v(" "),a("p",[t._v("Selecting Turbo as the upload method using the Irys CLI is similarly simple. "),a("code",[t._v("https://up.arweave.net")]),t._v(" can be set as the target node when using the "),a("code",[t._v("upload")]),t._v(" or "),a("code",[t._v("upload-dir")]),t._v(" CLI commands with the "),a("code",[t._v("-h")]),t._v(" flag:")]),t._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v("irys upload importantFile.pdf -h https://up.arweave.net --tags superImportant needsPermanence\n")])])]),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v("irys upload-dir ./bigFolder -h https://up.arweave.net \n")])])]),a("p",[t._v("Other flags may be used as normal")]),t._v(" "),a("h2",{attrs:{id:"differences"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#differences"}},[t._v("#")]),t._v(" Differences")]),t._v(" "),a("h3",{attrs:{id:"crypto-top-ups-withdrawals"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#crypto-top-ups-withdrawals"}},[t._v("#")]),t._v(" Crypto Top Ups / Withdrawals")]),t._v(" "),a("p",[t._v("Turbo does not natively support block chains other than Arweave. This means that some features dealing with other chains, like topping up your Irys balance with other coins, or withdrawing from your Irys balance are not "),a("em",[t._v("currently")]),t._v(" supported.")]),t._v(" "),a("h2",{attrs:{id:"wallet-extensions-and-providers"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#wallet-extensions-and-providers"}},[t._v("#")]),t._v(" Wallet Extensions and Providers")]),t._v(" "),a("p",[t._v("Turbo is not "),a("em",[t._v("yet")]),t._v(" designed to interact with wallet extensions and providers that are not a part of the Arweave ecosystem. While the ArDrive Web App does support generating an Arweave wallet from an EVM wallet using Metamask, Turbo cannot facilitate uploading using an EVM wallet directly.")]),t._v(" "),a("h2",{attrs:{id:"graphql"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#graphql"}},[t._v("#")]),t._v(" GraphQL")]),t._v(" "),a("p",[t._v("Projects that do claim to allow uploading from non-arweave wallets actually accept payment on their front ends and handle the actual uploading using an Arweave wallet. As such, the "),a("code",[t._v("owner")]),t._v(" of an upload will not match the non-arweave wallet address and the upload cannot be found by searching for it in GraphQL. This value can, however, be added as a tag on the upload and searched in that way.")])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[39],{317:function(t,a,s){"use strict";s.r(a);var e=s(10),n=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"migrating-to-turbo-from-irys"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#migrating-to-turbo-from-irys"}},[t._v("#")]),t._v(" Migrating to Turbo From Irys")]),t._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[t._v("Irys Version Management")]),t._v(" "),a("p",[t._v("This was tested using Irys SDK v0.1.1 Future versions of the Irys SDK, and by extension the Irys CLI, may introduce breaking changes. It is suggested that developers lock their version.")])]),t._v(" "),a("h2",{attrs:{id:"overview"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#overview"}},[t._v("#")]),t._v(" Overview")]),t._v(" "),a("p",[t._v("In the interest of maintaining robust and decentralized infrastructure throughout the Arweave community, it is important to provide options and alternatives to single points of potential failure. With this in mind, ArDrive Turbo provides an Irys-compatible API, allowing for simple migrations across services if desired.")]),t._v(" "),a("h2",{attrs:{id:"using-irys-sdk-with-turbo"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#using-irys-sdk-with-turbo"}},[t._v("#")]),t._v(" Using Irys SDK with Turbo")]),t._v(" "),a("p",[t._v("ArDrive Turbo can be selected as the upload method for projects that currently use the Irys SDK by setting the "),a("code",[t._v("url")]),t._v(" value to "),a("code",[t._v("https://up.arweave.net")]),t._v(" when instantiating the Irys instance:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// import Irys as normal")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Irys "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"@irys/sdk"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" fs "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"fs"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// load Arweave wallet")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" wallet "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("JSON")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("parse")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n fs\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("readFileSync")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Keyfile.json"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("init")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" token "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"arweave"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" irys "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Irys")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("url")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://up.arweave.net"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// URL of the node you want to connect to, https://up.arweave.net will facilitate upload using ArDrive Turbo.")]),t._v("\n token"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Token used for payment and signing")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("key")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" wallet"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Arweave wallet")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" receipt "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" irys"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("upload")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file/to/upload"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("receipt"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"using-irys-cli-with-turbo"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#using-irys-cli-with-turbo"}},[t._v("#")]),t._v(" Using Irys CLI with Turbo")]),t._v(" "),a("p",[t._v("Selecting Turbo as the upload method using the Irys CLI is similarly simple. "),a("code",[t._v("https://up.arweave.net")]),t._v(" can be set as the target node when using the "),a("code",[t._v("upload")]),t._v(" or "),a("code",[t._v("upload-dir")]),t._v(" CLI commands with the "),a("code",[t._v("-h")]),t._v(" flag:")]),t._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v("irys upload importantFile.pdf -h https://up.arweave.net --tags superImportant needsPermanence\n")])])]),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v("irys upload-dir ./bigFolder -h https://up.arweave.net \n")])])]),a("p",[t._v("Other flags may be used as normal")]),t._v(" "),a("h2",{attrs:{id:"differences"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#differences"}},[t._v("#")]),t._v(" Differences")]),t._v(" "),a("h3",{attrs:{id:"crypto-top-ups-withdrawals"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#crypto-top-ups-withdrawals"}},[t._v("#")]),t._v(" Crypto Top Ups / Withdrawals")]),t._v(" "),a("p",[t._v("Turbo does not natively support block chains other than Arweave. This means that some features dealing with other chains, like topping up your Irys balance with other coins, or withdrawing from your Irys balance are not "),a("em",[t._v("currently")]),t._v(" supported.")]),t._v(" "),a("h2",{attrs:{id:"wallet-extensions-and-providers"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#wallet-extensions-and-providers"}},[t._v("#")]),t._v(" Wallet Extensions and Providers")]),t._v(" "),a("p",[t._v("Turbo is not "),a("em",[t._v("yet")]),t._v(" designed to interact with wallet extensions and providers that are not a part of the Arweave ecosystem. While the ArDrive Web App does support generating an Arweave wallet from an EVM wallet using Metamask, Turbo cannot facilitate uploading using an EVM wallet directly.")]),t._v(" "),a("h2",{attrs:{id:"graphql"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#graphql"}},[t._v("#")]),t._v(" GraphQL")]),t._v(" "),a("p",[t._v("Projects that do claim to allow uploading from non-arweave wallets actually accept payment on their front ends and handle the actual uploading using an Arweave wallet. As such, the "),a("code",[t._v("owner")]),t._v(" of an upload will not match the non-arweave wallet address and the upload cannot be found by searching for it in GraphQL. This value can, however, be added as a tag on the upload and searched in that way.")])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/40.35038ceb.js b/assets/js/40.6c41e12f.js similarity index 99% rename from assets/js/40.35038ceb.js rename to assets/js/40.6c41e12f.js index 76c4258..13de69e 100644 --- a/assets/js/40.35038ceb.js +++ b/assets/js/40.6c41e12f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[40],{320:function(t,s,a){"use strict";a.r(s);var n=a(10),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"ardriveapp-turbo-sdk-🚀"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#ardriveapp-turbo-sdk-🚀"}},[t._v("#")]),t._v(" @ardriveapp/turbo-sdk 🚀")]),t._v(" "),s("p",[t._v("Welcome to the "),s("code",[t._v("@ardrive/turbo-sdk")]),t._v("! This SDK provides functionality for interacting with the Turbo Upload and Payment Services and is available for both NodeJS and Web environments.")]),t._v(" "),s("h2",{attrs:{id:"installation"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[t._v("#")]),t._v(" Installation")]),t._v(" "),s("div",{staticClass:"language-shell extra-class"},[s("pre",{pre:!0,attrs:{class:"language-shell"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[t._v("npm")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("install")]),t._v(" @ardrive/turbo-sdk\n")])])]),s("p",[t._v("or")]),t._v(" "),s("div",{staticClass:"language-shell extra-class"},[s("pre",{pre:!0,attrs:{class:"language-shell"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[t._v("yarn")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("add")]),t._v(" @ardrive/turbo-sdk\n")])])]),s("h2",{attrs:{id:"quick-start"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#quick-start"}},[t._v("#")]),t._v(" Quick Start")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" TurboFactory "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@ardrive/turbo-sdk'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// load your JWK from a file or generate a new one")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" jwk "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" fs"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("readFileSync")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'./my-jwk.json'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" address "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" arweave"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("wallets"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("jwkToAddress")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("jwk"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" turbo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" TurboFactory"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("authenticated")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" privateKey"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" jwk "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the wallet balance")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" winc"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" balance "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getBalance")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// prep file for upload")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" filePath "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" path"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("join")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("__dirname"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'./my-image.png'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" fileSize "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" fs"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("statSync")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("filePath"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("size"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the cost of uploading the file")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" winc"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" fileSizeCost "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getUploadCosts")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n bytes"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("fileSize"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// check if balance greater than upload cost")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("balance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v(" fileSizeCost"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" url "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createCheckoutSession")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n amount"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" fileSizeCost"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n owner"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" address"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a promo code if you have one")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// open the URL to top-up, continue when done")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("open")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("url"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// upload the file")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("try")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" id"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" owner"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" dataCaches"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" fastFinalityIndexes "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("uploadFile")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n fileStreamFactory "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" fs"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createReadStream")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("filePath"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n fileSizeFactory "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" fileSize"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// upload complete!")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token builtin"}},[t._v("console")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Successfully upload data item!'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" id"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" owner"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" dataCaches"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" fastFinalityIndexes "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("error"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// upload failed")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token builtin"}},[t._v("console")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("error")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Failed to upload data item!'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" error"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("finally")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" winc"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" newBalance "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getBalance")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token builtin"}},[t._v("console")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'New balance:'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" newBalance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("h2",{attrs:{id:"usage"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#usage"}},[t._v("#")]),t._v(" Usage")]),t._v(" "),s("p",[t._v("The SDK is provided in both CommonJS and ESM formats, and it's compatible with bundlers such as Webpack, Rollup, and ESbuild. Utilize the appropriate named exports provided by this SDK's "),s("a",{attrs:{href:"https://github.com/ardriveapp/turbo-sdk/blob/main/package.json",target:"_blank",rel:"noopener noreferrer"}},[t._v("package.json"),s("OutboundLink")],1),t._v(" based on your project's configuration. Refer to the "),s("a",{attrs:{href:"https://github.com/ardriveapp/turbo-sdk/tree/main/examples",target:"_blank",rel:"noopener noreferrer"}},[t._v("examples"),s("OutboundLink")],1),t._v(" directory to see how to use the SDK in various environments.")]),t._v(" "),s("h3",{attrs:{id:"web"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#web"}},[t._v("#")]),t._v(" Web")]),t._v(" "),s("h4",{attrs:{id:"bundlers-webpack-rollup-esbuild-etc"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#bundlers-webpack-rollup-esbuild-etc"}},[t._v("#")]),t._v(" Bundlers (Webpack, Rollup, ESbuild, etc.)")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" TurboFactory "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@ardrive/turbo-sdk'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" turbo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" TurboFactory"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("unauthenticated")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" rates "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getFiatRates")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"browser"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#browser"}},[t._v("#")]),t._v(" Browser")]),t._v(" "),s("div",{staticClass:"language-html extra-class"},[s("pre",{pre:!0,attrs:{class:"language-html"}},[s("code",[t._v("\n"),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("module"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token script"}},[s("span",{pre:!0,attrs:{class:"token language-javascript"}},[t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" TurboFactory "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'https://unpkg.com/@ardrive/turbo-sdk'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" turbo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" TurboFactory"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("unauthenticated")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" rates "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getFiatRates")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),s("h3",{attrs:{id:"nodejs"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#nodejs"}},[t._v("#")]),t._v(" NodeJS")]),t._v(" "),s("h4",{attrs:{id:"commonjs"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#commonjs"}},[t._v("#")]),t._v(" CommonJS")]),t._v(" "),s("p",[t._v("Project's "),s("code",[t._v("package.json")]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-json extra-class"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"commonjs"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// or absent")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("p",[t._v("Project's "),s("code",[t._v("tsconfig.json")]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-json extra-class"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"compilerOptions"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"module"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"CommonJS"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"moduleResolution"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Node"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"skipLibCheck"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("p",[t._v("Usage:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" TurboFactory "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@ardrive/turbo-sdk'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" turbo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" TurboFactory"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("unauthenticated")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" rates "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getFiatRates")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"esm"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#esm"}},[t._v("#")]),t._v(" ESM")]),t._v(" "),s("p",[t._v("Project's "),s("code",[t._v("package.json")]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-json extra-class"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"module"')]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("p",[t._v("Project's "),s("code",[t._v("tsconfig.json")]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-json extra-class"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"compilerOptions"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"module"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"NodeNext"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"moduleResolution"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"NodeNext"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"skipLibCheck"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("p",[t._v("Usage:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" TurboFactory "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@ardrive/turbo-sdk/node'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" turbo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" TurboFactory"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("unauthenticated")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" rates "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getFiatRates")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"typescript"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#typescript"}},[t._v("#")]),t._v(" Typescript")]),t._v(" "),s("p",[t._v("The SDK provides TypeScript types. When you import the SDK in a TypeScript project:")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" TurboFactory "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@ardrive/turbo-sdk/web'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// or '@ardrive/turbo-sdk/node' for Node.js projects")]),t._v("\n")])])]),s("p",[t._v("Types are exported from "),s("code",[t._v("./lib/types/[node/web]/index.d.ts")]),t._v(" and should be automatically recognized, offering benefits such as type-checking and autocompletion.")]),t._v(" "),s("h2",{attrs:{id:"apis"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#apis"}},[t._v("#")]),t._v(" APIs")]),t._v(" "),s("h3",{attrs:{id:"turbofactory"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#turbofactory"}},[t._v("#")]),t._v(" TurboFactory")]),t._v(" "),s("ul",[s("li",[s("p",[s("code",[t._v("unauthenticated()")]),t._v(" - Creates an instance of a client that accesses Turbo's unauthenticated services.")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" turbo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" TurboFactory"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("unauthenticated")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("authenticated()")]),t._v(" - Creates an instance of a client that accesses Turbo's authenticated and unauthenticated services.")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" jwk "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" arweave"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("crypto"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("generateJWK")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" turbo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" TurboFactory"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("authenticated")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" privateKey"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" jwk "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])]),t._v(" "),s("h3",{attrs:{id:"turbounauthenticatedclient"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#turbounauthenticatedclient"}},[t._v("#")]),t._v(" TurboUnauthenticatedClient")]),t._v(" "),s("ul",[s("li",[s("p",[s("code",[t._v("getSupportedCurrencies()")]),t._v(" - Returns the list of currencies supported by the Turbo Payment Service for topping up a user balance of AR Credits (measured in Winston Credits, or winc).")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" currencies "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSupportedCurrencies")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("getSupportedCountries()")]),t._v(" - Returns the list of countries supported by the Turbo Payment Service's top up workflow.")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" countries "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSupportedCountries")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("getFiatToAR({ currency })")]),t._v(" - Returns the current raw fiat to AR conversion rate for a specific currency as reported by third-party pricing oracles.")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" fiatToAR "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getFiatToAR")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" currency"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'USD'")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("getFiatRates()")]),t._v(" - Returns the current fiat rates for 1 GiB of data for supported currencies, including all top-up adjustments and fees.")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" rates "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getFiatRates")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("getWincForFiat({ amount })")]),t._v(" - Returns the current amount of Winston Credits including all adjustments for the provided fiat currency, amount. To leverage promo codes, see "),s("a",{attrs:{href:"#turboauthenticatedclient"}},[t._v("TurboAuthenticatedClient")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" winc"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" paymentAmount"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" quotedPaymentAmount"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" adjustments "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getWincForFiat")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n amount"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("USD")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// promo codes require an authenticated client")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("getUploadCosts({ bytes })")]),t._v(" - Returns the estimated cost in Winston Credits for the provided file sizes, including all upload adjustments and fees.")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("uploadCostForFile"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getUploadCosts")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" bytes"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1024")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" winc"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" adjustments "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" uploadCostForFile"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("uploadSignedDataItem({ dataItemStreamFactory, dataItemSizeFactory, signal })")]),t._v(" - Uploads a signed data item. The provided "),s("code",[t._v("dataItemStreamFactory")]),t._v(" should produce a NEW signed data item stream each time is it invoked. The "),s("code",[t._v("dataItemSizeFactory")]),t._v(" is a function that returns the size of the file. The "),s("code",[t._v("signal")]),t._v(" is an optional "),s("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal",target:"_blank",rel:"noopener noreferrer"}},[t._v("AbortSignal"),s("OutboundLink")],1),t._v(" that can be used to cancel the upload or timeout the request.")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" filePath "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" path"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("join")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("__dirname"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'./my-signed-data-item'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" dataItemSize "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" fs"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("statSync")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("filePath"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("size"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" uploadResponse "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("uploadSignedDataItem")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("dataItemStreamFactory")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" fs"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createReadStream")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("filePath"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("dataItemSizeFactory")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" dataItemSize"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n signal"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" AbortSignal"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("timeout")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("10_000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// cancel the upload after 10 seconds")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("createCheckoutSession({ amount, owner })")]),t._v(" - Creates a Stripe checkout session for a Turbo Top Up with the provided amount, currency, owner. The returned URL can be opened in the browser, all payments are processed by Stripe. To leverage promo codes, see "),s("a",{attrs:{href:"#turboauthenticatedclient"}},[t._v("TurboAuthenticatedClient")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" url"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" winc"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" paymentAmount"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" quotedPaymentAmount"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" adjustments "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createCheckoutSession")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n amount"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("USD")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("10.0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// $10.00 USD")]),t._v("\n owner"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" publicArweaveAddress"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// promo codes require an authenticated client")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Open checkout session in a browser")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("platform "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'darwin'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// macOS")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("exec")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("open ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("url"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("platform "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'win32'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Windows")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("exec")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('start "" "')]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("url"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"')]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" shell"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Linux/Unix")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("open")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("url"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])])]),t._v(" "),s("h3",{attrs:{id:"turboauthenticatedclient"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#turboauthenticatedclient"}},[t._v("#")]),t._v(" TurboAuthenticatedClient")]),t._v(" "),s("ul",[s("li",[s("p",[s("code",[t._v("getBalance()")]),t._v(" - Issues a signed request to get the credit balance of a wallet measured in AR (measured in Winston Credits, or winc).")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" winc"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" balance "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getBalance")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("getWincForFiat({ amount, promoCodes })")]),t._v(" - Returns the current amount of Winston Credits including all adjustments for the provided fiat currency, amount, and optional promo codes.")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" winc"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" paymentAmount"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" quotedPaymentAmount"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" adjustments "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getWincForFiat")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n amount"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("USD")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n promoCodes"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MY_PROMO_CODE'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// promo codes require an authenticated client")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("createCheckoutSession({ amount, owner, promoCodes })")]),t._v(" - Creates a Stripe checkout session for a Turbo Top Up with the provided amount, currency, owner, and optional promo codes. The returned URL can be opened in the browser, all payments are processed by Stripe. Promo codes require an authenticated client.")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" url"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" winc"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" paymentAmount"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" quotedPaymentAmount"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" adjustments "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createCheckoutSession")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n amount"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("USD")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("10.0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// $10.00 USD")]),t._v("\n owner"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" publicArweaveAddress"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n promoCodes"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MY_PROMO_CODE'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// promo codes require an authenticated client")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Open checkout session in a browser")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("platform "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'darwin'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// macOS")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("exec")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("open ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("url"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("platform "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'win32'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Windows")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("exec")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('start "" "')]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("url"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"')]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" shell"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Linux/Unix")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("open")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("url"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("uploadFile({ fileStreamFactory, fileSizeFactory, signal })")]),t._v(" - Signs and uploads a raw file. The provided "),s("code",[t._v("fileStreamFactory")]),t._v(" should produce a NEW file data stream each time is it invoked. The "),s("code",[t._v("fileSizeFactory")]),t._v(" is a function that returns the size of the file. The "),s("code",[t._v("signal")]),t._v(" is an optional "),s("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal",target:"_blank",rel:"noopener noreferrer"}},[t._v("AbortSignal"),s("OutboundLink")],1),t._v(" that can be used to cancel the upload or timeout the request.")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" filePath "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" path"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("join")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("__dirname"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'./my-unsigned-file.txt'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" fileSize "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" fs"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("stateSync")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("filePath"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("size"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" uploadResult "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("uploadFile")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("fileStreamFactory")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" fs"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createReadStream")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("filePath"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("fileSizeFactory")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" fileSize"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// no timeout or AbortSignal provided")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])]),t._v(" "),s("h2",{attrs:{id:"contributions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#contributions"}},[t._v("#")]),t._v(" Contributions")]),t._v(" "),s("p",[t._v("If you encounter any issues or have feature requests, please file an issue on our GitHub repository. Contributions, pull requests, and feedback are both welcome and encouraged.")])])}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[40],{319:function(t,s,a){"use strict";a.r(s);var n=a(10),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"ardriveapp-turbo-sdk-🚀"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#ardriveapp-turbo-sdk-🚀"}},[t._v("#")]),t._v(" @ardriveapp/turbo-sdk 🚀")]),t._v(" "),s("p",[t._v("Welcome to the "),s("code",[t._v("@ardrive/turbo-sdk")]),t._v("! This SDK provides functionality for interacting with the Turbo Upload and Payment Services and is available for both NodeJS and Web environments.")]),t._v(" "),s("h2",{attrs:{id:"installation"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[t._v("#")]),t._v(" Installation")]),t._v(" "),s("div",{staticClass:"language-shell extra-class"},[s("pre",{pre:!0,attrs:{class:"language-shell"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[t._v("npm")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("install")]),t._v(" @ardrive/turbo-sdk\n")])])]),s("p",[t._v("or")]),t._v(" "),s("div",{staticClass:"language-shell extra-class"},[s("pre",{pre:!0,attrs:{class:"language-shell"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[t._v("yarn")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("add")]),t._v(" @ardrive/turbo-sdk\n")])])]),s("h2",{attrs:{id:"quick-start"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#quick-start"}},[t._v("#")]),t._v(" Quick Start")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" TurboFactory "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@ardrive/turbo-sdk'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// load your JWK from a file or generate a new one")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" jwk "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" fs"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("readFileSync")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'./my-jwk.json'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" address "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" arweave"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("wallets"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("jwkToAddress")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("jwk"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" turbo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" TurboFactory"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("authenticated")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" privateKey"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" jwk "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the wallet balance")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" winc"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" balance "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getBalance")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// prep file for upload")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" filePath "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" path"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("join")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("__dirname"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'./my-image.png'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" fileSize "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" fs"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("statSync")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("filePath"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("size"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the cost of uploading the file")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" winc"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" fileSizeCost "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getUploadCosts")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n bytes"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("fileSize"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// check if balance greater than upload cost")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("balance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v(" fileSizeCost"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" url "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createCheckoutSession")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n amount"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" fileSizeCost"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n owner"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" address"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a promo code if you have one")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// open the URL to top-up, continue when done")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("open")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("url"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// upload the file")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("try")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" id"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" owner"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" dataCaches"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" fastFinalityIndexes "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("uploadFile")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n fileStreamFactory "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" fs"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createReadStream")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("filePath"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n fileSizeFactory "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" fileSize"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// upload complete!")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token builtin"}},[t._v("console")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Successfully upload data item!'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" id"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" owner"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" dataCaches"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" fastFinalityIndexes "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("error"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// upload failed")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token builtin"}},[t._v("console")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("error")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Failed to upload data item!'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" error"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("finally")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" winc"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" newBalance "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getBalance")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token builtin"}},[t._v("console")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'New balance:'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" newBalance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("h2",{attrs:{id:"usage"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#usage"}},[t._v("#")]),t._v(" Usage")]),t._v(" "),s("p",[t._v("The SDK is provided in both CommonJS and ESM formats, and it's compatible with bundlers such as Webpack, Rollup, and ESbuild. Utilize the appropriate named exports provided by this SDK's "),s("a",{attrs:{href:"https://github.com/ardriveapp/turbo-sdk/blob/main/package.json",target:"_blank",rel:"noopener noreferrer"}},[t._v("package.json"),s("OutboundLink")],1),t._v(" based on your project's configuration. Refer to the "),s("a",{attrs:{href:"https://github.com/ardriveapp/turbo-sdk/tree/main/examples",target:"_blank",rel:"noopener noreferrer"}},[t._v("examples"),s("OutboundLink")],1),t._v(" directory to see how to use the SDK in various environments.")]),t._v(" "),s("h3",{attrs:{id:"web"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#web"}},[t._v("#")]),t._v(" Web")]),t._v(" "),s("h4",{attrs:{id:"bundlers-webpack-rollup-esbuild-etc"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#bundlers-webpack-rollup-esbuild-etc"}},[t._v("#")]),t._v(" Bundlers (Webpack, Rollup, ESbuild, etc.)")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" TurboFactory "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@ardrive/turbo-sdk'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" turbo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" TurboFactory"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("unauthenticated")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" rates "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getFiatRates")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"browser"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#browser"}},[t._v("#")]),t._v(" Browser")]),t._v(" "),s("div",{staticClass:"language-html extra-class"},[s("pre",{pre:!0,attrs:{class:"language-html"}},[s("code",[t._v("\n"),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("module"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token script"}},[s("span",{pre:!0,attrs:{class:"token language-javascript"}},[t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" TurboFactory "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'https://unpkg.com/@ardrive/turbo-sdk'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" turbo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" TurboFactory"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("unauthenticated")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" rates "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getFiatRates")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),s("h3",{attrs:{id:"nodejs"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#nodejs"}},[t._v("#")]),t._v(" NodeJS")]),t._v(" "),s("h4",{attrs:{id:"commonjs"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#commonjs"}},[t._v("#")]),t._v(" CommonJS")]),t._v(" "),s("p",[t._v("Project's "),s("code",[t._v("package.json")]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-json extra-class"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"commonjs"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// or absent")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("p",[t._v("Project's "),s("code",[t._v("tsconfig.json")]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-json extra-class"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"compilerOptions"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"module"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"CommonJS"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"moduleResolution"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Node"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"skipLibCheck"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("p",[t._v("Usage:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" TurboFactory "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@ardrive/turbo-sdk'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" turbo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" TurboFactory"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("unauthenticated")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" rates "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getFiatRates")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"esm"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#esm"}},[t._v("#")]),t._v(" ESM")]),t._v(" "),s("p",[t._v("Project's "),s("code",[t._v("package.json")]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-json extra-class"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"module"')]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("p",[t._v("Project's "),s("code",[t._v("tsconfig.json")]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-json extra-class"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"compilerOptions"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"module"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"NodeNext"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"moduleResolution"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"NodeNext"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"skipLibCheck"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("p",[t._v("Usage:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" TurboFactory "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@ardrive/turbo-sdk/node'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" turbo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" TurboFactory"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("unauthenticated")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" rates "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getFiatRates")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"typescript"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#typescript"}},[t._v("#")]),t._v(" Typescript")]),t._v(" "),s("p",[t._v("The SDK provides TypeScript types. When you import the SDK in a TypeScript project:")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" TurboFactory "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@ardrive/turbo-sdk/web'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// or '@ardrive/turbo-sdk/node' for Node.js projects")]),t._v("\n")])])]),s("p",[t._v("Types are exported from "),s("code",[t._v("./lib/types/[node/web]/index.d.ts")]),t._v(" and should be automatically recognized, offering benefits such as type-checking and autocompletion.")]),t._v(" "),s("h2",{attrs:{id:"apis"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#apis"}},[t._v("#")]),t._v(" APIs")]),t._v(" "),s("h3",{attrs:{id:"turbofactory"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#turbofactory"}},[t._v("#")]),t._v(" TurboFactory")]),t._v(" "),s("ul",[s("li",[s("p",[s("code",[t._v("unauthenticated()")]),t._v(" - Creates an instance of a client that accesses Turbo's unauthenticated services.")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" turbo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" TurboFactory"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("unauthenticated")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("authenticated()")]),t._v(" - Creates an instance of a client that accesses Turbo's authenticated and unauthenticated services.")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" jwk "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" arweave"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("crypto"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("generateJWK")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" turbo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" TurboFactory"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("authenticated")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" privateKey"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" jwk "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])]),t._v(" "),s("h3",{attrs:{id:"turbounauthenticatedclient"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#turbounauthenticatedclient"}},[t._v("#")]),t._v(" TurboUnauthenticatedClient")]),t._v(" "),s("ul",[s("li",[s("p",[s("code",[t._v("getSupportedCurrencies()")]),t._v(" - Returns the list of currencies supported by the Turbo Payment Service for topping up a user balance of AR Credits (measured in Winston Credits, or winc).")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" currencies "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSupportedCurrencies")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("getSupportedCountries()")]),t._v(" - Returns the list of countries supported by the Turbo Payment Service's top up workflow.")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" countries "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSupportedCountries")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("getFiatToAR({ currency })")]),t._v(" - Returns the current raw fiat to AR conversion rate for a specific currency as reported by third-party pricing oracles.")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" fiatToAR "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getFiatToAR")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" currency"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'USD'")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("getFiatRates()")]),t._v(" - Returns the current fiat rates for 1 GiB of data for supported currencies, including all top-up adjustments and fees.")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" rates "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getFiatRates")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("getWincForFiat({ amount })")]),t._v(" - Returns the current amount of Winston Credits including all adjustments for the provided fiat currency, amount. To leverage promo codes, see "),s("a",{attrs:{href:"#turboauthenticatedclient"}},[t._v("TurboAuthenticatedClient")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" winc"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" paymentAmount"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" quotedPaymentAmount"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" adjustments "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getWincForFiat")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n amount"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("USD")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// promo codes require an authenticated client")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("getUploadCosts({ bytes })")]),t._v(" - Returns the estimated cost in Winston Credits for the provided file sizes, including all upload adjustments and fees.")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("uploadCostForFile"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getUploadCosts")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" bytes"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1024")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" winc"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" adjustments "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" uploadCostForFile"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("uploadSignedDataItem({ dataItemStreamFactory, dataItemSizeFactory, signal })")]),t._v(" - Uploads a signed data item. The provided "),s("code",[t._v("dataItemStreamFactory")]),t._v(" should produce a NEW signed data item stream each time is it invoked. The "),s("code",[t._v("dataItemSizeFactory")]),t._v(" is a function that returns the size of the file. The "),s("code",[t._v("signal")]),t._v(" is an optional "),s("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal",target:"_blank",rel:"noopener noreferrer"}},[t._v("AbortSignal"),s("OutboundLink")],1),t._v(" that can be used to cancel the upload or timeout the request.")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" filePath "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" path"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("join")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("__dirname"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'./my-signed-data-item'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" dataItemSize "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" fs"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("statSync")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("filePath"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("size"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" uploadResponse "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("uploadSignedDataItem")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("dataItemStreamFactory")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" fs"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createReadStream")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("filePath"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("dataItemSizeFactory")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" dataItemSize"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n signal"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" AbortSignal"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("timeout")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("10_000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// cancel the upload after 10 seconds")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("createCheckoutSession({ amount, owner })")]),t._v(" - Creates a Stripe checkout session for a Turbo Top Up with the provided amount, currency, owner. The returned URL can be opened in the browser, all payments are processed by Stripe. To leverage promo codes, see "),s("a",{attrs:{href:"#turboauthenticatedclient"}},[t._v("TurboAuthenticatedClient")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" url"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" winc"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" paymentAmount"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" quotedPaymentAmount"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" adjustments "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createCheckoutSession")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n amount"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("USD")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("10.0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// $10.00 USD")]),t._v("\n owner"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" publicArweaveAddress"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// promo codes require an authenticated client")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Open checkout session in a browser")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("platform "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'darwin'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// macOS")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("exec")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("open ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("url"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("platform "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'win32'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Windows")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("exec")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('start "" "')]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("url"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"')]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" shell"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Linux/Unix")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("open")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("url"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])])]),t._v(" "),s("h3",{attrs:{id:"turboauthenticatedclient"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#turboauthenticatedclient"}},[t._v("#")]),t._v(" TurboAuthenticatedClient")]),t._v(" "),s("ul",[s("li",[s("p",[s("code",[t._v("getBalance()")]),t._v(" - Issues a signed request to get the credit balance of a wallet measured in AR (measured in Winston Credits, or winc).")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" winc"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" balance "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getBalance")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("getWincForFiat({ amount, promoCodes })")]),t._v(" - Returns the current amount of Winston Credits including all adjustments for the provided fiat currency, amount, and optional promo codes.")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" winc"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" paymentAmount"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" quotedPaymentAmount"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" adjustments "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getWincForFiat")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n amount"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("USD")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n promoCodes"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MY_PROMO_CODE'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// promo codes require an authenticated client")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("createCheckoutSession({ amount, owner, promoCodes })")]),t._v(" - Creates a Stripe checkout session for a Turbo Top Up with the provided amount, currency, owner, and optional promo codes. The returned URL can be opened in the browser, all payments are processed by Stripe. Promo codes require an authenticated client.")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" url"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" winc"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" paymentAmount"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" quotedPaymentAmount"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" adjustments "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createCheckoutSession")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n amount"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("USD")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("10.0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// $10.00 USD")]),t._v("\n owner"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" publicArweaveAddress"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n promoCodes"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MY_PROMO_CODE'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// promo codes require an authenticated client")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Open checkout session in a browser")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("platform "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'darwin'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// macOS")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("exec")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("open ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("url"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("platform "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'win32'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Windows")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("exec")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('start "" "')]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("url"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"')]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" shell"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Linux/Unix")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("open")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("url"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])]),t._v(" "),s("li",[s("p",[s("code",[t._v("uploadFile({ fileStreamFactory, fileSizeFactory, signal })")]),t._v(" - Signs and uploads a raw file. The provided "),s("code",[t._v("fileStreamFactory")]),t._v(" should produce a NEW file data stream each time is it invoked. The "),s("code",[t._v("fileSizeFactory")]),t._v(" is a function that returns the size of the file. The "),s("code",[t._v("signal")]),t._v(" is an optional "),s("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal",target:"_blank",rel:"noopener noreferrer"}},[t._v("AbortSignal"),s("OutboundLink")],1),t._v(" that can be used to cancel the upload or timeout the request.")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" filePath "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" path"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("join")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("__dirname"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'./my-unsigned-file.txt'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" fileSize "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" fs"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("stateSync")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("filePath"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("size"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" uploadResult "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" turbo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("uploadFile")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("fileStreamFactory")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" fs"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createReadStream")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("filePath"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("fileSizeFactory")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" fileSize"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// no timeout or AbortSignal provided")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])]),t._v(" "),s("h2",{attrs:{id:"contributions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#contributions"}},[t._v("#")]),t._v(" Contributions")]),t._v(" "),s("p",[t._v("If you encounter any issues or have feature requests, please file an issue on our GitHub repository. Contributions, pull requests, and feedback are both welcome and encouraged.")])])}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/assets/js/41.42b360cd.js b/assets/js/41.9b0828f2.js similarity index 99% rename from assets/js/41.42b360cd.js rename to assets/js/41.9b0828f2.js index d6fa033..bd910cd 100644 --- a/assets/js/41.42b360cd.js +++ b/assets/js/41.9b0828f2.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[41],{323:function(e,t,a){"use strict";a.r(t);var r=a(10),o=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"turbo-sdk-release-notes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#turbo-sdk-release-notes"}},[e._v("#")]),e._v(" Turbo SDK Release Notes")]),e._v(" "),t("h2",{attrs:{id:"overview"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#overview"}},[e._v("#")]),e._v(" Overview")]),e._v(" "),t("p",[e._v("Welcome to the documentation page for the Turbo SDK release notes. Here, you will find detailed information about each version of the Turbo SDK, including the enhancements, bug fixes, and any other changes introduced in every release. This page serves as a comprehensive resource to keep you informed about the latest developments and updates in the Turbo SDK. For those interested in exploring the source code, each version's code is readily accessible at our GitHub repository: "),t("a",{attrs:{href:"https://github.com/ardriveapp/turbo-sdk/releases",target:"_blank",rel:"noopener noreferrer"}},[e._v("Turbo SDK Releases"),t("OutboundLink")],1),e._v(". Stay updated with the continuous improvements and advancements in the Turbo SDK by referring to this page for all release-related information.")]),e._v(" "),t("h2",{attrs:{id:"releases"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#releases"}},[e._v("#")]),e._v(" Releases")]),e._v(" "),t("h3",{attrs:{id:"v1-3-0"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#v1-3-0"}},[e._v("#")]),e._v(" V1.3.0")]),e._v(" "),t("p",[e._v("(2024-01-03)")]),e._v(" "),t("p",[e._v("Bug Fixes")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("web")]),e._v(": ensure we have the public key for arconnect wallets when signing data")]),e._v(" "),t("li",[t("strong",[e._v("web")]),e._v(": remove reference to "),t("code",[e._v("node:crypto")]),e._v(" in websigner, use signer to signer to sign header")])]),e._v(" "),t("p",[e._v("Features")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("signer")]),e._v(": allow an optional signer to be passed instead of JWK for signing data items")])]),e._v(" "),t("h3",{attrs:{id:"v1-2-0"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#v1-2-0"}},[e._v("#")]),e._v(" V1.2.0")]),e._v(" "),t("p",[e._v("(2023-12-15)")]),e._v(" "),t("p",[e._v("Features")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("data item opts")]),e._v(": init tags anchor and target support PE-5035")])]),e._v(" "),t("h3",{attrs:{id:"v1-1-1"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#v1-1-1"}},[e._v("#")]),e._v(" V1.1.1")]),e._v(" "),t("p",[e._v("(2023-12-14)")]),e._v(" "),t("p",[e._v("Bug Fixes")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("exports")]),e._v(": use bundled export to avoid issue with polyfilled features needed for web")]),e._v(" "),t("li",[t("strong",[e._v("exports")]),e._v(": web exports reference an invalid build path")]),e._v(" "),t("li",[t("strong",[e._v("polyfills")]),e._v(": update esbuild script to include crypto polyfill")])]),e._v(" "),t("h3",{attrs:{id:"v1-1-0"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#v1-1-0"}},[e._v("#")]),e._v(" V1.1.0")]),e._v(" "),t("p",[e._v("(2023-11-10)")]),e._v(" "),t("p",[e._v("Bug Fixes")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("axios")]),e._v(": set "),t("code",[e._v("maxRedirects")]),e._v(" to "),t("code",[e._v("0")]),e._v(" on our axios instances")])]),e._v(" "),t("p",[e._v("Features")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("logger")]),e._v(": add configurable global logger")])]),e._v(" "),t("h3",{attrs:{id:"v1-0-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#v1-0-2"}},[e._v("#")]),e._v(" V1.0.2")]),e._v(" "),t("p",[e._v("(2023-11-03)")]),e._v(" "),t("p",[e._v("Bug Fixes")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("upload")]),e._v(": update the default upload service URL")])]),e._v(" "),t("h3",{attrs:{id:"v1-0-1"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#v1-0-1"}},[e._v("#")]),e._v(" V1.0.1")]),e._v(" "),t("p",[e._v("(2023-09-27)")]),e._v(" "),t("p",[e._v("Bug Fixes")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("headers")]),e._v(": add default headers for all HTTP requests")]),e._v(" "),t("li",[t("strong",[e._v("release")]),e._v(": use script that updates built version.js files")]),e._v(" "),t("li",[t("strong",[e._v("version")]),e._v(": update version.js to proper version on build and commit it back to git after a release")])]),e._v(" "),t("h3",{attrs:{id:"v1-0-0"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#v1-0-0"}},[e._v("#")]),e._v(" V1.0.0")]),e._v(" "),t("p",[e._v("(2023-09-26)")]),e._v(" "),t("p",[e._v("Bug Fixes")]),e._v(" "),t("ul",[t("li",[e._v("add command that removes type module from package.json")]),e._v(" "),t("li",[e._v("add command that removes type module from package.json")]),e._v(" "),t("li",[e._v("add main import and allow wildcard imports")]),e._v(" "),t("li",[e._v("add module to package.json and tweak types")]),e._v(" "),t("li",[e._v("add one more step to make esm useable")]),e._v(" "),t("li",[e._v("add owner to TurboUploadDataItemResponse and remove byteCount")]),e._v(" "),t("li",[e._v("add separate folder for types, use it in named exports")]),e._v(" "),t("li",[e._v("change name of public facing clients.")]),e._v(" "),t("li",[t("strong",[e._v("cjs")]),e._v(": add separate cjs and esm outputs")]),e._v(" "),t("li",[t("strong",[e._v("content-length")]),e._v(": require content length factory for uploads")]),e._v(" "),t("li",[t("strong",[e._v("exports")]),e._v(": move turbo configurations to turbo.ts so it is available to clients")]),e._v(" "),t("li",[e._v("fix package.json")]),e._v(" "),t("li",[e._v("modify return type of signDataItem function, tweak implementation of ArweaveSigner header")]),e._v(" "),t("li",[e._v("move from getWincPriceForBytes to getUploadCosts")]),e._v(" "),t("li",[t("strong",[e._v("package.json")]),e._v(": add back module to package.json")]),e._v(" "),t("li",[e._v("remove package.json from lib directory")]),e._v(" "),t("li",[e._v("remove postinstall command")]),e._v(" "),t("li",[e._v("replace retry-axios, add additional retry logic")]),e._v(" "),t("li",[t("strong",[e._v("retry-axios")]),e._v(": pin retry-axios to 3.0.0")]),e._v(" "),t("li",[e._v("revert to single file upload/data item upload")]),e._v(" "),t("li",[e._v("swap adding package.json to esm to cjs")]),e._v(" "),t("li",[t("strong",[e._v("top up")]),e._v(": export type PE-4465")]),e._v(" "),t("li",[e._v("type imports for web and node")]),e._v(" "),t("li",[t("strong",[e._v("types")]),e._v(": finalize types, update default payment and upload URLs")]),e._v(" "),t("li",[e._v("update main and types path in package.json")]),e._v(" "),t("li",[e._v("update package.json output for esm")]),e._v(" "),t("li",[e._v("update web signer and cleanup examples")]),e._v(" "),t("li",[e._v("use .cjs as base for types to avoid reference require errors")]),e._v(" "),t("li",[e._v("use declare in sub-classes to overwrite parent class type")]),e._v(" "),t("li",[t("strong",[e._v("wildcard")]),e._v(": allow wildcard exports for older projects")]),e._v(" "),t("li",[e._v("wrong path for types!")])]),e._v(" "),t("p",[e._v("Features")]),e._v(" "),t("ul",[t("li",[e._v("abstract axios to TurboHTTPService class")]),e._v(" "),t("li",[e._v("abstract JWKInterface used in AuthenticatedPayment and AuthenticatedUploadService")]),e._v(" "),t("li",[e._v("add remaining unauthenticated apis for payment service, introduce some new types, add tests")]),e._v(" "),t("li",[e._v("add uploadFiles implementation for node and web")]),e._v(" "),t("li",[e._v("break services into auth vs unauth")]),e._v(" "),t("li",[e._v("initial implementation of TurboWebClient and TurboNodeClient")]),e._v(" "),t("li",[e._v("introduce AbortController")]),e._v(" "),t("li",[e._v("introduce uploadSignedDataItem interface, implement for node")]),e._v(" "),t("li",[e._v("remove TurboDataItemVerifier")]),e._v(" "),t("li",[t("strong",[e._v("sdk")]),e._v(": all uphill from here 🚀 PE-4064")]),e._v(" "),t("li",[t("strong",[e._v("top-up")]),e._v(": init get checkout session PE-4465")]),e._v(" "),t("li",[t("strong",[e._v("winc for fiat")]),e._v(": extend AmountMapper pattern and add promoCode support PE-4465")])])])}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[41],{320:function(e,t,a){"use strict";a.r(t);var r=a(10),o=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"turbo-sdk-release-notes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#turbo-sdk-release-notes"}},[e._v("#")]),e._v(" Turbo SDK Release Notes")]),e._v(" "),t("h2",{attrs:{id:"overview"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#overview"}},[e._v("#")]),e._v(" Overview")]),e._v(" "),t("p",[e._v("Welcome to the documentation page for the Turbo SDK release notes. Here, you will find detailed information about each version of the Turbo SDK, including the enhancements, bug fixes, and any other changes introduced in every release. This page serves as a comprehensive resource to keep you informed about the latest developments and updates in the Turbo SDK. For those interested in exploring the source code, each version's code is readily accessible at our GitHub repository: "),t("a",{attrs:{href:"https://github.com/ardriveapp/turbo-sdk/releases",target:"_blank",rel:"noopener noreferrer"}},[e._v("Turbo SDK Releases"),t("OutboundLink")],1),e._v(". Stay updated with the continuous improvements and advancements in the Turbo SDK by referring to this page for all release-related information.")]),e._v(" "),t("h2",{attrs:{id:"releases"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#releases"}},[e._v("#")]),e._v(" Releases")]),e._v(" "),t("h3",{attrs:{id:"v1-3-0"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#v1-3-0"}},[e._v("#")]),e._v(" V1.3.0")]),e._v(" "),t("p",[e._v("(2024-01-03)")]),e._v(" "),t("p",[e._v("Bug Fixes")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("web")]),e._v(": ensure we have the public key for arconnect wallets when signing data")]),e._v(" "),t("li",[t("strong",[e._v("web")]),e._v(": remove reference to "),t("code",[e._v("node:crypto")]),e._v(" in websigner, use signer to signer to sign header")])]),e._v(" "),t("p",[e._v("Features")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("signer")]),e._v(": allow an optional signer to be passed instead of JWK for signing data items")])]),e._v(" "),t("h3",{attrs:{id:"v1-2-0"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#v1-2-0"}},[e._v("#")]),e._v(" V1.2.0")]),e._v(" "),t("p",[e._v("(2023-12-15)")]),e._v(" "),t("p",[e._v("Features")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("data item opts")]),e._v(": init tags anchor and target support PE-5035")])]),e._v(" "),t("h3",{attrs:{id:"v1-1-1"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#v1-1-1"}},[e._v("#")]),e._v(" V1.1.1")]),e._v(" "),t("p",[e._v("(2023-12-14)")]),e._v(" "),t("p",[e._v("Bug Fixes")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("exports")]),e._v(": use bundled export to avoid issue with polyfilled features needed for web")]),e._v(" "),t("li",[t("strong",[e._v("exports")]),e._v(": web exports reference an invalid build path")]),e._v(" "),t("li",[t("strong",[e._v("polyfills")]),e._v(": update esbuild script to include crypto polyfill")])]),e._v(" "),t("h3",{attrs:{id:"v1-1-0"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#v1-1-0"}},[e._v("#")]),e._v(" V1.1.0")]),e._v(" "),t("p",[e._v("(2023-11-10)")]),e._v(" "),t("p",[e._v("Bug Fixes")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("axios")]),e._v(": set "),t("code",[e._v("maxRedirects")]),e._v(" to "),t("code",[e._v("0")]),e._v(" on our axios instances")])]),e._v(" "),t("p",[e._v("Features")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("logger")]),e._v(": add configurable global logger")])]),e._v(" "),t("h3",{attrs:{id:"v1-0-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#v1-0-2"}},[e._v("#")]),e._v(" V1.0.2")]),e._v(" "),t("p",[e._v("(2023-11-03)")]),e._v(" "),t("p",[e._v("Bug Fixes")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("upload")]),e._v(": update the default upload service URL")])]),e._v(" "),t("h3",{attrs:{id:"v1-0-1"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#v1-0-1"}},[e._v("#")]),e._v(" V1.0.1")]),e._v(" "),t("p",[e._v("(2023-09-27)")]),e._v(" "),t("p",[e._v("Bug Fixes")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("headers")]),e._v(": add default headers for all HTTP requests")]),e._v(" "),t("li",[t("strong",[e._v("release")]),e._v(": use script that updates built version.js files")]),e._v(" "),t("li",[t("strong",[e._v("version")]),e._v(": update version.js to proper version on build and commit it back to git after a release")])]),e._v(" "),t("h3",{attrs:{id:"v1-0-0"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#v1-0-0"}},[e._v("#")]),e._v(" V1.0.0")]),e._v(" "),t("p",[e._v("(2023-09-26)")]),e._v(" "),t("p",[e._v("Bug Fixes")]),e._v(" "),t("ul",[t("li",[e._v("add command that removes type module from package.json")]),e._v(" "),t("li",[e._v("add command that removes type module from package.json")]),e._v(" "),t("li",[e._v("add main import and allow wildcard imports")]),e._v(" "),t("li",[e._v("add module to package.json and tweak types")]),e._v(" "),t("li",[e._v("add one more step to make esm useable")]),e._v(" "),t("li",[e._v("add owner to TurboUploadDataItemResponse and remove byteCount")]),e._v(" "),t("li",[e._v("add separate folder for types, use it in named exports")]),e._v(" "),t("li",[e._v("change name of public facing clients.")]),e._v(" "),t("li",[t("strong",[e._v("cjs")]),e._v(": add separate cjs and esm outputs")]),e._v(" "),t("li",[t("strong",[e._v("content-length")]),e._v(": require content length factory for uploads")]),e._v(" "),t("li",[t("strong",[e._v("exports")]),e._v(": move turbo configurations to turbo.ts so it is available to clients")]),e._v(" "),t("li",[e._v("fix package.json")]),e._v(" "),t("li",[e._v("modify return type of signDataItem function, tweak implementation of ArweaveSigner header")]),e._v(" "),t("li",[e._v("move from getWincPriceForBytes to getUploadCosts")]),e._v(" "),t("li",[t("strong",[e._v("package.json")]),e._v(": add back module to package.json")]),e._v(" "),t("li",[e._v("remove package.json from lib directory")]),e._v(" "),t("li",[e._v("remove postinstall command")]),e._v(" "),t("li",[e._v("replace retry-axios, add additional retry logic")]),e._v(" "),t("li",[t("strong",[e._v("retry-axios")]),e._v(": pin retry-axios to 3.0.0")]),e._v(" "),t("li",[e._v("revert to single file upload/data item upload")]),e._v(" "),t("li",[e._v("swap adding package.json to esm to cjs")]),e._v(" "),t("li",[t("strong",[e._v("top up")]),e._v(": export type PE-4465")]),e._v(" "),t("li",[e._v("type imports for web and node")]),e._v(" "),t("li",[t("strong",[e._v("types")]),e._v(": finalize types, update default payment and upload URLs")]),e._v(" "),t("li",[e._v("update main and types path in package.json")]),e._v(" "),t("li",[e._v("update package.json output for esm")]),e._v(" "),t("li",[e._v("update web signer and cleanup examples")]),e._v(" "),t("li",[e._v("use .cjs as base for types to avoid reference require errors")]),e._v(" "),t("li",[e._v("use declare in sub-classes to overwrite parent class type")]),e._v(" "),t("li",[t("strong",[e._v("wildcard")]),e._v(": allow wildcard exports for older projects")]),e._v(" "),t("li",[e._v("wrong path for types!")])]),e._v(" "),t("p",[e._v("Features")]),e._v(" "),t("ul",[t("li",[e._v("abstract axios to TurboHTTPService class")]),e._v(" "),t("li",[e._v("abstract JWKInterface used in AuthenticatedPayment and AuthenticatedUploadService")]),e._v(" "),t("li",[e._v("add remaining unauthenticated apis for payment service, introduce some new types, add tests")]),e._v(" "),t("li",[e._v("add uploadFiles implementation for node and web")]),e._v(" "),t("li",[e._v("break services into auth vs unauth")]),e._v(" "),t("li",[e._v("initial implementation of TurboWebClient and TurboNodeClient")]),e._v(" "),t("li",[e._v("introduce AbortController")]),e._v(" "),t("li",[e._v("introduce uploadSignedDataItem interface, implement for node")]),e._v(" "),t("li",[e._v("remove TurboDataItemVerifier")]),e._v(" "),t("li",[t("strong",[e._v("sdk")]),e._v(": all uphill from here 🚀 PE-4064")]),e._v(" "),t("li",[t("strong",[e._v("top-up")]),e._v(": init get checkout session PE-4465")]),e._v(" "),t("li",[t("strong",[e._v("winc for fiat")]),e._v(": extend AmountMapper pattern and add promoCode support PE-4465")])])])}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/43.607caec2.js b/assets/js/43.f5f23fa5.js similarity index 98% rename from assets/js/43.607caec2.js rename to assets/js/43.f5f23fa5.js index 97ea59b..33f7a4a 100644 --- a/assets/js/43.607caec2.js +++ b/assets/js/43.f5f23fa5.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[43],{321:function(t,e,a){"use strict";a.r(e);var r=a(10),i=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"what-is-turbo"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#what-is-turbo"}},[t._v("#")]),t._v(" What Is Turbo?")]),t._v(" "),e("p",[t._v("Turbo, offered by ArDrive, is a streamlined service that simplifies permaweb storage, making it more accessible by allowing users to pay for uploads with credit or debit cards. It integrates two key components: a service that bundles uploads for efficiency and ease, and a payment system designed for straightforward transactions. Turbo Credits, which users can purchase within the ArDrive web app, enable a direct conversion from AR tokens, reflecting the amount of data one can upload. These credits are meticulously calibrated, with the Winston Credit (winc) representing the smallest unit, ensuring users have precise control over their storage needs. As an open-source technology, Turbo encourages community engagement, allowing developers to contribute to its continuous enhancement.")]),t._v(" "),e("div",{staticStyle:{"text-align":"center"}},[e("table",{staticClass:"inline-table"},[e("tr",[e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Feature")])]),t._v(" "),e("tr",[e("th",[t._v("Access")]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("ul",[e("li",[t._v("Optimistic, instant data caching, using arweave.net.")]),t._v(" "),e("li",[t._v("Optimistic, near instant GraphQL indexing including cross-chain token address indexing, using arweave.net.")]),t._v(" "),e("li",[t._v("Irys-compatible transaction status endpoint for checking transaction finality.")])])])]),t._v(" "),e("tr",[e("th",[t._v("Development and Integration")]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("ul",[e("li",[t._v("Rich documentation for developer integrations, SDK and Turbo APIs. "),e("ul",[e("li",[e("a",{attrs:{href:"https://upload.ardrive.io/api-docs",target:"_blank"}},[t._v("Swagger UI")]),t._v(" Upload Service API docs.")]),e("li",[e("a",{attrs:{href:"https://payment.ardrive.io/api-docs",target:"_blank"}},[t._v("Swagger UI")]),t._v(" Payment Service API docs.")])])]),t._v(" "),e("li",[t._v("Deploy your own upload and payment service for bundling data and sending it to Arweave. "),e("ul",[e("li",[e("a",{attrs:{target:"_blank",href:"https://github.com/ardriveapp/turbo-upload-service"}},[t._v("GitHub - ardriveapp/turbo-upload-service: Turbo Upload service that allows users to upload data items using fiat currencies.")])]),e("li",[e("a",{attrs:{target:"_blank",href:"https://github.com/ardriveapp/turbo-payment-service"}},[t._v("GitHub - ardriveapp/turbo-payment-service: ArDrive Turbo Payment Service that manages Turbo balances.")])])])]),e("li",[t._v("Flexible typescript SDK for seamless web and NodeJS integration.")]),t._v(" "),e("li",[e("a",{attrs:{target:"_blank",href:"https://github.com/ardriveapp/turbo-sdk"}},[t._v("GitHub - ardriveapp/turbo-sdk: The first SDK on Arweave to bring you programmable fiat top ups, Turbo-powered upload reliability, and fast data and indexing finality for Typescript based Web and Node projects.")])]),t._v(" "),e("li",[t._v("Development and testing environment.")])])])]),t._v(" "),e("tr",[e("th",[t._v("Enterprise")]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Built for scale and trusted by enterprises")])]),t._v(" "),e("tr",[e("th",[t._v("Identity")]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("ul",[e("li",[t._v("Cryptographic sign in using Arweave, Ethereum, Solana or other Irys-compatible keys.")]),t._v(" "),e("li",[t._v("Arweave ecosystem supported web wallets and providers: "),e("ul",[e("li",[t._v("✅ Arconnect")]),e("li",[t._v("✅ arweave.app")]),e("li",[t._v("✅ ArweaveWalletAdapter")])])])])])]),t._v(" "),e("tr",[e("th",[t._v("Maturity")]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("ul",[e("li",[t._v("Run by PDS, the same team that has been operating arweave.net since March 2022, with over 1.8B transactions indexed and accessible.")]),t._v(" "),e("li",[t._v("First bundling services launched in October 2022, with as ArDrive Turbo launching in July 2023. \n "),e("ul",[e("li",[e("a",{attrs:{target:"_blank",href:"https://viewblock.io/arweave/address/yCxjLRyXjzHJ4gMZK8HFYiW146dykI9QgP6CSsVXFwk"}},[t._v("ar.io Meta Bundler | Arweave Explorer | ViewBlock")])]),t._v(" "),e("li",[e("a",{attrs:{target:"_blank",href:"https://viewblock.io/arweave/address/JNC6vBhjHY1EPwV3pEeNmrsgFMxH5d38_LHsZ7jful8"}},[t._v("ArDrive Turbo | Arweave Explorer | ViewBlock")])])])])])])]),t._v(" "),e("tr",[e("th",[t._v("Payments")]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("ul",[e("li",[t._v("Instantly fund your Turbo account with your credit card.")]),t._v(" "),e("li",[t._v("Leverage other Turbo benefits like Gifting and Coupon Codes.")])])])]),t._v(" "),e("tr",[e("th",[t._v("Performance")]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("ul",[e("li",[t._v("Irys-compatible single request or multipart uploading.")]),t._v(" "),e("li",[t._v("Proven, high layer 2 transactional throughput with 860/sec sustained on 12/18 and 12/19")])])])]),t._v(" "),e("tr",[e("th",[t._v("Provenance")]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Irys-compatible receipts with transaction id, high resolution timestamp, upload price and cryptographic signature.")])]),t._v(" "),e("tr",[e("th",[t._v("Transparency")]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Open source infrastructure and software development kit with AGPL3.0 licensing.")])])])])])}),[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[43],{323:function(t,e,a){"use strict";a.r(e);var r=a(10),i=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"what-is-turbo"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#what-is-turbo"}},[t._v("#")]),t._v(" What Is Turbo?")]),t._v(" "),e("p",[t._v("Turbo, offered by ArDrive, is a streamlined service that simplifies permaweb storage, making it more accessible by allowing users to pay for uploads with credit or debit cards. It integrates two key components: a service that bundles uploads for efficiency and ease, and a payment system designed for straightforward transactions. Turbo Credits, which users can purchase within the ArDrive web app, enable a direct conversion from AR tokens, reflecting the amount of data one can upload. These credits are meticulously calibrated, with the Winston Credit (winc) representing the smallest unit, ensuring users have precise control over their storage needs. As an open-source technology, Turbo encourages community engagement, allowing developers to contribute to its continuous enhancement.")]),t._v(" "),e("div",{staticStyle:{"text-align":"center"}},[e("table",{staticClass:"inline-table"},[e("tr",[e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Feature")])]),t._v(" "),e("tr",[e("th",[t._v("Access")]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("ul",[e("li",[t._v("Optimistic, instant data caching, using arweave.net.")]),t._v(" "),e("li",[t._v("Optimistic, near instant GraphQL indexing including cross-chain token address indexing, using arweave.net.")]),t._v(" "),e("li",[t._v("Irys-compatible transaction status endpoint for checking transaction finality.")])])])]),t._v(" "),e("tr",[e("th",[t._v("Development and Integration")]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("ul",[e("li",[t._v("Rich documentation for developer integrations, SDK and Turbo APIs. "),e("ul",[e("li",[e("a",{attrs:{href:"https://upload.ardrive.io/api-docs",target:"_blank"}},[t._v("Swagger UI")]),t._v(" Upload Service API docs.")]),e("li",[e("a",{attrs:{href:"https://payment.ardrive.io/api-docs",target:"_blank"}},[t._v("Swagger UI")]),t._v(" Payment Service API docs.")])])]),t._v(" "),e("li",[t._v("Deploy your own upload and payment service for bundling data and sending it to Arweave. "),e("ul",[e("li",[e("a",{attrs:{target:"_blank",href:"https://github.com/ardriveapp/turbo-upload-service"}},[t._v("GitHub - ardriveapp/turbo-upload-service: Turbo Upload service that allows users to upload data items using fiat currencies.")])]),e("li",[e("a",{attrs:{target:"_blank",href:"https://github.com/ardriveapp/turbo-payment-service"}},[t._v("GitHub - ardriveapp/turbo-payment-service: ArDrive Turbo Payment Service that manages Turbo balances.")])])])]),e("li",[t._v("Flexible typescript SDK for seamless web and NodeJS integration.")]),t._v(" "),e("li",[e("a",{attrs:{target:"_blank",href:"https://github.com/ardriveapp/turbo-sdk"}},[t._v("GitHub - ardriveapp/turbo-sdk: The first SDK on Arweave to bring you programmable fiat top ups, Turbo-powered upload reliability, and fast data and indexing finality for Typescript based Web and Node projects.")])]),t._v(" "),e("li",[t._v("Development and testing environment.")])])])]),t._v(" "),e("tr",[e("th",[t._v("Enterprise")]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Built for scale and trusted by enterprises")])]),t._v(" "),e("tr",[e("th",[t._v("Identity")]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("ul",[e("li",[t._v("Cryptographic sign in using Arweave, Ethereum, Solana or other Irys-compatible keys.")]),t._v(" "),e("li",[t._v("Arweave ecosystem supported web wallets and providers: "),e("ul",[e("li",[t._v("✅ Arconnect")]),e("li",[t._v("✅ arweave.app")]),e("li",[t._v("✅ ArweaveWalletAdapter")])])])])])]),t._v(" "),e("tr",[e("th",[t._v("Maturity")]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("ul",[e("li",[t._v("Run by PDS, the same team that has been operating arweave.net since March 2022, with over 1.8B transactions indexed and accessible.")]),t._v(" "),e("li",[t._v("First bundling services launched in October 2022, with as ArDrive Turbo launching in July 2023. \n "),e("ul",[e("li",[e("a",{attrs:{target:"_blank",href:"https://viewblock.io/arweave/address/yCxjLRyXjzHJ4gMZK8HFYiW146dykI9QgP6CSsVXFwk"}},[t._v("ar.io Meta Bundler | Arweave Explorer | ViewBlock")])]),t._v(" "),e("li",[e("a",{attrs:{target:"_blank",href:"https://viewblock.io/arweave/address/JNC6vBhjHY1EPwV3pEeNmrsgFMxH5d38_LHsZ7jful8"}},[t._v("ArDrive Turbo | Arweave Explorer | ViewBlock")])])])])])])]),t._v(" "),e("tr",[e("th",[t._v("Payments")]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("ul",[e("li",[t._v("Instantly fund your Turbo account with your credit card.")]),t._v(" "),e("li",[t._v("Leverage other Turbo benefits like Gifting and Coupon Codes.")])])])]),t._v(" "),e("tr",[e("th",[t._v("Performance")]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("ul",[e("li",[t._v("Irys-compatible single request or multipart uploading.")]),t._v(" "),e("li",[t._v("Proven, high layer 2 transactional throughput with 860/sec sustained on 12/18 and 12/19")])])])]),t._v(" "),e("tr",[e("th",[t._v("Provenance")]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Irys-compatible receipts with transaction id, high resolution timestamp, upload price and cryptographic signature.")])]),t._v(" "),e("tr",[e("th",[t._v("Transparency")]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Open source infrastructure and software development kit with AGPL3.0 licensing.")])])])])])}),[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file diff --git a/assets/js/8.c9ca9ade.js b/assets/js/8.adcff5a3.js similarity index 99% rename from assets/js/8.c9ca9ade.js rename to assets/js/8.adcff5a3.js index 1a6a5f6..5652188 100644 --- a/assets/js/8.c9ca9ade.js +++ b/assets/js/8.adcff5a3.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[8],{290:function(t,a,e){"use strict";e.r(a);var s=e(10),n=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"data-model"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#data-model"}},[t._v("#")]),t._v(" Data Model")]),t._v(" "),a("p",[t._v("Because of Arweave's permanent and immutable nature, traditional file structure operations such as renaming and moving files or folders cannot be accomplished by simply updating on-chain data. ArFS works around this by defining an append-only transaction data model based on the metadata tags found in the Arweave "),a("a",{attrs:{href:"https://docs.arweave.org/developers/server/http-api#transaction-format",target:"_blank",rel:"noopener noreferrer"}},[t._v("Transaction Headers."),a("OutboundLink")],1)]),t._v(" "),a("p",[t._v("This model uses a bottom-up reference method, which avoids race conditions in file system updates. Each file contains metadata that refers to the parent folder, and each folder contains metadata that refers to its parent drive. A top-down data model would require the parent model (i.e. a folder) to store references to its children.")]),t._v(" "),a("p",[t._v("These defined entities allow the state of the drive to be constructed by a client to look and feel like a file system")]),t._v(" "),a("ul",[a("li",[a("p",[t._v("Drive Entities contain folders and files")])]),t._v(" "),a("li",[a("p",[t._v("Folder Entities contain other folders or files")])]),t._v(" "),a("li",[a("p",[t._v("File Entities contain both the file data and metadata")])]),t._v(" "),a("li",[a("p",[t._v("Snapshot entities contain a state rollups of all files and folder metadata within a drive")])]),t._v(" "),a("li",[a("p",[t._v("Drive Entities contain folders and files")])]),t._v(" "),a("li",[a("p",[t._v("Folder Entities contain other folders or files")])]),t._v(" "),a("li",[a("p",[t._v("File Entities contain both the file data and metadata")])]),t._v(" "),a("li",[a("p",[t._v("Snapshot entities contain a state rollups of all files and folder metadata within a drive")])]),t._v(" "),a("li",[a("p",[t._v("Drive Entities contain folders and files")])]),t._v(" "),a("li",[a("p",[t._v("Folder Entities contain other folders or files")])]),t._v(" "),a("li",[a("p",[t._v("File Entities are composed by both the file data and metadata")])]),t._v(" "),a("li",[a("p",[t._v("Snapshot entities contain a state rollups of all entities' (such as drive, folder, file and snapshot) metadata within a drive")])])]),t._v(" "),a("h2",{attrs:{id:"entity-relationships"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#entity-relationships"}},[t._v("#")]),t._v(" Entity relationships")]),t._v(" "),a("p",[t._v("The following diagram shows the high level relationships between drive, folder, and file entities, and their associated data. More detailed information about each Entity Type can be found "),a("RouterLink",{attrs:{to:"/docs/arfs/entity-types.html"}},[t._v("here")]),t._v(".")],1),t._v(" "),a("img",{staticClass:"amazingdiagram",staticStyle:{width:"75%"},attrs:{src:t.$withBase("/images/entity-relationship-diagram.png")}}),t._v(" "),a("div",{staticClass:"caption"},[t._v("Entity Relationship Diagram")]),t._v(" "),a("p",[t._v("As you can see, each file and folder contains metadata which points to both the parent folder and the parent drive. The drive entity contains metadata about itself, but not the child contents. So clients must build drive states from the lowest level and work their way up.")]),t._v(" "),a("h2",{attrs:{id:"metadata-format"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#metadata-format"}},[t._v("#")]),t._v(" Metadata Format")]),t._v(" "),a("p",[t._v("Metadata stored in any Arweave transaction tag will be defined in the following manner:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Example-Tag"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"example-data"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Metadata stored in the Transaction Data Payload will follow JSON formatting like below:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"exampleField"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"exampleData"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("fields with a "),a("code",[t._v("?")]),t._v(" suffix are optional.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"My Project"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"description"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"This is a sample project."')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"version?"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"1.0.0"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"author?"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"John Doe"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v('Enumerated field values (those which must adhere to certain values) are defined in the format "value 1 | value 2".')]),t._v(" "),a("p",[t._v("All UUIDs used for Entity-Ids are based on the "),a("a",{attrs:{href:"https://en.wikipedia.org/wiki/Universally_unique_identifier",target:"_blank",rel:"noopener noreferrer"}},[t._v("Universally Unique Identifier"),a("OutboundLink")],1),t._v(" standard.")]),t._v(" "),a("p",[t._v("There are no requirements to list ArFS tags in any specific order.")])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[8],{288:function(t,a,e){"use strict";e.r(a);var s=e(10),n=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"data-model"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#data-model"}},[t._v("#")]),t._v(" Data Model")]),t._v(" "),a("p",[t._v("Because of Arweave's permanent and immutable nature, traditional file structure operations such as renaming and moving files or folders cannot be accomplished by simply updating on-chain data. ArFS works around this by defining an append-only transaction data model based on the metadata tags found in the Arweave "),a("a",{attrs:{href:"https://docs.arweave.org/developers/server/http-api#transaction-format",target:"_blank",rel:"noopener noreferrer"}},[t._v("Transaction Headers."),a("OutboundLink")],1)]),t._v(" "),a("p",[t._v("This model uses a bottom-up reference method, which avoids race conditions in file system updates. Each file contains metadata that refers to the parent folder, and each folder contains metadata that refers to its parent drive. A top-down data model would require the parent model (i.e. a folder) to store references to its children.")]),t._v(" "),a("p",[t._v("These defined entities allow the state of the drive to be constructed by a client to look and feel like a file system")]),t._v(" "),a("ul",[a("li",[a("p",[t._v("Drive Entities contain folders and files")])]),t._v(" "),a("li",[a("p",[t._v("Folder Entities contain other folders or files")])]),t._v(" "),a("li",[a("p",[t._v("File Entities contain both the file data and metadata")])]),t._v(" "),a("li",[a("p",[t._v("Snapshot entities contain a state rollups of all files and folder metadata within a drive")])]),t._v(" "),a("li",[a("p",[t._v("Drive Entities contain folders and files")])]),t._v(" "),a("li",[a("p",[t._v("Folder Entities contain other folders or files")])]),t._v(" "),a("li",[a("p",[t._v("File Entities contain both the file data and metadata")])]),t._v(" "),a("li",[a("p",[t._v("Snapshot entities contain a state rollups of all files and folder metadata within a drive")])]),t._v(" "),a("li",[a("p",[t._v("Drive Entities contain folders and files")])]),t._v(" "),a("li",[a("p",[t._v("Folder Entities contain other folders or files")])]),t._v(" "),a("li",[a("p",[t._v("File Entities are composed by both the file data and metadata")])]),t._v(" "),a("li",[a("p",[t._v("Snapshot entities contain a state rollups of all entities' (such as drive, folder, file and snapshot) metadata within a drive")])])]),t._v(" "),a("h2",{attrs:{id:"entity-relationships"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#entity-relationships"}},[t._v("#")]),t._v(" Entity relationships")]),t._v(" "),a("p",[t._v("The following diagram shows the high level relationships between drive, folder, and file entities, and their associated data. More detailed information about each Entity Type can be found "),a("RouterLink",{attrs:{to:"/docs/arfs/entity-types.html"}},[t._v("here")]),t._v(".")],1),t._v(" "),a("img",{staticClass:"amazingdiagram",staticStyle:{width:"75%"},attrs:{src:t.$withBase("/images/entity-relationship-diagram.png")}}),t._v(" "),a("div",{staticClass:"caption"},[t._v("Entity Relationship Diagram")]),t._v(" "),a("p",[t._v("As you can see, each file and folder contains metadata which points to both the parent folder and the parent drive. The drive entity contains metadata about itself, but not the child contents. So clients must build drive states from the lowest level and work their way up.")]),t._v(" "),a("h2",{attrs:{id:"metadata-format"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#metadata-format"}},[t._v("#")]),t._v(" Metadata Format")]),t._v(" "),a("p",[t._v("Metadata stored in any Arweave transaction tag will be defined in the following manner:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Example-Tag"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"example-data"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Metadata stored in the Transaction Data Payload will follow JSON formatting like below:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"exampleField"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"exampleData"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("fields with a "),a("code",[t._v("?")]),t._v(" suffix are optional.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"My Project"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"description"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"This is a sample project."')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"version?"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"1.0.0"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"author?"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"John Doe"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v('Enumerated field values (those which must adhere to certain values) are defined in the format "value 1 | value 2".')]),t._v(" "),a("p",[t._v("All UUIDs used for Entity-Ids are based on the "),a("a",{attrs:{href:"https://en.wikipedia.org/wiki/Universally_unique_identifier",target:"_blank",rel:"noopener noreferrer"}},[t._v("Universally Unique Identifier"),a("OutboundLink")],1),t._v(" standard.")]),t._v(" "),a("p",[t._v("There are no requirements to list ArFS tags in any specific order.")])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/9.6ede0db4.js b/assets/js/9.5c2e713c.js similarity index 99% rename from assets/js/9.6ede0db4.js rename to assets/js/9.5c2e713c.js index d27a209..3fe83a6 100644 --- a/assets/js/9.6ede0db4.js +++ b/assets/js/9.5c2e713c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[9],{288:function(t,a,s){"use strict";s.r(a);var e=s(10),n=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"entity-types"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#entity-types"}},[t._v("#")]),t._v(" Entity Types")]),t._v(" "),a("h2",{attrs:{id:"overview"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#overview"}},[t._v("#")]),t._v(" Overview")]),t._v(" "),a("p",[t._v("Arweave transactions are composed of transaction headers and data payloads.")]),t._v(" "),a("p",[t._v("ArFS entities, therefore, have their data split between being stored as tags on their transaction header and encoded as JSON and stored as the data of a transaction. In the case of private entities, JSON data and file data payloads are always encrypted according to the protocol processes defined below.")]),t._v(" "),a("ul",[a("li",[a("p",[t._v("Drive entities require a single metadata transaction, with standard Drive tags and encoded JSON with secondary metadata.")])]),t._v(" "),a("li",[a("p",[t._v("Folder entities require a single metadata transaction, with standard Folder tags and an encoded JSON with secondary metadata.")])]),t._v(" "),a("li",[a("p",[t._v("File entities require a metadata transaction, with standard File tags and an encoded Data JSON with secondary metadata relating to the file.")])]),t._v(" "),a("li",[a("p",[t._v("File entities also require a second data transaction, which includes a limited set of File tags and the actual file data itself.")])]),t._v(" "),a("li",[a("p",[t._v("Snapshot entities require a single transaction. which contains a Data JSON with all of the Drive’s rolled up ArFS metadata and standard Snapshot GQL tags that identify the Snapshot.")])])]),t._v(" "),a("p",[t._v("ArFS v0.14 introduces the "),a("code",[t._v("isHidden")]),t._v(" metadata property. "),a("code",[t._v("isHidden")]),t._v(" is a boolean (true/false) that tells clients if they should display the file or folder. Hidden files still exist and will be included in "),a("a",{attrs:{href:"#snapshot"}},[t._v("snapshots")]),t._v(", but should not be rendered by clients. If "),a("code",[t._v("isHidden")]),t._v(" is not present, its value should be assumed false.")]),t._v(" "),a("h2",{attrs:{id:"drive"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#drive"}},[t._v("#")]),t._v(" Drive")]),t._v(" "),a("p",[t._v("A drive is the highest level logical grouping of folders and files. All folders and files must be part of a drive, and reference the Drive ID of that drive.")]),t._v(" "),a("p",[t._v("When creating a Drive, a corresponding folder must be created as well. This will act as the root folder of the drive. This separation of drive and folder entity enables features such as folder view queries, renaming, and linking.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[t._v("ArFS"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0.14"')]),t._v("\nCipher?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"AES256-GCM"')]),t._v("\nCipher-IV?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"<12 byte initialization vector as Base64>"')]),t._v("\nContent-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v("\nDrive-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v("\nDrive-Privacy"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v("\nDrive-Auth-Mode?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"password"')]),t._v("\nEntity-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"drive"')]),t._v("\nUnix-Time"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v("\n\nMetadata JSON "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"rootFolderId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("div",{staticClass:"caption"},[t._v("Drive Entity Transaction Example")]),t._v(" "),a("h2",{attrs:{id:"folder"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#folder"}},[t._v("#")]),t._v(" Folder")]),t._v(" "),a("p",[t._v("A folder is a logical grouping of other folders and files. Folder entity metadata transactions without a parent folder id are considered the Drive Root Folder of their corresponding Drives. All other Folder entities must have a parent folder id. Since folders do not have underlying data, there is no Folder data transaction required.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[t._v("ArFS"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0.14"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nCipher?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"AES256-GCM"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nCipher-IV?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"<12 byte initialization vector as Base64>"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nContent-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nDrive-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nEntity-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"folder"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nFolder-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nParent-Folder-Id?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nUnix-Time"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v("\n\nMetadata JSON "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"isHidden"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("div",{staticClass:"caption"},[t._v("Folder Entity Transaction Example")]),t._v(" "),a("h2",{attrs:{id:"file"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#file"}},[t._v("#")]),t._v(" File")]),t._v(" "),a("p",[t._v("A File contains uploaded data, like a photo, document, or movie.")]),t._v(" "),a("p",[t._v("In the Arweave File System, a single file is broken into 2 parts - its metadata and its data.")]),t._v(" "),a("p",[t._v("In the Arweave File System, a single file is broken into 2 parts - its metadata and its data.")]),t._v(" "),a("p",[t._v("A File entity metadata transaction does not include the actual File data. Instead, the File data must be uploaded as a separate transaction, called the File Data Transaction. The File JSON metadata transaction contains a reference to the File Data Transaction ID so that it can retrieve the actual data. This separation allows for file metadata to be updated without requiring the file itself to be reuploaded. It also ensures that private files can have their JSON Metadata Transaction encrypted as well, ensuring that no one without authorization can see either the file or its metadata.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[t._v("ArFS"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0.14"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nCipher?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"AES256-GCM"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nCipher-IV?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"<12 byte initialization vector as Base64>"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nContent-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nDrive-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nEntity-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nFile-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nParent-Folder-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nUnix-Time"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v("\n\n\nMetadata JSON "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"size"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"lastModifiedDate"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"dataTxId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"dataContentType"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"isHidden"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"pinnedDataOwner"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" # Optional\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("div",{staticClass:"caption"},[t._v(" Pin Files ")]),t._v(" "),a("p",[t._v("Since the version v0.13, ArFS suports Pins. Pins are files whose data may be any transaction uploaded to Arweave, that may or may not be owned by the wallet that created the pin.")]),t._v(" "),a("p",[t._v("When a new File Pin is created, the only created transaction is the Metadata Transaction. The "),a("code",[t._v("dataTxId")]),t._v(" field will point it to any transaction in Arweave, and the optional "),a("code",[t._v("pinnedDataOwner")]),t._v(" field is gonna hold the address of the wallet that owns the original copy of the data transaction.")]),t._v(" "),a("div",{staticClass:"caption"},[t._v("File Data Transaction Example")]),t._v(" "),a("p",[t._v("The File Data Transaction contains limited information about the file, such as the information required to decrypt it, or the Content-Type (mime-type) needed to view in the browser.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[t._v("Cipher?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"AES256-GCM"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nCipher-IV?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"<12 byte initialization vector as Base64>"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nContent-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" File Data - Encrypted if private "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("div",{staticClass:"caption"},[t._v("File Metadata Transaction Example")]),t._v(" "),a("p",[t._v("The the File Metadata Transaction contains the GQL Tags necessary to identify the file within a drive and folder.")]),t._v(" "),a("p",[t._v("Its data contains the JSON metadata for the file. This includes the file name, size, last modified date, data transaction id, and data content type.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[t._v("ArFS"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0.14"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nCipher?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"AES256-GCM"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nCipher-IV?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"<12 byte initialization vector as Base64>"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nContent-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nDrive-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nEntity-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nFile-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nParent-Folder-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nUnix-Time"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" File JSON Metadata - Encrypted if private "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"snapshot"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#snapshot"}},[t._v("#")]),t._v(" Snapshot")]),t._v(" "),a("p",[t._v("ArFS applications generate the latest state of a drive by querying for all ArFS transactions made relating to a user's particular "),a("code",[t._v("Drive-Id")]),t._v(". This includes both paged queries for indexed ArFS data via GQL, as well as the ArFS JSON metadata entries for each ArFS transaction.")]),t._v(" "),a("p",[t._v("For small drives (less than 1000 files), a few thousand requests for very small volumes of data can be achieved relatively quickly and reliably. For larger drives, however, this results in long sync times to pull every piece of ArFS metadata when the local database cache is empty. This can also potentially trigger rate-limiting related ArWeave Gateway delays.")]),t._v(" "),a("p",[t._v("Once a drive state has been completely, and accurately generated, in can be rolled up into a single snapshot and uploaded as an Arweave transaction. ArFS clients can use GQL to find and retrieve this snapshot in order to rapidly reconstitute the total state of the drive, or a large portion of it. They can then query individual transactions performed after the snapshot.")]),t._v(" "),a("p",[t._v("This optional method offers convenience and resource efficiency when building the drive state, at the cost of paying for uploading the snapshot data. Using this method means a client will only have to iterate through a few snapshots instead of every transaction performed on the drive.")]),t._v(" "),a("h3",{attrs:{id:"snapshot-entity-tags"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#snapshot-entity-tags"}},[t._v("#")]),t._v(" Snapshot Entity Tags")]),t._v(" "),a("p",[t._v("Snapshot entities require the following tags. These are queried by ArFS clients to find drive snapshots, organize them together with any other transactions not included within them, and build the latest state of the drive.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[t._v("ArFS"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0.14"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nDrive-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nEntity-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"snapshot"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nSnapshot-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nContent-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nBlock-Start"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nBlock-End"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nData-Start"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v("\n")])])]),a("div",{staticClass:"caption"},[t._v("Snapshot Transaction GQL tags example")]),t._v(" "),a("h3",{attrs:{id:"snapshot-entity-data"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#snapshot-entity-data"}},[t._v("#")]),t._v(" Snapshot Entity Data")]),t._v(" "),a("p",[t._v("A JSON data object must also be uploaded with every ArFS Snapshot entity. THis data contains all ArFS Drive, Folder, and File metadata changes within the associated drive, as well as any previous Snapshots. The Snapshot Data contains an array "),a("code",[t._v("txSnapshots")]),t._v(". Each item includes both the GQL and ArFS metadata details of each transaction made for the associated drive, within the snapshot's start and end period.")]),t._v(" "),a("p",[t._v("A "),a("code",[t._v("tsSnapshot")]),t._v(" contains a "),a("code",[t._v("gqlNode")]),t._v(" object which uses the same GQL tags interface returned by the Arweave Gateway. It includes all of the important "),a("code",[t._v("block")]),t._v(", "),a("code",[t._v("owner")]),t._v(", "),a("code",[t._v("tags")]),t._v(", and "),a("code",[t._v("bundledIn")]),t._v(" information needed by ArFS clients. It also contains a "),a("code",[t._v("dataJson")]),t._v(" object which stores the correlated Data JSON for that ArFS entity.")]),t._v(" "),a("p",[t._v("For private drives, the "),a("code",[t._v("dataJson")]),t._v(" object contains the JSON-string-escaped encrypted text of the associated file or folder. This encrypted text uses the file's existing "),a("code",[t._v("Cipher")]),t._v(" and "),a("code",[t._v("Cipher-IV")]),t._v(". This ensures clients can decrypt this information quickly using the existing ArFS privacy protocols.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"txSnapshots"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"gqlNode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"id"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bWCvIc3cOzwVgquD349HUVsn5Dd1_GIri8Dglok41Vg"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"owner"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"address"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"hlWRbyJ6WUoErm3b0wqVgd1l3LTgaQeLBhB36v2HxgY"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"bundledIn"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"id"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"39n5evzP1Ip9MhGytuFm7F3TDaozwHuVUbS55My-MBk"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"block"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1062005")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1669053791")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"tags"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Content-Type"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"application/json"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ArFS"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0.11"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Entity-Type"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"drive"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Drive-Id"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"f27abc4b-ed6f-4108-a9f5-e545fc4ff55b"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Drive-Privacy"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"public"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"App-Name"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ArDrive-App"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"App-Platform"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Web"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"App-Version"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"1.39.0"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Unix-Time"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"1669053323"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"dataJson"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"{\\"name\\":\\"november\\",\\"rootFolderId\\":\\"71dfc1cb-5368-4323-972a-e9dd0b1c63a0\\", \\"isHidden\\":false}"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("div",{staticClass:"caption"},[t._v("Snapshot Transaction JSON data example")]),t._v(" "),a("h2",{attrs:{id:"schema-diagrams"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#schema-diagrams"}},[t._v("#")]),t._v(" Schema Diagrams")]),t._v(" "),a("p",[t._v("The following diagrams show complete examples of Drive, Folder, and File entity Schemas.")]),t._v(" "),a("h3",{attrs:{id:"public-drive"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#public-drive"}},[t._v("#")]),t._v(" Public Drive")]),t._v(" "),a("img",{staticClass:"amazingdiagram",staticStyle:{width:"75%"},attrs:{src:t.$withBase("/images/public-drive-schema.png")}}),t._v(" "),a("div",{staticClass:"caption"},[t._v("Public Drive Schema")]),t._v(" "),a("h3",{attrs:{id:"private-drive"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#private-drive"}},[t._v("#")]),t._v(" Private Drive")]),t._v(" "),a("img",{staticClass:"amazingdiagram",staticStyle:{width:"75%"},attrs:{src:t.$withBase("/images/private-drive-schema.png")}}),t._v(" "),a("div",{staticClass:"caption"},[t._v("Private Drive Schema")])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[9],{293:function(t,a,s){"use strict";s.r(a);var e=s(10),n=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"entity-types"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#entity-types"}},[t._v("#")]),t._v(" Entity Types")]),t._v(" "),a("h2",{attrs:{id:"overview"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#overview"}},[t._v("#")]),t._v(" Overview")]),t._v(" "),a("p",[t._v("Arweave transactions are composed of transaction headers and data payloads.")]),t._v(" "),a("p",[t._v("ArFS entities, therefore, have their data split between being stored as tags on their transaction header and encoded as JSON and stored as the data of a transaction. In the case of private entities, JSON data and file data payloads are always encrypted according to the protocol processes defined below.")]),t._v(" "),a("ul",[a("li",[a("p",[t._v("Drive entities require a single metadata transaction, with standard Drive tags and encoded JSON with secondary metadata.")])]),t._v(" "),a("li",[a("p",[t._v("Folder entities require a single metadata transaction, with standard Folder tags and an encoded JSON with secondary metadata.")])]),t._v(" "),a("li",[a("p",[t._v("File entities require a metadata transaction, with standard File tags and an encoded Data JSON with secondary metadata relating to the file.")])]),t._v(" "),a("li",[a("p",[t._v("File entities also require a second data transaction, which includes a limited set of File tags and the actual file data itself.")])]),t._v(" "),a("li",[a("p",[t._v("Snapshot entities require a single transaction. which contains a Data JSON with all of the Drive’s rolled up ArFS metadata and standard Snapshot GQL tags that identify the Snapshot.")])])]),t._v(" "),a("p",[t._v("ArFS v0.14 introduces the "),a("code",[t._v("isHidden")]),t._v(" metadata property. "),a("code",[t._v("isHidden")]),t._v(" is a boolean (true/false) that tells clients if they should display the file or folder. Hidden files still exist and will be included in "),a("a",{attrs:{href:"#snapshot"}},[t._v("snapshots")]),t._v(", but should not be rendered by clients. If "),a("code",[t._v("isHidden")]),t._v(" is not present, its value should be assumed false.")]),t._v(" "),a("h2",{attrs:{id:"drive"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#drive"}},[t._v("#")]),t._v(" Drive")]),t._v(" "),a("p",[t._v("A drive is the highest level logical grouping of folders and files. All folders and files must be part of a drive, and reference the Drive ID of that drive.")]),t._v(" "),a("p",[t._v("When creating a Drive, a corresponding folder must be created as well. This will act as the root folder of the drive. This separation of drive and folder entity enables features such as folder view queries, renaming, and linking.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[t._v("ArFS"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0.14"')]),t._v("\nCipher?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"AES256-GCM"')]),t._v("\nCipher-IV?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"<12 byte initialization vector as Base64>"')]),t._v("\nContent-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v("\nDrive-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v("\nDrive-Privacy"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v("\nDrive-Auth-Mode?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"password"')]),t._v("\nEntity-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"drive"')]),t._v("\nUnix-Time"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v("\n\nMetadata JSON "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"rootFolderId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("div",{staticClass:"caption"},[t._v("Drive Entity Transaction Example")]),t._v(" "),a("h2",{attrs:{id:"folder"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#folder"}},[t._v("#")]),t._v(" Folder")]),t._v(" "),a("p",[t._v("A folder is a logical grouping of other folders and files. Folder entity metadata transactions without a parent folder id are considered the Drive Root Folder of their corresponding Drives. All other Folder entities must have a parent folder id. Since folders do not have underlying data, there is no Folder data transaction required.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[t._v("ArFS"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0.14"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nCipher?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"AES256-GCM"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nCipher-IV?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"<12 byte initialization vector as Base64>"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nContent-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nDrive-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nEntity-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"folder"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nFolder-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nParent-Folder-Id?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nUnix-Time"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v("\n\nMetadata JSON "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"isHidden"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("div",{staticClass:"caption"},[t._v("Folder Entity Transaction Example")]),t._v(" "),a("h2",{attrs:{id:"file"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#file"}},[t._v("#")]),t._v(" File")]),t._v(" "),a("p",[t._v("A File contains uploaded data, like a photo, document, or movie.")]),t._v(" "),a("p",[t._v("In the Arweave File System, a single file is broken into 2 parts - its metadata and its data.")]),t._v(" "),a("p",[t._v("In the Arweave File System, a single file is broken into 2 parts - its metadata and its data.")]),t._v(" "),a("p",[t._v("A File entity metadata transaction does not include the actual File data. Instead, the File data must be uploaded as a separate transaction, called the File Data Transaction. The File JSON metadata transaction contains a reference to the File Data Transaction ID so that it can retrieve the actual data. This separation allows for file metadata to be updated without requiring the file itself to be reuploaded. It also ensures that private files can have their JSON Metadata Transaction encrypted as well, ensuring that no one without authorization can see either the file or its metadata.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[t._v("ArFS"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0.14"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nCipher?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"AES256-GCM"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nCipher-IV?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"<12 byte initialization vector as Base64>"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nContent-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nDrive-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nEntity-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nFile-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nParent-Folder-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nUnix-Time"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v("\n\n\nMetadata JSON "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"size"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"lastModifiedDate"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"dataTxId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"dataContentType"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"isHidden"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"pinnedDataOwner"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" # Optional\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("div",{staticClass:"caption"},[t._v(" Pin Files ")]),t._v(" "),a("p",[t._v("Since the version v0.13, ArFS suports Pins. Pins are files whose data may be any transaction uploaded to Arweave, that may or may not be owned by the wallet that created the pin.")]),t._v(" "),a("p",[t._v("When a new File Pin is created, the only created transaction is the Metadata Transaction. The "),a("code",[t._v("dataTxId")]),t._v(" field will point it to any transaction in Arweave, and the optional "),a("code",[t._v("pinnedDataOwner")]),t._v(" field is gonna hold the address of the wallet that owns the original copy of the data transaction.")]),t._v(" "),a("div",{staticClass:"caption"},[t._v("File Data Transaction Example")]),t._v(" "),a("p",[t._v("The File Data Transaction contains limited information about the file, such as the information required to decrypt it, or the Content-Type (mime-type) needed to view in the browser.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[t._v("Cipher?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"AES256-GCM"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nCipher-IV?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"<12 byte initialization vector as Base64>"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nContent-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" File Data - Encrypted if private "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("div",{staticClass:"caption"},[t._v("File Metadata Transaction Example")]),t._v(" "),a("p",[t._v("The the File Metadata Transaction contains the GQL Tags necessary to identify the file within a drive and folder.")]),t._v(" "),a("p",[t._v("Its data contains the JSON metadata for the file. This includes the file name, size, last modified date, data transaction id, and data content type.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[t._v("ArFS"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0.14"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nCipher?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"AES256-GCM"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nCipher-IV?"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"<12 byte initialization vector as Base64>"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nContent-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nDrive-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nEntity-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nFile-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nParent-Folder-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nUnix-Time"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" File JSON Metadata - Encrypted if private "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"snapshot"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#snapshot"}},[t._v("#")]),t._v(" Snapshot")]),t._v(" "),a("p",[t._v("ArFS applications generate the latest state of a drive by querying for all ArFS transactions made relating to a user's particular "),a("code",[t._v("Drive-Id")]),t._v(". This includes both paged queries for indexed ArFS data via GQL, as well as the ArFS JSON metadata entries for each ArFS transaction.")]),t._v(" "),a("p",[t._v("For small drives (less than 1000 files), a few thousand requests for very small volumes of data can be achieved relatively quickly and reliably. For larger drives, however, this results in long sync times to pull every piece of ArFS metadata when the local database cache is empty. This can also potentially trigger rate-limiting related ArWeave Gateway delays.")]),t._v(" "),a("p",[t._v("Once a drive state has been completely, and accurately generated, in can be rolled up into a single snapshot and uploaded as an Arweave transaction. ArFS clients can use GQL to find and retrieve this snapshot in order to rapidly reconstitute the total state of the drive, or a large portion of it. They can then query individual transactions performed after the snapshot.")]),t._v(" "),a("p",[t._v("This optional method offers convenience and resource efficiency when building the drive state, at the cost of paying for uploading the snapshot data. Using this method means a client will only have to iterate through a few snapshots instead of every transaction performed on the drive.")]),t._v(" "),a("h3",{attrs:{id:"snapshot-entity-tags"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#snapshot-entity-tags"}},[t._v("#")]),t._v(" Snapshot Entity Tags")]),t._v(" "),a("p",[t._v("Snapshot entities require the following tags. These are queried by ArFS clients to find drive snapshots, organize them together with any other transactions not included within them, and build the latest state of the drive.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[t._v("ArFS"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0.14"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nDrive-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nEntity-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"snapshot"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nSnapshot-Id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nContent-Type"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nBlock-Start"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nBlock-End"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\nData-Start"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v("\n")])])]),a("div",{staticClass:"caption"},[t._v("Snapshot Transaction GQL tags example")]),t._v(" "),a("h3",{attrs:{id:"snapshot-entity-data"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#snapshot-entity-data"}},[t._v("#")]),t._v(" Snapshot Entity Data")]),t._v(" "),a("p",[t._v("A JSON data object must also be uploaded with every ArFS Snapshot entity. THis data contains all ArFS Drive, Folder, and File metadata changes within the associated drive, as well as any previous Snapshots. The Snapshot Data contains an array "),a("code",[t._v("txSnapshots")]),t._v(". Each item includes both the GQL and ArFS metadata details of each transaction made for the associated drive, within the snapshot's start and end period.")]),t._v(" "),a("p",[t._v("A "),a("code",[t._v("tsSnapshot")]),t._v(" contains a "),a("code",[t._v("gqlNode")]),t._v(" object which uses the same GQL tags interface returned by the Arweave Gateway. It includes all of the important "),a("code",[t._v("block")]),t._v(", "),a("code",[t._v("owner")]),t._v(", "),a("code",[t._v("tags")]),t._v(", and "),a("code",[t._v("bundledIn")]),t._v(" information needed by ArFS clients. It also contains a "),a("code",[t._v("dataJson")]),t._v(" object which stores the correlated Data JSON for that ArFS entity.")]),t._v(" "),a("p",[t._v("For private drives, the "),a("code",[t._v("dataJson")]),t._v(" object contains the JSON-string-escaped encrypted text of the associated file or folder. This encrypted text uses the file's existing "),a("code",[t._v("Cipher")]),t._v(" and "),a("code",[t._v("Cipher-IV")]),t._v(". This ensures clients can decrypt this information quickly using the existing ArFS privacy protocols.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"txSnapshots"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"gqlNode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"id"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bWCvIc3cOzwVgquD349HUVsn5Dd1_GIri8Dglok41Vg"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"owner"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"address"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"hlWRbyJ6WUoErm3b0wqVgd1l3LTgaQeLBhB36v2HxgY"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"bundledIn"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"id"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"39n5evzP1Ip9MhGytuFm7F3TDaozwHuVUbS55My-MBk"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"block"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1062005")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1669053791")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"tags"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Content-Type"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"application/json"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ArFS"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0.11"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Entity-Type"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"drive"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Drive-Id"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"f27abc4b-ed6f-4108-a9f5-e545fc4ff55b"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Drive-Privacy"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"public"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"App-Name"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ArDrive-App"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"App-Platform"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Web"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"App-Version"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"1.39.0"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Unix-Time"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"1669053323"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"dataJson"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"{\\"name\\":\\"november\\",\\"rootFolderId\\":\\"71dfc1cb-5368-4323-972a-e9dd0b1c63a0\\", \\"isHidden\\":false}"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("div",{staticClass:"caption"},[t._v("Snapshot Transaction JSON data example")]),t._v(" "),a("h2",{attrs:{id:"schema-diagrams"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#schema-diagrams"}},[t._v("#")]),t._v(" Schema Diagrams")]),t._v(" "),a("p",[t._v("The following diagrams show complete examples of Drive, Folder, and File entity Schemas.")]),t._v(" "),a("h3",{attrs:{id:"public-drive"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#public-drive"}},[t._v("#")]),t._v(" Public Drive")]),t._v(" "),a("img",{staticClass:"amazingdiagram",staticStyle:{width:"75%"},attrs:{src:t.$withBase("/images/public-drive-schema.png")}}),t._v(" "),a("div",{staticClass:"caption"},[t._v("Public Drive Schema")]),t._v(" "),a("h3",{attrs:{id:"private-drive"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#private-drive"}},[t._v("#")]),t._v(" Private Drive")]),t._v(" "),a("img",{staticClass:"amazingdiagram",staticStyle:{width:"75%"},attrs:{src:t.$withBase("/images/private-drive-schema.png")}}),t._v(" "),a("div",{staticClass:"caption"},[t._v("Private Drive Schema")])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/app.846d4f25.js b/assets/js/app.a0503b5c.js similarity index 83% rename from assets/js/app.846d4f25.js rename to assets/js/app.a0503b5c.js index 594fa6d..abc0ee1 100644 --- a/assets/js/app.846d4f25.js +++ b/assets/js/app.a0503b5c.js @@ -1,4 +1,4 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[0],[]]);!function(t){function e(e){for(var r,a,s=e[0],c=e[1],u=e[2],f=0,p=[];f
'};function o(t,e,n){return tn?n:t}function i(t){return 100*(-1+t)}n.configure=function(t){var e,n;for(e in t)void 0!==(n=t[e])&&t.hasOwnProperty(e)&&(r[e]=n);return this},n.status=null,n.set=function(t){var e=n.isStarted();t=o(t,r.minimum,1),n.status=1===t?null:t;var c=n.render(!e),u=c.querySelector(r.barSelector),l=r.speed,f=r.easing;return c.offsetWidth,a((function(e){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),s(u,function(t,e,n){var o;return(o="translate3d"===r.positionUsing?{transform:"translate3d("+i(t)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+i(t)+"%,0)"}:{"margin-left":i(t)+"%"}).transition="all "+e+"ms "+n,o}(t,l,f)),1===t?(s(c,{transition:"none",opacity:1}),c.offsetWidth,setTimeout((function(){s(c,{transition:"all "+l+"ms linear",opacity:0}),setTimeout((function(){n.remove(),e()}),l)}),l)):setTimeout(e,l)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var t=function(){setTimeout((function(){n.status&&(n.trickle(),t())}),r.trickleSpeed)};return r.trickle&&t(),this},n.done=function(t){return t||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(t){var e=n.status;return e?("number"!=typeof t&&(t=(1-e)*o(Math.random()*e,.1,.95)),e=o(e+t,0,.994),n.set(e)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},t=0,e=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===e&&n.start(),t++,e++,r.always((function(){0==--e?(t=0,n.done()):n.set((t-e)/t)})),this):this},n.render=function(t){if(n.isRendered())return document.getElementById("nprogress");u(document.documentElement,"nprogress-busy");var e=document.createElement("div");e.id="nprogress",e.innerHTML=r.template;var o,a=e.querySelector(r.barSelector),c=t?"-100":i(n.status||0),l=document.querySelector(r.parent);return s(a,{transition:"all 0 linear",transform:"translate3d("+c+"%,0,0)"}),r.showSpinner||(o=e.querySelector(r.spinnerSelector))&&p(o),l!=document.body&&u(l,"nprogress-custom-parent"),l.appendChild(e),e},n.remove=function(){l(document.documentElement,"nprogress-busy"),l(document.querySelector(r.parent),"nprogress-custom-parent");var t=document.getElementById("nprogress");t&&p(t)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var t=document.body.style,e="WebkitTransform"in t?"Webkit":"MozTransform"in t?"Moz":"msTransform"in t?"ms":"OTransform"in t?"O":"";return e+"Perspective"in t?"translate3d":e+"Transform"in t?"translate":"margin"};var a=function(){var t=[];function e(){var n=t.shift();n&&n(e)}return function(n){t.push(n),1==t.length&&e()}}(),s=function(){var t=["Webkit","O","Moz","ms"],e={};function n(n){return n=n.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(t,e){return e.toUpperCase()})),e[n]||(e[n]=function(e){var n=document.body.style;if(e in n)return e;for(var r,o=t.length,i=e.charAt(0).toUpperCase()+e.slice(1);o--;)if((r=t[o]+i)in n)return r;return e}(n))}function r(t,e,r){e=n(e),t.style[e]=r}return function(t,e){var n,o,i=arguments;if(2==i.length)for(n in e)void 0!==(o=e[n])&&e.hasOwnProperty(n)&&r(t,n,o);else r(t,i[1],i[2])}}();function c(t,e){return("string"==typeof t?t:f(t)).indexOf(" "+e+" ")>=0}function u(t,e){var n=f(t),r=n+e;c(n,e)||(t.className=r.substring(1))}function l(t,e){var n,r=f(t);c(t,e)&&(n=r.replace(" "+e+" "," "),t.className=n.substring(1,n.length-1))}function f(t){return(" "+(t.className||"")+" ").replace(/\s+/gi," ")}function p(t){t&&t.parentNode&&t.parentNode.removeChild(t)}return n})?r.call(e,n,e,t):r)||(t.exports=o)},function(t,e,n){var r=n(3),o=n(45).f,i=n(13),a=n(106),s=n(32),c=n(61),u=n(122);t.exports=function(t,e){var n,l,f,p,d,h=t.target,v=t.global,g=t.stat;if(n=v?r:g?r[h]||s(h,{}):(r[h]||{}).prototype)for(l in e){if(p=e[l],f=t.dontCallGetSet?(d=o(n,l))&&d.value:n[l],!u(v?l:h+(g?".":"#")+l,t.forced)&&void 0!==f){if(typeof p==typeof f)continue;c(p,f)}(t.sham||f&&f.sham)&&i(p,"sham",!0),a(n,l,p,t)}}},function(t,e,n){var r=n(25),o=Function.prototype.call;t.exports=r?o.bind(o):function(){return o.apply(o,arguments)}},function(t,e,n){var r=n(1);t.exports=!r((function(){var t=function(){}.bind();return"function"!=typeof t||t.hasOwnProperty("prototype")}))},function(t,e){t.exports=function(t,e){return{enumerable:!(1&t),configurable:!(2&t),writable:!(4&t),value:e}}},function(t,e,n){var r=n(46),o=n(47);t.exports=function(t){return r(o(t))}},function(t,e,n){var r=n(3),o=n(0),i=function(t){return o(t)?t:void 0};t.exports=function(t,e){return arguments.length<2?i(r[t]):r[t]&&r[t][e]}},function(t,e,n){var r=n(0),o=n(102),i=TypeError;t.exports=function(t){if(r(t))return t;throw i(o(t)+" is not a function")}},function(t,e,n){var r=n(3),o=n(56),i=n(7),a=n(58),s=n(54),c=n(53),u=r.Symbol,l=o("wks"),f=c?u.for||u:u&&u.withoutSetter||a;t.exports=function(t){return i(l,t)||(l[t]=s&&i(u,t)?u[t]:f("Symbol."+t)),l[t]}},function(t,e,n){var r=n(3),o=n(32),i=r["__core-js_shared__"]||o("__core-js_shared__",{});t.exports=i},function(t,e,n){var r=n(3),o=Object.defineProperty;t.exports=function(t,e){try{o(r,t,{value:e,configurable:!0,writable:!0})}catch(n){r[t]=e}return e}},function(t,e,n){var r=n(47),o=Object;t.exports=function(t){return o(r(t))}},function(t,e,n){var r=n(8),o=String,i=TypeError;t.exports=function(t){if(r(t))return t;throw i(o(t)+" is not an object")}},function(t,e,n){var r=n(119);t.exports=function(t){return r(t.length)}},function(t,e,n){var r=n(146),o=n(11),i=Object.prototype,a=i.hasOwnProperty,s=i.propertyIsEnumerable,c=r(function(){return arguments}())?r:function(t){return o(t)&&a.call(t,"callee")&&!s.call(t,"callee")};t.exports=c},function(t,e,n){var r=n(9)(n(6),"Map");t.exports=r},function(t,e){t.exports=function(t){var e=typeof t;return null!=t&&("object"==e||"function"==e)}},function(t,e,n){var r=n(166),o=n(173),i=n(175),a=n(176),s=n(177);function c(t){var e=-1,n=null==t?0:t.length;for(this.clear();++e-1&&t%1==0&&t<=9007199254740991}},function(t,e,n){var r=n(4),o=n(43),i=/\.|\[(?:[^[\]]*|(["'])(?:(?!\1)[^\\]|\\.)*?\1)\]/,a=/^\w*$/;t.exports=function(t,e){if(r(t))return!1;var n=typeof t;return!("number"!=n&&"symbol"!=n&&"boolean"!=n&&null!=t&&!o(t))||(a.test(t)||!i.test(t)||null!=e&&t in Object(e))}},function(t,e,n){var r=n(12),o=n(11);t.exports=function(t){return"symbol"==typeof t||o(t)&&"[object Symbol]"==r(t)}},function(t,e){t.exports=function(t){return t}},function(t,e,n){var r=n(5),o=n(24),i=n(98),a=n(26),s=n(27),c=n(49),u=n(7),l=n(59),f=Object.getOwnPropertyDescriptor;e.f=r?f:function(t,e){if(t=s(t),e=c(e),l)try{return f(t,e)}catch(t){}if(u(t,e))return a(!o(i.f,t,e),t[e])}},function(t,e,n){var r=n(2),o=n(1),i=n(15),a=Object,s=r("".split);t.exports=o((function(){return!a("z").propertyIsEnumerable(0)}))?function(t){return"String"==i(t)?s(t,""):a(t)}:a},function(t,e,n){var r=n(48),o=TypeError;t.exports=function(t){if(r(t))throw o("Can't call method on "+t);return t}},function(t,e){t.exports=function(t){return null==t}},function(t,e,n){var r=n(99),o=n(51);t.exports=function(t){var e=r(t,"string");return o(e)?e:e+""}},function(t,e){var n="object"==typeof document&&document.all,r=void 0===n&&void 0!==n;t.exports={all:n,IS_HTMLDDA:r}},function(t,e,n){var r=n(28),o=n(0),i=n(52),a=n(53),s=Object;t.exports=a?function(t){return"symbol"==typeof t}:function(t){var e=r("Symbol");return o(e)&&i(e.prototype,s(t))}},function(t,e,n){var r=n(2);t.exports=r({}.isPrototypeOf)},function(t,e,n){var r=n(54);t.exports=r&&!Symbol.sham&&"symbol"==typeof Symbol.iterator},function(t,e,n){var r=n(55),o=n(1);t.exports=!!Object.getOwnPropertySymbols&&!o((function(){var t=Symbol();return!String(t)||!(Object(t)instanceof Symbol)||!Symbol.sham&&r&&r<41}))},function(t,e,n){var r,o,i=n(3),a=n(100),s=i.process,c=i.Deno,u=s&&s.versions||c&&c.version,l=u&&u.v8;l&&(o=(r=l.split("."))[0]>0&&r[0]<4?1:+(r[0]+r[1])),!o&&a&&(!(r=a.match(/Edge\/(\d+)/))||r[1]>=74)&&(r=a.match(/Chrome\/(\d+)/))&&(o=+r[1]),t.exports=o},function(t,e,n){var r=n(57),o=n(31);(t.exports=function(t,e){return o[t]||(o[t]=void 0!==e?e:{})})("versions",[]).push({version:"3.30.1",mode:r?"pure":"global",copyright:"© 2014-2023 Denis Pushkarev (zloirock.ru)",license:"https://github.com/zloirock/core-js/blob/v3.30.1/LICENSE",source:"https://github.com/zloirock/core-js"})},function(t,e){t.exports=!1},function(t,e,n){var r=n(2),o=0,i=Math.random(),a=r(1..toString);t.exports=function(t){return"Symbol("+(void 0===t?"":t)+")_"+a(++o+i,36)}},function(t,e,n){var r=n(5),o=n(1),i=n(104);t.exports=!r&&!o((function(){return 7!=Object.defineProperty(i("div"),"a",{get:function(){return 7}}).a}))},function(t,e){t.exports={}},function(t,e,n){var r=n(7),o=n(113),i=n(45),a=n(16);t.exports=function(t,e,n){for(var s=o(e),c=a.f,u=i.f,l=0;ll))return!1;var p=c.get(t),d=c.get(e);if(p&&d)return p==e&&d==t;var h=-1,v=!0,g=2&n?new r:void 0;for(c.set(t,e),c.set(e,t);++h-1&&t%1==0&&t=0&&Math.floor(e)===e&&isFinite(t)}function v(t){return a(t)&&"function"==typeof t.then&&"function"==typeof t.catch}function g(t){return null==t?"":Array.isArray(t)||p(t)&&t.toString===f?JSON.stringify(t,null,2):String(t)}function m(t){var e=parseFloat(t);return isNaN(e)?t:e}function y(t,e){for(var n=Object.create(null),r=t.split(","),o=0;o-1)return t.splice(r,1)}}var w=Object.prototype.hasOwnProperty;function x(t,e){return w.call(t,e)}function k(t){var e=Object.create(null);return function(n){return e[n]||(e[n]=t(n))}}var O=/-(\w)/g,C=k((function(t){return t.replace(O,(function(t,e){return e?e.toUpperCase():""}))})),S=k((function(t){return t.charAt(0).toUpperCase()+t.slice(1)})),j=/\B([A-Z])/g,$=k((function(t){return t.replace(j,"-$1").toLowerCase()}));var E=Function.prototype.bind?function(t,e){return t.bind(e)}:function(t,e){function n(n){var r=arguments.length;return r?r>1?t.apply(e,arguments):t.call(e,n):t.call(e)}return n._length=t.length,n};function P(t,e){e=e||0;for(var n=t.length-e,r=new Array(n);n--;)r[n]=t[n+e];return r}function A(t,e){for(var n in e)t[n]=e[n];return t}function T(t){for(var e={},n=0;n0,X=Q&&Q.indexOf("edge/")>0;Q&&Q.indexOf("android");var Z=Q&&/iphone|ipad|ipod|ios/.test(Q);Q&&/chrome\/\d+/.test(Q),Q&&/phantomjs/.test(Q);var tt,et=Q&&Q.match(/firefox\/(\d+)/),nt={}.watch,rt=!1;if(K)try{var ot={};Object.defineProperty(ot,"passive",{get:function(){rt=!0}}),window.addEventListener("test-passive",null,ot)}catch(t){}var it=function(){return void 0===tt&&(tt=!K&&"undefined"!=typeof global&&(global.process&&"server"===global.process.env.VUE_ENV)),tt},at=K&&window.__VUE_DEVTOOLS_GLOBAL_HOOK__;function st(t){return"function"==typeof t&&/native code/.test(t.toString())}var ct,ut="undefined"!=typeof Symbol&&st(Symbol)&&"undefined"!=typeof Reflect&&st(Reflect.ownKeys);ct="undefined"!=typeof Set&&st(Set)?Set:function(){function t(){this.set=Object.create(null)}return t.prototype.has=function(t){return!0===this.set[t]},t.prototype.add=function(t){this.set[t]=!0},t.prototype.clear=function(){this.set=Object.create(null)},t}();var lt=null;function ft(t){void 0===t&&(t=null),t||lt&<._scope.off(),lt=t,t&&t._scope.on()}var pt=function(){function t(t,e,n,r,o,i,a,s){this.tag=t,this.data=e,this.children=n,this.text=r,this.elm=o,this.ns=void 0,this.context=i,this.fnContext=void 0,this.fnOptions=void 0,this.fnScopeId=void 0,this.key=e&&e.key,this.componentOptions=a,this.componentInstance=void 0,this.parent=void 0,this.raw=!1,this.isStatic=!1,this.isRootInsert=!0,this.isComment=!1,this.isCloned=!1,this.isOnce=!1,this.asyncFactory=s,this.asyncMeta=void 0,this.isAsyncPlaceholder=!1}return Object.defineProperty(t.prototype,"child",{get:function(){return this.componentInstance},enumerable:!1,configurable:!0}),t}(),dt=function(t){void 0===t&&(t="");var e=new pt;return e.text=t,e.isComment=!0,e};function ht(t){return new pt(void 0,void 0,void 0,String(t))}function vt(t){var e=new pt(t.tag,t.data,t.children&&t.children.slice(),t.text,t.elm,t.context,t.componentOptions,t.asyncFactory);return e.ns=t.ns,e.isStatic=t.isStatic,e.key=t.key,e.isComment=t.isComment,e.fnContext=t.fnContext,e.fnOptions=t.fnOptions,e.fnScopeId=t.fnScopeId,e.asyncMeta=t.asyncMeta,e.isCloned=!0,e}var gt=0,mt=[],yt=function(){function t(){this._pending=!1,this.id=gt++,this.subs=[]}return t.prototype.addSub=function(t){this.subs.push(t)},t.prototype.removeSub=function(t){this.subs[this.subs.indexOf(t)]=null,this._pending||(this._pending=!0,mt.push(this))},t.prototype.depend=function(e){t.target&&t.target.addDep(this)},t.prototype.notify=function(t){var e=this.subs.filter((function(t){return t}));for(var n=0,r=e.length;n0&&(re((u=t(u,"".concat(n||"","_").concat(r)))[0])&&re(f)&&(p[l]=ht(f.text+u[0].text),u.shift()),p.push.apply(p,u)):c(u)?re(f)?p[l]=ht(f.text+u):""!==u&&p.push(ht(u)):re(u)&&re(f)?p[l]=ht(f.text+u.text):(s(e._isVList)&&a(u.tag)&&i(u.key)&&a(n)&&(u.key="__vlist".concat(n,"_").concat(r,"__")),p.push(u)));return p}(t):void 0}function re(t){return a(t)&&a(t.text)&&!1===t.isComment}function oe(t,e){var n,r,i,s,c=null;if(o(t)||"string"==typeof t)for(c=new Array(t.length),n=0,r=t.length;n0,s=e?!!e.$stable:!a,c=e&&e.$key;if(e){if(e._normalized)return e._normalized;if(s&&o&&o!==r&&c===o.$key&&!a&&!o.$hasNormal)return o;for(var u in i={},e)e[u]&&"$"!==u[0]&&(i[u]=ke(t,n,u,e[u]))}else i={};for(var l in n)l in i||(i[l]=Oe(n,l));return e&&Object.isExtensible(e)&&(e._normalized=i),W(i,"$stable",s),W(i,"$key",c),W(i,"$hasNormal",a),i}function ke(t,e,n,r){var i=function(){var e=lt;ft(t);var n=arguments.length?r.apply(null,arguments):r({}),i=(n=n&&"object"==typeof n&&!o(n)?[n]:ne(n))&&n[0];return ft(e),n&&(!i||1===n.length&&i.isComment&&!we(i))?void 0:n};return r.proxy&&Object.defineProperty(e,n,{get:i,enumerable:!0,configurable:!0}),i}function Oe(t,e){return function(){return t[e]}}function Ce(t){return{get attrs(){if(!t._attrsProxy){var e=t._attrsProxy={};W(e,"_v_attr_proxy",!0),Se(e,t.$attrs,r,t,"$attrs")}return t._attrsProxy},get listeners(){t._listenersProxy||Se(t._listenersProxy={},t.$listeners,r,t,"$listeners");return t._listenersProxy},get slots(){return function(t){t._slotsProxy||$e(t._slotsProxy={},t.$scopedSlots);return t._slotsProxy}(t)},emit:E(t.$emit,t),expose:function(e){e&&Object.keys(e).forEach((function(n){return Vt(t,e,n)}))}}}function Se(t,e,n,r,o){var i=!1;for(var a in e)a in t?e[a]!==n[a]&&(i=!0):(i=!0,je(t,a,r,o));for(var a in t)a in e||(i=!0,delete t[a]);return i}function je(t,e,n,r){Object.defineProperty(t,e,{enumerable:!0,configurable:!0,get:function(){return n[r][e]}})}function $e(t,e){for(var n in e)t[n]=e[n];for(var n in t)n in e||delete t[n]}var Ee=null;function Pe(t,e){return(t.__esModule||ut&&"Module"===t[Symbol.toStringTag])&&(t=t.default),l(t)?e.extend(t):t}function Ae(t){if(o(t))for(var e=0;edocument.createEvent("Event").timeStamp&&(gn=function(){return mn.now()})}var yn=function(t,e){if(t.post){if(!e.post)return 1}else if(e.post)return-1;return t.id-e.id};function bn(){var t,e;for(vn=gn(),dn=!0,un.sort(yn),hn=0;hnhn&&un[n].id>t.id;)n--;un.splice(n+1,0,t)}else un.push(t);pn||(pn=!0,qe(bn))}}function wn(t,e){if(t){for(var n=Object.create(null),r=ut?Reflect.ownKeys(t):Object.keys(t),o=0;o-1)if(i&&!x(o,"default"))a=!1;else if(""===a||a===$(t)){var c=zn(String,o.type);(c<0||s-1:"string"==typeof t?t.split(",").indexOf(e)>-1:!!d(t)&&t.test(e)}function or(t,e){var n=t.cache,r=t.keys,o=t._vnode;for(var i in n){var a=n[i];if(a){var s=a.name;s&&!e(s)&&ir(n,i,r,o)}}}function ir(t,e,n,r){var o=t[e];!o||r&&o.tag===r.tag||o.componentInstance.$destroy(),t[e]=null,_(n,e)}tr.prototype._init=function(t){var e=this;e._uid=Xn++,e._isVue=!0,e.__v_skip=!0,e._scope=new Qt(!0),e._scope._vm=!0,t&&t._isComponent?function(t,e){var n=t.$options=Object.create(t.constructor.options),r=e._parentVnode;n.parent=e.parent,n._parentVnode=r;var o=r.componentOptions;n.propsData=o.propsData,n._parentListeners=o.listeners,n._renderChildren=o.children,n._componentTag=o.tag,e.render&&(n.render=e.render,n.staticRenderFns=e.staticRenderFns)}(e,t):e.$options=Rn(Zn(e.constructor),t||{},e),e._renderProxy=e,e._self=e,function(t){var e=t.$options,n=e.parent;if(n&&!e.abstract){for(;n.$options.abstract&&n.$parent;)n=n.$parent;n.$children.push(t)}t.$parent=n,t.$root=n?n.$root:t,t.$children=[],t.$refs={},t._provided=n?n._provided:Object.create(null),t._watcher=null,t._inactive=null,t._directInactive=!1,t._isMounted=!1,t._isDestroyed=!1,t._isBeingDestroyed=!1}(e),function(t){t._events=Object.create(null),t._hasHookEvent=!1;var e=t.$options._parentListeners;e&&nn(t,e)}(e),function(t){t._vnode=null,t._staticTrees=null;var e=t.$options,n=t.$vnode=e._parentVnode,o=n&&n.context;t.$slots=be(e._renderChildren,o),t.$scopedSlots=n?xe(t.$parent,n.data.scopedSlots,t.$slots):r,t._c=function(e,n,r,o){return Te(t,e,n,r,o,!1)},t.$createElement=function(e,n,r,o){return Te(t,e,n,r,o,!0)};var i=n&&n.data;At(t,"$attrs",i&&i.attrs||r,null,!0),At(t,"$listeners",e._parentListeners||r,null,!0)}(e),cn(e,"beforeCreate",void 0,!1),function(t){var e=wn(t.$options.inject,t);e&&(jt(!1),Object.keys(e).forEach((function(n){At(t,n,e[n])})),jt(!0))}(e),qn(e),function(t){var e=t.$options.provide;if(e){var n=u(e)?e.call(t):e;if(!l(n))return;for(var r=Jt(t),o=ut?Reflect.ownKeys(n):Object.keys(n),i=0;i1?P(n):n;for(var r=P(arguments,1),o='event handler for "'.concat(t,'"'),i=0,a=n.length;iparseInt(this.max)&&ir(t,e[0],e,this._vnode),this.vnodeToCache=null}}},created:function(){this.cache=Object.create(null),this.keys=[]},destroyed:function(){for(var t in this.cache)ir(this.cache,t,this.keys)},mounted:function(){var t=this;this.cacheVNode(),this.$watch("include",(function(e){or(t,(function(t){return rr(e,t)}))})),this.$watch("exclude",(function(e){or(t,(function(t){return!rr(e,t)}))}))},updated:function(){this.cacheVNode()},render:function(){var t=this.$slots.default,e=Ae(t),n=e&&e.componentOptions;if(n){var r=nr(n),o=this.include,i=this.exclude;if(o&&(!r||!rr(o,r))||i&&r&&rr(i,r))return e;var a=this.cache,s=this.keys,c=null==e.key?n.Ctor.cid+(n.tag?"::".concat(n.tag):""):e.key;a[c]?(e.componentInstance=a[c].componentInstance,_(s,c),s.push(c)):(this.vnodeToCache=e,this.keyToCache=c),e.data.keepAlive=!0}return e||t&&t[0]}}};!function(t){var e={get:function(){return B}};Object.defineProperty(t,"config",e),t.util={warn:Pn,extend:A,mergeOptions:Rn,defineReactive:At},t.set=Tt,t.delete=Lt,t.nextTick=qe,t.observable=function(t){return Pt(t),t},t.options=Object.create(null),U.forEach((function(e){t.options[e+"s"]=Object.create(null)})),t.options._base=t,A(t.options.components,sr),function(t){t.use=function(t){var e=this._installedPlugins||(this._installedPlugins=[]);if(e.indexOf(t)>-1)return this;var n=P(arguments,1);return n.unshift(this),u(t.install)?t.install.apply(t,n):u(t)&&t.apply(null,n),e.push(t),this}}(t),function(t){t.mixin=function(t){return this.options=Rn(this.options,t),this}}(t),er(t),function(t){U.forEach((function(e){t[e]=function(t,n){return n?("component"===e&&p(n)&&(n.name=n.name||t,n=this.options._base.extend(n)),"directive"===e&&u(n)&&(n={bind:n,update:n}),this.options[e+"s"][t]=n,n):this.options[e+"s"][t]}}))}(t)}(tr),Object.defineProperty(tr.prototype,"$isServer",{get:it}),Object.defineProperty(tr.prototype,"$ssrContext",{get:function(){return this.$vnode&&this.$vnode.ssrContext}}),Object.defineProperty(tr,"FunctionalRenderContext",{value:xn}),tr.version="2.7.14";var cr=y("style,class"),ur=y("input,textarea,option,select,progress"),lr=y("contenteditable,draggable,spellcheck"),fr=y("events,caret,typing,plaintext-only"),pr=y("allowfullscreen,async,autofocus,autoplay,checked,compact,controls,declare,default,defaultchecked,defaultmuted,defaultselected,defer,disabled,enabled,formnovalidate,hidden,indeterminate,inert,ismap,itemscope,loop,multiple,muted,nohref,noresize,noshade,novalidate,nowrap,open,pauseonexit,readonly,required,reversed,scoped,seamless,selected,sortable,truespeed,typemustmatch,visible"),dr="http://www.w3.org/1999/xlink",hr=function(t){return":"===t.charAt(5)&&"xlink"===t.slice(0,5)},vr=function(t){return hr(t)?t.slice(6,t.length):""},gr=function(t){return null==t||!1===t};function mr(t){for(var e=t.data,n=t,r=t;a(r.componentInstance);)(r=r.componentInstance._vnode)&&r.data&&(e=yr(r.data,e));for(;a(n=n.parent);)n&&n.data&&(e=yr(e,n.data));return function(t,e){if(a(t)||a(e))return br(t,_r(e));return""}(e.staticClass,e.class)}function yr(t,e){return{staticClass:br(t.staticClass,e.staticClass),class:a(t.class)?[t.class,e.class]:e.class}}function br(t,e){return t?e?t+" "+e:t:e||""}function _r(t){return Array.isArray(t)?function(t){for(var e,n="",r=0,o=t.length;r-1?Hr(t,e,n):pr(e)?gr(n)?t.removeAttribute(e):(n="allowfullscreen"===e&&"EMBED"===t.tagName?"true":e,t.setAttribute(e,n)):lr(e)?t.setAttribute(e,function(t,e){return gr(e)||"false"===e?"false":"contenteditable"===t&&fr(e)?e:"true"}(e,n)):hr(e)?gr(n)?t.removeAttributeNS(dr,vr(e)):t.setAttributeNS(dr,e,n):Hr(t,e,n)}function Hr(t,e,n){if(gr(n))t.removeAttribute(e);else{if(J&&!Y&&"TEXTAREA"===t.tagName&&"placeholder"===e&&""!==n&&!t.__ieph){var r=function(e){e.stopImmediatePropagation(),t.removeEventListener("input",r)};t.addEventListener("input",r),t.__ieph=!0}t.setAttribute(e,n)}}var Wr={create:Br,update:Br};function qr(t,e){var n=e.elm,r=e.data,o=t.data;if(!(i(r.staticClass)&&i(r.class)&&(i(o)||i(o.staticClass)&&i(o.class)))){var s=mr(e),c=n._transitionClasses;a(c)&&(s=br(s,_r(c))),s!==n._prevClass&&(n.setAttribute("class",s),n._prevClass=s)}}var Gr,Kr={create:qr,update:qr};function Qr(t,e,n){var r=Gr;return function o(){var i=e.apply(null,arguments);null!==i&&Xr(t,o,n,r)}}var Jr=Fe&&!(et&&Number(et[1])<=53);function Yr(t,e,n,r){if(Jr){var o=vn,i=e;e=i._wrapper=function(t){if(t.target===t.currentTarget||t.timeStamp>=o||t.timeStamp<=0||t.target.ownerDocument!==document)return i.apply(this,arguments)}}Gr.addEventListener(t,e,rt?{capture:n,passive:r}:n)}function Xr(t,e,n,r){(r||Gr).removeEventListener(t,e._wrapper||e,n)}function Zr(t,e){if(!i(t.data.on)||!i(e.data.on)){var n=e.data.on||{},r=t.data.on||{};Gr=e.elm||t.elm,function(t){if(a(t.__r)){var e=J?"change":"input";t[e]=[].concat(t.__r,t[e]||[]),delete t.__r}a(t.__c)&&(t.change=[].concat(t.__c,t.change||[]),delete t.__c)}(n),Zt(n,r,Yr,Xr,Qr,e.context),Gr=void 0}}var to,eo={create:Zr,update:Zr,destroy:function(t){return Zr(t,Ar)}};function no(t,e){if(!i(t.data.domProps)||!i(e.data.domProps)){var n,r,o=e.elm,c=t.data.domProps||{},u=e.data.domProps||{};for(n in(a(u.__ob__)||s(u._v_attr_proxy))&&(u=e.data.domProps=A({},u)),c)n in u||(o[n]="");for(n in u){if(r=u[n],"textContent"===n||"innerHTML"===n){if(e.children&&(e.children.length=0),r===c[n])continue;1===o.childNodes.length&&o.removeChild(o.childNodes[0])}if("value"===n&&"PROGRESS"!==o.tagName){o._value=r;var l=i(r)?"":String(r);ro(o,l)&&(o.value=l)}else if("innerHTML"===n&&kr(o.tagName)&&i(o.innerHTML)){(to=to||document.createElement("div")).innerHTML="".concat(r,"");for(var f=to.firstChild;o.firstChild;)o.removeChild(o.firstChild);for(;f.firstChild;)o.appendChild(f.firstChild)}else if(r!==c[n])try{o[n]=r}catch(t){}}}}function ro(t,e){return!t.composing&&("OPTION"===t.tagName||function(t,e){var n=!0;try{n=document.activeElement!==t}catch(t){}return n&&t.value!==e}(t,e)||function(t,e){var n=t.value,r=t._vModifiers;if(a(r)){if(r.number)return m(n)!==m(e);if(r.trim)return n.trim()!==e.trim()}return n!==e}(t,e))}var oo={create:no,update:no},io=k((function(t){var e={},n=/:(.+)/;return t.split(/;(?![^(]*\))/g).forEach((function(t){if(t){var r=t.split(n);r.length>1&&(e[r[0].trim()]=r[1].trim())}})),e}));function ao(t){var e=so(t.style);return t.staticStyle?A(t.staticStyle,e):e}function so(t){return Array.isArray(t)?T(t):"string"==typeof t?io(t):t}var co,uo=/^--/,lo=/\s*!important$/,fo=function(t,e,n){if(uo.test(e))t.style.setProperty(e,n);else if(lo.test(n))t.style.setProperty($(e),n.replace(lo,""),"important");else{var r=ho(e);if(Array.isArray(n))for(var o=0,i=n.length;o-1?e.split(mo).forEach((function(e){return t.classList.add(e)})):t.classList.add(e);else{var n=" ".concat(t.getAttribute("class")||""," ");n.indexOf(" "+e+" ")<0&&t.setAttribute("class",(n+e).trim())}}function bo(t,e){if(e&&(e=e.trim()))if(t.classList)e.indexOf(" ")>-1?e.split(mo).forEach((function(e){return t.classList.remove(e)})):t.classList.remove(e),t.classList.length||t.removeAttribute("class");else{for(var n=" ".concat(t.getAttribute("class")||""," "),r=" "+e+" ";n.indexOf(r)>=0;)n=n.replace(r," ");(n=n.trim())?t.setAttribute("class",n):t.removeAttribute("class")}}function _o(t){if(t){if("object"==typeof t){var e={};return!1!==t.css&&A(e,wo(t.name||"v")),A(e,t),e}return"string"==typeof t?wo(t):void 0}}var wo=k((function(t){return{enterClass:"".concat(t,"-enter"),enterToClass:"".concat(t,"-enter-to"),enterActiveClass:"".concat(t,"-enter-active"),leaveClass:"".concat(t,"-leave"),leaveToClass:"".concat(t,"-leave-to"),leaveActiveClass:"".concat(t,"-leave-active")}})),xo=K&&!Y,ko="transition",Oo="transitionend",Co="animation",So="animationend";xo&&(void 0===window.ontransitionend&&void 0!==window.onwebkittransitionend&&(ko="WebkitTransition",Oo="webkitTransitionEnd"),void 0===window.onanimationend&&void 0!==window.onwebkitanimationend&&(Co="WebkitAnimation",So="webkitAnimationEnd"));var jo=K?window.requestAnimationFrame?window.requestAnimationFrame.bind(window):setTimeout:function(t){return t()};function $o(t){jo((function(){jo(t)}))}function Eo(t,e){var n=t._transitionClasses||(t._transitionClasses=[]);n.indexOf(e)<0&&(n.push(e),yo(t,e))}function Po(t,e){t._transitionClasses&&_(t._transitionClasses,e),bo(t,e)}function Ao(t,e,n){var r=Lo(t,e),o=r.type,i=r.timeout,a=r.propCount;if(!o)return n();var s="transition"===o?Oo:So,c=0,u=function(){t.removeEventListener(s,l),n()},l=function(e){e.target===t&&++c>=a&&u()};setTimeout((function(){c0&&(n="transition",l=a,f=i.length):"animation"===e?u>0&&(n="animation",l=u,f=c.length):f=(n=(l=Math.max(a,u))>0?a>u?"transition":"animation":null)?"transition"===n?i.length:c.length:0,{type:n,timeout:l,propCount:f,hasTransform:"transition"===n&&To.test(r[ko+"Property"])}}function Mo(t,e){for(;t.length1}function Uo(t,e){!0!==e.data.show&&Io(e)}var Vo=function(t){var e,n,r={},u=t.modules,l=t.nodeOps;for(e=0;eh?_(t,i(n[m+1])?null:n[m+1].elm,n,d,m,r):d>m&&x(e,f,h)}(f,v,m,n,u):a(m)?(a(t.text)&&l.setTextContent(f,""),_(f,null,m,0,m.length-1,n)):a(v)?x(v,0,v.length-1):a(t.text)&&l.setTextContent(f,""):t.text!==e.text&&l.setTextContent(f,e.text),a(h)&&a(d=h.hook)&&a(d=d.postpatch)&&d(t,e)}}}function S(t,e,n){if(s(n)&&a(t.parent))t.parent.data.pendingInsert=e;else for(var r=0;r-1,a.selected!==i&&(a.selected=i);else if(I(qo(a),r))return void(t.selectedIndex!==s&&(t.selectedIndex=s));o||(t.selectedIndex=-1)}}function Wo(t,e){return e.every((function(e){return!I(e,t)}))}function qo(t){return"_value"in t?t._value:t.value}function Go(t){t.target.composing=!0}function Ko(t){t.target.composing&&(t.target.composing=!1,Qo(t.target,"input"))}function Qo(t,e){var n=document.createEvent("HTMLEvents");n.initEvent(e,!0,!0),t.dispatchEvent(n)}function Jo(t){return!t.componentInstance||t.data&&t.data.transition?t:Jo(t.componentInstance._vnode)}var Yo={model:Bo,show:{bind:function(t,e,n){var r=e.value,o=(n=Jo(n)).data&&n.data.transition,i=t.__vOriginalDisplay="none"===t.style.display?"":t.style.display;r&&o?(n.data.show=!0,Io(n,(function(){t.style.display=i}))):t.style.display=r?i:"none"},update:function(t,e,n){var r=e.value;!r!=!e.oldValue&&((n=Jo(n)).data&&n.data.transition?(n.data.show=!0,r?Io(n,(function(){t.style.display=t.__vOriginalDisplay})):Ro(n,(function(){t.style.display="none"}))):t.style.display=r?t.__vOriginalDisplay:"none")},unbind:function(t,e,n,r,o){o||(t.style.display=t.__vOriginalDisplay)}}},Xo={name:String,appear:Boolean,css:Boolean,mode:String,type:String,enterClass:String,leaveClass:String,enterToClass:String,leaveToClass:String,enterActiveClass:String,leaveActiveClass:String,appearClass:String,appearActiveClass:String,appearToClass:String,duration:[Number,String,Object]};function Zo(t){var e=t&&t.componentOptions;return e&&e.Ctor.options.abstract?Zo(Ae(e.children)):t}function ti(t){var e={},n=t.$options;for(var r in n.propsData)e[r]=t[r];var o=n._parentListeners;for(var r in o)e[C(r)]=o[r];return e}function ei(t,e){if(/\d-keep-alive$/.test(e.tag))return t("keep-alive",{props:e.componentOptions.propsData})}var ni=function(t){return t.tag||we(t)},ri=function(t){return"show"===t.name},oi={name:"transition",props:Xo,abstract:!0,render:function(t){var e=this,n=this.$slots.default;if(n&&(n=n.filter(ni)).length){0;var r=this.mode;0;var o=n[0];if(function(t){for(;t=t.parent;)if(t.data.transition)return!0}(this.$vnode))return o;var i=Zo(o);if(!i)return o;if(this._leaving)return ei(t,o);var a="__transition-".concat(this._uid,"-");i.key=null==i.key?i.isComment?a+"comment":a+i.tag:c(i.key)?0===String(i.key).indexOf(a)?i.key:a+i.key:i.key;var s=(i.data||(i.data={})).transition=ti(this),u=this._vnode,l=Zo(u);if(i.data.directives&&i.data.directives.some(ri)&&(i.data.show=!0),l&&l.data&&!function(t,e){return e.key===t.key&&e.tag===t.tag}(i,l)&&!we(l)&&(!l.componentInstance||!l.componentInstance._vnode.isComment)){var f=l.data.transition=A({},s);if("out-in"===r)return this._leaving=!0,te(f,"afterLeave",(function(){e._leaving=!1,e.$forceUpdate()})),ei(t,o);if("in-out"===r){if(we(i))return u;var p,d=function(){p()};te(s,"afterEnter",d),te(s,"enterCancelled",d),te(f,"delayLeave",(function(t){p=t}))}}return o}}},ii=A({tag:String,moveClass:String},Xo);function ai(t){t.elm._moveCb&&t.elm._moveCb(),t.elm._enterCb&&t.elm._enterCb()}function si(t){t.data.newPos=t.elm.getBoundingClientRect()}function ci(t){var e=t.data.pos,n=t.data.newPos,r=e.left-n.left,o=e.top-n.top;if(r||o){t.data.moved=!0;var i=t.elm.style;i.transform=i.WebkitTransform="translate(".concat(r,"px,").concat(o,"px)"),i.transitionDuration="0s"}}delete ii.mode;var ui={Transition:oi,TransitionGroup:{props:ii,beforeMount:function(){var t=this,e=this._update;this._update=function(n,r){var o=on(t);t.__patch__(t._vnode,t.kept,!1,!0),t._vnode=t.kept,o(),e.call(t,n,r)}},render:function(t){for(var e=this.tag||this.$vnode.data.tag||"span",n=Object.create(null),r=this.prevChildren=this.children,o=this.$slots.default||[],i=this.children=[],a=ti(this),s=0;s-1?Cr[t]=e.constructor===window.HTMLUnknownElement||e.constructor===window.HTMLElement:Cr[t]=/HTMLUnknownElement/.test(e.toString())},A(tr.options.directives,Yo),A(tr.options.components,ui),tr.prototype.__patch__=K?Vo:L,tr.prototype.$mount=function(t,e){return function(t,e,n){var r;t.$el=e,t.$options.render||(t.$options.render=dt),cn(t,"beforeMount"),r=function(){t._update(t._render(),n)},new Xe(t,r,L,{before:function(){t._isMounted&&!t._isDestroyed&&cn(t,"beforeUpdate")}},!0),n=!1;var o=t._preWatchers;if(o)for(var i=0;i=0&&(e=t.slice(r),t=t.slice(0,r));var o=t.indexOf("?");return o>=0&&(n=t.slice(o+1),t=t.slice(0,o)),{path:t,query:n,hash:e}}(o.path||""),u=e&&e.path||"/",l=c.path?Pi(c.path,u,n||o.append):u,f=function(t,e,n){void 0===e&&(e={});var r,o=n||mi;try{r=o(t||"")}catch(t){r={}}for(var i in e){var a=e[i];r[i]=Array.isArray(a)?a.map(gi):gi(a)}return r}(c.query,o.query,r&&r.options.parseQuery),p=o.hash||c.hash;return p&&"#"!==p.charAt(0)&&(p="#"+p),{_normalized:!0,path:l,query:f,hash:p}}var Yi,Xi=function(){},Zi={name:"RouterLink",props:{to:{type:[String,Object],required:!0},tag:{type:String,default:"a"},custom:Boolean,exact:Boolean,exactPath:Boolean,append:Boolean,replace:Boolean,activeClass:String,exactActiveClass:String,ariaCurrentValue:{type:String,default:"page"},event:{type:[String,Array],default:"click"}},render:function(t){var e=this,n=this.$router,r=this.$route,o=n.resolve(this.to,r,this.append),i=o.location,a=o.route,s=o.href,c={},u=n.options.linkActiveClass,l=n.options.linkExactActiveClass,f=null==u?"router-link-active":u,p=null==l?"router-link-exact-active":l,d=null==this.activeClass?f:this.activeClass,h=null==this.exactActiveClass?p:this.exactActiveClass,v=a.redirectedFrom?_i(null,Ji(a.redirectedFrom),null,n):a;c[h]=Ci(r,v,this.exactPath),c[d]=this.exact||this.exactPath?c[h]:function(t,e){return 0===t.path.replace(bi,"/").indexOf(e.path.replace(bi,"/"))&&(!e.hash||t.hash===e.hash)&&function(t,e){for(var n in e)if(!(n in t))return!1;return!0}(t.query,e.query)}(r,v);var g=c[h]?this.ariaCurrentValue:null,m=function(t){ta(t)&&(e.replace?n.replace(i,Xi):n.push(i,Xi))},y={click:ta};Array.isArray(this.event)?this.event.forEach((function(t){y[t]=m})):y[this.event]=m;var b={class:c},_=!this.$scopedSlots.$hasNormal&&this.$scopedSlots.default&&this.$scopedSlots.default({href:s,route:a,navigate:m,isActive:c[d],isExactActive:c[h]});if(_){if(1===_.length)return _[0];if(_.length>1||!_.length)return 0===_.length?t():t("span",{},_)}if("a"===this.tag)b.on=y,b.attrs={href:s,"aria-current":g};else{var w=function t(e){var n;if(e)for(var r=0;r-1&&(s.params[p]=n.params[p]);return s.path=Qi(l.path,s.params),c(l,s,a)}if(s.path){s.params={};for(var d=0;d-1}function Aa(t,e){return Pa(t)&&t._isRouter&&(null==e||t.type===e)}function Ta(t,e,n){var r=function(o){o>=t.length?n():t[o]?e(t[o],(function(){r(o+1)})):r(o+1)};r(0)}function La(t){return function(e,n,r){var o=!1,i=0,a=null;Ma(t,(function(t,e,n,s){if("function"==typeof t&&void 0===t.cid){o=!0,i++;var c,u=Ra((function(e){var o;((o=e).__esModule||Ia&&"Module"===o[Symbol.toStringTag])&&(e=e.default),t.resolved="function"==typeof e?e:Yi.extend(e),n.components[s]=e,--i<=0&&r()})),l=Ra((function(t){var e="Failed to resolve async component "+s+": "+t;a||(a=Pa(t)?t:new Error(e),r(a))}));try{c=t(u,l)}catch(t){l(t)}if(c)if("function"==typeof c.then)c.then(u,l);else{var f=c.component;f&&"function"==typeof f.then&&f.then(u,l)}}})),o||r()}}function Ma(t,e){return Da(t.map((function(t){return Object.keys(t.components).map((function(n){return e(t.components[n],t.instances[n],t,n)}))})))}function Da(t){return Array.prototype.concat.apply([],t)}var Ia="function"==typeof Symbol&&"symbol"==typeof Symbol.toStringTag;function Ra(t){var e=!1;return function(){for(var n=[],r=arguments.length;r--;)n[r]=arguments[r];if(!e)return e=!0,t.apply(this,n)}}var Fa=function(t,e){this.router=t,this.base=function(t){if(!t)if(ea){var e=document.querySelector("base");t=(t=e&&e.getAttribute("href")||"/").replace(/^https?:\/\/[^\/]+/,"")}else t="/";"/"!==t.charAt(0)&&(t="/"+t);return t.replace(/\/$/,"")}(e),this.current=xi,this.pending=null,this.ready=!1,this.readyCbs=[],this.readyErrorCbs=[],this.errorCbs=[],this.listeners=[]};function Na(t,e,n,r){var o=Ma(t,(function(t,r,o,i){var a=function(t,e){"function"!=typeof t&&(t=Yi.extend(t));return t.options[e]}(t,e);if(a)return Array.isArray(a)?a.map((function(t){return n(t,r,o,i)})):n(a,r,o,i)}));return Da(r?o.reverse():o)}function Ua(t,e){if(e)return function(){return t.apply(e,arguments)}}Fa.prototype.listen=function(t){this.cb=t},Fa.prototype.onReady=function(t,e){this.ready?t():(this.readyCbs.push(t),e&&this.readyErrorCbs.push(e))},Fa.prototype.onError=function(t){this.errorCbs.push(t)},Fa.prototype.transitionTo=function(t,e,n){var r,o=this;try{r=this.router.match(t,this.current)}catch(t){throw this.errorCbs.forEach((function(e){e(t)})),t}var i=this.current;this.confirmTransition(r,(function(){o.updateRoute(r),e&&e(r),o.ensureURL(),o.router.afterHooks.forEach((function(t){t&&t(r,i)})),o.ready||(o.ready=!0,o.readyCbs.forEach((function(t){t(r)})))}),(function(t){n&&n(t),t&&!o.ready&&(Aa(t,Ca.redirected)&&i===xi||(o.ready=!0,o.readyErrorCbs.forEach((function(e){e(t)}))))}))},Fa.prototype.confirmTransition=function(t,e,n){var r=this,o=this.current;this.pending=t;var i,a,s=function(t){!Aa(t)&&Pa(t)&&(r.errorCbs.length?r.errorCbs.forEach((function(e){e(t)})):console.error(t)),n&&n(t)},c=t.matched.length-1,u=o.matched.length-1;if(Ci(t,o)&&c===u&&t.matched[c]===o.matched[u])return this.ensureURL(),t.hash&&da(this.router,o,t,!1),s(((a=$a(i=o,t,Ca.duplicated,'Avoided redundant navigation to current location: "'+i.fullPath+'".')).name="NavigationDuplicated",a));var l=function(t,e){var n,r=Math.max(t.length,e.length);for(n=0;n0)){var e=this.router,n=e.options.scrollBehavior,r=xa&&n;r&&this.listeners.push(pa());var o=function(){var n=t.current,o=Ba(t.base);t.current===xi&&o===t._startLocation||t.transitionTo(o,(function(t){r&&da(e,t,n,!0)}))};window.addEventListener("popstate",o),this.listeners.push((function(){window.removeEventListener("popstate",o)}))}},e.prototype.go=function(t){window.history.go(t)},e.prototype.push=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){ka(Ai(r.base+t.fullPath)),da(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.replace=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){Oa(Ai(r.base+t.fullPath)),da(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.ensureURL=function(t){if(Ba(this.base)!==this.current.fullPath){var e=Ai(this.base+this.current.fullPath);t?ka(e):Oa(e)}},e.prototype.getCurrentLocation=function(){return Ba(this.base)},e}(Fa);function Ba(t){var e=window.location.pathname,n=e.toLowerCase(),r=t.toLowerCase();return!t||n!==r&&0!==n.indexOf(Ai(r+"/"))||(e=e.slice(t.length)),(e||"/")+window.location.search+window.location.hash}var za=function(t){function e(e,n,r){t.call(this,e,n),r&&function(t){var e=Ba(t);if(!/^\/#/.test(e))return window.location.replace(Ai(t+"/#"+e)),!0}(this.base)||Ha()}return t&&(e.__proto__=t),e.prototype=Object.create(t&&t.prototype),e.prototype.constructor=e,e.prototype.setupListeners=function(){var t=this;if(!(this.listeners.length>0)){var e=this.router.options.scrollBehavior,n=xa&&e;n&&this.listeners.push(pa());var r=function(){var e=t.current;Ha()&&t.transitionTo(Wa(),(function(r){n&&da(t.router,r,e,!0),xa||Ka(r.fullPath)}))},o=xa?"popstate":"hashchange";window.addEventListener(o,r),this.listeners.push((function(){window.removeEventListener(o,r)}))}},e.prototype.push=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){Ga(t.fullPath),da(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.replace=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){Ka(t.fullPath),da(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.go=function(t){window.history.go(t)},e.prototype.ensureURL=function(t){var e=this.current.fullPath;Wa()!==e&&(t?Ga(e):Ka(e))},e.prototype.getCurrentLocation=function(){return Wa()},e}(Fa);function Ha(){var t=Wa();return"/"===t.charAt(0)||(Ka("/"+t),!1)}function Wa(){var t=window.location.href,e=t.indexOf("#");return e<0?"":t=t.slice(e+1)}function qa(t){var e=window.location.href,n=e.indexOf("#");return(n>=0?e.slice(0,n):e)+"#"+t}function Ga(t){xa?ka(qa(t)):window.location.hash=t}function Ka(t){xa?Oa(qa(t)):window.location.replace(qa(t))}var Qa=function(t){function e(e,n){t.call(this,e,n),this.stack=[],this.index=-1}return t&&(e.__proto__=t),e.prototype=Object.create(t&&t.prototype),e.prototype.constructor=e,e.prototype.push=function(t,e,n){var r=this;this.transitionTo(t,(function(t){r.stack=r.stack.slice(0,r.index+1).concat(t),r.index++,e&&e(t)}),n)},e.prototype.replace=function(t,e,n){var r=this;this.transitionTo(t,(function(t){r.stack=r.stack.slice(0,r.index).concat(t),e&&e(t)}),n)},e.prototype.go=function(t){var e=this,n=this.index+t;if(!(n<0||n>=this.stack.length)){var r=this.stack[n];this.confirmTransition(r,(function(){var t=e.current;e.index=n,e.updateRoute(r),e.router.afterHooks.forEach((function(e){e&&e(r,t)}))}),(function(t){Aa(t,Ca.duplicated)&&(e.index=n)}))}},e.prototype.getCurrentLocation=function(){var t=this.stack[this.stack.length-1];return t?t.fullPath:"/"},e.prototype.ensureURL=function(){},e}(Fa),Ja=function(t){void 0===t&&(t={}),this.app=null,this.apps=[],this.options=t,this.beforeHooks=[],this.resolveHooks=[],this.afterHooks=[],this.matcher=oa(t.routes||[],this);var e=t.mode||"hash";switch(this.fallback="history"===e&&!xa&&!1!==t.fallback,this.fallback&&(e="hash"),ea||(e="abstract"),this.mode=e,e){case"history":this.history=new Va(this,t.base);break;case"hash":this.history=new za(this,t.base,this.fallback);break;case"abstract":this.history=new Qa(this,t.base);break;default:0}},Ya={currentRoute:{configurable:!0}};Ja.prototype.match=function(t,e,n){return this.matcher.match(t,e,n)},Ya.currentRoute.get=function(){return this.history&&this.history.current},Ja.prototype.init=function(t){var e=this;if(this.apps.push(t),t.$once("hook:destroyed",(function(){var n=e.apps.indexOf(t);n>-1&&e.apps.splice(n,1),e.app===t&&(e.app=e.apps[0]||null),e.app||e.history.teardown()})),!this.app){this.app=t;var n=this.history;if(n instanceof Va||n instanceof za){var r=function(t){n.setupListeners(),function(t){var r=n.current,o=e.options.scrollBehavior;xa&&o&&"fullPath"in t&&da(e,t,r,!1)}(t)};n.transitionTo(n.getCurrentLocation(),r,r)}n.listen((function(t){e.apps.forEach((function(e){e._route=t}))}))}},Ja.prototype.beforeEach=function(t){return Za(this.beforeHooks,t)},Ja.prototype.beforeResolve=function(t){return Za(this.resolveHooks,t)},Ja.prototype.afterEach=function(t){return Za(this.afterHooks,t)},Ja.prototype.onReady=function(t,e){this.history.onReady(t,e)},Ja.prototype.onError=function(t){this.history.onError(t)},Ja.prototype.push=function(t,e,n){var r=this;if(!e&&!n&&"undefined"!=typeof Promise)return new Promise((function(e,n){r.history.push(t,e,n)}));this.history.push(t,e,n)},Ja.prototype.replace=function(t,e,n){var r=this;if(!e&&!n&&"undefined"!=typeof Promise)return new Promise((function(e,n){r.history.replace(t,e,n)}));this.history.replace(t,e,n)},Ja.prototype.go=function(t){this.history.go(t)},Ja.prototype.back=function(){this.go(-1)},Ja.prototype.forward=function(){this.go(1)},Ja.prototype.getMatchedComponents=function(t){var e=t?t.matched?t:this.resolve(t).route:this.currentRoute;return e?[].concat.apply([],e.matched.map((function(t){return Object.keys(t.components).map((function(e){return t.components[e]}))}))):[]},Ja.prototype.resolve=function(t,e,n){var r=Ji(t,e=e||this.history.current,n,this),o=this.match(r,e),i=o.redirectedFrom||o.fullPath;return{location:r,route:o,href:function(t,e,n){var r="hash"===n?"#"+e:e;return t?Ai(t+"/"+r):r}(this.history.base,i,this.mode),normalizedTo:r,resolved:o}},Ja.prototype.getRoutes=function(){return this.matcher.getRoutes()},Ja.prototype.addRoute=function(t,e){this.matcher.addRoute(t,e),this.history.current!==xi&&this.history.transitionTo(this.history.getCurrentLocation())},Ja.prototype.addRoutes=function(t){this.matcher.addRoutes(t),this.history.current!==xi&&this.history.transitionTo(this.history.getCurrentLocation())},Object.defineProperties(Ja.prototype,Ya);var Xa=Ja;function Za(t,e){return t.push(e),function(){var n=t.indexOf(e);n>-1&&t.splice(n,1)}}Ja.install=function t(e){if(!t.installed||Yi!==e){t.installed=!0,Yi=e;var n=function(t){return void 0!==t},r=function(t,e){var r=t.$options._parentVnode;n(r)&&n(r=r.data)&&n(r=r.registerRouteInstance)&&r(t,e)};e.mixin({beforeCreate:function(){n(this.$options.router)?(this._routerRoot=this,this._router=this.$options.router,this._router.init(this),e.util.defineReactive(this,"_route",this._router.history.current)):this._routerRoot=this.$parent&&this.$parent._routerRoot||this,r(this,this)},destroyed:function(){r(this)}}),Object.defineProperty(e.prototype,"$router",{get:function(){return this._routerRoot._router}}),Object.defineProperty(e.prototype,"$route",{get:function(){return this._routerRoot._route}}),e.component("RouterView",$i),e.component("RouterLink",Zi);var o=e.config.optionMergeStrategies;o.beforeRouteEnter=o.beforeRouteLeave=o.beforeRouteUpdate=o.created}},Ja.version="3.6.5",Ja.isNavigationFailure=Aa,Ja.NavigationFailureType=Ca,Ja.START_LOCATION=xi,ea&&window.Vue&&window.Vue.use(Ja);n(97);n(91),n(129);var ts={NotFound:()=>n.e(6).then(n.bind(null,284)),Layout:()=>Promise.all([n.e(0),n.e(2)]).then(n.bind(null,283))},es={"v-5e1e685a":()=>n.e(7).then(n.bind(null,287)),"v-0d609624":()=>n.e(9).then(n.bind(null,288)),"v-4f037d1a":()=>n.e(10).then(n.bind(null,289)),"v-c97ca880":()=>n.e(8).then(n.bind(null,290)),"v-2eaf1140":()=>n.e(14).then(n.bind(null,291)),"v-18d0587a":()=>n.e(11).then(n.bind(null,292)),"v-2f7f848c":()=>n.e(13).then(n.bind(null,293)),"v-18c2b964":()=>n.e(15).then(n.bind(null,294)),"v-09d6f550":()=>n.e(16).then(n.bind(null,295)),"v-7cc0117c":()=>n.e(18).then(n.bind(null,296)),"v-690a4650":()=>n.e(19).then(n.bind(null,297)),"v-58f7366c":()=>n.e(20).then(n.bind(null,298)),"v-0877efcc":()=>n.e(21).then(n.bind(null,299)),"v-3120da0c":()=>n.e(12).then(n.bind(null,300)),"v-9356a30c":()=>n.e(17).then(n.bind(null,301)),"v-950c4d48":()=>n.e(22).then(n.bind(null,302)),"v-47c1f97a":()=>n.e(23).then(n.bind(null,303)),"v-4fad50ba":()=>n.e(24).then(n.bind(null,304)),"v-4fc0d1c8":()=>n.e(25).then(n.bind(null,305)),"v-31657474":()=>n.e(26).then(n.bind(null,306)),"v-84e0b14c":()=>n.e(29).then(n.bind(null,307)),"v-074d53cc":()=>n.e(30).then(n.bind(null,308)),"v-0c3bd15a":()=>n.e(28).then(n.bind(null,309)),"v-3e6ef1ac":()=>n.e(32).then(n.bind(null,310)),"v-0d650648":()=>n.e(31).then(n.bind(null,311)),"v-e2784654":()=>n.e(27).then(n.bind(null,312)),"v-6dd912ec":()=>n.e(33).then(n.bind(null,313)),"v-3258450c":()=>n.e(34).then(n.bind(null,314)),"v-35b0f3b1":()=>n.e(36).then(n.bind(null,315)),"v-a6e64848":()=>n.e(35).then(n.bind(null,316)),"v-e65ea9a4":()=>n.e(37).then(n.bind(null,317)),"v-57c590fa":()=>n.e(38).then(n.bind(null,318)),"v-45095440":()=>n.e(39).then(n.bind(null,319)),"v-d297eaa6":()=>n.e(40).then(n.bind(null,320)),"v-5d3101c8":()=>n.e(43).then(n.bind(null,321)),"v-7cc2c9e4":()=>n.e(42).then(n.bind(null,322)),"v-f81e553c":()=>n.e(41).then(n.bind(null,323)),"v-501d8193":()=>n.e(44).then(n.bind(null,324))};function ns(t){const e=Object.create(null);return function(n){return e[n]||(e[n]=t(n))}}const rs=/-(\w)/g,os=ns(t=>t.replace(rs,(t,e)=>e?e.toUpperCase():"")),is=/\B([A-Z])/g,as=ns(t=>t.replace(is,"-$1").toLowerCase()),ss=ns(t=>t.charAt(0).toUpperCase()+t.slice(1));function cs(t,e){if(!e)return;if(t(e))return t(e);return e.includes("-")?t(ss(os(e))):t(ss(e))||t(as(e))}const us=Object.assign({},ts,es),ls=t=>us[t],fs=t=>es[t],ps=t=>ts[t],ds=t=>tr.component(t);function hs(t){return cs(fs,t)}function vs(t){return cs(ps,t)}function gs(t){return cs(ls,t)}function ms(t){return cs(ds,t)}function ys(...t){return Promise.all(t.filter(t=>t).map(async t=>{if(!ms(t)&&gs(t)){const e=await gs(t)();tr.component(t,e.default)}}))}function bs(t,e){"undefined"!=typeof window&&window.__VUEPRESS__&&(window.__VUEPRESS__[t]=e)}var _s=n(88),ws=n.n(_s),xs=n(89),ks=n.n(xs),Os={created(){if(this.siteMeta=this.$site.headTags.filter(([t])=>"meta"===t).map(([t,e])=>e),this.$ssrContext){const e=this.getMergedMetaTags();this.$ssrContext.title=this.$title,this.$ssrContext.lang=this.$lang,this.$ssrContext.pageMeta=(t=e)?t.map(t=>{let e="{e+=` ${n}="${ks()(t[n])}"`}),e+">"}).join("\n "):"",this.$ssrContext.canonicalLink=Ss(this.$canonicalUrl)}var t},mounted(){this.currentMetaTags=[...document.querySelectorAll("meta")],this.updateMeta(),this.updateCanonicalLink()},methods:{updateMeta(){document.title=this.$title,document.documentElement.lang=this.$lang;const t=this.getMergedMetaTags();this.currentMetaTags=js(t,this.currentMetaTags)},getMergedMetaTags(){const t=this.$page.frontmatter.meta||[];return ws()([{name:"description",content:this.$description}],t,this.siteMeta,$s)},updateCanonicalLink(){Cs(),this.$canonicalUrl&&document.head.insertAdjacentHTML("beforeend",Ss(this.$canonicalUrl))}},watch:{$page(){this.updateMeta(),this.updateCanonicalLink()}},beforeDestroy(){js(null,this.currentMetaTags),Cs()}};function Cs(){const t=document.querySelector("link[rel='canonical']");t&&t.remove()}function Ss(t=""){return t?``:""}function js(t,e){if(e&&[...e].filter(t=>t.parentNode===document.head).forEach(t=>document.head.removeChild(t)),t)return t.map(t=>{const e=document.createElement("meta");return Object.keys(t).forEach(n=>{e.setAttribute(n,t[n])}),document.head.appendChild(e),e})}function $s(t){for(const e of["name","property","itemprop"])if(t.hasOwnProperty(e))return t[e]+e;return JSON.stringify(t)}var Es=n(90),Ps={mounted(){window.addEventListener("scroll",this.onScroll)},methods:{onScroll:n.n(Es)()((function(){this.setActiveHash()}),300),setActiveHash(){const t=[].slice.call(document.querySelectorAll(".sidebar-link")),e=[].slice.call(document.querySelectorAll(".header-anchor")).filter(e=>t.some(t=>t.hash===e.hash)),n=Math.max(window.pageYOffset,document.documentElement.scrollTop,document.body.scrollTop),r=Math.max(document.documentElement.scrollHeight,document.body.scrollHeight),o=window.innerHeight+n;for(let t=0;t=i.parentElement.offsetTop+10&&(!a||n{this.$nextTick(()=>{this.$vuepress.$set("disableScrollBehavior",!1)})})}}}},beforeDestroy(){window.removeEventListener("scroll",this.onScroll)}},As=n(22),Ts=n.n(As),Ls={mounted(){Ts.a.configure({showSpinner:!1}),this.$router.beforeEach((t,e,n)=>{t.path===e.path||tr.component(t.name)||Ts.a.start(),n()}),this.$router.afterEach(()=>{Ts.a.done(),this.isSidebarOpen=!1})}},Ms={props:{parent:Object,code:String,options:{align:String,color:String,backgroundTransition:Boolean,backgroundColor:String,successText:String,staticIcon:Boolean}},data:()=>({success:!1,originalBackground:null,originalTransition:null}),computed:{alignStyle(){let t={};return t[this.options.align]="7.5px",t},iconClass(){return this.options.staticIcon?"":"hover"}},mounted(){this.originalTransition=this.parent.style.transition,this.originalBackground=this.parent.style.background},beforeDestroy(){this.parent.style.transition=this.originalTransition,this.parent.style.background=this.originalBackground},methods:{hexToRgb(t){let e=/^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(t);return e?{r:parseInt(e[1],16),g:parseInt(e[2],16),b:parseInt(e[3],16)}:null},copyToClipboard(t){if(navigator.clipboard)navigator.clipboard.writeText(this.code).then(()=>{this.setSuccessTransitions()},()=>{});else{let t=document.createElement("textarea");document.body.appendChild(t),t.value=this.code,t.select(),document.execCommand("Copy"),t.remove(),this.setSuccessTransitions()}},setSuccessTransitions(){if(clearTimeout(this.successTimeout),this.options.backgroundTransition){this.parent.style.transition="background 350ms";let t=this.hexToRgb(this.options.backgroundColor);this.parent.style.background=`rgba(${t.r}, ${t.g}, ${t.b}, 0.1)`}this.success=!0,this.successTimeout=setTimeout(()=>{this.options.backgroundTransition&&(this.parent.style.background=this.originalBackground,this.parent.style.transition=this.originalTransition),this.success=!1},500)}}},Ds=(n(237),n(10)),Is=Object(Ds.a)(Ms,(function(){var t=this,e=t._self._c;return e("div",{staticClass:"code-copy"},[e("svg",{class:t.iconClass,style:t.alignStyle,attrs:{xmlns:"http://www.w3.org/2000/svg",width:"24",height:"24",viewBox:"0 0 24 24"},on:{click:t.copyToClipboard}},[e("path",{attrs:{fill:"none",d:"M0 0h24v24H0z"}}),t._v(" "),e("path",{attrs:{fill:t.options.color,d:"M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4l6 6v10c0 1.1-.9 2-2 2H7.99C6.89 23 6 22.1 6 21l.01-14c0-1.1.89-2 1.99-2h7zm-1 7h5.5L14 6.5V12z"}})]),t._v(" "),e("span",{class:t.success?"success":"",style:t.alignStyle},[t._v("\n "+t._s(t.options.successText)+"\n ")])])}),[],!1,null,"49140617",null).exports,Rs=(n(238),[Os,Ps,Ls,{updated(){this.update()},methods:{update(){setTimeout(()=>{document.querySelectorAll('div[class*="language-"] pre').forEach(t=>{if(t.classList.contains("code-copy-added"))return;let e=new(tr.extend(Is));e.options={align:"bottom",color:"#27b1ff",backgroundTransition:!0,backgroundColor:"#0075b8",successText:"Copied!",staticIcon:!1},e.code=t.innerText,e.parent=t,e.$mount(),t.classList.add("code-copy-added"),t.appendChild(e.$el)})},100)}}}]),Fs={name:"GlobalLayout",computed:{layout(){const t=this.getLayout();return bs("layout",t),tr.component(t)}},methods:{getLayout(){if(this.$page.path){const t=this.$page.frontmatter.layout;return t&&(this.$vuepress.getLayoutAsyncComponent(t)||this.$vuepress.getVueComponent(t))?t:"Layout"}return"NotFound"}}},Ns=Object(Ds.a)(Fs,(function(){return(0,this._self._c)(this.layout,{tag:"component"})}),[],!1,null,null,null).exports;!function(t,e,n){switch(e){case"components":t[e]||(t[e]={}),Object.assign(t[e],n);break;case"mixins":t[e]||(t[e]=[]),t[e].push(...n);break;default:throw new Error("Unknown option name.")}}(Ns,"mixins",Rs);const Us=[{name:"v-5e1e685a",path:"/docs/arfs/content-types.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-5e1e685a").then(n)}},{name:"v-0d609624",path:"/docs/arfs/entity-types.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-0d609624").then(n)}},{name:"v-4f037d1a",path:"/docs/arfs/",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-4f037d1a").then(n)}},{path:"/docs/arfs/index.html",redirect:"/docs/arfs/"},{path:"/docs/arfs/overview.html",redirect:"/docs/arfs/"},{name:"v-c97ca880",path:"/docs/arfs/data-model.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-c97ca880").then(n)}},{name:"v-2eaf1140",path:"/docs/arfs/usage/change/files.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-2eaf1140").then(n)}},{name:"v-18d0587a",path:"/docs/arfs/privacy.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-18d0587a").then(n)}},{name:"v-2f7f848c",path:"/docs/arfs/usage/change/drives.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-2f7f848c").then(n)}},{name:"v-18c2b964",path:"/docs/arfs/usage/change/folders.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-18c2b964").then(n)}},{name:"v-09d6f550",path:"/docs/arfs/usage/change/snapshots.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-09d6f550").then(n)}},{name:"v-7cc0117c",path:"/docs/arfs/usage/create/create-file.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-7cc0117c").then(n)}},{name:"v-690a4650",path:"/docs/arfs/usage/create/create-folder.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-690a4650").then(n)}},{name:"v-58f7366c",path:"/docs/arfs/usage/create/create-snapshot.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-58f7366c").then(n)}},{name:"v-0877efcc",path:"/docs/arfs/usage/extending-schemas.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-0877efcc").then(n)}},{name:"v-3120da0c",path:"/docs/arfs/schema-diagrams.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-3120da0c").then(n)}},{name:"v-9356a30c",path:"/docs/arfs/usage/create/",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-9356a30c").then(n)}},{path:"/docs/arfs/usage/create/index.html",redirect:"/docs/arfs/usage/create/"},{path:"/docs/arfs/usage/create/create-drive.html",redirect:"/docs/arfs/usage/create/"},{name:"v-950c4d48",path:"/docs/arfs/usage/read/",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-950c4d48").then(n)}},{path:"/docs/arfs/usage/read/index.html",redirect:"/docs/arfs/usage/read/"},{path:"/docs/arfs/usage/read/read-operations.html",redirect:"/docs/arfs/usage/read/"},{name:"v-47c1f97a",path:"/docs/cli/all-commands.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-47c1f97a").then(n)}},{name:"v-4fad50ba",path:"/docs/cli/getting-help.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-4fad50ba").then(n)}},{name:"v-4fc0d1c8",path:"/docs/cli/getting-started.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-4fc0d1c8").then(n)}},{name:"v-31657474",path:"/docs/cli/",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-31657474").then(n)}},{path:"/docs/cli/index.html",redirect:"/docs/cli/"},{path:"/docs/cli/intro.html",redirect:"/docs/cli/"},{name:"v-84e0b14c",path:"/docs/misc/deploy/deploy.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-84e0b14c").then(n)}},{name:"v-074d53cc",path:"/docs/misc/deploy/examples.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-074d53cc").then(n)}},{name:"v-0c3bd15a",path:"/docs/core-sdk.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-0c3bd15a").then(n)}},{name:"v-3e6ef1ac",path:"/docs/misc/deploy/",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-3e6ef1ac").then(n)}},{path:"/docs/misc/deploy/index.html",redirect:"/docs/misc/deploy/"},{path:"/docs/misc/deploy/prepare.html",redirect:"/docs/misc/deploy/"},{name:"v-0d650648",path:"/docs/misc/deploy/paths.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-0d650648").then(n)}},{name:"v-e2784654",path:"/docs/cli/using-the-cli.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-e2784654").then(n)}},{name:"v-6dd912ec",path:"/docs/misc/deploy/routing.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-6dd912ec").then(n)}},{name:"v-3258450c",path:"/docs/misc/permasite.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-3258450c").then(n)}},{name:"v-35b0f3b1",path:"/docs/",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-35b0f3b1").then(n)}},{path:"/docs/index.html",redirect:"/docs/"},{name:"v-a6e64848",path:"/docs/misc/price-calculator.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-a6e64848").then(n)}},{name:"v-e65ea9a4",path:"/docs/turbo/api/payment.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-e65ea9a4").then(n)}},{name:"v-57c590fa",path:"/docs/turbo/api/upload.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-57c590fa").then(n)}},{name:"v-45095440",path:"/docs/turbo/migrating.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-45095440").then(n)}},{name:"v-d297eaa6",path:"/docs/turbo/turbo-sdk/",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-d297eaa6").then(n)}},{path:"/docs/turbo/turbo-sdk/index.html",redirect:"/docs/turbo/turbo-sdk/"},{name:"v-5d3101c8",path:"/docs/turbo/what-is-turbo.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-5d3101c8").then(n)}},{name:"v-7cc2c9e4",path:"/docs/turbo/turbo-sdk/turbo-web.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-7cc2c9e4").then(n)}},{name:"v-f81e553c",path:"/docs/turbo/turbo-sdk/release-notes.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-f81e553c").then(n)}},{name:"v-501d8193",path:"/",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-501d8193").then(n)}},{path:"/index.html",redirect:"/"},{path:"*",component:Ns}],Vs={title:"ArDrive Docs",description:"ArDrive documentation",base:"/",headTags:[["meta",{property:"og:image",content:"https://docs.ardrive.io/images/card-image.png"}],["meta",{name:"theme-color",content:"#3eaf7c"}],["meta",{name:"apple-mobile-web-app-capable",content:"yes"}],["meta",{name:"apple-mobile-web-app-status-bar-style",content:"black"}],["script",{src:"https://plausible.io/js/script.js",defer:!0,"data-domain":"docs.ardrive.io"}]],pages:[{title:"Content Types",frontmatter:{},regularPath:"/docs/arfs/content-types.html",relativePath:"docs/arfs/content-types.md",key:"v-5e1e685a",path:"/docs/arfs/content-types.html",headers:[{level:2,title:"Other Tags",slug:"other-tags"}]},{title:"Entity Types",frontmatter:{},regularPath:"/docs/arfs/entity-types.html",relativePath:"docs/arfs/entity-types.md",key:"v-0d609624",path:"/docs/arfs/entity-types.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Drive",slug:"drive"},{level:2,title:"Folder",slug:"folder"},{level:2,title:"File",slug:"file"},{level:2,title:"Snapshot",slug:"snapshot"},{level:3,title:"Snapshot Entity Tags",slug:"snapshot-entity-tags"},{level:3,title:"Snapshot Entity Data",slug:"snapshot-entity-data"},{level:2,title:"Schema Diagrams",slug:"schema-diagrams"},{level:3,title:"Public Drive",slug:"public-drive"},{level:3,title:"Private Drive",slug:"private-drive"}]},{title:"ArFS Protocol: A Decentralized File System on Arweave",frontmatter:{permalink:"/docs/arfs/"},regularPath:"/docs/arfs/overview.html",relativePath:"docs/arfs/overview.md",key:"v-4f037d1a",path:"/docs/arfs/",headers:[{level:2,title:"Key Features",slug:"key-features"},{level:3,title:"File Structure",slug:"file-structure"},{level:3,title:"Metadata",slug:"metadata"},{level:3,title:"File Permissions",slug:"file-permissions"},{level:3,title:"File Versioning",slug:"file-versioning"},{level:3,title:"Data Deduplication",slug:"data-deduplication"},{level:3,title:"Search and Discovery",slug:"search-and-discovery"},{level:3,title:"Interoperability",slug:"interoperability"},{level:2,title:"Getting Started",slug:"getting-started"},{level:2,title:"ArFS Version History",slug:"arfs-version-history"},{level:2,title:"Resources",slug:"resources"}]},{title:"Data Model",frontmatter:{},regularPath:"/docs/arfs/data-model.html",relativePath:"docs/arfs/data-model.md",key:"v-c97ca880",path:"/docs/arfs/data-model.html",headers:[{level:2,title:"Entity relationships",slug:"entity-relationships"},{level:2,title:"Metadata Format",slug:"metadata-format"}]},{title:"File Write Operations",frontmatter:{},regularPath:"/docs/arfs/usage/change/files.html",relativePath:"docs/arfs/usage/change/files.md",key:"v-2eaf1140",path:"/docs/arfs/usage/change/files.html",headers:[{level:2,title:"Move File",slug:"move-file"},{level:2,title:"Rename File",slug:"rename-file"},{level:2,title:"Update File Version",slug:"update-file-version"},{level:2,title:"Hide or Unhide File",slug:"hide-or-unhide-file"}]},{title:"Privacy",frontmatter:{},regularPath:"/docs/arfs/privacy.html",relativePath:"docs/arfs/privacy.md",key:"v-18d0587a",path:"/docs/arfs/privacy.html",headers:[{level:2,title:"Deriving Keys",slug:"deriving-keys"},{level:2,title:"Private Drives",slug:"private-drives"},{level:2,title:"Private Files",slug:"private-files"}]},{title:"Drive Write Operations",frontmatter:{},regularPath:"/docs/arfs/usage/change/drives.html",relativePath:"docs/arfs/usage/change/drives.md",key:"v-2f7f848c",path:"/docs/arfs/usage/change/drives.html",headers:[{level:2,title:"Rename Drives",slug:"rename-drives"}]},{title:"Folder Write Operations",frontmatter:{},regularPath:"/docs/arfs/usage/change/folders.html",relativePath:"docs/arfs/usage/change/folders.md",key:"v-18c2b964",path:"/docs/arfs/usage/change/folders.html",headers:[{level:2,title:"Move Folder",slug:"move-folder"},{level:2,title:"Rename Folder",slug:"rename-folder"}]},{frontmatter:{},regularPath:"/docs/arfs/usage/change/snapshots.html",relativePath:"docs/arfs/usage/change/snapshots.md",key:"v-09d6f550",path:"/docs/arfs/usage/change/snapshots.html"},{title:"Create File",frontmatter:{},regularPath:"/docs/arfs/usage/create/create-file.html",relativePath:"docs/arfs/usage/create/create-file.md",key:"v-7cc0117c",path:"/docs/arfs/usage/create/create-file.html",headers:[{level:2,title:"New File Entity",slug:"new-file-entity"}]},{title:"Create Folder",frontmatter:{},regularPath:"/docs/arfs/usage/create/create-folder.html",relativePath:"docs/arfs/usage/create/create-folder.md",key:"v-690a4650",path:"/docs/arfs/usage/create/create-folder.html",headers:[{level:2,title:"New Folder Entity",slug:"new-folder-entity"}]},{frontmatter:{},regularPath:"/docs/arfs/usage/create/create-snapshot.html",relativePath:"docs/arfs/usage/create/create-snapshot.md",key:"v-58f7366c",path:"/docs/arfs/usage/create/create-snapshot.html"},{title:"Extending Schemas",frontmatter:{next:!1},regularPath:"/docs/arfs/usage/extending-schemas.html",relativePath:"docs/arfs/usage/extending-schemas.md",key:"v-0877efcc",path:"/docs/arfs/usage/extending-schemas.html",headers:[{level:2,title:"Extending Schemas",slug:"extending-schemas"}]},{title:"Schema Diagrams",frontmatter:{},regularPath:"/docs/arfs/schema-diagrams.html",relativePath:"docs/arfs/schema-diagrams.md",key:"v-3120da0c",path:"/docs/arfs/schema-diagrams.html",headers:[{level:2,title:"Schema Diagrams",slug:"schema-diagrams"},{level:3,title:"Public Drive",slug:"public-drive"},{level:3,title:"Private Drive",slug:"private-drive"}]},{title:"Create Drive",frontmatter:{permalink:"/docs/arfs/usage/create/"},regularPath:"/docs/arfs/usage/create/create-drive.html",relativePath:"docs/arfs/usage/create/create-drive.md",key:"v-9356a30c",path:"/docs/arfs/usage/create/",headers:[{level:2,title:"New Drive Entity",slug:"new-drive-entity"},{level:2,title:"New Root Folder Entity",slug:"new-root-folder-entity"}]},{title:"Read ArFS Data",frontmatter:{permalink:"/docs/arfs/usage/read/"},regularPath:"/docs/arfs/usage/read/read-operations.html",relativePath:"docs/arfs/usage/read/read-operations.md",key:"v-950c4d48",path:"/docs/arfs/usage/read/",headers:[{level:2,title:"Folder/File Paths",slug:"folder-file-paths"},{level:2,title:"Folder View Queries",slug:"folder-view-queries"}]},{title:"All ArDrive CLI Commands",frontmatter:{},regularPath:"/docs/cli/all-commands.html",relativePath:"docs/cli/all-commands.md",key:"v-47c1f97a",path:"/docs/cli/all-commands.html"},{title:"Getting Help",frontmatter:{},regularPath:"/docs/cli/getting-help.html",relativePath:"docs/cli/getting-help.md",key:"v-4fad50ba",path:"/docs/cli/getting-help.html"},{title:"Getting Started",frontmatter:{},regularPath:"/docs/cli/getting-started.html",relativePath:"docs/cli/getting-started.md",key:"v-4fc0d1c8",path:"/docs/cli/getting-started.html",headers:[{level:2,title:"Prerequisites",slug:"prerequisites"},{level:3,title:"Git",slug:"git"},{level:3,title:"NVM (Optional - Recommended)",slug:"nvm-optional-recommended"},{level:2,title:"Quick Start",slug:"quick-start"},{level:3,title:"Installing and Starting the CLI From NPM Package",slug:"installing-and-starting-the-cli-from-npm-package"},{level:3,title:"Upgrading to the Latest Version",slug:"upgrading-to-the-latest-version"},{level:2,title:"Build and Run from Source",slug:"build-and-run-from-source"},{level:3,title:"Install Yarn 3",slug:"install-yarn-3"},{level:3,title:"Husky (Developers Only)",slug:"husky-developers-only"},{level:3,title:"Using a custom ArDrive-Core-JS (Optional)",slug:"using-a-custom-ardrive-core-js-optional"},{level:3,title:"Installing and Starting the CLI From Source",slug:"installing-and-starting-the-cli-from-source"},{level:3,title:"Recommended Visual Studio Code extensions (Developers Only)",slug:"recommended-visual-studio-code-extensions-developers-only"},{level:2,title:"Limitations",slug:"limitations"}]},{title:"CLI",frontmatter:{homepage:!0,permalink:"/docs/cli/"},regularPath:"/docs/cli/intro.html",relativePath:"docs/cli/intro.md",key:"v-31657474",path:"/docs/cli/",headers:[{level:2,title:"ArFS",slug:"arfs"},{level:2,title:"Data Portability",slug:"data-portability"},{level:2,title:"Intended Audience",slug:"intended-audience"}]},{title:"Deploying your dApp",frontmatter:{},regularPath:"/docs/misc/deploy/deploy.html",relativePath:"docs/misc/deploy/deploy.md",key:"v-84e0b14c",path:"/docs/misc/deploy/deploy.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Deploying",slug:"deploying"},{level:3,title:"Step 1: Log into ArDrive",slug:"step-1-log-into-ardrive"},{level:3,title:"Step 2: Select or Create a Drive",slug:"step-2-select-or-create-a-drive"},{level:3,title:"Step 3: Upload your project",slug:"step-3-upload-your-project"},{level:3,title:"Step 4: Confirm Upload",slug:"step-4-confirm-upload"},{level:3,title:"Step 5: Create the Manifest",slug:"step-5-create-the-manifest"},{level:3,title:"Step 6: Get the Data TX ID",slug:"step-6-get-the-data-tx-id"},{level:3,title:"Step 7: View and Share your dApp",slug:"step-7-view-and-share-your-dapp"},{level:2,title:"Updating your dApp",slug:"updating-your-dapp"}]},{title:"Examples",frontmatter:{},regularPath:"/docs/misc/deploy/examples.html",relativePath:"docs/misc/deploy/examples.md",key:"v-074d53cc",path:"/docs/misc/deploy/examples.html",headers:[{level:2,title:"Basic HTML",slug:"basic-html"},{level:2,title:"React",slug:"react"},{level:2,title:"Next",slug:"next"},{level:2,title:"WordPress",slug:"wordpress"}]},{title:"Overview",frontmatter:{},regularPath:"/docs/core-sdk.html",relativePath:"docs/core-sdk.md",key:"v-0c3bd15a",path:"/docs/core-sdk.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Integrating with ArDrive Core",slug:"integrating-with-ardrive-core"},{level:2,title:"Development Environment Setup",slug:"development-environment-setup"},{level:3,title:"Recommended Visual Studio Code extensions",slug:"recommended-visual-studio-code-extensions"},{level:2,title:"Building the Library",slug:"building-the-library"},{level:2,title:"Testing the Library",slug:"testing-the-library"},{level:3,title:"Coverage",slug:"coverage"},{level:3,title:"Adding tests",slug:"adding-tests"},{level:3,title:"Using Sinon",slug:"using-sinon"},{level:3,title:"Debugging with Power-Assert",slug:"debugging-with-power-assert"},{level:3,title:"Progress Logging of Transaction Uploads",slug:"progress-logging-of-transaction-uploads"},{level:3,title:"Persistent Caching of ArFS Entity Metadata",slug:"persistent-caching-of-arfs-entity-metadata"},{level:3,title:"Applying Custom MetaData to ArFS File Transactions",slug:"applying-custom-metadata-to-arfs-file-transactions"}]},{title:"Preparing Your dApp",frontmatter:{prev:!1,permalink:"/docs/misc/deploy/"},regularPath:"/docs/misc/deploy/prepare.html",relativePath:"docs/misc/deploy/prepare.md",key:"v-3e6ef1ac",path:"/docs/misc/deploy/"},{title:"File Paths",frontmatter:{},regularPath:"/docs/misc/deploy/paths.html",relativePath:"docs/misc/deploy/paths.md",key:"v-0d650648",path:"/docs/misc/deploy/paths.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Absolute Vs. Relative",slug:"absolute-vs-relative"},{level:2,title:"Why Relative Paths",slug:"why-relative-paths"},{level:2,title:"Identifying Relative and Absolute Paths",slug:"identifying-relative-and-absolute-paths"},{level:2,title:"Navigating with Relative Paths",slug:"navigating-with-relative-paths"}]},{title:"Using the CLI",frontmatter:{sidebarDepth:1},regularPath:"/docs/cli/using-the-cli.html",relativePath:"docs/cli/using-the-cli.md",key:"v-e2784654",path:"/docs/cli/using-the-cli.html",headers:[{level:2,title:"CLI Help",slug:"cli-help"},{level:2,title:"CLI Version",slug:"cli-version"},{level:2,title:"Wallet Operations",slug:"wallet-operations"},{level:2,title:"Working With Entities",slug:"working-with-entities"},{level:3,title:"Dry Run",slug:"dry-run"},{level:3,title:"Uploading to Turbo (BETA)",slug:"uploading-to-turbo-beta"},{level:2,title:"Working With Drives",slug:"working-with-drives"},{level:3,title:"Understanding Drive Hierarchies",slug:"understanding-drive-hierarchies"},{level:3,title:"Understanding Drive and File Keys",slug:"understanding-drive-and-file-keys"},{level:3,title:"Managing Drive Passwords",slug:"managing-drive-passwords"},{level:3,title:"Creating Drives",slug:"creating-drives"},{level:3,title:"Listing Drives for an Address",slug:"listing-drives-for-an-address"},{level:3,title:"Listing Every Entity in a Drive",slug:"listing-every-entity-in-a-drive"},{level:3,title:"List Drive Pipeline Examples",slug:"list-drive-pipeline-examples"},{level:2,title:"Working With Folders",slug:"working-with-folders"},{level:3,title:"Creating Folders",slug:"creating-folders"},{level:3,title:"Moving Folders",slug:"moving-folders"},{level:3,title:"Renaming Folders",slug:"renaming-folders"},{level:3,title:"Viewing Folder Metadata",slug:"viewing-folder-metadata"},{level:3,title:"Listing Contents of a Folder",slug:"listing-contents-of-a-folder"},{level:2,title:"Working With Files",slug:"working-with-files"},{level:3,title:"Uploading a Single File",slug:"uploading-a-single-file"},{level:3,title:"IPFS CID Tagging",slug:"ipfs-cid-tagging"},{level:3,title:"Progress Logging of Transaction Uploads",slug:"progress-logging-of-transaction-uploads"},{level:3,title:"Download a Single file (BETA)",slug:"download-a-single-file-beta"},{level:3,title:"Rename a Single File",slug:"rename-a-single-file"},{level:3,title:"Uploading a Folder with Files (Bulk Upload)",slug:"uploading-a-folder-with-files-bulk-upload"},{level:3,title:"Downloading a Folder with Files",slug:"downloading-a-folder-with-files"},{level:3,title:"Downloading a Drive",slug:"downloading-a-drive"},{level:3,title:"Uploading Multiple Files",slug:"uploading-multiple-files"},{level:3,title:"Name Conflict Resolution on Upload",slug:"name-conflict-resolution-on-upload"},{level:3,title:"Understanding Bundled Transactions",slug:"understanding-bundled-transactions"},{level:3,title:"Uploading a Non-Bundled Transaction (NOT RECOMMENDED)",slug:"uploading-a-non-bundled-transaction-not-recommended"},{level:3,title:"Fetching the Metadata of a File Entity",slug:"fetching-the-metadata-of-a-file-entity"},{level:3,title:"Retrying a Failed File Data Transaction (Public Unbundled Files Only)",slug:"retrying-a-failed-file-data-transaction-public-unbundled-files-only"},{level:3,title:"Moving Files",slug:"moving-files"},{level:3,title:"Uploading Manifests",slug:"uploading-manifests"},{level:3,title:"Uploading With a Custom Content Type",slug:"uploading-with-a-custom-content-type"},{level:3,title:"Uploading From a Remote URL",slug:"uploading-from-a-remote-url"},{level:3,title:"Uploading a Custom Manifest",slug:"uploading-a-custom-manifest"},{level:3,title:"Uploading Files with Custom MetaData",slug:"uploading-files-with-custom-metadata"},{level:2,title:"Other Utility Operations",slug:"other-utility-operations"},{level:3,title:"Monitoring Transactions",slug:"monitoring-transactions"},{level:3,title:"Dealing With Network Congestion",slug:"dealing-with-network-congestion"},{level:3,title:"Using a Custom Arweave Gateway",slug:"using-a-custom-arweave-gateway"},{level:3,title:"Persistent Caching of ArFS Entity Metadata",slug:"persistent-caching-of-arfs-entity-metadata"}]},{title:"Hash Routing",frontmatter:{},regularPath:"/docs/misc/deploy/routing.html",relativePath:"docs/misc/deploy/routing.md",key:"v-6dd912ec",path:"/docs/misc/deploy/routing.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Hash Routing Vs. History Routing",slug:"hash-routing-vs-history-routing"},{level:2,title:"Why Hash Routing for dApps",slug:"why-hash-routing-for-dapps"}]},{title:"How to Save a Website Permanently",frontmatter:{},regularPath:"/docs/misc/permasite.html",relativePath:"docs/misc/permasite.md",key:"v-3258450c",path:"/docs/misc/permasite.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"1. Download Static Site Files",slug:"_1-download-static-site-files"},{level:3,title:"Windows Users",slug:"windows-users"},{level:3,title:"Mac Users",slug:"mac-users"},{level:3,title:"Command Line Utility",slug:"command-line-utility"},{level:3,title:"WordPress",slug:"wordpress"},{level:2,title:"2. Create an Account on ArDrive",slug:"_2-create-an-account-on-ardrive"},{level:2,title:"3. Create a New Public Drive",slug:"_3-create-a-new-public-drive"},{level:2,title:"4. Top Up",slug:"_4-top-up"},{level:2,title:"5. Upload Static Files",slug:"_5-upload-static-files"},{level:2,title:"6. Wait",slug:"_6-wait"},{level:2,title:"7. Create a Manifest",slug:"_7-create-a-manifest"},{level:2,title:"8. Wait Again",slug:"_8-wait-again"},{level:2,title:"9. Preview the Manifest",slug:"_9-preview-the-manifest"},{level:2,title:"10. Add a Redirect or Domain Masking",slug:"_10-add-a-redirect-or-domain-masking"},{level:2,title:"Notes",slug:"notes"},{level:2,title:"Other Use Cases",slug:"other-use-cases"},{level:2,title:"Example",slug:"example"}]},{title:"placeholder",frontmatter:{},regularPath:"/docs/",relativePath:"docs/readme.md",key:"v-35b0f3b1",path:"/docs/"},{title:"ArDrive Price Calculator",frontmatter:{prev:!1,next:!1},regularPath:"/docs/misc/price-calculator.html",relativePath:"docs/misc/price-calculator.md",key:"v-a6e64848",path:"/docs/misc/price-calculator.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Developer Setup",slug:"developer-setup"},{level:3,title:"Install Yarn 2",slug:"install-yarn-2"},{level:3,title:"NVM",slug:"nvm"},{level:3,title:"Recommended Visual Studio Code extensions",slug:"recommended-visual-studio-code-extensions"},{level:2,title:"Available Scripts",slug:"available-scripts"},{level:3,title:"yarn start",slug:"yarn-start"},{level:3,title:"yarn build",slug:"yarn-build"},{level:3,title:"yarn test",slug:"yarn-test"},{level:3,title:"yarn run:prod",slug:"yarn-run-prod"}]},{title:"Payment API",frontmatter:{},regularPath:"/docs/turbo/api/payment.html",relativePath:"docs/turbo/api/payment.md",key:"v-e65ea9a4",path:"/docs/turbo/api/payment.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Endpoints",slug:"endpoints"},{level:3,title:"Get Amount of Credits for Byte Count",slug:"get-amount-of-credits-for-byte-count"},{level:3,title:"Get winc for Payment Type and Amount",slug:"get-winc-for-payment-type-and-amount"},{level:3,title:"Get Current Balance of winc",slug:"get-current-balance-of-winc"},{level:3,title:"Get Quote for Credits",slug:"get-quote-for-credits"},{level:3,title:"Get Supported Currencies",slug:"get-supported-currencies"},{level:3,title:"Get Supported Countries",slug:"get-supported-countries"},{level:3,title:"Get Conversion Rates",slug:"get-conversion-rates"}]},{title:"Upload API",frontmatter:{next:!1},regularPath:"/docs/turbo/api/upload.html",relativePath:"docs/turbo/api/upload.md",key:"v-57c590fa",path:"/docs/turbo/api/upload.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Endpoint",slug:"endpoint"},{level:2,title:"Schema",slug:"schema"},{level:3,title:"Headers",slug:"headers"},{level:3,title:"Body",slug:"body"},{level:3,title:"Response",slug:"response"}]},{title:"Migrating to Turbo From Irys",frontmatter:{next:!1},regularPath:"/docs/turbo/migrating.html",relativePath:"docs/turbo/migrating.md",key:"v-45095440",path:"/docs/turbo/migrating.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Using Irys SDK with Turbo",slug:"using-irys-sdk-with-turbo"},{level:2,title:"Using Irys CLI with Turbo",slug:"using-irys-cli-with-turbo"},{level:2,title:"Differences",slug:"differences"},{level:3,title:"Crypto Top Ups / Withdrawals",slug:"crypto-top-ups-withdrawals"},{level:2,title:"Wallet Extensions and Providers",slug:"wallet-extensions-and-providers"},{level:2,title:"GraphQL",slug:"graphql"}]},{title:"@ardriveapp/turbo-sdk 🚀",frontmatter:{},regularPath:"/docs/turbo/turbo-sdk/",relativePath:"docs/turbo/turbo-sdk/index.md",key:"v-d297eaa6",path:"/docs/turbo/turbo-sdk/",headers:[{level:2,title:"Installation",slug:"installation"},{level:2,title:"Quick Start",slug:"quick-start"},{level:2,title:"Usage",slug:"usage"},{level:3,title:"Web",slug:"web"},{level:3,title:"NodeJS",slug:"nodejs"},{level:3,title:"Typescript",slug:"typescript"},{level:2,title:"APIs",slug:"apis"},{level:3,title:"TurboFactory",slug:"turbofactory"},{level:3,title:"TurboUnauthenticatedClient",slug:"turbounauthenticatedclient"},{level:3,title:"TurboAuthenticatedClient",slug:"turboauthenticatedclient"},{level:2,title:"Contributions",slug:"contributions"}]},{title:"What Is Turbo?",frontmatter:{prev:!1},regularPath:"/docs/turbo/what-is-turbo.html",relativePath:"docs/turbo/what-is-turbo.md",key:"v-5d3101c8",path:"/docs/turbo/what-is-turbo.html"},{title:"Using Turbo SDK in a Browser Environment",frontmatter:{},regularPath:"/docs/turbo/turbo-sdk/turbo-web.html",relativePath:"docs/turbo/turbo-sdk/turbo-web.md",key:"v-7cc2c9e4",path:"/docs/turbo/turbo-sdk/turbo-web.html",headers:[{level:2,title:"Overview",slug:"overview"}]},{title:"Turbo SDK Release Notes",frontmatter:{},regularPath:"/docs/turbo/turbo-sdk/release-notes.html",relativePath:"docs/turbo/turbo-sdk/release-notes.md",key:"v-f81e553c",path:"/docs/turbo/turbo-sdk/release-notes.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Releases",slug:"releases"},{level:3,title:"V1.3.0",slug:"v1-3-0"},{level:3,title:"V1.2.0",slug:"v1-2-0"},{level:3,title:"V1.1.1",slug:"v1-1-1"},{level:3,title:"V1.1.0",slug:"v1-1-0"},{level:3,title:"V1.0.2",slug:"v1-0-2"},{level:3,title:"V1.0.1",slug:"v1-0-1"},{level:3,title:"V1.0.0",slug:"v1-0-0"}]},{title:"About ArDrive",frontmatter:{homepage:!0},regularPath:"/",relativePath:"index.md",key:"v-501d8193",path:"/",headers:[{level:2,title:"Control Your Own Data",slug:"control-your-own-data"},{level:3,title:"True Data Ownership",slug:"true-data-ownership"},{level:3,title:"No More Lost Data",slug:"no-more-lost-data"},{level:3,title:"Decentralized Network",slug:"decentralized-network"},{level:3,title:"Community Owned",slug:"community-owned"},{level:2,title:"How can Ardrive Help You?",slug:"how-can-ardrive-help-you"},{level:3,title:"Store Family Memories Forever",slug:"store-family-memories-forever"},{level:3,title:"Permanence",slug:"permanence"},{level:3,title:"Totally Private or Totally Public",slug:"totally-private-or-totally-public"},{level:3,title:"Eliminate Subscription Fees",slug:"eliminate-subscription-fees"},{level:3,title:"Control Your Data",slug:"control-your-data"},{level:3,title:"Perfect Record Keeping",slug:"perfect-record-keeping"},{level:3,title:"Durable NFTs",slug:"durable-nfts"},{level:3,title:"Archive the Web",slug:"archive-the-web"}]}],themeConfig:{searchPlaceholder:"Search",repo:"",editLinks:!1,docsDir:"",editLinkText:"",lastUpdated:!1,initialOpenGroupIndex:-1,logo:"/images/ArDrive-Logo.png",sidebar:{"/":[{title:"Core-js",path:"/docs/core-sdk"},{title:"CLI",initialOpenGroupIndex:-1,collapsable:!0,children:[{title:"Overview",path:"/docs/cli/intro"},{title:"Getting Started",path:"/docs/cli/getting-started"},{title:"Using the CLI",path:"/docs/cli/using-the-cli"},{title:"All Commands",path:"/docs/cli/all-commands"},{title:"Help",path:"/docs/cli/getting-help"}]},{title:"ArFS",initialOpenGroupIndex:-1,children:[{title:"Overview",path:"/docs/arfs/overview"},{title:"Data Model",path:"/docs/arfs/data-model"},{title:"Entity Types",path:"/docs/arfs/entity-types"},{title:"Schema Diagrams",path:"/docs/arfs/schema-diagrams"},{title:"Content Types",path:"/docs/arfs/content-types"},{title:"Privacy",path:"/docs/arfs/privacy"},{title:"Usage",children:[{title:"Create",children:[{title:"Create Drive",path:"/docs/arfs/usage/create/create-drive"},{title:"Create Folder",path:"/docs/arfs/usage/create/create-folder"},{title:"Create File",path:"/docs/arfs/usage/create/create-file"}]},{title:"Modify",children:[{title:"Modify Drives",path:"/docs/arfs/usage/change/drives"},{title:"Modify Folders",path:"/docs/arfs/usage/change/folders"},{title:"Modify Files",path:"/docs/arfs/usage/change/files"}]},{title:"Read",path:"/docs/arfs/usage/read/read-operations"},{title:"Extending Schemas",path:"/docs/arfs/usage/extending-schemas"}]}]},{title:"Turbo",sidebarDepth:2,children:[{title:"What is Turbo?",path:"/docs/turbo/what-is-turbo"},{title:"Payment API",path:"/docs/turbo/api/payment"},{title:"Upload API",path:"/docs/turbo/api/upload"},{title:"Turbo SDK",path:"/docs/turbo/turbo-sdk/"},{title:"Turbo SDK Release Notes",path:"/docs/turbo/turbo-sdk/release-notes"},{title:"Migrating From Irys",path:"/docs/turbo/migrating"}]},{title:"Misc.",children:[{title:"Permasites",path:"/docs/misc/permasite"},{title:"Price Calculator",path:"/docs/misc/price-calculator"},{title:"How to Deploy a dApp",children:[{title:"Preparing your dApp",path:"/docs/misc/deploy/prepare"},{title:"Hash Routing",path:"/docs/misc/deploy/routing"},{title:"Relative File Paths",path:"/docs/misc/deploy/paths"},{title:"How to Deploy",path:"/docs/misc/deploy/deploy"},{title:"Examples",path:"/docs/misc/deploy/examples"}]}]}]}}};function Bs(){return"undefined"!=typeof navigator&&"undefined"!=typeof window?window:"undefined"!=typeof global?global:{}}const zs="function"==typeof Proxy;let Hs,Ws;function qs(){return void 0!==Hs||("undefined"!=typeof window&&window.performance?(Hs=!0,Ws=window.performance):"undefined"!=typeof global&&(null===(t=global.perf_hooks)||void 0===t?void 0:t.performance)?(Hs=!0,Ws=global.perf_hooks.performance):Hs=!1),Hs?Ws.now():Date.now();var t}class Gs{constructor(t,e){this.target=null,this.targetQueue=[],this.onQueue=[],this.plugin=t,this.hook=e;const n={};if(t.settings)for(const e in t.settings){const r=t.settings[e];n[e]=r.defaultValue}const r="__vue-devtools-plugin-settings__"+t.id;let o=Object.assign({},n);try{const t=localStorage.getItem(r),e=JSON.parse(t);Object.assign(o,e)}catch(t){}this.fallbacks={getSettings:()=>o,setSettings(t){try{localStorage.setItem(r,JSON.stringify(t))}catch(t){}o=t},now:()=>qs()},e&&e.on("plugin:settings:set",(t,e)=>{t===this.plugin.id&&this.fallbacks.setSettings(e)}),this.proxiedOn=new Proxy({},{get:(t,e)=>this.target?this.target.on[e]:(...t)=>{this.onQueue.push({method:e,args:t})}}),this.proxiedTarget=new Proxy({},{get:(t,e)=>this.target?this.target[e]:"on"===e?this.proxiedOn:Object.keys(this.fallbacks).includes(e)?(...t)=>(this.targetQueue.push({method:e,args:t,resolve:()=>{}}),this.fallbacks[e](...t)):(...t)=>new Promise(n=>{this.targetQueue.push({method:e,args:t,resolve:n})})})}async setRealTarget(t){this.target=t;for(const t of this.onQueue)this.target.on[t.method](...t.args);for(const t of this.targetQueue)t.resolve(await this.target[t.method](...t.args))}}function Ks(t,e){const n=t,r=Bs(),o=Bs().__VUE_DEVTOOLS_GLOBAL_HOOK__,i=zs&&n.enableEarlyProxy;if(!o||!r.__VUE_DEVTOOLS_PLUGIN_API_AVAILABLE__&&i){const t=i?new Gs(n,o):null;(r.__VUE_DEVTOOLS_PLUGINS__=r.__VUE_DEVTOOLS_PLUGINS__||[]).push({pluginDescriptor:n,setupFn:e,proxy:t}),t&&e(t.proxiedTarget)}else o.emit("devtools-plugin:setup",t,e)} +var r=Object.freeze({}),o=Array.isArray;function i(t){return null==t}function a(t){return null!=t}function s(t){return!0===t}function c(t){return"string"==typeof t||"number"==typeof t||"symbol"==typeof t||"boolean"==typeof t}function u(t){return"function"==typeof t}function l(t){return null!==t&&"object"==typeof t}var f=Object.prototype.toString;function p(t){return"[object Object]"===f.call(t)}function d(t){return"[object RegExp]"===f.call(t)}function h(t){var e=parseFloat(String(t));return e>=0&&Math.floor(e)===e&&isFinite(t)}function v(t){return a(t)&&"function"==typeof t.then&&"function"==typeof t.catch}function g(t){return null==t?"":Array.isArray(t)||p(t)&&t.toString===f?JSON.stringify(t,null,2):String(t)}function m(t){var e=parseFloat(t);return isNaN(e)?t:e}function y(t,e){for(var n=Object.create(null),r=t.split(","),o=0;o-1)return t.splice(r,1)}}var w=Object.prototype.hasOwnProperty;function x(t,e){return w.call(t,e)}function k(t){var e=Object.create(null);return function(n){return e[n]||(e[n]=t(n))}}var O=/-(\w)/g,C=k((function(t){return t.replace(O,(function(t,e){return e?e.toUpperCase():""}))})),S=k((function(t){return t.charAt(0).toUpperCase()+t.slice(1)})),j=/\B([A-Z])/g,$=k((function(t){return t.replace(j,"-$1").toLowerCase()}));var E=Function.prototype.bind?function(t,e){return t.bind(e)}:function(t,e){function n(n){var r=arguments.length;return r?r>1?t.apply(e,arguments):t.call(e,n):t.call(e)}return n._length=t.length,n};function P(t,e){e=e||0;for(var n=t.length-e,r=new Array(n);n--;)r[n]=t[n+e];return r}function A(t,e){for(var n in e)t[n]=e[n];return t}function T(t){for(var e={},n=0;n0,X=Q&&Q.indexOf("edge/")>0;Q&&Q.indexOf("android");var Z=Q&&/iphone|ipad|ipod|ios/.test(Q);Q&&/chrome\/\d+/.test(Q),Q&&/phantomjs/.test(Q);var tt,et=Q&&Q.match(/firefox\/(\d+)/),nt={}.watch,rt=!1;if(K)try{var ot={};Object.defineProperty(ot,"passive",{get:function(){rt=!0}}),window.addEventListener("test-passive",null,ot)}catch(t){}var it=function(){return void 0===tt&&(tt=!K&&"undefined"!=typeof global&&(global.process&&"server"===global.process.env.VUE_ENV)),tt},at=K&&window.__VUE_DEVTOOLS_GLOBAL_HOOK__;function st(t){return"function"==typeof t&&/native code/.test(t.toString())}var ct,ut="undefined"!=typeof Symbol&&st(Symbol)&&"undefined"!=typeof Reflect&&st(Reflect.ownKeys);ct="undefined"!=typeof Set&&st(Set)?Set:function(){function t(){this.set=Object.create(null)}return t.prototype.has=function(t){return!0===this.set[t]},t.prototype.add=function(t){this.set[t]=!0},t.prototype.clear=function(){this.set=Object.create(null)},t}();var lt=null;function ft(t){void 0===t&&(t=null),t||lt&<._scope.off(),lt=t,t&&t._scope.on()}var pt=function(){function t(t,e,n,r,o,i,a,s){this.tag=t,this.data=e,this.children=n,this.text=r,this.elm=o,this.ns=void 0,this.context=i,this.fnContext=void 0,this.fnOptions=void 0,this.fnScopeId=void 0,this.key=e&&e.key,this.componentOptions=a,this.componentInstance=void 0,this.parent=void 0,this.raw=!1,this.isStatic=!1,this.isRootInsert=!0,this.isComment=!1,this.isCloned=!1,this.isOnce=!1,this.asyncFactory=s,this.asyncMeta=void 0,this.isAsyncPlaceholder=!1}return Object.defineProperty(t.prototype,"child",{get:function(){return this.componentInstance},enumerable:!1,configurable:!0}),t}(),dt=function(t){void 0===t&&(t="");var e=new pt;return e.text=t,e.isComment=!0,e};function ht(t){return new pt(void 0,void 0,void 0,String(t))}function vt(t){var e=new pt(t.tag,t.data,t.children&&t.children.slice(),t.text,t.elm,t.context,t.componentOptions,t.asyncFactory);return e.ns=t.ns,e.isStatic=t.isStatic,e.key=t.key,e.isComment=t.isComment,e.fnContext=t.fnContext,e.fnOptions=t.fnOptions,e.fnScopeId=t.fnScopeId,e.asyncMeta=t.asyncMeta,e.isCloned=!0,e}var gt=0,mt=[],yt=function(){function t(){this._pending=!1,this.id=gt++,this.subs=[]}return t.prototype.addSub=function(t){this.subs.push(t)},t.prototype.removeSub=function(t){this.subs[this.subs.indexOf(t)]=null,this._pending||(this._pending=!0,mt.push(this))},t.prototype.depend=function(e){t.target&&t.target.addDep(this)},t.prototype.notify=function(t){var e=this.subs.filter((function(t){return t}));for(var n=0,r=e.length;n0&&(re((u=t(u,"".concat(n||"","_").concat(r)))[0])&&re(f)&&(p[l]=ht(f.text+u[0].text),u.shift()),p.push.apply(p,u)):c(u)?re(f)?p[l]=ht(f.text+u):""!==u&&p.push(ht(u)):re(u)&&re(f)?p[l]=ht(f.text+u.text):(s(e._isVList)&&a(u.tag)&&i(u.key)&&a(n)&&(u.key="__vlist".concat(n,"_").concat(r,"__")),p.push(u)));return p}(t):void 0}function re(t){return a(t)&&a(t.text)&&!1===t.isComment}function oe(t,e){var n,r,i,s,c=null;if(o(t)||"string"==typeof t)for(c=new Array(t.length),n=0,r=t.length;n0,s=e?!!e.$stable:!a,c=e&&e.$key;if(e){if(e._normalized)return e._normalized;if(s&&o&&o!==r&&c===o.$key&&!a&&!o.$hasNormal)return o;for(var u in i={},e)e[u]&&"$"!==u[0]&&(i[u]=ke(t,n,u,e[u]))}else i={};for(var l in n)l in i||(i[l]=Oe(n,l));return e&&Object.isExtensible(e)&&(e._normalized=i),W(i,"$stable",s),W(i,"$key",c),W(i,"$hasNormal",a),i}function ke(t,e,n,r){var i=function(){var e=lt;ft(t);var n=arguments.length?r.apply(null,arguments):r({}),i=(n=n&&"object"==typeof n&&!o(n)?[n]:ne(n))&&n[0];return ft(e),n&&(!i||1===n.length&&i.isComment&&!we(i))?void 0:n};return r.proxy&&Object.defineProperty(e,n,{get:i,enumerable:!0,configurable:!0}),i}function Oe(t,e){return function(){return t[e]}}function Ce(t){return{get attrs(){if(!t._attrsProxy){var e=t._attrsProxy={};W(e,"_v_attr_proxy",!0),Se(e,t.$attrs,r,t,"$attrs")}return t._attrsProxy},get listeners(){t._listenersProxy||Se(t._listenersProxy={},t.$listeners,r,t,"$listeners");return t._listenersProxy},get slots(){return function(t){t._slotsProxy||$e(t._slotsProxy={},t.$scopedSlots);return t._slotsProxy}(t)},emit:E(t.$emit,t),expose:function(e){e&&Object.keys(e).forEach((function(n){return Vt(t,e,n)}))}}}function Se(t,e,n,r,o){var i=!1;for(var a in e)a in t?e[a]!==n[a]&&(i=!0):(i=!0,je(t,a,r,o));for(var a in t)a in e||(i=!0,delete t[a]);return i}function je(t,e,n,r){Object.defineProperty(t,e,{enumerable:!0,configurable:!0,get:function(){return n[r][e]}})}function $e(t,e){for(var n in e)t[n]=e[n];for(var n in t)n in e||delete t[n]}var Ee=null;function Pe(t,e){return(t.__esModule||ut&&"Module"===t[Symbol.toStringTag])&&(t=t.default),l(t)?e.extend(t):t}function Ae(t){if(o(t))for(var e=0;edocument.createEvent("Event").timeStamp&&(gn=function(){return mn.now()})}var yn=function(t,e){if(t.post){if(!e.post)return 1}else if(e.post)return-1;return t.id-e.id};function bn(){var t,e;for(vn=gn(),dn=!0,un.sort(yn),hn=0;hnhn&&un[n].id>t.id;)n--;un.splice(n+1,0,t)}else un.push(t);pn||(pn=!0,qe(bn))}}function wn(t,e){if(t){for(var n=Object.create(null),r=ut?Reflect.ownKeys(t):Object.keys(t),o=0;o-1)if(i&&!x(o,"default"))a=!1;else if(""===a||a===$(t)){var c=zn(String,o.type);(c<0||s-1:"string"==typeof t?t.split(",").indexOf(e)>-1:!!d(t)&&t.test(e)}function or(t,e){var n=t.cache,r=t.keys,o=t._vnode;for(var i in n){var a=n[i];if(a){var s=a.name;s&&!e(s)&&ir(n,i,r,o)}}}function ir(t,e,n,r){var o=t[e];!o||r&&o.tag===r.tag||o.componentInstance.$destroy(),t[e]=null,_(n,e)}tr.prototype._init=function(t){var e=this;e._uid=Xn++,e._isVue=!0,e.__v_skip=!0,e._scope=new Qt(!0),e._scope._vm=!0,t&&t._isComponent?function(t,e){var n=t.$options=Object.create(t.constructor.options),r=e._parentVnode;n.parent=e.parent,n._parentVnode=r;var o=r.componentOptions;n.propsData=o.propsData,n._parentListeners=o.listeners,n._renderChildren=o.children,n._componentTag=o.tag,e.render&&(n.render=e.render,n.staticRenderFns=e.staticRenderFns)}(e,t):e.$options=Rn(Zn(e.constructor),t||{},e),e._renderProxy=e,e._self=e,function(t){var e=t.$options,n=e.parent;if(n&&!e.abstract){for(;n.$options.abstract&&n.$parent;)n=n.$parent;n.$children.push(t)}t.$parent=n,t.$root=n?n.$root:t,t.$children=[],t.$refs={},t._provided=n?n._provided:Object.create(null),t._watcher=null,t._inactive=null,t._directInactive=!1,t._isMounted=!1,t._isDestroyed=!1,t._isBeingDestroyed=!1}(e),function(t){t._events=Object.create(null),t._hasHookEvent=!1;var e=t.$options._parentListeners;e&&nn(t,e)}(e),function(t){t._vnode=null,t._staticTrees=null;var e=t.$options,n=t.$vnode=e._parentVnode,o=n&&n.context;t.$slots=be(e._renderChildren,o),t.$scopedSlots=n?xe(t.$parent,n.data.scopedSlots,t.$slots):r,t._c=function(e,n,r,o){return Te(t,e,n,r,o,!1)},t.$createElement=function(e,n,r,o){return Te(t,e,n,r,o,!0)};var i=n&&n.data;At(t,"$attrs",i&&i.attrs||r,null,!0),At(t,"$listeners",e._parentListeners||r,null,!0)}(e),cn(e,"beforeCreate",void 0,!1),function(t){var e=wn(t.$options.inject,t);e&&(jt(!1),Object.keys(e).forEach((function(n){At(t,n,e[n])})),jt(!0))}(e),qn(e),function(t){var e=t.$options.provide;if(e){var n=u(e)?e.call(t):e;if(!l(n))return;for(var r=Jt(t),o=ut?Reflect.ownKeys(n):Object.keys(n),i=0;i1?P(n):n;for(var r=P(arguments,1),o='event handler for "'.concat(t,'"'),i=0,a=n.length;iparseInt(this.max)&&ir(t,e[0],e,this._vnode),this.vnodeToCache=null}}},created:function(){this.cache=Object.create(null),this.keys=[]},destroyed:function(){for(var t in this.cache)ir(this.cache,t,this.keys)},mounted:function(){var t=this;this.cacheVNode(),this.$watch("include",(function(e){or(t,(function(t){return rr(e,t)}))})),this.$watch("exclude",(function(e){or(t,(function(t){return!rr(e,t)}))}))},updated:function(){this.cacheVNode()},render:function(){var t=this.$slots.default,e=Ae(t),n=e&&e.componentOptions;if(n){var r=nr(n),o=this.include,i=this.exclude;if(o&&(!r||!rr(o,r))||i&&r&&rr(i,r))return e;var a=this.cache,s=this.keys,c=null==e.key?n.Ctor.cid+(n.tag?"::".concat(n.tag):""):e.key;a[c]?(e.componentInstance=a[c].componentInstance,_(s,c),s.push(c)):(this.vnodeToCache=e,this.keyToCache=c),e.data.keepAlive=!0}return e||t&&t[0]}}};!function(t){var e={get:function(){return B}};Object.defineProperty(t,"config",e),t.util={warn:Pn,extend:A,mergeOptions:Rn,defineReactive:At},t.set=Tt,t.delete=Lt,t.nextTick=qe,t.observable=function(t){return Pt(t),t},t.options=Object.create(null),U.forEach((function(e){t.options[e+"s"]=Object.create(null)})),t.options._base=t,A(t.options.components,sr),function(t){t.use=function(t){var e=this._installedPlugins||(this._installedPlugins=[]);if(e.indexOf(t)>-1)return this;var n=P(arguments,1);return n.unshift(this),u(t.install)?t.install.apply(t,n):u(t)&&t.apply(null,n),e.push(t),this}}(t),function(t){t.mixin=function(t){return this.options=Rn(this.options,t),this}}(t),er(t),function(t){U.forEach((function(e){t[e]=function(t,n){return n?("component"===e&&p(n)&&(n.name=n.name||t,n=this.options._base.extend(n)),"directive"===e&&u(n)&&(n={bind:n,update:n}),this.options[e+"s"][t]=n,n):this.options[e+"s"][t]}}))}(t)}(tr),Object.defineProperty(tr.prototype,"$isServer",{get:it}),Object.defineProperty(tr.prototype,"$ssrContext",{get:function(){return this.$vnode&&this.$vnode.ssrContext}}),Object.defineProperty(tr,"FunctionalRenderContext",{value:xn}),tr.version="2.7.14";var cr=y("style,class"),ur=y("input,textarea,option,select,progress"),lr=y("contenteditable,draggable,spellcheck"),fr=y("events,caret,typing,plaintext-only"),pr=y("allowfullscreen,async,autofocus,autoplay,checked,compact,controls,declare,default,defaultchecked,defaultmuted,defaultselected,defer,disabled,enabled,formnovalidate,hidden,indeterminate,inert,ismap,itemscope,loop,multiple,muted,nohref,noresize,noshade,novalidate,nowrap,open,pauseonexit,readonly,required,reversed,scoped,seamless,selected,sortable,truespeed,typemustmatch,visible"),dr="http://www.w3.org/1999/xlink",hr=function(t){return":"===t.charAt(5)&&"xlink"===t.slice(0,5)},vr=function(t){return hr(t)?t.slice(6,t.length):""},gr=function(t){return null==t||!1===t};function mr(t){for(var e=t.data,n=t,r=t;a(r.componentInstance);)(r=r.componentInstance._vnode)&&r.data&&(e=yr(r.data,e));for(;a(n=n.parent);)n&&n.data&&(e=yr(e,n.data));return function(t,e){if(a(t)||a(e))return br(t,_r(e));return""}(e.staticClass,e.class)}function yr(t,e){return{staticClass:br(t.staticClass,e.staticClass),class:a(t.class)?[t.class,e.class]:e.class}}function br(t,e){return t?e?t+" "+e:t:e||""}function _r(t){return Array.isArray(t)?function(t){for(var e,n="",r=0,o=t.length;r-1?Hr(t,e,n):pr(e)?gr(n)?t.removeAttribute(e):(n="allowfullscreen"===e&&"EMBED"===t.tagName?"true":e,t.setAttribute(e,n)):lr(e)?t.setAttribute(e,function(t,e){return gr(e)||"false"===e?"false":"contenteditable"===t&&fr(e)?e:"true"}(e,n)):hr(e)?gr(n)?t.removeAttributeNS(dr,vr(e)):t.setAttributeNS(dr,e,n):Hr(t,e,n)}function Hr(t,e,n){if(gr(n))t.removeAttribute(e);else{if(J&&!Y&&"TEXTAREA"===t.tagName&&"placeholder"===e&&""!==n&&!t.__ieph){var r=function(e){e.stopImmediatePropagation(),t.removeEventListener("input",r)};t.addEventListener("input",r),t.__ieph=!0}t.setAttribute(e,n)}}var Wr={create:Br,update:Br};function qr(t,e){var n=e.elm,r=e.data,o=t.data;if(!(i(r.staticClass)&&i(r.class)&&(i(o)||i(o.staticClass)&&i(o.class)))){var s=mr(e),c=n._transitionClasses;a(c)&&(s=br(s,_r(c))),s!==n._prevClass&&(n.setAttribute("class",s),n._prevClass=s)}}var Gr,Kr={create:qr,update:qr};function Qr(t,e,n){var r=Gr;return function o(){var i=e.apply(null,arguments);null!==i&&Xr(t,o,n,r)}}var Jr=Fe&&!(et&&Number(et[1])<=53);function Yr(t,e,n,r){if(Jr){var o=vn,i=e;e=i._wrapper=function(t){if(t.target===t.currentTarget||t.timeStamp>=o||t.timeStamp<=0||t.target.ownerDocument!==document)return i.apply(this,arguments)}}Gr.addEventListener(t,e,rt?{capture:n,passive:r}:n)}function Xr(t,e,n,r){(r||Gr).removeEventListener(t,e._wrapper||e,n)}function Zr(t,e){if(!i(t.data.on)||!i(e.data.on)){var n=e.data.on||{},r=t.data.on||{};Gr=e.elm||t.elm,function(t){if(a(t.__r)){var e=J?"change":"input";t[e]=[].concat(t.__r,t[e]||[]),delete t.__r}a(t.__c)&&(t.change=[].concat(t.__c,t.change||[]),delete t.__c)}(n),Zt(n,r,Yr,Xr,Qr,e.context),Gr=void 0}}var to,eo={create:Zr,update:Zr,destroy:function(t){return Zr(t,Ar)}};function no(t,e){if(!i(t.data.domProps)||!i(e.data.domProps)){var n,r,o=e.elm,c=t.data.domProps||{},u=e.data.domProps||{};for(n in(a(u.__ob__)||s(u._v_attr_proxy))&&(u=e.data.domProps=A({},u)),c)n in u||(o[n]="");for(n in u){if(r=u[n],"textContent"===n||"innerHTML"===n){if(e.children&&(e.children.length=0),r===c[n])continue;1===o.childNodes.length&&o.removeChild(o.childNodes[0])}if("value"===n&&"PROGRESS"!==o.tagName){o._value=r;var l=i(r)?"":String(r);ro(o,l)&&(o.value=l)}else if("innerHTML"===n&&kr(o.tagName)&&i(o.innerHTML)){(to=to||document.createElement("div")).innerHTML="".concat(r,"");for(var f=to.firstChild;o.firstChild;)o.removeChild(o.firstChild);for(;f.firstChild;)o.appendChild(f.firstChild)}else if(r!==c[n])try{o[n]=r}catch(t){}}}}function ro(t,e){return!t.composing&&("OPTION"===t.tagName||function(t,e){var n=!0;try{n=document.activeElement!==t}catch(t){}return n&&t.value!==e}(t,e)||function(t,e){var n=t.value,r=t._vModifiers;if(a(r)){if(r.number)return m(n)!==m(e);if(r.trim)return n.trim()!==e.trim()}return n!==e}(t,e))}var oo={create:no,update:no},io=k((function(t){var e={},n=/:(.+)/;return t.split(/;(?![^(]*\))/g).forEach((function(t){if(t){var r=t.split(n);r.length>1&&(e[r[0].trim()]=r[1].trim())}})),e}));function ao(t){var e=so(t.style);return t.staticStyle?A(t.staticStyle,e):e}function so(t){return Array.isArray(t)?T(t):"string"==typeof t?io(t):t}var co,uo=/^--/,lo=/\s*!important$/,fo=function(t,e,n){if(uo.test(e))t.style.setProperty(e,n);else if(lo.test(n))t.style.setProperty($(e),n.replace(lo,""),"important");else{var r=ho(e);if(Array.isArray(n))for(var o=0,i=n.length;o-1?e.split(mo).forEach((function(e){return t.classList.add(e)})):t.classList.add(e);else{var n=" ".concat(t.getAttribute("class")||""," ");n.indexOf(" "+e+" ")<0&&t.setAttribute("class",(n+e).trim())}}function bo(t,e){if(e&&(e=e.trim()))if(t.classList)e.indexOf(" ")>-1?e.split(mo).forEach((function(e){return t.classList.remove(e)})):t.classList.remove(e),t.classList.length||t.removeAttribute("class");else{for(var n=" ".concat(t.getAttribute("class")||""," "),r=" "+e+" ";n.indexOf(r)>=0;)n=n.replace(r," ");(n=n.trim())?t.setAttribute("class",n):t.removeAttribute("class")}}function _o(t){if(t){if("object"==typeof t){var e={};return!1!==t.css&&A(e,wo(t.name||"v")),A(e,t),e}return"string"==typeof t?wo(t):void 0}}var wo=k((function(t){return{enterClass:"".concat(t,"-enter"),enterToClass:"".concat(t,"-enter-to"),enterActiveClass:"".concat(t,"-enter-active"),leaveClass:"".concat(t,"-leave"),leaveToClass:"".concat(t,"-leave-to"),leaveActiveClass:"".concat(t,"-leave-active")}})),xo=K&&!Y,ko="transition",Oo="transitionend",Co="animation",So="animationend";xo&&(void 0===window.ontransitionend&&void 0!==window.onwebkittransitionend&&(ko="WebkitTransition",Oo="webkitTransitionEnd"),void 0===window.onanimationend&&void 0!==window.onwebkitanimationend&&(Co="WebkitAnimation",So="webkitAnimationEnd"));var jo=K?window.requestAnimationFrame?window.requestAnimationFrame.bind(window):setTimeout:function(t){return t()};function $o(t){jo((function(){jo(t)}))}function Eo(t,e){var n=t._transitionClasses||(t._transitionClasses=[]);n.indexOf(e)<0&&(n.push(e),yo(t,e))}function Po(t,e){t._transitionClasses&&_(t._transitionClasses,e),bo(t,e)}function Ao(t,e,n){var r=Lo(t,e),o=r.type,i=r.timeout,a=r.propCount;if(!o)return n();var s="transition"===o?Oo:So,c=0,u=function(){t.removeEventListener(s,l),n()},l=function(e){e.target===t&&++c>=a&&u()};setTimeout((function(){c0&&(n="transition",l=a,f=i.length):"animation"===e?u>0&&(n="animation",l=u,f=c.length):f=(n=(l=Math.max(a,u))>0?a>u?"transition":"animation":null)?"transition"===n?i.length:c.length:0,{type:n,timeout:l,propCount:f,hasTransform:"transition"===n&&To.test(r[ko+"Property"])}}function Do(t,e){for(;t.length1}function Uo(t,e){!0!==e.data.show&&Io(e)}var Vo=function(t){var e,n,r={},u=t.modules,l=t.nodeOps;for(e=0;eh?_(t,i(n[m+1])?null:n[m+1].elm,n,d,m,r):d>m&&x(e,f,h)}(f,v,m,n,u):a(m)?(a(t.text)&&l.setTextContent(f,""),_(f,null,m,0,m.length-1,n)):a(v)?x(v,0,v.length-1):a(t.text)&&l.setTextContent(f,""):t.text!==e.text&&l.setTextContent(f,e.text),a(h)&&a(d=h.hook)&&a(d=d.postpatch)&&d(t,e)}}}function S(t,e,n){if(s(n)&&a(t.parent))t.parent.data.pendingInsert=e;else for(var r=0;r-1,a.selected!==i&&(a.selected=i);else if(I(qo(a),r))return void(t.selectedIndex!==s&&(t.selectedIndex=s));o||(t.selectedIndex=-1)}}function Wo(t,e){return e.every((function(e){return!I(e,t)}))}function qo(t){return"_value"in t?t._value:t.value}function Go(t){t.target.composing=!0}function Ko(t){t.target.composing&&(t.target.composing=!1,Qo(t.target,"input"))}function Qo(t,e){var n=document.createEvent("HTMLEvents");n.initEvent(e,!0,!0),t.dispatchEvent(n)}function Jo(t){return!t.componentInstance||t.data&&t.data.transition?t:Jo(t.componentInstance._vnode)}var Yo={model:Bo,show:{bind:function(t,e,n){var r=e.value,o=(n=Jo(n)).data&&n.data.transition,i=t.__vOriginalDisplay="none"===t.style.display?"":t.style.display;r&&o?(n.data.show=!0,Io(n,(function(){t.style.display=i}))):t.style.display=r?i:"none"},update:function(t,e,n){var r=e.value;!r!=!e.oldValue&&((n=Jo(n)).data&&n.data.transition?(n.data.show=!0,r?Io(n,(function(){t.style.display=t.__vOriginalDisplay})):Ro(n,(function(){t.style.display="none"}))):t.style.display=r?t.__vOriginalDisplay:"none")},unbind:function(t,e,n,r,o){o||(t.style.display=t.__vOriginalDisplay)}}},Xo={name:String,appear:Boolean,css:Boolean,mode:String,type:String,enterClass:String,leaveClass:String,enterToClass:String,leaveToClass:String,enterActiveClass:String,leaveActiveClass:String,appearClass:String,appearActiveClass:String,appearToClass:String,duration:[Number,String,Object]};function Zo(t){var e=t&&t.componentOptions;return e&&e.Ctor.options.abstract?Zo(Ae(e.children)):t}function ti(t){var e={},n=t.$options;for(var r in n.propsData)e[r]=t[r];var o=n._parentListeners;for(var r in o)e[C(r)]=o[r];return e}function ei(t,e){if(/\d-keep-alive$/.test(e.tag))return t("keep-alive",{props:e.componentOptions.propsData})}var ni=function(t){return t.tag||we(t)},ri=function(t){return"show"===t.name},oi={name:"transition",props:Xo,abstract:!0,render:function(t){var e=this,n=this.$slots.default;if(n&&(n=n.filter(ni)).length){0;var r=this.mode;0;var o=n[0];if(function(t){for(;t=t.parent;)if(t.data.transition)return!0}(this.$vnode))return o;var i=Zo(o);if(!i)return o;if(this._leaving)return ei(t,o);var a="__transition-".concat(this._uid,"-");i.key=null==i.key?i.isComment?a+"comment":a+i.tag:c(i.key)?0===String(i.key).indexOf(a)?i.key:a+i.key:i.key;var s=(i.data||(i.data={})).transition=ti(this),u=this._vnode,l=Zo(u);if(i.data.directives&&i.data.directives.some(ri)&&(i.data.show=!0),l&&l.data&&!function(t,e){return e.key===t.key&&e.tag===t.tag}(i,l)&&!we(l)&&(!l.componentInstance||!l.componentInstance._vnode.isComment)){var f=l.data.transition=A({},s);if("out-in"===r)return this._leaving=!0,te(f,"afterLeave",(function(){e._leaving=!1,e.$forceUpdate()})),ei(t,o);if("in-out"===r){if(we(i))return u;var p,d=function(){p()};te(s,"afterEnter",d),te(s,"enterCancelled",d),te(f,"delayLeave",(function(t){p=t}))}}return o}}},ii=A({tag:String,moveClass:String},Xo);function ai(t){t.elm._moveCb&&t.elm._moveCb(),t.elm._enterCb&&t.elm._enterCb()}function si(t){t.data.newPos=t.elm.getBoundingClientRect()}function ci(t){var e=t.data.pos,n=t.data.newPos,r=e.left-n.left,o=e.top-n.top;if(r||o){t.data.moved=!0;var i=t.elm.style;i.transform=i.WebkitTransform="translate(".concat(r,"px,").concat(o,"px)"),i.transitionDuration="0s"}}delete ii.mode;var ui={Transition:oi,TransitionGroup:{props:ii,beforeMount:function(){var t=this,e=this._update;this._update=function(n,r){var o=on(t);t.__patch__(t._vnode,t.kept,!1,!0),t._vnode=t.kept,o(),e.call(t,n,r)}},render:function(t){for(var e=this.tag||this.$vnode.data.tag||"span",n=Object.create(null),r=this.prevChildren=this.children,o=this.$slots.default||[],i=this.children=[],a=ti(this),s=0;s-1?Cr[t]=e.constructor===window.HTMLUnknownElement||e.constructor===window.HTMLElement:Cr[t]=/HTMLUnknownElement/.test(e.toString())},A(tr.options.directives,Yo),A(tr.options.components,ui),tr.prototype.__patch__=K?Vo:L,tr.prototype.$mount=function(t,e){return function(t,e,n){var r;t.$el=e,t.$options.render||(t.$options.render=dt),cn(t,"beforeMount"),r=function(){t._update(t._render(),n)},new Xe(t,r,L,{before:function(){t._isMounted&&!t._isDestroyed&&cn(t,"beforeUpdate")}},!0),n=!1;var o=t._preWatchers;if(o)for(var i=0;i=0&&(e=t.slice(r),t=t.slice(0,r));var o=t.indexOf("?");return o>=0&&(n=t.slice(o+1),t=t.slice(0,o)),{path:t,query:n,hash:e}}(o.path||""),u=e&&e.path||"/",l=c.path?Pi(c.path,u,n||o.append):u,f=function(t,e,n){void 0===e&&(e={});var r,o=n||mi;try{r=o(t||"")}catch(t){r={}}for(var i in e){var a=e[i];r[i]=Array.isArray(a)?a.map(gi):gi(a)}return r}(c.query,o.query,r&&r.options.parseQuery),p=o.hash||c.hash;return p&&"#"!==p.charAt(0)&&(p="#"+p),{_normalized:!0,path:l,query:f,hash:p}}var Yi,Xi=function(){},Zi={name:"RouterLink",props:{to:{type:[String,Object],required:!0},tag:{type:String,default:"a"},custom:Boolean,exact:Boolean,exactPath:Boolean,append:Boolean,replace:Boolean,activeClass:String,exactActiveClass:String,ariaCurrentValue:{type:String,default:"page"},event:{type:[String,Array],default:"click"}},render:function(t){var e=this,n=this.$router,r=this.$route,o=n.resolve(this.to,r,this.append),i=o.location,a=o.route,s=o.href,c={},u=n.options.linkActiveClass,l=n.options.linkExactActiveClass,f=null==u?"router-link-active":u,p=null==l?"router-link-exact-active":l,d=null==this.activeClass?f:this.activeClass,h=null==this.exactActiveClass?p:this.exactActiveClass,v=a.redirectedFrom?_i(null,Ji(a.redirectedFrom),null,n):a;c[h]=Ci(r,v,this.exactPath),c[d]=this.exact||this.exactPath?c[h]:function(t,e){return 0===t.path.replace(bi,"/").indexOf(e.path.replace(bi,"/"))&&(!e.hash||t.hash===e.hash)&&function(t,e){for(var n in e)if(!(n in t))return!1;return!0}(t.query,e.query)}(r,v);var g=c[h]?this.ariaCurrentValue:null,m=function(t){ta(t)&&(e.replace?n.replace(i,Xi):n.push(i,Xi))},y={click:ta};Array.isArray(this.event)?this.event.forEach((function(t){y[t]=m})):y[this.event]=m;var b={class:c},_=!this.$scopedSlots.$hasNormal&&this.$scopedSlots.default&&this.$scopedSlots.default({href:s,route:a,navigate:m,isActive:c[d],isExactActive:c[h]});if(_){if(1===_.length)return _[0];if(_.length>1||!_.length)return 0===_.length?t():t("span",{},_)}if("a"===this.tag)b.on=y,b.attrs={href:s,"aria-current":g};else{var w=function t(e){var n;if(e)for(var r=0;r-1&&(s.params[p]=n.params[p]);return s.path=Qi(l.path,s.params),c(l,s,a)}if(s.path){s.params={};for(var d=0;d-1}function Aa(t,e){return Pa(t)&&t._isRouter&&(null==e||t.type===e)}function Ta(t,e,n){var r=function(o){o>=t.length?n():t[o]?e(t[o],(function(){r(o+1)})):r(o+1)};r(0)}function La(t){return function(e,n,r){var o=!1,i=0,a=null;Da(t,(function(t,e,n,s){if("function"==typeof t&&void 0===t.cid){o=!0,i++;var c,u=Ra((function(e){var o;((o=e).__esModule||Ia&&"Module"===o[Symbol.toStringTag])&&(e=e.default),t.resolved="function"==typeof e?e:Yi.extend(e),n.components[s]=e,--i<=0&&r()})),l=Ra((function(t){var e="Failed to resolve async component "+s+": "+t;a||(a=Pa(t)?t:new Error(e),r(a))}));try{c=t(u,l)}catch(t){l(t)}if(c)if("function"==typeof c.then)c.then(u,l);else{var f=c.component;f&&"function"==typeof f.then&&f.then(u,l)}}})),o||r()}}function Da(t,e){return Ma(t.map((function(t){return Object.keys(t.components).map((function(n){return e(t.components[n],t.instances[n],t,n)}))})))}function Ma(t){return Array.prototype.concat.apply([],t)}var Ia="function"==typeof Symbol&&"symbol"==typeof Symbol.toStringTag;function Ra(t){var e=!1;return function(){for(var n=[],r=arguments.length;r--;)n[r]=arguments[r];if(!e)return e=!0,t.apply(this,n)}}var Fa=function(t,e){this.router=t,this.base=function(t){if(!t)if(ea){var e=document.querySelector("base");t=(t=e&&e.getAttribute("href")||"/").replace(/^https?:\/\/[^\/]+/,"")}else t="/";"/"!==t.charAt(0)&&(t="/"+t);return t.replace(/\/$/,"")}(e),this.current=xi,this.pending=null,this.ready=!1,this.readyCbs=[],this.readyErrorCbs=[],this.errorCbs=[],this.listeners=[]};function Na(t,e,n,r){var o=Da(t,(function(t,r,o,i){var a=function(t,e){"function"!=typeof t&&(t=Yi.extend(t));return t.options[e]}(t,e);if(a)return Array.isArray(a)?a.map((function(t){return n(t,r,o,i)})):n(a,r,o,i)}));return Ma(r?o.reverse():o)}function Ua(t,e){if(e)return function(){return t.apply(e,arguments)}}Fa.prototype.listen=function(t){this.cb=t},Fa.prototype.onReady=function(t,e){this.ready?t():(this.readyCbs.push(t),e&&this.readyErrorCbs.push(e))},Fa.prototype.onError=function(t){this.errorCbs.push(t)},Fa.prototype.transitionTo=function(t,e,n){var r,o=this;try{r=this.router.match(t,this.current)}catch(t){throw this.errorCbs.forEach((function(e){e(t)})),t}var i=this.current;this.confirmTransition(r,(function(){o.updateRoute(r),e&&e(r),o.ensureURL(),o.router.afterHooks.forEach((function(t){t&&t(r,i)})),o.ready||(o.ready=!0,o.readyCbs.forEach((function(t){t(r)})))}),(function(t){n&&n(t),t&&!o.ready&&(Aa(t,Ca.redirected)&&i===xi||(o.ready=!0,o.readyErrorCbs.forEach((function(e){e(t)}))))}))},Fa.prototype.confirmTransition=function(t,e,n){var r=this,o=this.current;this.pending=t;var i,a,s=function(t){!Aa(t)&&Pa(t)&&(r.errorCbs.length?r.errorCbs.forEach((function(e){e(t)})):console.error(t)),n&&n(t)},c=t.matched.length-1,u=o.matched.length-1;if(Ci(t,o)&&c===u&&t.matched[c]===o.matched[u])return this.ensureURL(),t.hash&&da(this.router,o,t,!1),s(((a=$a(i=o,t,Ca.duplicated,'Avoided redundant navigation to current location: "'+i.fullPath+'".')).name="NavigationDuplicated",a));var l=function(t,e){var n,r=Math.max(t.length,e.length);for(n=0;n0)){var e=this.router,n=e.options.scrollBehavior,r=xa&&n;r&&this.listeners.push(pa());var o=function(){var n=t.current,o=Ba(t.base);t.current===xi&&o===t._startLocation||t.transitionTo(o,(function(t){r&&da(e,t,n,!0)}))};window.addEventListener("popstate",o),this.listeners.push((function(){window.removeEventListener("popstate",o)}))}},e.prototype.go=function(t){window.history.go(t)},e.prototype.push=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){ka(Ai(r.base+t.fullPath)),da(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.replace=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){Oa(Ai(r.base+t.fullPath)),da(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.ensureURL=function(t){if(Ba(this.base)!==this.current.fullPath){var e=Ai(this.base+this.current.fullPath);t?ka(e):Oa(e)}},e.prototype.getCurrentLocation=function(){return Ba(this.base)},e}(Fa);function Ba(t){var e=window.location.pathname,n=e.toLowerCase(),r=t.toLowerCase();return!t||n!==r&&0!==n.indexOf(Ai(r+"/"))||(e=e.slice(t.length)),(e||"/")+window.location.search+window.location.hash}var za=function(t){function e(e,n,r){t.call(this,e,n),r&&function(t){var e=Ba(t);if(!/^\/#/.test(e))return window.location.replace(Ai(t+"/#"+e)),!0}(this.base)||Ha()}return t&&(e.__proto__=t),e.prototype=Object.create(t&&t.prototype),e.prototype.constructor=e,e.prototype.setupListeners=function(){var t=this;if(!(this.listeners.length>0)){var e=this.router.options.scrollBehavior,n=xa&&e;n&&this.listeners.push(pa());var r=function(){var e=t.current;Ha()&&t.transitionTo(Wa(),(function(r){n&&da(t.router,r,e,!0),xa||Ka(r.fullPath)}))},o=xa?"popstate":"hashchange";window.addEventListener(o,r),this.listeners.push((function(){window.removeEventListener(o,r)}))}},e.prototype.push=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){Ga(t.fullPath),da(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.replace=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){Ka(t.fullPath),da(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.go=function(t){window.history.go(t)},e.prototype.ensureURL=function(t){var e=this.current.fullPath;Wa()!==e&&(t?Ga(e):Ka(e))},e.prototype.getCurrentLocation=function(){return Wa()},e}(Fa);function Ha(){var t=Wa();return"/"===t.charAt(0)||(Ka("/"+t),!1)}function Wa(){var t=window.location.href,e=t.indexOf("#");return e<0?"":t=t.slice(e+1)}function qa(t){var e=window.location.href,n=e.indexOf("#");return(n>=0?e.slice(0,n):e)+"#"+t}function Ga(t){xa?ka(qa(t)):window.location.hash=t}function Ka(t){xa?Oa(qa(t)):window.location.replace(qa(t))}var Qa=function(t){function e(e,n){t.call(this,e,n),this.stack=[],this.index=-1}return t&&(e.__proto__=t),e.prototype=Object.create(t&&t.prototype),e.prototype.constructor=e,e.prototype.push=function(t,e,n){var r=this;this.transitionTo(t,(function(t){r.stack=r.stack.slice(0,r.index+1).concat(t),r.index++,e&&e(t)}),n)},e.prototype.replace=function(t,e,n){var r=this;this.transitionTo(t,(function(t){r.stack=r.stack.slice(0,r.index).concat(t),e&&e(t)}),n)},e.prototype.go=function(t){var e=this,n=this.index+t;if(!(n<0||n>=this.stack.length)){var r=this.stack[n];this.confirmTransition(r,(function(){var t=e.current;e.index=n,e.updateRoute(r),e.router.afterHooks.forEach((function(e){e&&e(r,t)}))}),(function(t){Aa(t,Ca.duplicated)&&(e.index=n)}))}},e.prototype.getCurrentLocation=function(){var t=this.stack[this.stack.length-1];return t?t.fullPath:"/"},e.prototype.ensureURL=function(){},e}(Fa),Ja=function(t){void 0===t&&(t={}),this.app=null,this.apps=[],this.options=t,this.beforeHooks=[],this.resolveHooks=[],this.afterHooks=[],this.matcher=oa(t.routes||[],this);var e=t.mode||"hash";switch(this.fallback="history"===e&&!xa&&!1!==t.fallback,this.fallback&&(e="hash"),ea||(e="abstract"),this.mode=e,e){case"history":this.history=new Va(this,t.base);break;case"hash":this.history=new za(this,t.base,this.fallback);break;case"abstract":this.history=new Qa(this,t.base);break;default:0}},Ya={currentRoute:{configurable:!0}};Ja.prototype.match=function(t,e,n){return this.matcher.match(t,e,n)},Ya.currentRoute.get=function(){return this.history&&this.history.current},Ja.prototype.init=function(t){var e=this;if(this.apps.push(t),t.$once("hook:destroyed",(function(){var n=e.apps.indexOf(t);n>-1&&e.apps.splice(n,1),e.app===t&&(e.app=e.apps[0]||null),e.app||e.history.teardown()})),!this.app){this.app=t;var n=this.history;if(n instanceof Va||n instanceof za){var r=function(t){n.setupListeners(),function(t){var r=n.current,o=e.options.scrollBehavior;xa&&o&&"fullPath"in t&&da(e,t,r,!1)}(t)};n.transitionTo(n.getCurrentLocation(),r,r)}n.listen((function(t){e.apps.forEach((function(e){e._route=t}))}))}},Ja.prototype.beforeEach=function(t){return Za(this.beforeHooks,t)},Ja.prototype.beforeResolve=function(t){return Za(this.resolveHooks,t)},Ja.prototype.afterEach=function(t){return Za(this.afterHooks,t)},Ja.prototype.onReady=function(t,e){this.history.onReady(t,e)},Ja.prototype.onError=function(t){this.history.onError(t)},Ja.prototype.push=function(t,e,n){var r=this;if(!e&&!n&&"undefined"!=typeof Promise)return new Promise((function(e,n){r.history.push(t,e,n)}));this.history.push(t,e,n)},Ja.prototype.replace=function(t,e,n){var r=this;if(!e&&!n&&"undefined"!=typeof Promise)return new Promise((function(e,n){r.history.replace(t,e,n)}));this.history.replace(t,e,n)},Ja.prototype.go=function(t){this.history.go(t)},Ja.prototype.back=function(){this.go(-1)},Ja.prototype.forward=function(){this.go(1)},Ja.prototype.getMatchedComponents=function(t){var e=t?t.matched?t:this.resolve(t).route:this.currentRoute;return e?[].concat.apply([],e.matched.map((function(t){return Object.keys(t.components).map((function(e){return t.components[e]}))}))):[]},Ja.prototype.resolve=function(t,e,n){var r=Ji(t,e=e||this.history.current,n,this),o=this.match(r,e),i=o.redirectedFrom||o.fullPath;return{location:r,route:o,href:function(t,e,n){var r="hash"===n?"#"+e:e;return t?Ai(t+"/"+r):r}(this.history.base,i,this.mode),normalizedTo:r,resolved:o}},Ja.prototype.getRoutes=function(){return this.matcher.getRoutes()},Ja.prototype.addRoute=function(t,e){this.matcher.addRoute(t,e),this.history.current!==xi&&this.history.transitionTo(this.history.getCurrentLocation())},Ja.prototype.addRoutes=function(t){this.matcher.addRoutes(t),this.history.current!==xi&&this.history.transitionTo(this.history.getCurrentLocation())},Object.defineProperties(Ja.prototype,Ya);var Xa=Ja;function Za(t,e){return t.push(e),function(){var n=t.indexOf(e);n>-1&&t.splice(n,1)}}Ja.install=function t(e){if(!t.installed||Yi!==e){t.installed=!0,Yi=e;var n=function(t){return void 0!==t},r=function(t,e){var r=t.$options._parentVnode;n(r)&&n(r=r.data)&&n(r=r.registerRouteInstance)&&r(t,e)};e.mixin({beforeCreate:function(){n(this.$options.router)?(this._routerRoot=this,this._router=this.$options.router,this._router.init(this),e.util.defineReactive(this,"_route",this._router.history.current)):this._routerRoot=this.$parent&&this.$parent._routerRoot||this,r(this,this)},destroyed:function(){r(this)}}),Object.defineProperty(e.prototype,"$router",{get:function(){return this._routerRoot._router}}),Object.defineProperty(e.prototype,"$route",{get:function(){return this._routerRoot._route}}),e.component("RouterView",$i),e.component("RouterLink",Zi);var o=e.config.optionMergeStrategies;o.beforeRouteEnter=o.beforeRouteLeave=o.beforeRouteUpdate=o.created}},Ja.version="3.6.5",Ja.isNavigationFailure=Aa,Ja.NavigationFailureType=Ca,Ja.START_LOCATION=xi,ea&&window.Vue&&window.Vue.use(Ja);n(97);n(91),n(129);var ts={NotFound:()=>n.e(6).then(n.bind(null,284)),Layout:()=>Promise.all([n.e(0),n.e(2)]).then(n.bind(null,283))},es={"v-5e1e685a":()=>n.e(7).then(n.bind(null,287)),"v-c97ca880":()=>n.e(8).then(n.bind(null,288)),"v-18d0587a":()=>n.e(11).then(n.bind(null,289)),"v-4f037d1a":()=>n.e(10).then(n.bind(null,290)),"v-3120da0c":()=>n.e(12).then(n.bind(null,291)),"v-2f7f848c":()=>n.e(13).then(n.bind(null,292)),"v-0d609624":()=>n.e(9).then(n.bind(null,293)),"v-2eaf1140":()=>n.e(14).then(n.bind(null,294)),"v-09d6f550":()=>n.e(16).then(n.bind(null,295)),"v-18c2b964":()=>n.e(15).then(n.bind(null,296)),"v-9356a30c":()=>n.e(17).then(n.bind(null,297)),"v-7cc0117c":()=>n.e(18).then(n.bind(null,298)),"v-690a4650":()=>n.e(19).then(n.bind(null,299)),"v-58f7366c":()=>n.e(20).then(n.bind(null,300)),"v-47c1f97a":()=>n.e(23).then(n.bind(null,301)),"v-950c4d48":()=>n.e(22).then(n.bind(null,302)),"v-0877efcc":()=>n.e(21).then(n.bind(null,303)),"v-4fad50ba":()=>n.e(24).then(n.bind(null,304)),"v-31657474":()=>n.e(26).then(n.bind(null,305)),"v-4fc0d1c8":()=>n.e(25).then(n.bind(null,306)),"v-0c3bd15a":()=>n.e(28).then(n.bind(null,307)),"v-e2784654":()=>n.e(27).then(n.bind(null,308)),"v-84e0b14c":()=>n.e(29).then(n.bind(null,309)),"v-074d53cc":()=>n.e(30).then(n.bind(null,310)),"v-3e6ef1ac":()=>n.e(32).then(n.bind(null,311)),"v-6dd912ec":()=>n.e(33).then(n.bind(null,312)),"v-3258450c":()=>n.e(34).then(n.bind(null,313)),"v-0d650648":()=>n.e(31).then(n.bind(null,314)),"v-a6e64848":()=>n.e(35).then(n.bind(null,315)),"v-35b0f3b1":()=>n.e(36).then(n.bind(null,316)),"v-45095440":()=>n.e(39).then(n.bind(null,317)),"v-57c590fa":()=>n.e(38).then(n.bind(null,318)),"v-d297eaa6":()=>n.e(40).then(n.bind(null,319)),"v-f81e553c":()=>n.e(41).then(n.bind(null,320)),"v-e65ea9a4":()=>n.e(37).then(n.bind(null,321)),"v-7cc2c9e4":()=>n.e(42).then(n.bind(null,322)),"v-5d3101c8":()=>n.e(43).then(n.bind(null,323)),"v-501d8193":()=>n.e(44).then(n.bind(null,324))};function ns(t){const e=Object.create(null);return function(n){return e[n]||(e[n]=t(n))}}const rs=/-(\w)/g,os=ns(t=>t.replace(rs,(t,e)=>e?e.toUpperCase():"")),is=/\B([A-Z])/g,as=ns(t=>t.replace(is,"-$1").toLowerCase()),ss=ns(t=>t.charAt(0).toUpperCase()+t.slice(1));function cs(t,e){if(!e)return;if(t(e))return t(e);return e.includes("-")?t(ss(os(e))):t(ss(e))||t(as(e))}const us=Object.assign({},ts,es),ls=t=>us[t],fs=t=>es[t],ps=t=>ts[t],ds=t=>tr.component(t);function hs(t){return cs(fs,t)}function vs(t){return cs(ps,t)}function gs(t){return cs(ls,t)}function ms(t){return cs(ds,t)}function ys(...t){return Promise.all(t.filter(t=>t).map(async t=>{if(!ms(t)&&gs(t)){const e=await gs(t)();tr.component(t,e.default)}}))}function bs(t,e){"undefined"!=typeof window&&window.__VUEPRESS__&&(window.__VUEPRESS__[t]=e)}var _s=n(88),ws=n.n(_s),xs=n(89),ks=n.n(xs),Os={created(){if(this.siteMeta=this.$site.headTags.filter(([t])=>"meta"===t).map(([t,e])=>e),this.$ssrContext){const e=this.getMergedMetaTags();this.$ssrContext.title=this.$title,this.$ssrContext.lang=this.$lang,this.$ssrContext.pageMeta=(t=e)?t.map(t=>{let e="{e+=` ${n}="${ks()(t[n])}"`}),e+">"}).join("\n "):"",this.$ssrContext.canonicalLink=Ss(this.$canonicalUrl)}var t},mounted(){this.currentMetaTags=[...document.querySelectorAll("meta")],this.updateMeta(),this.updateCanonicalLink()},methods:{updateMeta(){document.title=this.$title,document.documentElement.lang=this.$lang;const t=this.getMergedMetaTags();this.currentMetaTags=js(t,this.currentMetaTags)},getMergedMetaTags(){const t=this.$page.frontmatter.meta||[];return ws()([{name:"description",content:this.$description}],t,this.siteMeta,$s)},updateCanonicalLink(){Cs(),this.$canonicalUrl&&document.head.insertAdjacentHTML("beforeend",Ss(this.$canonicalUrl))}},watch:{$page(){this.updateMeta(),this.updateCanonicalLink()}},beforeDestroy(){js(null,this.currentMetaTags),Cs()}};function Cs(){const t=document.querySelector("link[rel='canonical']");t&&t.remove()}function Ss(t=""){return t?``:""}function js(t,e){if(e&&[...e].filter(t=>t.parentNode===document.head).forEach(t=>document.head.removeChild(t)),t)return t.map(t=>{const e=document.createElement("meta");return Object.keys(t).forEach(n=>{e.setAttribute(n,t[n])}),document.head.appendChild(e),e})}function $s(t){for(const e of["name","property","itemprop"])if(t.hasOwnProperty(e))return t[e]+e;return JSON.stringify(t)}var Es=n(90),Ps={mounted(){window.addEventListener("scroll",this.onScroll)},methods:{onScroll:n.n(Es)()((function(){this.setActiveHash()}),300),setActiveHash(){const t=[].slice.call(document.querySelectorAll(".sidebar-link")),e=[].slice.call(document.querySelectorAll(".header-anchor")).filter(e=>t.some(t=>t.hash===e.hash)),n=Math.max(window.pageYOffset,document.documentElement.scrollTop,document.body.scrollTop),r=Math.max(document.documentElement.scrollHeight,document.body.scrollHeight),o=window.innerHeight+n;for(let t=0;t=i.parentElement.offsetTop+10&&(!a||n{this.$nextTick(()=>{this.$vuepress.$set("disableScrollBehavior",!1)})})}}}},beforeDestroy(){window.removeEventListener("scroll",this.onScroll)}},As=n(22),Ts=n.n(As),Ls={mounted(){Ts.a.configure({showSpinner:!1}),this.$router.beforeEach((t,e,n)=>{t.path===e.path||tr.component(t.name)||Ts.a.start(),n()}),this.$router.afterEach(()=>{Ts.a.done(),this.isSidebarOpen=!1})}},Ds={props:{parent:Object,code:String,options:{align:String,color:String,backgroundTransition:Boolean,backgroundColor:String,successText:String,staticIcon:Boolean}},data:()=>({success:!1,originalBackground:null,originalTransition:null}),computed:{alignStyle(){let t={};return t[this.options.align]="7.5px",t},iconClass(){return this.options.staticIcon?"":"hover"}},mounted(){this.originalTransition=this.parent.style.transition,this.originalBackground=this.parent.style.background},beforeDestroy(){this.parent.style.transition=this.originalTransition,this.parent.style.background=this.originalBackground},methods:{hexToRgb(t){let e=/^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(t);return e?{r:parseInt(e[1],16),g:parseInt(e[2],16),b:parseInt(e[3],16)}:null},copyToClipboard(t){if(navigator.clipboard)navigator.clipboard.writeText(this.code).then(()=>{this.setSuccessTransitions()},()=>{});else{let t=document.createElement("textarea");document.body.appendChild(t),t.value=this.code,t.select(),document.execCommand("Copy"),t.remove(),this.setSuccessTransitions()}},setSuccessTransitions(){if(clearTimeout(this.successTimeout),this.options.backgroundTransition){this.parent.style.transition="background 350ms";let t=this.hexToRgb(this.options.backgroundColor);this.parent.style.background=`rgba(${t.r}, ${t.g}, ${t.b}, 0.1)`}this.success=!0,this.successTimeout=setTimeout(()=>{this.options.backgroundTransition&&(this.parent.style.background=this.originalBackground,this.parent.style.transition=this.originalTransition),this.success=!1},500)}}},Ms=(n(237),n(10)),Is=Object(Ms.a)(Ds,(function(){var t=this,e=t._self._c;return e("div",{staticClass:"code-copy"},[e("svg",{class:t.iconClass,style:t.alignStyle,attrs:{xmlns:"http://www.w3.org/2000/svg",width:"24",height:"24",viewBox:"0 0 24 24"},on:{click:t.copyToClipboard}},[e("path",{attrs:{fill:"none",d:"M0 0h24v24H0z"}}),t._v(" "),e("path",{attrs:{fill:t.options.color,d:"M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4l6 6v10c0 1.1-.9 2-2 2H7.99C6.89 23 6 22.1 6 21l.01-14c0-1.1.89-2 1.99-2h7zm-1 7h5.5L14 6.5V12z"}})]),t._v(" "),e("span",{class:t.success?"success":"",style:t.alignStyle},[t._v("\n "+t._s(t.options.successText)+"\n ")])])}),[],!1,null,"49140617",null).exports,Rs=(n(238),[Os,Ps,Ls,{updated(){this.update()},methods:{update(){setTimeout(()=>{document.querySelectorAll('div[class*="language-"] pre').forEach(t=>{if(t.classList.contains("code-copy-added"))return;let e=new(tr.extend(Is));e.options={align:"bottom",color:"#27b1ff",backgroundTransition:!0,backgroundColor:"#0075b8",successText:"Copied!",staticIcon:!1},e.code=t.innerText,e.parent=t,e.$mount(),t.classList.add("code-copy-added"),t.appendChild(e.$el)})},100)}}}]),Fs={name:"GlobalLayout",computed:{layout(){const t=this.getLayout();return bs("layout",t),tr.component(t)}},methods:{getLayout(){if(this.$page.path){const t=this.$page.frontmatter.layout;return t&&(this.$vuepress.getLayoutAsyncComponent(t)||this.$vuepress.getVueComponent(t))?t:"Layout"}return"NotFound"}}},Ns=Object(Ms.a)(Fs,(function(){return(0,this._self._c)(this.layout,{tag:"component"})}),[],!1,null,null,null).exports;!function(t,e,n){switch(e){case"components":t[e]||(t[e]={}),Object.assign(t[e],n);break;case"mixins":t[e]||(t[e]=[]),t[e].push(...n);break;default:throw new Error("Unknown option name.")}}(Ns,"mixins",Rs);const Us=[{name:"v-5e1e685a",path:"/docs/arfs/content-types.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-5e1e685a").then(n)}},{name:"v-c97ca880",path:"/docs/arfs/data-model.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-c97ca880").then(n)}},{name:"v-18d0587a",path:"/docs/arfs/privacy.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-18d0587a").then(n)}},{name:"v-4f037d1a",path:"/docs/arfs/",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-4f037d1a").then(n)}},{path:"/docs/arfs/index.html",redirect:"/docs/arfs/"},{path:"/docs/arfs/overview.html",redirect:"/docs/arfs/"},{name:"v-3120da0c",path:"/docs/arfs/schema-diagrams.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-3120da0c").then(n)}},{name:"v-2f7f848c",path:"/docs/arfs/usage/change/drives.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-2f7f848c").then(n)}},{name:"v-0d609624",path:"/docs/arfs/entity-types.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-0d609624").then(n)}},{name:"v-2eaf1140",path:"/docs/arfs/usage/change/files.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-2eaf1140").then(n)}},{name:"v-09d6f550",path:"/docs/arfs/usage/change/snapshots.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-09d6f550").then(n)}},{name:"v-18c2b964",path:"/docs/arfs/usage/change/folders.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-18c2b964").then(n)}},{name:"v-9356a30c",path:"/docs/arfs/usage/create/",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-9356a30c").then(n)}},{path:"/docs/arfs/usage/create/index.html",redirect:"/docs/arfs/usage/create/"},{path:"/docs/arfs/usage/create/create-drive.html",redirect:"/docs/arfs/usage/create/"},{name:"v-7cc0117c",path:"/docs/arfs/usage/create/create-file.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-7cc0117c").then(n)}},{name:"v-690a4650",path:"/docs/arfs/usage/create/create-folder.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-690a4650").then(n)}},{name:"v-58f7366c",path:"/docs/arfs/usage/create/create-snapshot.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-58f7366c").then(n)}},{name:"v-47c1f97a",path:"/docs/cli/all-commands.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-47c1f97a").then(n)}},{name:"v-950c4d48",path:"/docs/arfs/usage/read/",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-950c4d48").then(n)}},{path:"/docs/arfs/usage/read/index.html",redirect:"/docs/arfs/usage/read/"},{path:"/docs/arfs/usage/read/read-operations.html",redirect:"/docs/arfs/usage/read/"},{name:"v-0877efcc",path:"/docs/arfs/usage/extending-schemas.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-0877efcc").then(n)}},{name:"v-4fad50ba",path:"/docs/cli/getting-help.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-4fad50ba").then(n)}},{name:"v-31657474",path:"/docs/cli/",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-31657474").then(n)}},{path:"/docs/cli/index.html",redirect:"/docs/cli/"},{path:"/docs/cli/intro.html",redirect:"/docs/cli/"},{name:"v-4fc0d1c8",path:"/docs/cli/getting-started.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-4fc0d1c8").then(n)}},{name:"v-0c3bd15a",path:"/docs/core-sdk.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-0c3bd15a").then(n)}},{name:"v-e2784654",path:"/docs/cli/using-the-cli.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-e2784654").then(n)}},{name:"v-84e0b14c",path:"/docs/misc/deploy/deploy.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-84e0b14c").then(n)}},{name:"v-074d53cc",path:"/docs/misc/deploy/examples.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-074d53cc").then(n)}},{name:"v-3e6ef1ac",path:"/docs/misc/deploy/",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-3e6ef1ac").then(n)}},{path:"/docs/misc/deploy/index.html",redirect:"/docs/misc/deploy/"},{path:"/docs/misc/deploy/prepare.html",redirect:"/docs/misc/deploy/"},{name:"v-6dd912ec",path:"/docs/misc/deploy/routing.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-6dd912ec").then(n)}},{name:"v-3258450c",path:"/docs/misc/permasite.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-3258450c").then(n)}},{name:"v-0d650648",path:"/docs/misc/deploy/paths.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-0d650648").then(n)}},{name:"v-a6e64848",path:"/docs/misc/price-calculator.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-a6e64848").then(n)}},{name:"v-35b0f3b1",path:"/docs/",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-35b0f3b1").then(n)}},{path:"/docs/index.html",redirect:"/docs/"},{name:"v-45095440",path:"/docs/turbo/migrating.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-45095440").then(n)}},{name:"v-57c590fa",path:"/docs/turbo/api/upload.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-57c590fa").then(n)}},{name:"v-d297eaa6",path:"/docs/turbo/turbo-sdk/",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-d297eaa6").then(n)}},{path:"/docs/turbo/turbo-sdk/index.html",redirect:"/docs/turbo/turbo-sdk/"},{name:"v-f81e553c",path:"/docs/turbo/turbo-sdk/release-notes.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-f81e553c").then(n)}},{name:"v-e65ea9a4",path:"/docs/turbo/api/payment.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-e65ea9a4").then(n)}},{name:"v-7cc2c9e4",path:"/docs/turbo/turbo-sdk/turbo-web.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-7cc2c9e4").then(n)}},{name:"v-5d3101c8",path:"/docs/turbo/what-is-turbo.html",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-5d3101c8").then(n)}},{name:"v-501d8193",path:"/",component:Ns,beforeEnter:(t,e,n)=>{ys("Layout","v-501d8193").then(n)}},{path:"/index.html",redirect:"/"},{path:"*",component:Ns}],Vs={title:"ArDrive Docs",description:"ArDrive documentation",base:"/",headTags:[["meta",{property:"og:image",content:"https://docs.ardrive.io/images/card-image.png"}],["meta",{name:"theme-color",content:"#3eaf7c"}],["meta",{name:"apple-mobile-web-app-capable",content:"yes"}],["meta",{name:"apple-mobile-web-app-status-bar-style",content:"black"}],["script",{src:"https://plausible.io/js/script.js",defer:!0,"data-domain":"docs.ardrive.io"}]],pages:[{title:"Content Types",frontmatter:{},regularPath:"/docs/arfs/content-types.html",relativePath:"docs/arfs/content-types.md",key:"v-5e1e685a",path:"/docs/arfs/content-types.html",headers:[{level:2,title:"Other Tags",slug:"other-tags"}]},{title:"Data Model",frontmatter:{},regularPath:"/docs/arfs/data-model.html",relativePath:"docs/arfs/data-model.md",key:"v-c97ca880",path:"/docs/arfs/data-model.html",headers:[{level:2,title:"Entity relationships",slug:"entity-relationships"},{level:2,title:"Metadata Format",slug:"metadata-format"}]},{title:"Privacy",frontmatter:{},regularPath:"/docs/arfs/privacy.html",relativePath:"docs/arfs/privacy.md",key:"v-18d0587a",path:"/docs/arfs/privacy.html",headers:[{level:2,title:"Deriving Keys",slug:"deriving-keys"},{level:2,title:"Private Drives",slug:"private-drives"},{level:2,title:"Private Files",slug:"private-files"}]},{title:"ArFS Protocol: A Decentralized File System on Arweave",frontmatter:{permalink:"/docs/arfs/"},regularPath:"/docs/arfs/overview.html",relativePath:"docs/arfs/overview.md",key:"v-4f037d1a",path:"/docs/arfs/",headers:[{level:2,title:"Key Features",slug:"key-features"},{level:3,title:"File Structure",slug:"file-structure"},{level:3,title:"Metadata",slug:"metadata"},{level:3,title:"File Permissions",slug:"file-permissions"},{level:3,title:"File Versioning",slug:"file-versioning"},{level:3,title:"Data Deduplication",slug:"data-deduplication"},{level:3,title:"Search and Discovery",slug:"search-and-discovery"},{level:3,title:"Interoperability",slug:"interoperability"},{level:2,title:"Getting Started",slug:"getting-started"},{level:2,title:"ArFS Version History",slug:"arfs-version-history"},{level:2,title:"Resources",slug:"resources"}]},{title:"Schema Diagrams",frontmatter:{},regularPath:"/docs/arfs/schema-diagrams.html",relativePath:"docs/arfs/schema-diagrams.md",key:"v-3120da0c",path:"/docs/arfs/schema-diagrams.html",headers:[{level:2,title:"Schema Diagrams",slug:"schema-diagrams"},{level:3,title:"Public Drive",slug:"public-drive"},{level:3,title:"Private Drive",slug:"private-drive"}]},{title:"Drive Write Operations",frontmatter:{},regularPath:"/docs/arfs/usage/change/drives.html",relativePath:"docs/arfs/usage/change/drives.md",key:"v-2f7f848c",path:"/docs/arfs/usage/change/drives.html",headers:[{level:2,title:"Rename Drives",slug:"rename-drives"}]},{title:"Entity Types",frontmatter:{tags:["pin","pins","pinnedDataOwner","hidden","hide"]},regularPath:"/docs/arfs/entity-types.html",relativePath:"docs/arfs/entity-types.md",key:"v-0d609624",path:"/docs/arfs/entity-types.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Drive",slug:"drive"},{level:2,title:"Folder",slug:"folder"},{level:2,title:"File",slug:"file"},{level:2,title:"Snapshot",slug:"snapshot"},{level:3,title:"Snapshot Entity Tags",slug:"snapshot-entity-tags"},{level:3,title:"Snapshot Entity Data",slug:"snapshot-entity-data"},{level:2,title:"Schema Diagrams",slug:"schema-diagrams"},{level:3,title:"Public Drive",slug:"public-drive"},{level:3,title:"Private Drive",slug:"private-drive"}]},{title:"File Write Operations",frontmatter:{},regularPath:"/docs/arfs/usage/change/files.html",relativePath:"docs/arfs/usage/change/files.md",key:"v-2eaf1140",path:"/docs/arfs/usage/change/files.html",headers:[{level:2,title:"Move File",slug:"move-file"},{level:2,title:"Rename File",slug:"rename-file"},{level:2,title:"Update File Version",slug:"update-file-version"},{level:2,title:"Hide or Unhide File",slug:"hide-or-unhide-file"}]},{frontmatter:{},regularPath:"/docs/arfs/usage/change/snapshots.html",relativePath:"docs/arfs/usage/change/snapshots.md",key:"v-09d6f550",path:"/docs/arfs/usage/change/snapshots.html"},{title:"Folder Write Operations",frontmatter:{},regularPath:"/docs/arfs/usage/change/folders.html",relativePath:"docs/arfs/usage/change/folders.md",key:"v-18c2b964",path:"/docs/arfs/usage/change/folders.html",headers:[{level:2,title:"Move Folder",slug:"move-folder"},{level:2,title:"Rename Folder",slug:"rename-folder"}]},{title:"Create Drive",frontmatter:{permalink:"/docs/arfs/usage/create/"},regularPath:"/docs/arfs/usage/create/create-drive.html",relativePath:"docs/arfs/usage/create/create-drive.md",key:"v-9356a30c",path:"/docs/arfs/usage/create/",headers:[{level:2,title:"New Drive Entity",slug:"new-drive-entity"},{level:2,title:"New Root Folder Entity",slug:"new-root-folder-entity"}]},{title:"Create File",frontmatter:{},regularPath:"/docs/arfs/usage/create/create-file.html",relativePath:"docs/arfs/usage/create/create-file.md",key:"v-7cc0117c",path:"/docs/arfs/usage/create/create-file.html",headers:[{level:2,title:"New File Entity",slug:"new-file-entity"}]},{title:"Create Folder",frontmatter:{},regularPath:"/docs/arfs/usage/create/create-folder.html",relativePath:"docs/arfs/usage/create/create-folder.md",key:"v-690a4650",path:"/docs/arfs/usage/create/create-folder.html",headers:[{level:2,title:"New Folder Entity",slug:"new-folder-entity"}]},{frontmatter:{},regularPath:"/docs/arfs/usage/create/create-snapshot.html",relativePath:"docs/arfs/usage/create/create-snapshot.md",key:"v-58f7366c",path:"/docs/arfs/usage/create/create-snapshot.html"},{title:"All ArDrive CLI Commands",frontmatter:{},regularPath:"/docs/cli/all-commands.html",relativePath:"docs/cli/all-commands.md",key:"v-47c1f97a",path:"/docs/cli/all-commands.html"},{title:"Read ArFS Data",frontmatter:{permalink:"/docs/arfs/usage/read/"},regularPath:"/docs/arfs/usage/read/read-operations.html",relativePath:"docs/arfs/usage/read/read-operations.md",key:"v-950c4d48",path:"/docs/arfs/usage/read/",headers:[{level:2,title:"Folder/File Paths",slug:"folder-file-paths"},{level:2,title:"Folder View Queries",slug:"folder-view-queries"}]},{title:"Extending Schemas",frontmatter:{next:!1},regularPath:"/docs/arfs/usage/extending-schemas.html",relativePath:"docs/arfs/usage/extending-schemas.md",key:"v-0877efcc",path:"/docs/arfs/usage/extending-schemas.html",headers:[{level:2,title:"Extending Schemas",slug:"extending-schemas"}]},{title:"Getting Help",frontmatter:{},regularPath:"/docs/cli/getting-help.html",relativePath:"docs/cli/getting-help.md",key:"v-4fad50ba",path:"/docs/cli/getting-help.html"},{title:"CLI",frontmatter:{homepage:!0,permalink:"/docs/cli/"},regularPath:"/docs/cli/intro.html",relativePath:"docs/cli/intro.md",key:"v-31657474",path:"/docs/cli/",headers:[{level:2,title:"ArFS",slug:"arfs"},{level:2,title:"Data Portability",slug:"data-portability"},{level:2,title:"Intended Audience",slug:"intended-audience"}]},{title:"Getting Started",frontmatter:{},regularPath:"/docs/cli/getting-started.html",relativePath:"docs/cli/getting-started.md",key:"v-4fc0d1c8",path:"/docs/cli/getting-started.html",headers:[{level:2,title:"Prerequisites",slug:"prerequisites"},{level:3,title:"Git",slug:"git"},{level:3,title:"NVM (Optional - Recommended)",slug:"nvm-optional-recommended"},{level:2,title:"Quick Start",slug:"quick-start"},{level:3,title:"Installing and Starting the CLI From NPM Package",slug:"installing-and-starting-the-cli-from-npm-package"},{level:3,title:"Upgrading to the Latest Version",slug:"upgrading-to-the-latest-version"},{level:2,title:"Build and Run from Source",slug:"build-and-run-from-source"},{level:3,title:"Install Yarn 3",slug:"install-yarn-3"},{level:3,title:"Husky (Developers Only)",slug:"husky-developers-only"},{level:3,title:"Using a custom ArDrive-Core-JS (Optional)",slug:"using-a-custom-ardrive-core-js-optional"},{level:3,title:"Installing and Starting the CLI From Source",slug:"installing-and-starting-the-cli-from-source"},{level:3,title:"Recommended Visual Studio Code extensions (Developers Only)",slug:"recommended-visual-studio-code-extensions-developers-only"},{level:2,title:"Limitations",slug:"limitations"}]},{title:"Overview",frontmatter:{},regularPath:"/docs/core-sdk.html",relativePath:"docs/core-sdk.md",key:"v-0c3bd15a",path:"/docs/core-sdk.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Integrating with ArDrive Core",slug:"integrating-with-ardrive-core"},{level:2,title:"Development Environment Setup",slug:"development-environment-setup"},{level:3,title:"Recommended Visual Studio Code extensions",slug:"recommended-visual-studio-code-extensions"},{level:2,title:"Building the Library",slug:"building-the-library"},{level:2,title:"Testing the Library",slug:"testing-the-library"},{level:3,title:"Coverage",slug:"coverage"},{level:3,title:"Adding tests",slug:"adding-tests"},{level:3,title:"Using Sinon",slug:"using-sinon"},{level:3,title:"Debugging with Power-Assert",slug:"debugging-with-power-assert"},{level:3,title:"Progress Logging of Transaction Uploads",slug:"progress-logging-of-transaction-uploads"},{level:3,title:"Persistent Caching of ArFS Entity Metadata",slug:"persistent-caching-of-arfs-entity-metadata"},{level:3,title:"Applying Custom MetaData to ArFS File Transactions",slug:"applying-custom-metadata-to-arfs-file-transactions"}]},{title:"Using the CLI",frontmatter:{sidebarDepth:1},regularPath:"/docs/cli/using-the-cli.html",relativePath:"docs/cli/using-the-cli.md",key:"v-e2784654",path:"/docs/cli/using-the-cli.html",headers:[{level:2,title:"CLI Help",slug:"cli-help"},{level:2,title:"CLI Version",slug:"cli-version"},{level:2,title:"Wallet Operations",slug:"wallet-operations"},{level:2,title:"Working With Entities",slug:"working-with-entities"},{level:3,title:"Dry Run",slug:"dry-run"},{level:3,title:"Uploading to Turbo (BETA)",slug:"uploading-to-turbo-beta"},{level:2,title:"Working With Drives",slug:"working-with-drives"},{level:3,title:"Understanding Drive Hierarchies",slug:"understanding-drive-hierarchies"},{level:3,title:"Understanding Drive and File Keys",slug:"understanding-drive-and-file-keys"},{level:3,title:"Managing Drive Passwords",slug:"managing-drive-passwords"},{level:3,title:"Creating Drives",slug:"creating-drives"},{level:3,title:"Listing Drives for an Address",slug:"listing-drives-for-an-address"},{level:3,title:"Listing Every Entity in a Drive",slug:"listing-every-entity-in-a-drive"},{level:3,title:"List Drive Pipeline Examples",slug:"list-drive-pipeline-examples"},{level:2,title:"Working With Folders",slug:"working-with-folders"},{level:3,title:"Creating Folders",slug:"creating-folders"},{level:3,title:"Moving Folders",slug:"moving-folders"},{level:3,title:"Renaming Folders",slug:"renaming-folders"},{level:3,title:"Viewing Folder Metadata",slug:"viewing-folder-metadata"},{level:3,title:"Listing Contents of a Folder",slug:"listing-contents-of-a-folder"},{level:2,title:"Working With Files",slug:"working-with-files"},{level:3,title:"Uploading a Single File",slug:"uploading-a-single-file"},{level:3,title:"IPFS CID Tagging",slug:"ipfs-cid-tagging"},{level:3,title:"Progress Logging of Transaction Uploads",slug:"progress-logging-of-transaction-uploads"},{level:3,title:"Download a Single file (BETA)",slug:"download-a-single-file-beta"},{level:3,title:"Rename a Single File",slug:"rename-a-single-file"},{level:3,title:"Uploading a Folder with Files (Bulk Upload)",slug:"uploading-a-folder-with-files-bulk-upload"},{level:3,title:"Downloading a Folder with Files",slug:"downloading-a-folder-with-files"},{level:3,title:"Downloading a Drive",slug:"downloading-a-drive"},{level:3,title:"Uploading Multiple Files",slug:"uploading-multiple-files"},{level:3,title:"Name Conflict Resolution on Upload",slug:"name-conflict-resolution-on-upload"},{level:3,title:"Understanding Bundled Transactions",slug:"understanding-bundled-transactions"},{level:3,title:"Uploading a Non-Bundled Transaction (NOT RECOMMENDED)",slug:"uploading-a-non-bundled-transaction-not-recommended"},{level:3,title:"Fetching the Metadata of a File Entity",slug:"fetching-the-metadata-of-a-file-entity"},{level:3,title:"Retrying a Failed File Data Transaction (Public Unbundled Files Only)",slug:"retrying-a-failed-file-data-transaction-public-unbundled-files-only"},{level:3,title:"Moving Files",slug:"moving-files"},{level:3,title:"Uploading Manifests",slug:"uploading-manifests"},{level:3,title:"Uploading With a Custom Content Type",slug:"uploading-with-a-custom-content-type"},{level:3,title:"Uploading From a Remote URL",slug:"uploading-from-a-remote-url"},{level:3,title:"Uploading a Custom Manifest",slug:"uploading-a-custom-manifest"},{level:3,title:"Uploading Files with Custom MetaData",slug:"uploading-files-with-custom-metadata"},{level:2,title:"Other Utility Operations",slug:"other-utility-operations"},{level:3,title:"Monitoring Transactions",slug:"monitoring-transactions"},{level:3,title:"Dealing With Network Congestion",slug:"dealing-with-network-congestion"},{level:3,title:"Using a Custom Arweave Gateway",slug:"using-a-custom-arweave-gateway"},{level:3,title:"Persistent Caching of ArFS Entity Metadata",slug:"persistent-caching-of-arfs-entity-metadata"}]},{title:"Deploying your dApp",frontmatter:{},regularPath:"/docs/misc/deploy/deploy.html",relativePath:"docs/misc/deploy/deploy.md",key:"v-84e0b14c",path:"/docs/misc/deploy/deploy.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Deploying",slug:"deploying"},{level:3,title:"Step 1: Log into ArDrive",slug:"step-1-log-into-ardrive"},{level:3,title:"Step 2: Select or Create a Drive",slug:"step-2-select-or-create-a-drive"},{level:3,title:"Step 3: Upload your project",slug:"step-3-upload-your-project"},{level:3,title:"Step 4: Confirm Upload",slug:"step-4-confirm-upload"},{level:3,title:"Step 5: Create the Manifest",slug:"step-5-create-the-manifest"},{level:3,title:"Step 6: Get the Data TX ID",slug:"step-6-get-the-data-tx-id"},{level:3,title:"Step 7: View and Share your dApp",slug:"step-7-view-and-share-your-dapp"},{level:2,title:"Updating your dApp",slug:"updating-your-dapp"}]},{title:"Examples",frontmatter:{},regularPath:"/docs/misc/deploy/examples.html",relativePath:"docs/misc/deploy/examples.md",key:"v-074d53cc",path:"/docs/misc/deploy/examples.html",headers:[{level:2,title:"Basic HTML",slug:"basic-html"},{level:2,title:"React",slug:"react"},{level:2,title:"Next",slug:"next"},{level:2,title:"WordPress",slug:"wordpress"}]},{title:"Preparing Your dApp",frontmatter:{prev:!1,permalink:"/docs/misc/deploy/"},regularPath:"/docs/misc/deploy/prepare.html",relativePath:"docs/misc/deploy/prepare.md",key:"v-3e6ef1ac",path:"/docs/misc/deploy/"},{title:"Hash Routing",frontmatter:{},regularPath:"/docs/misc/deploy/routing.html",relativePath:"docs/misc/deploy/routing.md",key:"v-6dd912ec",path:"/docs/misc/deploy/routing.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Hash Routing Vs. History Routing",slug:"hash-routing-vs-history-routing"},{level:2,title:"Why Hash Routing for dApps",slug:"why-hash-routing-for-dapps"}]},{title:"How to Save a Website Permanently",frontmatter:{},regularPath:"/docs/misc/permasite.html",relativePath:"docs/misc/permasite.md",key:"v-3258450c",path:"/docs/misc/permasite.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"1. Download Static Site Files",slug:"_1-download-static-site-files"},{level:3,title:"Windows Users",slug:"windows-users"},{level:3,title:"Mac Users",slug:"mac-users"},{level:3,title:"Command Line Utility",slug:"command-line-utility"},{level:3,title:"WordPress",slug:"wordpress"},{level:2,title:"2. Create an Account on ArDrive",slug:"_2-create-an-account-on-ardrive"},{level:2,title:"3. Create a New Public Drive",slug:"_3-create-a-new-public-drive"},{level:2,title:"4. Top Up",slug:"_4-top-up"},{level:2,title:"5. Upload Static Files",slug:"_5-upload-static-files"},{level:2,title:"6. Wait",slug:"_6-wait"},{level:2,title:"7. Create a Manifest",slug:"_7-create-a-manifest"},{level:2,title:"8. Wait Again",slug:"_8-wait-again"},{level:2,title:"9. Preview the Manifest",slug:"_9-preview-the-manifest"},{level:2,title:"10. Add a Redirect or Domain Masking",slug:"_10-add-a-redirect-or-domain-masking"},{level:2,title:"Notes",slug:"notes"},{level:2,title:"Other Use Cases",slug:"other-use-cases"},{level:2,title:"Example",slug:"example"}]},{title:"File Paths",frontmatter:{},regularPath:"/docs/misc/deploy/paths.html",relativePath:"docs/misc/deploy/paths.md",key:"v-0d650648",path:"/docs/misc/deploy/paths.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Absolute Vs. Relative",slug:"absolute-vs-relative"},{level:2,title:"Why Relative Paths",slug:"why-relative-paths"},{level:2,title:"Identifying Relative and Absolute Paths",slug:"identifying-relative-and-absolute-paths"},{level:2,title:"Navigating with Relative Paths",slug:"navigating-with-relative-paths"}]},{title:"ArDrive Price Calculator",frontmatter:{prev:!1,next:!1},regularPath:"/docs/misc/price-calculator.html",relativePath:"docs/misc/price-calculator.md",key:"v-a6e64848",path:"/docs/misc/price-calculator.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Developer Setup",slug:"developer-setup"},{level:3,title:"Install Yarn 2",slug:"install-yarn-2"},{level:3,title:"NVM",slug:"nvm"},{level:3,title:"Recommended Visual Studio Code extensions",slug:"recommended-visual-studio-code-extensions"},{level:2,title:"Available Scripts",slug:"available-scripts"},{level:3,title:"yarn start",slug:"yarn-start"},{level:3,title:"yarn build",slug:"yarn-build"},{level:3,title:"yarn test",slug:"yarn-test"},{level:3,title:"yarn run:prod",slug:"yarn-run-prod"}]},{title:"placeholder",frontmatter:{},regularPath:"/docs/",relativePath:"docs/readme.md",key:"v-35b0f3b1",path:"/docs/"},{title:"Migrating to Turbo From Irys",frontmatter:{next:!1},regularPath:"/docs/turbo/migrating.html",relativePath:"docs/turbo/migrating.md",key:"v-45095440",path:"/docs/turbo/migrating.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Using Irys SDK with Turbo",slug:"using-irys-sdk-with-turbo"},{level:2,title:"Using Irys CLI with Turbo",slug:"using-irys-cli-with-turbo"},{level:2,title:"Differences",slug:"differences"},{level:3,title:"Crypto Top Ups / Withdrawals",slug:"crypto-top-ups-withdrawals"},{level:2,title:"Wallet Extensions and Providers",slug:"wallet-extensions-and-providers"},{level:2,title:"GraphQL",slug:"graphql"}]},{title:"Upload API",frontmatter:{next:!1},regularPath:"/docs/turbo/api/upload.html",relativePath:"docs/turbo/api/upload.md",key:"v-57c590fa",path:"/docs/turbo/api/upload.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Endpoint",slug:"endpoint"},{level:2,title:"Schema",slug:"schema"},{level:3,title:"Headers",slug:"headers"},{level:3,title:"Body",slug:"body"},{level:3,title:"Response",slug:"response"}]},{title:"@ardriveapp/turbo-sdk 🚀",frontmatter:{},regularPath:"/docs/turbo/turbo-sdk/",relativePath:"docs/turbo/turbo-sdk/index.md",key:"v-d297eaa6",path:"/docs/turbo/turbo-sdk/",headers:[{level:2,title:"Installation",slug:"installation"},{level:2,title:"Quick Start",slug:"quick-start"},{level:2,title:"Usage",slug:"usage"},{level:3,title:"Web",slug:"web"},{level:3,title:"NodeJS",slug:"nodejs"},{level:3,title:"Typescript",slug:"typescript"},{level:2,title:"APIs",slug:"apis"},{level:3,title:"TurboFactory",slug:"turbofactory"},{level:3,title:"TurboUnauthenticatedClient",slug:"turbounauthenticatedclient"},{level:3,title:"TurboAuthenticatedClient",slug:"turboauthenticatedclient"},{level:2,title:"Contributions",slug:"contributions"}]},{title:"Turbo SDK Release Notes",frontmatter:{},regularPath:"/docs/turbo/turbo-sdk/release-notes.html",relativePath:"docs/turbo/turbo-sdk/release-notes.md",key:"v-f81e553c",path:"/docs/turbo/turbo-sdk/release-notes.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Releases",slug:"releases"},{level:3,title:"V1.3.0",slug:"v1-3-0"},{level:3,title:"V1.2.0",slug:"v1-2-0"},{level:3,title:"V1.1.1",slug:"v1-1-1"},{level:3,title:"V1.1.0",slug:"v1-1-0"},{level:3,title:"V1.0.2",slug:"v1-0-2"},{level:3,title:"V1.0.1",slug:"v1-0-1"},{level:3,title:"V1.0.0",slug:"v1-0-0"}]},{title:"Payment API",frontmatter:{},regularPath:"/docs/turbo/api/payment.html",relativePath:"docs/turbo/api/payment.md",key:"v-e65ea9a4",path:"/docs/turbo/api/payment.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Endpoints",slug:"endpoints"},{level:3,title:"Get Amount of Credits for Byte Count",slug:"get-amount-of-credits-for-byte-count"},{level:3,title:"Get winc for Payment Type and Amount",slug:"get-winc-for-payment-type-and-amount"},{level:3,title:"Get Current Balance of winc",slug:"get-current-balance-of-winc"},{level:3,title:"Get Quote for Credits",slug:"get-quote-for-credits"},{level:3,title:"Get Supported Currencies",slug:"get-supported-currencies"},{level:3,title:"Get Supported Countries",slug:"get-supported-countries"},{level:3,title:"Get Conversion Rates",slug:"get-conversion-rates"}]},{title:"Using Turbo SDK in a Browser Environment",frontmatter:{},regularPath:"/docs/turbo/turbo-sdk/turbo-web.html",relativePath:"docs/turbo/turbo-sdk/turbo-web.md",key:"v-7cc2c9e4",path:"/docs/turbo/turbo-sdk/turbo-web.html",headers:[{level:2,title:"Overview",slug:"overview"}]},{title:"What Is Turbo?",frontmatter:{prev:!1},regularPath:"/docs/turbo/what-is-turbo.html",relativePath:"docs/turbo/what-is-turbo.md",key:"v-5d3101c8",path:"/docs/turbo/what-is-turbo.html"},{title:"About ArDrive",frontmatter:{homepage:!0},regularPath:"/",relativePath:"index.md",key:"v-501d8193",path:"/",headers:[{level:2,title:"Control Your Own Data",slug:"control-your-own-data"},{level:3,title:"True Data Ownership",slug:"true-data-ownership"},{level:3,title:"No More Lost Data",slug:"no-more-lost-data"},{level:3,title:"Decentralized Network",slug:"decentralized-network"},{level:3,title:"Community Owned",slug:"community-owned"},{level:2,title:"How can Ardrive Help You?",slug:"how-can-ardrive-help-you"},{level:3,title:"Store Family Memories Forever",slug:"store-family-memories-forever"},{level:3,title:"Permanence",slug:"permanence"},{level:3,title:"Totally Private or Totally Public",slug:"totally-private-or-totally-public"},{level:3,title:"Eliminate Subscription Fees",slug:"eliminate-subscription-fees"},{level:3,title:"Control Your Data",slug:"control-your-data"},{level:3,title:"Perfect Record Keeping",slug:"perfect-record-keeping"},{level:3,title:"Durable NFTs",slug:"durable-nfts"},{level:3,title:"Archive the Web",slug:"archive-the-web"}]}],themeConfig:{searchPlaceholder:"Search",repo:"",editLinks:!1,docsDir:"",editLinkText:"",lastUpdated:!1,initialOpenGroupIndex:-1,logo:"/images/ArDrive-Logo.png",sidebar:{"/":[{title:"Core-js",path:"/docs/core-sdk"},{title:"CLI",initialOpenGroupIndex:-1,collapsable:!0,children:[{title:"Overview",path:"/docs/cli/intro"},{title:"Getting Started",path:"/docs/cli/getting-started"},{title:"Using the CLI",path:"/docs/cli/using-the-cli"},{title:"All Commands",path:"/docs/cli/all-commands"},{title:"Help",path:"/docs/cli/getting-help"}]},{title:"ArFS",initialOpenGroupIndex:-1,children:[{title:"Overview",path:"/docs/arfs/overview"},{title:"Data Model",path:"/docs/arfs/data-model"},{title:"Entity Types",path:"/docs/arfs/entity-types"},{title:"Schema Diagrams",path:"/docs/arfs/schema-diagrams"},{title:"Content Types",path:"/docs/arfs/content-types"},{title:"Privacy",path:"/docs/arfs/privacy"},{title:"Usage",children:[{title:"Create",children:[{title:"Create Drive",path:"/docs/arfs/usage/create/create-drive"},{title:"Create Folder",path:"/docs/arfs/usage/create/create-folder"},{title:"Create File",path:"/docs/arfs/usage/create/create-file"}]},{title:"Modify",children:[{title:"Modify Drives",path:"/docs/arfs/usage/change/drives"},{title:"Modify Folders",path:"/docs/arfs/usage/change/folders"},{title:"Modify Files",path:"/docs/arfs/usage/change/files"}]},{title:"Read",path:"/docs/arfs/usage/read/read-operations"},{title:"Extending Schemas",path:"/docs/arfs/usage/extending-schemas"}]}]},{title:"Turbo",sidebarDepth:2,children:[{title:"What is Turbo?",path:"/docs/turbo/what-is-turbo"},{title:"Payment API",path:"/docs/turbo/api/payment"},{title:"Upload API",path:"/docs/turbo/api/upload"},{title:"Turbo SDK",path:"/docs/turbo/turbo-sdk/"},{title:"Turbo SDK Release Notes",path:"/docs/turbo/turbo-sdk/release-notes"},{title:"Migrating From Irys",path:"/docs/turbo/migrating"}]},{title:"Misc.",children:[{title:"Permasites",path:"/docs/misc/permasite"},{title:"Price Calculator",path:"/docs/misc/price-calculator"},{title:"How to Deploy a dApp",children:[{title:"Preparing your dApp",path:"/docs/misc/deploy/prepare"},{title:"Hash Routing",path:"/docs/misc/deploy/routing"},{title:"Relative File Paths",path:"/docs/misc/deploy/paths"},{title:"How to Deploy",path:"/docs/misc/deploy/deploy"},{title:"Examples",path:"/docs/misc/deploy/examples"}]}]}]}}};function Bs(){return"undefined"!=typeof navigator&&"undefined"!=typeof window?window:"undefined"!=typeof global?global:{}}const zs="function"==typeof Proxy;let Hs,Ws;function qs(){return void 0!==Hs||("undefined"!=typeof window&&window.performance?(Hs=!0,Ws=window.performance):"undefined"!=typeof global&&(null===(t=global.perf_hooks)||void 0===t?void 0:t.performance)?(Hs=!0,Ws=global.perf_hooks.performance):Hs=!1),Hs?Ws.now():Date.now();var t}class Gs{constructor(t,e){this.target=null,this.targetQueue=[],this.onQueue=[],this.plugin=t,this.hook=e;const n={};if(t.settings)for(const e in t.settings){const r=t.settings[e];n[e]=r.defaultValue}const r="__vue-devtools-plugin-settings__"+t.id;let o=Object.assign({},n);try{const t=localStorage.getItem(r),e=JSON.parse(t);Object.assign(o,e)}catch(t){}this.fallbacks={getSettings:()=>o,setSettings(t){try{localStorage.setItem(r,JSON.stringify(t))}catch(t){}o=t},now:()=>qs()},e&&e.on("plugin:settings:set",(t,e)=>{t===this.plugin.id&&this.fallbacks.setSettings(e)}),this.proxiedOn=new Proxy({},{get:(t,e)=>this.target?this.target.on[e]:(...t)=>{this.onQueue.push({method:e,args:t})}}),this.proxiedTarget=new Proxy({},{get:(t,e)=>this.target?this.target[e]:"on"===e?this.proxiedOn:Object.keys(this.fallbacks).includes(e)?(...t)=>(this.targetQueue.push({method:e,args:t,resolve:()=>{}}),this.fallbacks[e](...t)):(...t)=>new Promise(n=>{this.targetQueue.push({method:e,args:t,resolve:n})})})}async setRealTarget(t){this.target=t;for(const t of this.onQueue)this.target.on[t.method](...t.args);for(const t of this.targetQueue)t.resolve(await this.target[t.method](...t.args))}}function Ks(t,e){const n=t,r=Bs(),o=Bs().__VUE_DEVTOOLS_GLOBAL_HOOK__,i=zs&&n.enableEarlyProxy;if(!o||!r.__VUE_DEVTOOLS_PLUGIN_API_AVAILABLE__&&i){const t=i?new Gs(n,o):null;(r.__VUE_DEVTOOLS_PLUGINS__=r.__VUE_DEVTOOLS_PLUGINS__||[]).push({pluginDescriptor:n,setupFn:e,proxy:t}),t&&e(t.proxiedTarget)}else o.emit("devtools-plugin:setup",t,e)} /*! * vuex v4.1.0 * (c) 2022 Evan You * @license MIT - */function Qs(t,e){if(void 0===e&&(e=[]),null===t||"object"!=typeof t)return t;var n,r=(n=function(e){return e.original===t},e.filter(n)[0]);if(r)return r.copy;var o=Array.isArray(t)?[]:{};return e.push({original:t,copy:o}),Object.keys(t).forEach((function(n){o[n]=Qs(t[n],e)})),o}function Js(t,e){Object.keys(t).forEach((function(n){return e(t[n],n)}))}function Ys(t){return null!==t&&"object"==typeof t}function Xs(t,e){if(!t)throw new Error("[vuex] "+e)}function Zs(t,e,n){return e.indexOf(t)<0&&(n&&n.prepend?e.unshift(t):e.push(t)),function(){var n=e.indexOf(t);n>-1&&e.splice(n,1)}}function tc(t,e){t._actions=Object.create(null),t._mutations=Object.create(null),t._wrappedGetters=Object.create(null),t._modulesNamespaceMap=Object.create(null);var n=t.state;nc(t,n,[],t._modules.root,!0),ec(t,n,e)}function ec(t,e,n){var r=t._state,o=t._scope;t.getters={},t._makeLocalGettersCache=Object.create(null);var i,a=t._wrappedGetters,s={},c={},l=new Qt(!0);l.run((function(){Js(a,(function(e,n){s[n]=function(t,e){return function(){return t(e)}}(e,t),c[n]=function(t,e){var n,r,o=u(t);o?(n=t,r=L):(n=t.get,r=t.set);var i=it()?null:new Xe(lt,n,L,{lazy:!0}),a={effect:i,get value(){return i?(i.dirty&&i.evaluate(),yt.target&&i.depend(),i.value):n()},set value(t){r(t)}};return W(a,"__v_isRef",!0),W(a,"__v_isReadonly",o),a}((function(){return s[n]()})),Object.defineProperty(t.getters,n,{get:function(){return c[n].value},enumerable:!0})}))})),t._state=(It(i={data:e},!1),i),t._scope=l,t.strict&&function(t){Gt((function(){return t._state.data}),(function(){Xs(t._committing,"do not mutate vuex store state outside mutation handlers.")}),{deep:!0,flush:"sync"})}(t),r&&n&&t._withCommit((function(){r.data=null})),o&&o.stop()}function nc(t,e,n,r,o){var i=!n.length,a=t._modules.getNamespace(n);if(r.namespaced&&(t._modulesNamespaceMap[a]&&console.error("[vuex] duplicate namespace "+a+" for the namespaced module "+n.join("/")),t._modulesNamespaceMap[a]=r),!i&&!o){var s=oc(e,n.slice(0,-1)),c=n[n.length-1];t._withCommit((function(){c in s&&console.warn('[vuex] state field "'+c+'" was overridden by a module with the same name at "'+n.join(".")+'"'),s[c]=r.state}))}var u=r.context=function(t,e,n){var r=""===e,o={dispatch:r?t.dispatch:function(n,r,o){var i=ic(n,r,o),a=i.payload,s=i.options,c=i.type;if(s&&s.root||(c=e+c,t._actions[c]))return t.dispatch(c,a);console.error("[vuex] unknown local action type: "+i.type+", global type: "+c)},commit:r?t.commit:function(n,r,o){var i=ic(n,r,o),a=i.payload,s=i.options,c=i.type;s&&s.root||(c=e+c,t._mutations[c])?t.commit(c,a,s):console.error("[vuex] unknown local mutation type: "+i.type+", global type: "+c)}};return Object.defineProperties(o,{getters:{get:r?function(){return t.getters}:function(){return rc(t,e)}},state:{get:function(){return oc(t.state,n)}}}),o}(t,a,n);r.forEachMutation((function(e,n){!function(t,e,n,r){(t._mutations[e]||(t._mutations[e]=[])).push((function(e){n.call(t,r.state,e)}))}(t,a+n,e,u)})),r.forEachAction((function(e,n){var r=e.root?n:a+n,o=e.handler||e;!function(t,e,n,r){(t._actions[e]||(t._actions[e]=[])).push((function(e){var o,i=n.call(t,{dispatch:r.dispatch,commit:r.commit,getters:r.getters,state:r.state,rootGetters:t.getters,rootState:t.state},e);return(o=i)&&"function"==typeof o.then||(i=Promise.resolve(i)),t._devtoolHook?i.catch((function(e){throw t._devtoolHook.emit("vuex:error",e),e})):i}))}(t,r,o,u)})),r.forEachGetter((function(e,n){!function(t,e,n,r){if(t._wrappedGetters[e])return void console.error("[vuex] duplicate getter key: "+e);t._wrappedGetters[e]=function(t){return n(r.state,r.getters,t.state,t.getters)}}(t,a+n,e,u)})),r.forEachChild((function(r,i){nc(t,e,n.concat(i),r,o)}))}function rc(t,e){if(!t._makeLocalGettersCache[e]){var n={},r=e.length;Object.keys(t.getters).forEach((function(o){if(o.slice(0,r)===e){var i=o.slice(r);Object.defineProperty(n,i,{get:function(){return t.getters[o]},enumerable:!0})}})),t._makeLocalGettersCache[e]=n}return t._makeLocalGettersCache[e]}function oc(t,e){return e.reduce((function(t,e){return t[e]}),t)}function ic(t,e,n){return Ys(t)&&t.type&&(n=e,e=t,t=t.type),Xs("string"==typeof t,"expects string as the type, but found "+typeof t+"."),{type:t,payload:e,options:n}}var ac=0;function sc(t,e){Ks({id:"org.vuejs.vuex",app:t,label:"Vuex",homepage:"https://next.vuex.vuejs.org/",logo:"https://vuejs.org/images/icons/favicon-96x96.png",packageName:"vuex",componentStateTypes:["vuex bindings"]},(function(n){n.addTimelineLayer({id:"vuex:mutations",label:"Vuex Mutations",color:cc}),n.addTimelineLayer({id:"vuex:actions",label:"Vuex Actions",color:cc}),n.addInspector({id:"vuex",label:"Vuex",icon:"storage",treeFilterPlaceholder:"Filter stores..."}),n.on.getInspectorTree((function(n){if(n.app===t&&"vuex"===n.inspectorId)if(n.filter){var r=[];!function t(e,n,r,o){o.includes(r)&&e.push({id:o||"root",label:o.endsWith("/")?o.slice(0,o.length-1):o||"Root",tags:n.namespaced?[uc]:[]});Object.keys(n._children).forEach((function(i){t(e,n._children[i],r,o+i+"/")}))}(r,e._modules.root,n.filter,""),n.rootNodes=r}else n.rootNodes=[fc(e._modules.root,"")]})),n.on.getInspectorState((function(n){if(n.app===t&&"vuex"===n.inspectorId){var r=n.nodeId;rc(e,r),n.state=function(t,e,n){e="root"===n?e:e[n];var r=Object.keys(e),o={state:Object.keys(t.state).map((function(e){return{key:e,editable:!0,value:t.state[e]}}))};if(r.length){var i=function(t){var e={};return Object.keys(t).forEach((function(n){var r=n.split("/");if(r.length>1){var o=e,i=r.pop();r.forEach((function(t){o[t]||(o[t]={_custom:{value:{},display:t,tooltip:"Module",abstract:!0}}),o=o[t]._custom.value})),o[i]=pc((function(){return t[n]}))}else e[n]=pc((function(){return t[n]}))})),e}(e);o.getters=Object.keys(i).map((function(t){return{key:t.endsWith("/")?lc(t):t,editable:!1,value:pc((function(){return i[t]}))}}))}return o}((o=e._modules,(a=(i=r).split("/").filter((function(t){return t}))).reduce((function(t,e,n){var r=t[e];if(!r)throw new Error('Missing module "'+e+'" for path "'+i+'".');return n===a.length-1?r:r._children}),"root"===i?o:o.root._children)),"root"===r?e.getters:e._makeLocalGettersCache,r)}var o,i,a})),n.on.editInspectorState((function(n){if(n.app===t&&"vuex"===n.inspectorId){var r=n.nodeId,o=n.path;"root"!==r&&(o=r.split("/").filter(Boolean).concat(o)),e._withCommit((function(){n.set(e._state.data,o,n.state.value)}))}})),e.subscribe((function(t,e){var r={};t.payload&&(r.payload=t.payload),r.state=e,n.notifyComponentUpdate(),n.sendInspectorTree("vuex"),n.sendInspectorState("vuex"),n.addTimelineEvent({layerId:"vuex:mutations",event:{time:Date.now(),title:t.type,data:r}})})),e.subscribeAction({before:function(t,e){var r={};t.payload&&(r.payload=t.payload),t._id=ac++,t._time=Date.now(),r.state=e,n.addTimelineEvent({layerId:"vuex:actions",event:{time:t._time,title:t.type,groupId:t._id,subtitle:"start",data:r}})},after:function(t,e){var r={},o=Date.now()-t._time;r.duration={_custom:{type:"duration",display:o+"ms",tooltip:"Action duration",value:o}},t.payload&&(r.payload=t.payload),r.state=e,n.addTimelineEvent({layerId:"vuex:actions",event:{time:Date.now(),title:t.type,groupId:t._id,subtitle:"end",data:r}})}})}))}var cc=8702998,uc={label:"namespaced",textColor:16777215,backgroundColor:6710886};function lc(t){return t&&"root"!==t?t.split("/").slice(-2,-1)[0]:"Root"}function fc(t,e){return{id:e||"root",label:lc(e),tags:t.namespaced?[uc]:[],children:Object.keys(t._children).map((function(n){return fc(t._children[n],e+n+"/")}))}}function pc(t){try{return t()}catch(t){return t}}var dc=function(t,e){this.runtime=e,this._children=Object.create(null),this._rawModule=t;var n=t.state;this.state=("function"==typeof n?n():n)||{}},hc={namespaced:{configurable:!0}};hc.namespaced.get=function(){return!!this._rawModule.namespaced},dc.prototype.addChild=function(t,e){this._children[t]=e},dc.prototype.removeChild=function(t){delete this._children[t]},dc.prototype.getChild=function(t){return this._children[t]},dc.prototype.hasChild=function(t){return t in this._children},dc.prototype.update=function(t){this._rawModule.namespaced=t.namespaced,t.actions&&(this._rawModule.actions=t.actions),t.mutations&&(this._rawModule.mutations=t.mutations),t.getters&&(this._rawModule.getters=t.getters)},dc.prototype.forEachChild=function(t){Js(this._children,t)},dc.prototype.forEachGetter=function(t){this._rawModule.getters&&Js(this._rawModule.getters,t)},dc.prototype.forEachAction=function(t){this._rawModule.actions&&Js(this._rawModule.actions,t)},dc.prototype.forEachMutation=function(t){this._rawModule.mutations&&Js(this._rawModule.mutations,t)},Object.defineProperties(dc.prototype,hc);var vc=function(t){this.register([],t,!1)};vc.prototype.get=function(t){return t.reduce((function(t,e){return t.getChild(e)}),this.root)},vc.prototype.getNamespace=function(t){var e=this.root;return t.reduce((function(t,n){return t+((e=e.getChild(n)).namespaced?n+"/":"")}),"")},vc.prototype.update=function(t){!function t(e,n,r){if(yc(e,r),n.update(r),r.modules)for(var o in r.modules){if(!n.getChild(o))return void console.warn("[vuex] trying to add a new module '"+o+"' on hot reloading, manual reload is needed");t(e.concat(o),n.getChild(o),r.modules[o])}}([],this.root,t)},vc.prototype.register=function(t,e,n){var r=this;void 0===n&&(n=!0),yc(t,e);var o=new dc(e,n);0===t.length?this.root=o:this.get(t.slice(0,-1)).addChild(t[t.length-1],o);e.modules&&Js(e.modules,(function(e,o){r.register(t.concat(o),e,n)}))},vc.prototype.unregister=function(t){var e=this.get(t.slice(0,-1)),n=t[t.length-1],r=e.getChild(n);r?r.runtime&&e.removeChild(n):console.warn("[vuex] trying to unregister module '"+n+"', which is not registered")},vc.prototype.isRegistered=function(t){var e=this.get(t.slice(0,-1)),n=t[t.length-1];return!!e&&e.hasChild(n)};var gc={assert:function(t){return"function"==typeof t},expected:"function"},mc={getters:gc,mutations:gc,actions:{assert:function(t){return"function"==typeof t||"object"==typeof t&&"function"==typeof t.handler},expected:'function or object with "handler" function'}};function yc(t,e){Object.keys(mc).forEach((function(n){if(e[n]){var r=mc[n];Js(e[n],(function(e,o){Xs(r.assert(e),function(t,e,n,r,o){var i=e+" should be "+o+' but "'+e+"."+n+'"';t.length>0&&(i+=' in module "'+t.join(".")+'"');return i+=" is "+JSON.stringify(r)+"."}(t,n,o,e,r.expected))}))}}))}var bc=function t(e){var n=this;void 0===e&&(e={}),Xs("undefined"!=typeof Promise,"vuex requires a Promise polyfill in this browser."),Xs(this instanceof t,"store must be called with the new operator.");var r=e.plugins;void 0===r&&(r=[]);var o=e.strict;void 0===o&&(o=!1);var i=e.devtools;this._committing=!1,this._actions=Object.create(null),this._actionSubscribers=[],this._mutations=Object.create(null),this._wrappedGetters=Object.create(null),this._modules=new vc(e),this._modulesNamespaceMap=Object.create(null),this._subscribers=[],this._makeLocalGettersCache=Object.create(null),this._scope=null,this._devtools=i;var a=this,s=this.dispatch,c=this.commit;this.dispatch=function(t,e){return s.call(a,t,e)},this.commit=function(t,e,n){return c.call(a,t,e,n)},this.strict=o;var u=this._modules.root.state;nc(this,u,[],this._modules.root),ec(this,u),r.forEach((function(t){return t(n)}))},_c={state:{configurable:!0}};bc.prototype.install=function(t,e){t.provide(e||"store",this),t.config.globalProperties.$store=this,(void 0===this._devtools||this._devtools)&&sc(t,this)},_c.state.get=function(){return this._state.data},_c.state.set=function(t){Xs(!1,"use store.replaceState() to explicit replace store state.")},bc.prototype.commit=function(t,e,n){var r=this,o=ic(t,e,n),i=o.type,a=o.payload,s=o.options,c={type:i,payload:a},u=this._mutations[i];u?(this._withCommit((function(){u.forEach((function(t){t(a)}))})),this._subscribers.slice().forEach((function(t){return t(c,r.state)})),s&&s.silent&&console.warn("[vuex] mutation type: "+i+". Silent option has been removed. Use the filter functionality in the vue-devtools")):console.error("[vuex] unknown mutation type: "+i)},bc.prototype.dispatch=function(t,e){var n=this,r=ic(t,e),o=r.type,i=r.payload,a={type:o,payload:i},s=this._actions[o];if(s){try{this._actionSubscribers.slice().filter((function(t){return t.before})).forEach((function(t){return t.before(a,n.state)}))}catch(t){console.warn("[vuex] error in before action subscribers: "),console.error(t)}var c=s.length>1?Promise.all(s.map((function(t){return t(i)}))):s[0](i);return new Promise((function(t,e){c.then((function(e){try{n._actionSubscribers.filter((function(t){return t.after})).forEach((function(t){return t.after(a,n.state)}))}catch(t){console.warn("[vuex] error in after action subscribers: "),console.error(t)}t(e)}),(function(t){try{n._actionSubscribers.filter((function(t){return t.error})).forEach((function(e){return e.error(a,n.state,t)}))}catch(t){console.warn("[vuex] error in error action subscribers: "),console.error(t)}e(t)}))}))}console.error("[vuex] unknown action type: "+o)},bc.prototype.subscribe=function(t,e){return Zs(t,this._subscribers,e)},bc.prototype.subscribeAction=function(t,e){return Zs("function"==typeof t?{before:t}:t,this._actionSubscribers,e)},bc.prototype.watch=function(t,e,n){var r=this;return Xs("function"==typeof t,"store.watch only accepts a function."),Gt((function(){return t(r.state,r.getters)}),e,Object.assign({},n))},bc.prototype.replaceState=function(t){var e=this;this._withCommit((function(){e._state.data=t}))},bc.prototype.registerModule=function(t,e,n){void 0===n&&(n={}),"string"==typeof t&&(t=[t]),Xs(Array.isArray(t),"module path must be a string or an Array."),Xs(t.length>0,"cannot register the root module by using registerModule."),this._modules.register(t,e),nc(this,this.state,t,this._modules.get(t),n.preserveState),ec(this,this.state)},bc.prototype.unregisterModule=function(t){var e=this;"string"==typeof t&&(t=[t]),Xs(Array.isArray(t),"module path must be a string or an Array."),this._modules.unregister(t),this._withCommit((function(){delete oc(e.state,t.slice(0,-1))[t[t.length-1]]})),tc(this)},bc.prototype.hasModule=function(t){return"string"==typeof t&&(t=[t]),Xs(Array.isArray(t),"module path must be a string or an Array."),this._modules.isRegistered(t)},bc.prototype.hotUpdate=function(t){this._modules.update(t),tc(this,!0)},bc.prototype._withCommit=function(t){var e=this._committing;this._committing=!0,t(),this._committing=e},Object.defineProperties(bc.prototype,_c);var wc=jc((function(t,e){var n={};return Sc(e)||console.error("[vuex] mapState: mapper parameter must be either an Array or an Object"),Cc(e).forEach((function(e){var r=e.key,o=e.val;n[r]=function(){var e=this.$store.state,n=this.$store.getters;if(t){var r=$c(this.$store,"mapState",t);if(!r)return;e=r.context.state,n=r.context.getters}return"function"==typeof o?o.call(this,e,n):e[o]},n[r].vuex=!0})),n})),xc=jc((function(t,e){var n={};return Sc(e)||console.error("[vuex] mapMutations: mapper parameter must be either an Array or an Object"),Cc(e).forEach((function(e){var r=e.key,o=e.val;n[r]=function(){for(var e=[],n=arguments.length;n--;)e[n]=arguments[n];var r=this.$store.commit;if(t){var i=$c(this.$store,"mapMutations",t);if(!i)return;r=i.context.commit}return"function"==typeof o?o.apply(this,[r].concat(e)):r.apply(this.$store,[o].concat(e))}})),n})),kc=jc((function(t,e){var n={};return Sc(e)||console.error("[vuex] mapGetters: mapper parameter must be either an Array or an Object"),Cc(e).forEach((function(e){var r=e.key,o=e.val;o=t+o,n[r]=function(){if(!t||$c(this.$store,"mapGetters",t)){if(o in this.$store.getters)return this.$store.getters[o];console.error("[vuex] unknown getter: "+o)}},n[r].vuex=!0})),n})),Oc=jc((function(t,e){var n={};return Sc(e)||console.error("[vuex] mapActions: mapper parameter must be either an Array or an Object"),Cc(e).forEach((function(e){var r=e.key,o=e.val;n[r]=function(){for(var e=[],n=arguments.length;n--;)e[n]=arguments[n];var r=this.$store.dispatch;if(t){var i=$c(this.$store,"mapActions",t);if(!i)return;r=i.context.dispatch}return"function"==typeof o?o.apply(this,[r].concat(e)):r.apply(this.$store,[o].concat(e))}})),n}));function Cc(t){return Sc(t)?Array.isArray(t)?t.map((function(t){return{key:t,val:t}})):Object.keys(t).map((function(e){return{key:e,val:t[e]}})):[]}function Sc(t){return Array.isArray(t)||Ys(t)}function jc(t){return function(e,n){return"string"!=typeof e?(n=e,e=""):"/"!==e.charAt(e.length-1)&&(e+="/"),t(e,n)}}function $c(t,e,n){var r=t._modulesNamespaceMap[n];return r||console.error("[vuex] module namespace not found in "+e+"(): "+n),r}function Ec(t,e,n){var r=n?t.groupCollapsed:t.group;try{r.call(t,e)}catch(n){t.log(e)}}function Pc(t){try{t.groupEnd()}catch(e){t.log("—— log end ——")}}function Ac(){var t=new Date;return" @ "+Tc(t.getHours(),2)+":"+Tc(t.getMinutes(),2)+":"+Tc(t.getSeconds(),2)+"."+Tc(t.getMilliseconds(),3)}function Tc(t,e){return n="0",r=e-t.toString().length,new Array(r+1).join(n)+t;var n,r}var Lc={version:"4.1.0",Store:bc,storeKey:"store",createStore:function(t){return new bc(t)},useStore:function(t){return void 0===t&&(t=null),function(t,e,n){void 0===n&&(n=!1);var r=lt;if(r){var o=r.$parent&&r.$parent._provided;if(o&&t in o)return o[t];if(arguments.length>1)return n&&u(e)?e.call(r):e}else 0}(null!==t?t:"store")},mapState:wc,mapMutations:xc,mapGetters:kc,mapActions:Oc,createNamespacedHelpers:function(t){return{mapState:wc.bind(null,t),mapGetters:kc.bind(null,t),mapMutations:xc.bind(null,t),mapActions:Oc.bind(null,t)}},createLogger:function(t){void 0===t&&(t={});var e=t.collapsed;void 0===e&&(e=!0);var n=t.filter;void 0===n&&(n=function(t,e,n){return!0});var r=t.transformer;void 0===r&&(r=function(t){return t});var o=t.mutationTransformer;void 0===o&&(o=function(t){return t});var i=t.actionFilter;void 0===i&&(i=function(t,e){return!0});var a=t.actionTransformer;void 0===a&&(a=function(t){return t});var s=t.logMutations;void 0===s&&(s=!0);var c=t.logActions;void 0===c&&(c=!0);var u=t.logger;return void 0===u&&(u=console),function(t){var l=Qs(t.state);void 0!==u&&(s&&t.subscribe((function(t,i){var a=Qs(i);if(n(t,l,a)){var s=Ac(),c=o(t),f="mutation "+t.type+s;Ec(u,f,e),u.log("%c prev state","color: #9E9E9E; font-weight: bold",r(l)),u.log("%c mutation","color: #03A9F4; font-weight: bold",c),u.log("%c next state","color: #4CAF50; font-weight: bold",r(a)),Pc(u)}l=a})),c&&t.subscribeAction((function(t,n){if(i(t,n)){var r=Ac(),o=a(t),s="action "+t.type+r;Ec(u,s,e),u.log("%c action","color: #03A9F4; font-weight: bold",o),Pc(u)}})))}}};tr.use(Lc);var Mc=new Lc.Store({state:{isLight:!1,isSearchModalOpen:!1},mutations:{openSearchModal(t){t.isSearchModalOpen=!0},closeSearchModal(t){t.isSearchModalOpen=!1},toggleLightMode(t){t.isLight=!t.isLight}}});n(239);tr.component("Badge",()=>Promise.all([n.e(0),n.e(3)]).then(n.bind(null,325))),tr.component("CodeBlock",()=>Promise.all([n.e(0),n.e(4)]).then(n.bind(null,285))),tr.component("CodeGroup",()=>Promise.all([n.e(0),n.e(5)]).then(n.bind(null,286)));n(240);var Dc=[({Vue:t,options:e,router:n,siteData:r})=>{t.mixin({beforeCreate(){this.$store=Mc}})},{},({Vue:t})=>{t.mixin({computed:{$dataBlock(){return this.$options.__data__block__}}})},{},{},({Vue:t})=>{t.component("CodeCopy",Is)}],Ic=[];class Rc extends class{constructor(){this.store=new tr({data:{state:{}}})}$get(t){return this.store.state[t]}$set(t,e){tr.set(this.store.state,t,e)}$emit(...t){this.store.$emit(...t)}$on(...t){this.store.$on(...t)}}{}Object.assign(Rc.prototype,{getPageAsyncComponent:hs,getLayoutAsyncComponent:vs,getAsyncComponent:gs,getVueComponent:ms});var Fc={install(t){const e=new Rc;t.$vuepress=e,t.prototype.$vuepress=e}};function Nc(t,e){const n=e.toLowerCase();return t.options.routes.some(t=>t.path.toLowerCase()===n)}var Uc={props:{pageKey:String,slotKey:{type:String,default:"default"}},render(t){const e=this.pageKey||this.$parent.$page.key;return bs("pageKey",e),tr.component(e)||tr.component(e,hs(e)),tr.component(e)?t(e):t("")}},Vc={functional:!0,props:{slotKey:String,required:!0},render:(t,{props:e,slots:n})=>t("div",{class:["content__"+e.slotKey]},n()[e.slotKey])},Bc={computed:{openInNewWindowTitle(){return this.$themeLocaleConfig.openNewWindowText||"(opens new window)"}}},zc=(n(241),n(242),Object(Ds.a)(Bc,(function(){var t=this._self._c;return t("span",[t("svg",{staticClass:"icon outbound",attrs:{xmlns:"http://www.w3.org/2000/svg","aria-hidden":"true",focusable:"false",x:"0px",y:"0px",viewBox:"0 0 100 100",width:"15",height:"15"}},[t("path",{attrs:{fill:"currentColor",d:"M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"}}),this._v(" "),t("polygon",{attrs:{fill:"currentColor",points:"45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"}})]),this._v(" "),t("span",{staticClass:"sr-only"},[this._v(this._s(this.openInNewWindowTitle))])])}),[],!1,null,null,null).exports),Hc={functional:!0,render(t,{parent:e,children:n}){if(e._isMounted)return n;e.$once("hook:mounted",()=>{e.$forceUpdate()})}};tr.config.productionTip=!1,tr.use(Xa),tr.use(Fc),tr.mixin(function(t,e,n=tr){!function(t){t.locales&&Object.keys(t.locales).forEach(e=>{t.locales[e].path=e});Object.freeze(t)}(e),n.$vuepress.$set("siteData",e);const r=new(t(n.$vuepress.$get("siteData"))),o=Object.getOwnPropertyDescriptors(Object.getPrototypeOf(r)),i={};return Object.keys(o).reduce((t,e)=>(e.startsWith("$")&&(t[e]=o[e].get),t),i),{computed:i}}(t=>class{setPage(t){this.__page=t}get $site(){return t}get $themeConfig(){return this.$site.themeConfig}get $frontmatter(){return this.$page.frontmatter}get $localeConfig(){const{locales:t={}}=this.$site;let e,n;for(const r in t)"/"===r?n=t[r]:0===this.$page.path.indexOf(r)&&(e=t[r]);return e||n||{}}get $siteTitle(){return this.$localeConfig.title||this.$site.title||""}get $canonicalUrl(){const{canonicalUrl:t}=this.$page.frontmatter;return"string"==typeof t&&t}get $title(){const t=this.$page,{metaTitle:e}=this.$page.frontmatter;if("string"==typeof e)return e;const n=this.$siteTitle,r=t.frontmatter.home?null:t.frontmatter.title||t.title;return n?r?r+" | "+n:n:r||"VuePress"}get $description(){const t=function(t){if(t){const e=t.filter(t=>"description"===t.name)[0];if(e)return e.content}}(this.$page.frontmatter.meta);return t||(this.$page.frontmatter.description||this.$localeConfig.description||this.$site.description||"")}get $lang(){return this.$page.frontmatter.lang||this.$localeConfig.lang||"en-US"}get $localePath(){return this.$localeConfig.path||"/"}get $themeLocaleConfig(){return(this.$site.themeConfig.locales||{})[this.$localePath]||{}}get $page(){return this.__page?this.__page:function(t,e){for(let n=0;nn||(t.hash?!tr.$vuepress.$get("disableScrollBehavior")&&{selector:decodeURIComponent(t.hash)}:{x:0,y:0})});!function(t){t.beforeEach((e,n,r)=>{if(Nc(t,e.path))r();else if(/(\/|\.html)$/.test(e.path))if(/\/$/.test(e.path)){const n=e.path.replace(/\/$/,"")+".html";Nc(t,n)?r(n):r()}else r();else{const n=e.path+"/",o=e.path+".html";Nc(t,o)?r(o):Nc(t,n)?r(n):r()}})}(n);const r={};try{await Promise.all(Dc.filter(t=>"function"==typeof t).map(e=>e({Vue:tr,options:r,router:n,siteData:Vs,isServer:t})))}catch(t){console.error(t)}return{app:new tr(Object.assign(r,{router:n,render:t=>t("div",{attrs:{id:"app"}},[t("RouterView",{ref:"layout"}),t("div",{class:"global-ui"},Ic.map(e=>t(e)))])})),router:n}}(!1).then(({app:t,router:e})=>{e.onReady(()=>{t.$mount("#app")})})}]); \ No newline at end of file + */function Qs(t,e){if(void 0===e&&(e=[]),null===t||"object"!=typeof t)return t;var n,r=(n=function(e){return e.original===t},e.filter(n)[0]);if(r)return r.copy;var o=Array.isArray(t)?[]:{};return e.push({original:t,copy:o}),Object.keys(t).forEach((function(n){o[n]=Qs(t[n],e)})),o}function Js(t,e){Object.keys(t).forEach((function(n){return e(t[n],n)}))}function Ys(t){return null!==t&&"object"==typeof t}function Xs(t,e){if(!t)throw new Error("[vuex] "+e)}function Zs(t,e,n){return e.indexOf(t)<0&&(n&&n.prepend?e.unshift(t):e.push(t)),function(){var n=e.indexOf(t);n>-1&&e.splice(n,1)}}function tc(t,e){t._actions=Object.create(null),t._mutations=Object.create(null),t._wrappedGetters=Object.create(null),t._modulesNamespaceMap=Object.create(null);var n=t.state;nc(t,n,[],t._modules.root,!0),ec(t,n,e)}function ec(t,e,n){var r=t._state,o=t._scope;t.getters={},t._makeLocalGettersCache=Object.create(null);var i,a=t._wrappedGetters,s={},c={},l=new Qt(!0);l.run((function(){Js(a,(function(e,n){s[n]=function(t,e){return function(){return t(e)}}(e,t),c[n]=function(t,e){var n,r,o=u(t);o?(n=t,r=L):(n=t.get,r=t.set);var i=it()?null:new Xe(lt,n,L,{lazy:!0}),a={effect:i,get value(){return i?(i.dirty&&i.evaluate(),yt.target&&i.depend(),i.value):n()},set value(t){r(t)}};return W(a,"__v_isRef",!0),W(a,"__v_isReadonly",o),a}((function(){return s[n]()})),Object.defineProperty(t.getters,n,{get:function(){return c[n].value},enumerable:!0})}))})),t._state=(It(i={data:e},!1),i),t._scope=l,t.strict&&function(t){Gt((function(){return t._state.data}),(function(){Xs(t._committing,"do not mutate vuex store state outside mutation handlers.")}),{deep:!0,flush:"sync"})}(t),r&&n&&t._withCommit((function(){r.data=null})),o&&o.stop()}function nc(t,e,n,r,o){var i=!n.length,a=t._modules.getNamespace(n);if(r.namespaced&&(t._modulesNamespaceMap[a]&&console.error("[vuex] duplicate namespace "+a+" for the namespaced module "+n.join("/")),t._modulesNamespaceMap[a]=r),!i&&!o){var s=oc(e,n.slice(0,-1)),c=n[n.length-1];t._withCommit((function(){c in s&&console.warn('[vuex] state field "'+c+'" was overridden by a module with the same name at "'+n.join(".")+'"'),s[c]=r.state}))}var u=r.context=function(t,e,n){var r=""===e,o={dispatch:r?t.dispatch:function(n,r,o){var i=ic(n,r,o),a=i.payload,s=i.options,c=i.type;if(s&&s.root||(c=e+c,t._actions[c]))return t.dispatch(c,a);console.error("[vuex] unknown local action type: "+i.type+", global type: "+c)},commit:r?t.commit:function(n,r,o){var i=ic(n,r,o),a=i.payload,s=i.options,c=i.type;s&&s.root||(c=e+c,t._mutations[c])?t.commit(c,a,s):console.error("[vuex] unknown local mutation type: "+i.type+", global type: "+c)}};return Object.defineProperties(o,{getters:{get:r?function(){return t.getters}:function(){return rc(t,e)}},state:{get:function(){return oc(t.state,n)}}}),o}(t,a,n);r.forEachMutation((function(e,n){!function(t,e,n,r){(t._mutations[e]||(t._mutations[e]=[])).push((function(e){n.call(t,r.state,e)}))}(t,a+n,e,u)})),r.forEachAction((function(e,n){var r=e.root?n:a+n,o=e.handler||e;!function(t,e,n,r){(t._actions[e]||(t._actions[e]=[])).push((function(e){var o,i=n.call(t,{dispatch:r.dispatch,commit:r.commit,getters:r.getters,state:r.state,rootGetters:t.getters,rootState:t.state},e);return(o=i)&&"function"==typeof o.then||(i=Promise.resolve(i)),t._devtoolHook?i.catch((function(e){throw t._devtoolHook.emit("vuex:error",e),e})):i}))}(t,r,o,u)})),r.forEachGetter((function(e,n){!function(t,e,n,r){if(t._wrappedGetters[e])return void console.error("[vuex] duplicate getter key: "+e);t._wrappedGetters[e]=function(t){return n(r.state,r.getters,t.state,t.getters)}}(t,a+n,e,u)})),r.forEachChild((function(r,i){nc(t,e,n.concat(i),r,o)}))}function rc(t,e){if(!t._makeLocalGettersCache[e]){var n={},r=e.length;Object.keys(t.getters).forEach((function(o){if(o.slice(0,r)===e){var i=o.slice(r);Object.defineProperty(n,i,{get:function(){return t.getters[o]},enumerable:!0})}})),t._makeLocalGettersCache[e]=n}return t._makeLocalGettersCache[e]}function oc(t,e){return e.reduce((function(t,e){return t[e]}),t)}function ic(t,e,n){return Ys(t)&&t.type&&(n=e,e=t,t=t.type),Xs("string"==typeof t,"expects string as the type, but found "+typeof t+"."),{type:t,payload:e,options:n}}var ac=0;function sc(t,e){Ks({id:"org.vuejs.vuex",app:t,label:"Vuex",homepage:"https://next.vuex.vuejs.org/",logo:"https://vuejs.org/images/icons/favicon-96x96.png",packageName:"vuex",componentStateTypes:["vuex bindings"]},(function(n){n.addTimelineLayer({id:"vuex:mutations",label:"Vuex Mutations",color:cc}),n.addTimelineLayer({id:"vuex:actions",label:"Vuex Actions",color:cc}),n.addInspector({id:"vuex",label:"Vuex",icon:"storage",treeFilterPlaceholder:"Filter stores..."}),n.on.getInspectorTree((function(n){if(n.app===t&&"vuex"===n.inspectorId)if(n.filter){var r=[];!function t(e,n,r,o){o.includes(r)&&e.push({id:o||"root",label:o.endsWith("/")?o.slice(0,o.length-1):o||"Root",tags:n.namespaced?[uc]:[]});Object.keys(n._children).forEach((function(i){t(e,n._children[i],r,o+i+"/")}))}(r,e._modules.root,n.filter,""),n.rootNodes=r}else n.rootNodes=[fc(e._modules.root,"")]})),n.on.getInspectorState((function(n){if(n.app===t&&"vuex"===n.inspectorId){var r=n.nodeId;rc(e,r),n.state=function(t,e,n){e="root"===n?e:e[n];var r=Object.keys(e),o={state:Object.keys(t.state).map((function(e){return{key:e,editable:!0,value:t.state[e]}}))};if(r.length){var i=function(t){var e={};return Object.keys(t).forEach((function(n){var r=n.split("/");if(r.length>1){var o=e,i=r.pop();r.forEach((function(t){o[t]||(o[t]={_custom:{value:{},display:t,tooltip:"Module",abstract:!0}}),o=o[t]._custom.value})),o[i]=pc((function(){return t[n]}))}else e[n]=pc((function(){return t[n]}))})),e}(e);o.getters=Object.keys(i).map((function(t){return{key:t.endsWith("/")?lc(t):t,editable:!1,value:pc((function(){return i[t]}))}}))}return o}((o=e._modules,(a=(i=r).split("/").filter((function(t){return t}))).reduce((function(t,e,n){var r=t[e];if(!r)throw new Error('Missing module "'+e+'" for path "'+i+'".');return n===a.length-1?r:r._children}),"root"===i?o:o.root._children)),"root"===r?e.getters:e._makeLocalGettersCache,r)}var o,i,a})),n.on.editInspectorState((function(n){if(n.app===t&&"vuex"===n.inspectorId){var r=n.nodeId,o=n.path;"root"!==r&&(o=r.split("/").filter(Boolean).concat(o)),e._withCommit((function(){n.set(e._state.data,o,n.state.value)}))}})),e.subscribe((function(t,e){var r={};t.payload&&(r.payload=t.payload),r.state=e,n.notifyComponentUpdate(),n.sendInspectorTree("vuex"),n.sendInspectorState("vuex"),n.addTimelineEvent({layerId:"vuex:mutations",event:{time:Date.now(),title:t.type,data:r}})})),e.subscribeAction({before:function(t,e){var r={};t.payload&&(r.payload=t.payload),t._id=ac++,t._time=Date.now(),r.state=e,n.addTimelineEvent({layerId:"vuex:actions",event:{time:t._time,title:t.type,groupId:t._id,subtitle:"start",data:r}})},after:function(t,e){var r={},o=Date.now()-t._time;r.duration={_custom:{type:"duration",display:o+"ms",tooltip:"Action duration",value:o}},t.payload&&(r.payload=t.payload),r.state=e,n.addTimelineEvent({layerId:"vuex:actions",event:{time:Date.now(),title:t.type,groupId:t._id,subtitle:"end",data:r}})}})}))}var cc=8702998,uc={label:"namespaced",textColor:16777215,backgroundColor:6710886};function lc(t){return t&&"root"!==t?t.split("/").slice(-2,-1)[0]:"Root"}function fc(t,e){return{id:e||"root",label:lc(e),tags:t.namespaced?[uc]:[],children:Object.keys(t._children).map((function(n){return fc(t._children[n],e+n+"/")}))}}function pc(t){try{return t()}catch(t){return t}}var dc=function(t,e){this.runtime=e,this._children=Object.create(null),this._rawModule=t;var n=t.state;this.state=("function"==typeof n?n():n)||{}},hc={namespaced:{configurable:!0}};hc.namespaced.get=function(){return!!this._rawModule.namespaced},dc.prototype.addChild=function(t,e){this._children[t]=e},dc.prototype.removeChild=function(t){delete this._children[t]},dc.prototype.getChild=function(t){return this._children[t]},dc.prototype.hasChild=function(t){return t in this._children},dc.prototype.update=function(t){this._rawModule.namespaced=t.namespaced,t.actions&&(this._rawModule.actions=t.actions),t.mutations&&(this._rawModule.mutations=t.mutations),t.getters&&(this._rawModule.getters=t.getters)},dc.prototype.forEachChild=function(t){Js(this._children,t)},dc.prototype.forEachGetter=function(t){this._rawModule.getters&&Js(this._rawModule.getters,t)},dc.prototype.forEachAction=function(t){this._rawModule.actions&&Js(this._rawModule.actions,t)},dc.prototype.forEachMutation=function(t){this._rawModule.mutations&&Js(this._rawModule.mutations,t)},Object.defineProperties(dc.prototype,hc);var vc=function(t){this.register([],t,!1)};vc.prototype.get=function(t){return t.reduce((function(t,e){return t.getChild(e)}),this.root)},vc.prototype.getNamespace=function(t){var e=this.root;return t.reduce((function(t,n){return t+((e=e.getChild(n)).namespaced?n+"/":"")}),"")},vc.prototype.update=function(t){!function t(e,n,r){if(yc(e,r),n.update(r),r.modules)for(var o in r.modules){if(!n.getChild(o))return void console.warn("[vuex] trying to add a new module '"+o+"' on hot reloading, manual reload is needed");t(e.concat(o),n.getChild(o),r.modules[o])}}([],this.root,t)},vc.prototype.register=function(t,e,n){var r=this;void 0===n&&(n=!0),yc(t,e);var o=new dc(e,n);0===t.length?this.root=o:this.get(t.slice(0,-1)).addChild(t[t.length-1],o);e.modules&&Js(e.modules,(function(e,o){r.register(t.concat(o),e,n)}))},vc.prototype.unregister=function(t){var e=this.get(t.slice(0,-1)),n=t[t.length-1],r=e.getChild(n);r?r.runtime&&e.removeChild(n):console.warn("[vuex] trying to unregister module '"+n+"', which is not registered")},vc.prototype.isRegistered=function(t){var e=this.get(t.slice(0,-1)),n=t[t.length-1];return!!e&&e.hasChild(n)};var gc={assert:function(t){return"function"==typeof t},expected:"function"},mc={getters:gc,mutations:gc,actions:{assert:function(t){return"function"==typeof t||"object"==typeof t&&"function"==typeof t.handler},expected:'function or object with "handler" function'}};function yc(t,e){Object.keys(mc).forEach((function(n){if(e[n]){var r=mc[n];Js(e[n],(function(e,o){Xs(r.assert(e),function(t,e,n,r,o){var i=e+" should be "+o+' but "'+e+"."+n+'"';t.length>0&&(i+=' in module "'+t.join(".")+'"');return i+=" is "+JSON.stringify(r)+"."}(t,n,o,e,r.expected))}))}}))}var bc=function t(e){var n=this;void 0===e&&(e={}),Xs("undefined"!=typeof Promise,"vuex requires a Promise polyfill in this browser."),Xs(this instanceof t,"store must be called with the new operator.");var r=e.plugins;void 0===r&&(r=[]);var o=e.strict;void 0===o&&(o=!1);var i=e.devtools;this._committing=!1,this._actions=Object.create(null),this._actionSubscribers=[],this._mutations=Object.create(null),this._wrappedGetters=Object.create(null),this._modules=new vc(e),this._modulesNamespaceMap=Object.create(null),this._subscribers=[],this._makeLocalGettersCache=Object.create(null),this._scope=null,this._devtools=i;var a=this,s=this.dispatch,c=this.commit;this.dispatch=function(t,e){return s.call(a,t,e)},this.commit=function(t,e,n){return c.call(a,t,e,n)},this.strict=o;var u=this._modules.root.state;nc(this,u,[],this._modules.root),ec(this,u),r.forEach((function(t){return t(n)}))},_c={state:{configurable:!0}};bc.prototype.install=function(t,e){t.provide(e||"store",this),t.config.globalProperties.$store=this,(void 0===this._devtools||this._devtools)&&sc(t,this)},_c.state.get=function(){return this._state.data},_c.state.set=function(t){Xs(!1,"use store.replaceState() to explicit replace store state.")},bc.prototype.commit=function(t,e,n){var r=this,o=ic(t,e,n),i=o.type,a=o.payload,s=o.options,c={type:i,payload:a},u=this._mutations[i];u?(this._withCommit((function(){u.forEach((function(t){t(a)}))})),this._subscribers.slice().forEach((function(t){return t(c,r.state)})),s&&s.silent&&console.warn("[vuex] mutation type: "+i+". Silent option has been removed. Use the filter functionality in the vue-devtools")):console.error("[vuex] unknown mutation type: "+i)},bc.prototype.dispatch=function(t,e){var n=this,r=ic(t,e),o=r.type,i=r.payload,a={type:o,payload:i},s=this._actions[o];if(s){try{this._actionSubscribers.slice().filter((function(t){return t.before})).forEach((function(t){return t.before(a,n.state)}))}catch(t){console.warn("[vuex] error in before action subscribers: "),console.error(t)}var c=s.length>1?Promise.all(s.map((function(t){return t(i)}))):s[0](i);return new Promise((function(t,e){c.then((function(e){try{n._actionSubscribers.filter((function(t){return t.after})).forEach((function(t){return t.after(a,n.state)}))}catch(t){console.warn("[vuex] error in after action subscribers: "),console.error(t)}t(e)}),(function(t){try{n._actionSubscribers.filter((function(t){return t.error})).forEach((function(e){return e.error(a,n.state,t)}))}catch(t){console.warn("[vuex] error in error action subscribers: "),console.error(t)}e(t)}))}))}console.error("[vuex] unknown action type: "+o)},bc.prototype.subscribe=function(t,e){return Zs(t,this._subscribers,e)},bc.prototype.subscribeAction=function(t,e){return Zs("function"==typeof t?{before:t}:t,this._actionSubscribers,e)},bc.prototype.watch=function(t,e,n){var r=this;return Xs("function"==typeof t,"store.watch only accepts a function."),Gt((function(){return t(r.state,r.getters)}),e,Object.assign({},n))},bc.prototype.replaceState=function(t){var e=this;this._withCommit((function(){e._state.data=t}))},bc.prototype.registerModule=function(t,e,n){void 0===n&&(n={}),"string"==typeof t&&(t=[t]),Xs(Array.isArray(t),"module path must be a string or an Array."),Xs(t.length>0,"cannot register the root module by using registerModule."),this._modules.register(t,e),nc(this,this.state,t,this._modules.get(t),n.preserveState),ec(this,this.state)},bc.prototype.unregisterModule=function(t){var e=this;"string"==typeof t&&(t=[t]),Xs(Array.isArray(t),"module path must be a string or an Array."),this._modules.unregister(t),this._withCommit((function(){delete oc(e.state,t.slice(0,-1))[t[t.length-1]]})),tc(this)},bc.prototype.hasModule=function(t){return"string"==typeof t&&(t=[t]),Xs(Array.isArray(t),"module path must be a string or an Array."),this._modules.isRegistered(t)},bc.prototype.hotUpdate=function(t){this._modules.update(t),tc(this,!0)},bc.prototype._withCommit=function(t){var e=this._committing;this._committing=!0,t(),this._committing=e},Object.defineProperties(bc.prototype,_c);var wc=jc((function(t,e){var n={};return Sc(e)||console.error("[vuex] mapState: mapper parameter must be either an Array or an Object"),Cc(e).forEach((function(e){var r=e.key,o=e.val;n[r]=function(){var e=this.$store.state,n=this.$store.getters;if(t){var r=$c(this.$store,"mapState",t);if(!r)return;e=r.context.state,n=r.context.getters}return"function"==typeof o?o.call(this,e,n):e[o]},n[r].vuex=!0})),n})),xc=jc((function(t,e){var n={};return Sc(e)||console.error("[vuex] mapMutations: mapper parameter must be either an Array or an Object"),Cc(e).forEach((function(e){var r=e.key,o=e.val;n[r]=function(){for(var e=[],n=arguments.length;n--;)e[n]=arguments[n];var r=this.$store.commit;if(t){var i=$c(this.$store,"mapMutations",t);if(!i)return;r=i.context.commit}return"function"==typeof o?o.apply(this,[r].concat(e)):r.apply(this.$store,[o].concat(e))}})),n})),kc=jc((function(t,e){var n={};return Sc(e)||console.error("[vuex] mapGetters: mapper parameter must be either an Array or an Object"),Cc(e).forEach((function(e){var r=e.key,o=e.val;o=t+o,n[r]=function(){if(!t||$c(this.$store,"mapGetters",t)){if(o in this.$store.getters)return this.$store.getters[o];console.error("[vuex] unknown getter: "+o)}},n[r].vuex=!0})),n})),Oc=jc((function(t,e){var n={};return Sc(e)||console.error("[vuex] mapActions: mapper parameter must be either an Array or an Object"),Cc(e).forEach((function(e){var r=e.key,o=e.val;n[r]=function(){for(var e=[],n=arguments.length;n--;)e[n]=arguments[n];var r=this.$store.dispatch;if(t){var i=$c(this.$store,"mapActions",t);if(!i)return;r=i.context.dispatch}return"function"==typeof o?o.apply(this,[r].concat(e)):r.apply(this.$store,[o].concat(e))}})),n}));function Cc(t){return Sc(t)?Array.isArray(t)?t.map((function(t){return{key:t,val:t}})):Object.keys(t).map((function(e){return{key:e,val:t[e]}})):[]}function Sc(t){return Array.isArray(t)||Ys(t)}function jc(t){return function(e,n){return"string"!=typeof e?(n=e,e=""):"/"!==e.charAt(e.length-1)&&(e+="/"),t(e,n)}}function $c(t,e,n){var r=t._modulesNamespaceMap[n];return r||console.error("[vuex] module namespace not found in "+e+"(): "+n),r}function Ec(t,e,n){var r=n?t.groupCollapsed:t.group;try{r.call(t,e)}catch(n){t.log(e)}}function Pc(t){try{t.groupEnd()}catch(e){t.log("—— log end ——")}}function Ac(){var t=new Date;return" @ "+Tc(t.getHours(),2)+":"+Tc(t.getMinutes(),2)+":"+Tc(t.getSeconds(),2)+"."+Tc(t.getMilliseconds(),3)}function Tc(t,e){return n="0",r=e-t.toString().length,new Array(r+1).join(n)+t;var n,r}var Lc={version:"4.1.0",Store:bc,storeKey:"store",createStore:function(t){return new bc(t)},useStore:function(t){return void 0===t&&(t=null),function(t,e,n){void 0===n&&(n=!1);var r=lt;if(r){var o=r.$parent&&r.$parent._provided;if(o&&t in o)return o[t];if(arguments.length>1)return n&&u(e)?e.call(r):e}else 0}(null!==t?t:"store")},mapState:wc,mapMutations:xc,mapGetters:kc,mapActions:Oc,createNamespacedHelpers:function(t){return{mapState:wc.bind(null,t),mapGetters:kc.bind(null,t),mapMutations:xc.bind(null,t),mapActions:Oc.bind(null,t)}},createLogger:function(t){void 0===t&&(t={});var e=t.collapsed;void 0===e&&(e=!0);var n=t.filter;void 0===n&&(n=function(t,e,n){return!0});var r=t.transformer;void 0===r&&(r=function(t){return t});var o=t.mutationTransformer;void 0===o&&(o=function(t){return t});var i=t.actionFilter;void 0===i&&(i=function(t,e){return!0});var a=t.actionTransformer;void 0===a&&(a=function(t){return t});var s=t.logMutations;void 0===s&&(s=!0);var c=t.logActions;void 0===c&&(c=!0);var u=t.logger;return void 0===u&&(u=console),function(t){var l=Qs(t.state);void 0!==u&&(s&&t.subscribe((function(t,i){var a=Qs(i);if(n(t,l,a)){var s=Ac(),c=o(t),f="mutation "+t.type+s;Ec(u,f,e),u.log("%c prev state","color: #9E9E9E; font-weight: bold",r(l)),u.log("%c mutation","color: #03A9F4; font-weight: bold",c),u.log("%c next state","color: #4CAF50; font-weight: bold",r(a)),Pc(u)}l=a})),c&&t.subscribeAction((function(t,n){if(i(t,n)){var r=Ac(),o=a(t),s="action "+t.type+r;Ec(u,s,e),u.log("%c action","color: #03A9F4; font-weight: bold",o),Pc(u)}})))}}};tr.use(Lc);var Dc=new Lc.Store({state:{isLight:!1,isSearchModalOpen:!1},mutations:{openSearchModal(t){t.isSearchModalOpen=!0},closeSearchModal(t){t.isSearchModalOpen=!1},toggleLightMode(t){t.isLight=!t.isLight}}});n(239);tr.component("Badge",()=>Promise.all([n.e(0),n.e(3)]).then(n.bind(null,325))),tr.component("CodeBlock",()=>Promise.all([n.e(0),n.e(4)]).then(n.bind(null,285))),tr.component("CodeGroup",()=>Promise.all([n.e(0),n.e(5)]).then(n.bind(null,286)));n(240);var Mc=[({Vue:t,options:e,router:n,siteData:r})=>{t.mixin({beforeCreate(){this.$store=Dc}})},{},({Vue:t})=>{t.mixin({computed:{$dataBlock(){return this.$options.__data__block__}}})},{},{},({Vue:t})=>{t.component("CodeCopy",Is)}],Ic=[];class Rc extends class{constructor(){this.store=new tr({data:{state:{}}})}$get(t){return this.store.state[t]}$set(t,e){tr.set(this.store.state,t,e)}$emit(...t){this.store.$emit(...t)}$on(...t){this.store.$on(...t)}}{}Object.assign(Rc.prototype,{getPageAsyncComponent:hs,getLayoutAsyncComponent:vs,getAsyncComponent:gs,getVueComponent:ms});var Fc={install(t){const e=new Rc;t.$vuepress=e,t.prototype.$vuepress=e}};function Nc(t,e){const n=e.toLowerCase();return t.options.routes.some(t=>t.path.toLowerCase()===n)}var Uc={props:{pageKey:String,slotKey:{type:String,default:"default"}},render(t){const e=this.pageKey||this.$parent.$page.key;return bs("pageKey",e),tr.component(e)||tr.component(e,hs(e)),tr.component(e)?t(e):t("")}},Vc={functional:!0,props:{slotKey:String,required:!0},render:(t,{props:e,slots:n})=>t("div",{class:["content__"+e.slotKey]},n()[e.slotKey])},Bc={computed:{openInNewWindowTitle(){return this.$themeLocaleConfig.openNewWindowText||"(opens new window)"}}},zc=(n(241),n(242),Object(Ms.a)(Bc,(function(){var t=this._self._c;return t("span",[t("svg",{staticClass:"icon outbound",attrs:{xmlns:"http://www.w3.org/2000/svg","aria-hidden":"true",focusable:"false",x:"0px",y:"0px",viewBox:"0 0 100 100",width:"15",height:"15"}},[t("path",{attrs:{fill:"currentColor",d:"M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"}}),this._v(" "),t("polygon",{attrs:{fill:"currentColor",points:"45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"}})]),this._v(" "),t("span",{staticClass:"sr-only"},[this._v(this._s(this.openInNewWindowTitle))])])}),[],!1,null,null,null).exports),Hc={functional:!0,render(t,{parent:e,children:n}){if(e._isMounted)return n;e.$once("hook:mounted",()=>{e.$forceUpdate()})}};tr.config.productionTip=!1,tr.use(Xa),tr.use(Fc),tr.mixin(function(t,e,n=tr){!function(t){t.locales&&Object.keys(t.locales).forEach(e=>{t.locales[e].path=e});Object.freeze(t)}(e),n.$vuepress.$set("siteData",e);const r=new(t(n.$vuepress.$get("siteData"))),o=Object.getOwnPropertyDescriptors(Object.getPrototypeOf(r)),i={};return Object.keys(o).reduce((t,e)=>(e.startsWith("$")&&(t[e]=o[e].get),t),i),{computed:i}}(t=>class{setPage(t){this.__page=t}get $site(){return t}get $themeConfig(){return this.$site.themeConfig}get $frontmatter(){return this.$page.frontmatter}get $localeConfig(){const{locales:t={}}=this.$site;let e,n;for(const r in t)"/"===r?n=t[r]:0===this.$page.path.indexOf(r)&&(e=t[r]);return e||n||{}}get $siteTitle(){return this.$localeConfig.title||this.$site.title||""}get $canonicalUrl(){const{canonicalUrl:t}=this.$page.frontmatter;return"string"==typeof t&&t}get $title(){const t=this.$page,{metaTitle:e}=this.$page.frontmatter;if("string"==typeof e)return e;const n=this.$siteTitle,r=t.frontmatter.home?null:t.frontmatter.title||t.title;return n?r?r+" | "+n:n:r||"VuePress"}get $description(){const t=function(t){if(t){const e=t.filter(t=>"description"===t.name)[0];if(e)return e.content}}(this.$page.frontmatter.meta);return t||(this.$page.frontmatter.description||this.$localeConfig.description||this.$site.description||"")}get $lang(){return this.$page.frontmatter.lang||this.$localeConfig.lang||"en-US"}get $localePath(){return this.$localeConfig.path||"/"}get $themeLocaleConfig(){return(this.$site.themeConfig.locales||{})[this.$localePath]||{}}get $page(){return this.__page?this.__page:function(t,e){for(let n=0;nn||(t.hash?!tr.$vuepress.$get("disableScrollBehavior")&&{selector:decodeURIComponent(t.hash)}:{x:0,y:0})});!function(t){t.beforeEach((e,n,r)=>{if(Nc(t,e.path))r();else if(/(\/|\.html)$/.test(e.path))if(/\/$/.test(e.path)){const n=e.path.replace(/\/$/,"")+".html";Nc(t,n)?r(n):r()}else r();else{const n=e.path+"/",o=e.path+".html";Nc(t,o)?r(o):Nc(t,n)?r(n):r()}})}(n);const r={};try{await Promise.all(Mc.filter(t=>"function"==typeof t).map(e=>e({Vue:tr,options:r,router:n,siteData:Vs,isServer:t})))}catch(t){console.error(t)}return{app:new tr(Object.assign(r,{router:n,render:t=>t("div",{attrs:{id:"app"}},[t("RouterView",{ref:"layout"}),t("div",{class:"global-ui"},Ic.map(e=>t(e)))])})),router:n}}(!1).then(({app:t,router:e})=>{e.onReady(()=>{t.$mount("#app")})})}]); \ No newline at end of file diff --git a/docs/arfs/content-types.html b/docs/arfs/content-types.html index 9d7b75c..1d613dd 100644 --- a/docs/arfs/content-types.html +++ b/docs/arfs/content-types.html @@ -12,7 +12,7 @@ - + @@ -23,6 +23,6 @@ App-Version: "<defined version of the app eg. 0.5.0" Client?: "<if the application has multiple clients, they should be specified here eg. Web"
- + diff --git a/docs/arfs/data-model.html b/docs/arfs/data-model.html index e6fc5b6..5b27d00 100644 --- a/docs/arfs/data-model.html +++ b/docs/arfs/data-model.html @@ -12,7 +12,7 @@ - + @@ -27,6 +27,6 @@ "author?": "John Doe" }

Enumerated field values (those which must adhere to certain values) are defined in the format "value 1 | value 2".

All UUIDs used for Entity-Ids are based on the Universally Unique Identifier (opens new window) standard.

There are no requirements to list ArFS tags in any specific order.

- + diff --git a/docs/arfs/entity-types.html b/docs/arfs/entity-types.html index 274ce6d..98d2146 100644 --- a/docs/arfs/entity-types.html +++ b/docs/arfs/entity-types.html @@ -12,7 +12,7 @@ - + @@ -147,6 +147,6 @@ ] }
Snapshot Transaction JSON data example

# Schema Diagrams

The following diagrams show complete examples of Drive, Folder, and File entity Schemas.

# Public Drive

Public Drive Schema

# Private Drive

Private Drive Schema
- + diff --git a/docs/arfs/index.html b/docs/arfs/index.html index 0f6fa10..00f654e 100644 --- a/docs/arfs/index.html +++ b/docs/arfs/index.html @@ -12,11 +12,11 @@ - +
ArDrive Docs

# ArFS Protocol: A Decentralized File System on Arweave

Arweave File System, or “ArFS” is a data modeling, storage, and retrieval protocol designed to emulate common file system operations and to provide aspects of mutability to your data hierarchy on Arweave (opens new window)'s otherwise permanent, immutable data storage blockweave.

Due to Arweave's permanent, immutable and public nature traditional file system operations such as permissions, file/folder renaming and moving, and file updates cannot be done by simply updating the on-chain data model.

ArFS works around this by implementing a privacy and encryption pattern and defining an append-only transaction data model using tags within Arweave Transaction headers (opens new window).

# Key Features

# File Structure

ArFS organizes files and folders using a hierarchical structure. Files are stored as individual transactions on the Arweave blockchain, while folders are metadata that reference these file transactions.

# Metadata

Each file and folder has associated metadata, such as the name, type, size, and modification timestamp. ArFS leverages Arweave's tagging system to store this metadata in a standardized format, which allows for easy querying and organization.

# File Permissions

ArFS supports public and private file permissions. Public files can be accessed by anyone on the network, while private files are encrypted using the owner's private key, ensuring only they can decrypt and access the content.

# File Versioning

ArFS supports versioning of files, allowing users to store multiple versions of a file and access previous versions at any time. This is achieved by linking new file transactions to previous versions through the use of metadata tags.

# Data Deduplication

To minimize storage redundancy and costs, ArFS employs data deduplication techniques. If a user tries to store a file that already exists on the network, the protocol will simply create a new reference to the existing file instead of storing a duplicate copy.

# Search and Discovery

ArFS enables users to search and discover files based on their metadata, such as file names, types, and tags. This is made possible by indexing the metadata stored within the Arweave blockchain.

# Interoperability

ArFS is designed to be interoperable with other decentralized applications and services built on the Arweave network. This allows for seamless integration and collaboration between different applications and users.

# Getting Started

To start using ArFS, you'll need to familiarize yourself with the Arweave ecosystem, acquire AR tokens to cover storage costs, and choose a compatible client or library to interact with the ArFS protocol.

# ArFS Version History

Version Date Release Notes
0.10 August 2020 The brief, beta version that was in use during initial testing of ArDrive across Web (Dart) and legacy CLI (Typescript).
0.11 September 2020 Includes all of the major functionality supporting file systems on Arweave including new drives, folders, files, renames, moves and privacy.
0.12 December 2022 Added Snapshot entities to support quick synchronization of drive state.
0.13 August 2023 Added pins
0.14 January 2024 Added isHidden property to file and folder metadata to enable clients to "hide" content from end users.

# Resources

For more information, documentation, and community support, refer to the following resources:

- + diff --git a/docs/arfs/privacy.html b/docs/arfs/privacy.html index dc30079..f3bb0ba 100644 --- a/docs/arfs/privacy.html +++ b/docs/arfs/privacy.html @@ -12,7 +12,7 @@ - + @@ -24,6 +24,6 @@ Cipher-IV?: "<12 byte initialization vector as Base64>"

Just like drives, private files must have the Content-Type tag set as application/octet-stream in both its metadata and data transactions:

Content-Type: "application/octet-stream"
- + diff --git a/docs/arfs/schema-diagrams.html b/docs/arfs/schema-diagrams.html index 70be8e0..c3bf30f 100644 --- a/docs/arfs/schema-diagrams.html +++ b/docs/arfs/schema-diagrams.html @@ -12,11 +12,11 @@ - +
ArDrive Docs

# Schema Diagrams

The following diagrams show complete examples of Drive, Folder, and File entity Schemas.

# Public Drive

Public Drive Schema

# Private Drive

Private Drive Schema

Arweave GQL Tag Byte Limit is restricted to 2048. There is no determined limit on Data JSON custom metadata, though more data results in a higher upload cost.

- + diff --git a/docs/arfs/usage/change/drives.html b/docs/arfs/usage/change/drives.html index 573beda..9683c1f 100644 --- a/docs/arfs/usage/change/drives.html +++ b/docs/arfs/usage/change/drives.html @@ -12,12 +12,12 @@ - +
ArDrive Docs

# Drive Write Operations

# Rename Drives

  • A new root folder metadata transaction is created when a user wants to rename an existing drive.
  • The new root folder metadata transaction reuses the existing drive's Drive-Id and Folder-Id, and copies all of its old metadata values, except the drive's and folder's name field must be updated in its data JSON to the new drive name.
    • For private drives, new ciphers are generated for this new root folder metadata transaction.
  • The new root folder transaction must not have any Parent-Folder-Id since it is a root folder.
- + diff --git a/docs/arfs/usage/change/files.html b/docs/arfs/usage/change/files.html index 7431bb7..40ff055 100644 --- a/docs/arfs/usage/change/files.html +++ b/docs/arfs/usage/change/files.html @@ -12,7 +12,7 @@ - + @@ -20,6 +20,6 @@
  • For private files, a new Cipher-IV is generated for this new metadata transaction.
  • File’s must not be allowed to be moved into a folder if a file exists in that folder with the same file name.

    • # Rename File

    Files can be renamed from one name to another.

    • A new file metadata transaction is created when a user wants to rename an existing file.
    • The new file metadata transaction reuses the existing file’s File-Id and copies all of it’s old metadata values, but the file’s name field in its Data JSON must be updated to the new file name and extension.
      • For private files, a new Cipher-IV is generated for this new metadata transaction.
    • File’s must not be allowed to be renamed to the name of another file with that same name in that same folder.

    # Update File Version

    When a user adds a new file to a folder, and there is a file in that folder with the same name, then a new file version is created.

    • A new file version uses the same File-Id of the file with the matching name and same Parent-Folder-Id.
    • The file upload process is followed and new File Metadata and Data transactions are created.
    • However a new UUID is not generated and the same File-Id and associated metadata is used for this new version
    • The new File Metadata Transaction points to the new Data transaction.
      • Since the File-Id remains the same, the File Keys for private files can decrypt all versions of that file.
      • For private files, new Cipher-IVs are generated for this new metadata and data transaction
    • ArFS clients can now iterate through the state of this file, since it will have multiple versions using the same File-Id.

    # Hide or Unhide File

    Changing the value of isHidden in a file's metadata will change whether or not a client should display that file.

    - + diff --git a/docs/arfs/usage/change/folders.html b/docs/arfs/usage/change/folders.html index 567995d..0a2b982 100644 --- a/docs/arfs/usage/change/folders.html +++ b/docs/arfs/usage/change/folders.html @@ -12,13 +12,13 @@ - +
    ArDrive Docs

    # Folder Write Operations

    # Move Folder

    Folders can be moved from one folder to another within the same Drive.

    • A new file metadata transaction is created when a user wants to move a folder into a different folder.
    • The new file metadata transaction reuses the existing folder’s Folder-Id and copies all of it’s old metadata values, but the file’s Parent-Folder-Id must be updated to the Folder-Id of the folder is was just moved to.
      • For private folders, new ciphers are generated for this new metadata transaction.
    • Folder’s must not be allowed to be moved into a folder if another folder exists in that folder with the same folder name.

    # Rename Folder

    Folders can be renamed from one name to another.

    • A new folder metadata transaction is created when a user wants to rename an existing folder.
    • The new folder metadata transaction reuses the existing folder’s Folder-Id and copies all of it’s old metadata values, but the folder’s name field in its Data JSON must be updated to the new folder name.
      • For private folders, new ciphers are generated for this new metadata transaction.
    • Folders must not be allowed to be renamed to the name of another folder with that same name in that same folder.
    - + diff --git a/docs/arfs/usage/change/snapshots.html b/docs/arfs/usage/change/snapshots.html index e9c1a36..05fccaf 100644 --- a/docs/arfs/usage/change/snapshots.html +++ b/docs/arfs/usage/change/snapshots.html @@ -12,11 +12,11 @@ - +
    ArDrive Docs
    - + diff --git a/docs/arfs/usage/create/create-file.html b/docs/arfs/usage/create/create-file.html index 97d0d75..b1ff11b 100644 --- a/docs/arfs/usage/create/create-file.html +++ b/docs/arfs/usage/create/create-file.html @@ -12,13 +12,13 @@ - +
    ArDrive Docs

    # Create File

    # New File Entity

    • A new file metadata transaction and a separate data transaction are created when a user wants to create a new file.
    • Files can only be created in existing drives, and must have a valid Drive-Id.
    • Files can only be created in existing parent folders, and must have a valid Parent-Folder-Id.
    • The new File Entity Data transaction must only specify the file’s mime type aka Content-Type.
    • The new file metadata transaction must generate a new UUIDv4 for the File-Id.
    • File metadata transactions must have Entity-Type: "file".
    • The client gets the user’s local time for the Unix-Time tag, represented as Seconds Since Unix Epoch.
      • The client populates the File Entity Metadata Transaction Data JSON after creating the data transaction.
      • name The name of the file including extension.
      • size The size of the file on disk, in bytes as an integer.
      • lastModifiedDate The file’s last time of modification as reported by the user’s operating system, in milliseconds since Unix epoch.
      • dataTxId The Arweave transaction id of this File Entity’s Data Transaction.
      • dataContentType The mime time of this File Entity’s data must be determined by the client.
      • isHidden A boolean telling clients if they should display the file or not.
    • If the File is private:
      • Its Cipher tag must be filled out with the respective encryption algorithm (currently AES256-GCM) for both the Metadata and Data transactions.
      • Its Cipher-IV tag must be filled out with the generated Initialization Vector for both the Metadata and Data transactions. Each one has its own unique IV.
      • It must have the content type Content-Type: "application/octet-stream" for both the Metadata and Data transactions.
      • The ArFS client must encrypt the File Entity’s Data and Metadata JSON using their assigned Cipher and Cipher-IV
    - + diff --git a/docs/arfs/usage/create/create-folder.html b/docs/arfs/usage/create/create-folder.html index 730bee1..a5603c4 100644 --- a/docs/arfs/usage/create/create-folder.html +++ b/docs/arfs/usage/create/create-folder.html @@ -12,12 +12,12 @@ - +
    ArDrive Docs

    # Create Folder

    # New Folder Entity

    Folders can be created to organize files.

    • A new Folder Entity Metadata is created when a user wants to create a new folder.
    • Folders can only be created in existing drives, and must have a valid Drive-Id.
    • Folders can only be created in existing parent folders, and must have a valid Parent-Folder-Id.
    • The new folder metadata transaction must generate a new UUIDv4 for the Folder-Id.
    • Folder Entity Metadata transactions must have Entity-Type: "folder".
    • The client gets the user’s local time for the Unix-Time tag, represented as Seconds Since Unix Epoch.
    • The user defined folder name is added to the name property in the folder’s metadata transaction Data JSON.
    • Public folders must have the content type Content-Type: "<application/json>".
    • If the folder is private:
      • Its Cipher tag must be filled out with the respective encryption algorithm (currently AES256-GCM).
      • Its Cipher-IV tag must be filled out with the generated Initialization Vector for the private folder.
      • It must have the content type Content-Type: "application/octet-stream".
      • The ArFS client must encrypt the Folder entity’s metadata JSON using the assigned Cipher and Cipher-IV.
    - + diff --git a/docs/arfs/usage/create/create-snapshot.html b/docs/arfs/usage/create/create-snapshot.html index ffb2a95..74aaa15 100644 --- a/docs/arfs/usage/create/create-snapshot.html +++ b/docs/arfs/usage/create/create-snapshot.html @@ -12,11 +12,11 @@ - +
    ArDrive Docs
    - + diff --git a/docs/arfs/usage/create/index.html b/docs/arfs/usage/create/index.html index eaff8c8..8a39698 100644 --- a/docs/arfs/usage/create/index.html +++ b/docs/arfs/usage/create/index.html @@ -12,7 +12,7 @@ - + @@ -22,6 +22,6 @@
    • This name is stored within the Folder Entity's metadata JSON.
  • The Folder Entity's Folder-Id must match the rootFolderId previously created for the Drive Entity.
  • The Folder Entity's Drive-Id must match the Drive-Id previously created for the Drive Entity.
  • The Folder Entity must not include a Parent-Folder-Id tag.
    • This is how it is determined to be the root folder for a drive.
  • Folder Entity metadata transactions must have Entity-Type: 'folder'.
  • The client gets the user's local time for the Unix-Time tag, represented as seconds since Unix Epoch.
  • Public folders must have the content type Content-Type: "application/json".
  • If the folder is private
    • Its Cipher tag must be filled out with the correct encryption algorithm (currently AES256-GCM).
    • Its Cipher-IV tag must be filled out with the generated Initialization Vector for the private folder.
    • Its content type must be Content-Type: "application/octet-stream".
    • The ArFS client must encrypt the Drive Entity's metadata JSON using the assigned Cipher and Cipher-IV.
    • - + diff --git a/docs/arfs/usage/extending-schemas.html b/docs/arfs/usage/extending-schemas.html index 591df3f..22fbe36 100644 --- a/docs/arfs/usage/extending-schemas.html +++ b/docs/arfs/usage/extending-schemas.html @@ -12,7 +12,7 @@ - + @@ -27,6 +27,6 @@ "albumSong": "<the title of the song>" }

    Additionally, the above extended Metadata fields could be added directly as a transaction tag as well, in order to support GraphQL queries.

    Arweave Transaction Headers can only fit a maximum of 2048 bytes total, so this must be taken into account by clients writing custom GQL tags.

    - + diff --git a/docs/arfs/usage/read/index.html b/docs/arfs/usage/read/index.html index 569a56a..5eb9cab 100644 --- a/docs/arfs/usage/read/index.html +++ b/docs/arfs/usage/read/index.html @@ -12,11 +12,11 @@ - +
    ArDrive Docs

    # Read ArFS Data

    Clients can perform read operations to create a timeline of entity write transactions which can then be replayed to construct the Drive state. This is done by querying an Arweave GraphQL index for the user’s respective transactions. Arweave GraphQL Guide (opens new window) can provide more information on how to use Arweave GraphQL. If no GraphQL index is available, drive state can only be generated by downloading and inspecting all transactions made by the user’s wallet

    This timeline of transactions should be grouped by the block number of each transaction. At every step of the timeline, the client can check if the entity was written by an authorized user. This also conveniently enables the client to surface a trusted entity version history to the user.

    To determine the owner of a Drive, clients must check for who created the first Drive Entity transaction using that Drive-Id. Until a trusted permissions or ACL system is put in place, any transaction in a drive created by any wallet other than the one who created the first Drive Entity transaction could be considered spam.

    The Unix-Time defined on each transaction should be reserved for tie-breaking same entity updates in the same block and should not be trusted as the source of truth for entity write ordering. This is unimportant for single owner drives but is crucial for multi-owner drives with updateable permissions (currently undefined in this spec) as a malicious user could fake the Unix-Time to modify the drive timeline for other users.

    • Drives that have been updated many times can have a long entity timeline which can be a performance bottleneck. To avoid this, clients can cache the drive state locally and sync updates to the file system by only querying for entities in blocks higher than the last time they checked.
    • Not checking for Drive Ownership could result in seeing incorrect drive state and GraphQL queries.

    # Folder/File Paths

    ArweaveFS does not store folder or file paths along with entities as these paths will need to be updated whenever the parent folder name changes which can require many updates for deeply nested file systems. Instead, folder/file paths are left for the client to generate from the folder/file names.

    # Folder View Queries

    Clients that want to provide users with a quick view of a single folder can simply query for an entity timeline for a particular folder by its id. Clients with multi-owner permissions will additionally have to query for the folder's parent drive entity for permission based filtering of the timeline.

    - + diff --git a/docs/cli/all-commands.html b/docs/cli/all-commands.html index 0f97f82..8b22605 100644 --- a/docs/cli/all-commands.html +++ b/docs/cli/all-commands.html @@ -12,7 +12,7 @@ - + @@ -83,6 +83,6 @@ # Learn more about a command: ardrive <command> --help
    - + diff --git a/docs/cli/getting-help.html b/docs/cli/getting-help.html index 46c85fd..74aa08e 100644 --- a/docs/cli/getting-help.html +++ b/docs/cli/getting-help.html @@ -12,11 +12,11 @@ - + - + diff --git a/docs/cli/getting-started.html b/docs/cli/getting-started.html index 822c314..f63ddba 100644 --- a/docs/cli/getting-started.html +++ b/docs/cli/getting-started.html @@ -12,7 +12,7 @@ - + @@ -39,6 +39,6 @@ # then invoke the CLI from anywhere on your system: ardrive

    To ensure your environment is compatible, we also recommend the following VSCode extensions:

    # Limitations

    Number of files in a bulk upload: Theoretically unlimited
    Max individual file size: 2GB (Node.js limitation)
    Max file name length: 255 bytes
    Max ANS-104 bundled transaction size: 500 MiB per bundle. App will handle creating multiple bundles.
    Max ANS-104 data item counts per bundled transaction: 250 Files per bundle (500 Data Items).

    - + diff --git a/docs/cli/index.html b/docs/cli/index.html index 887112b..67ff2d1 100644 --- a/docs/cli/index.html +++ b/docs/cli/index.html @@ -12,7 +12,7 @@ - + @@ -75,6 +75,6 @@ } }

    This project is in a state of active development. Use at your own risk!

    # ArDrive

    ArDrive (opens new window) is a permanent storage platform whose applications and core libraries (opens new window) offer hierarchical organization, privacy via complete end-to-end encryption, flexibility, extensibility, and access control over your most valuable data, all made possible by its innovative core technology, the Arweave File System (ArFS) Protocol (opens new window).

    # ArFS

    ArFS (opens new window) is a data modeling, storage, and retrieval protocol designed to emulate common file system operations and to provide aspects of mutability to your data hierarchy on Arweave (opens new window)'s otherwise permanent, immutable data storage blockweave.

    # Data Portability

    Data uploaded via the ArDrive CLI, once indexed by Arweave's Gateways and sufficiently seeded across enough nodes on the network, can be accessed via all other ArDrive applications including the ArDrive Web application (opens new window) at https://app.ardrive.io.

    All transactions successfully executed by ArDrive can always be inspected in the Viewblock blockchain explorer (opens new window).

    # Intended Audience

    This tool is intended for use by:

    • ArDrive power users with advanced workflows and resource efficiency in mind: bulk uploaders, those with larger storage demand, game developers, nft creators, storage/db admins, etc.
    • Automation tools
    • Services
    • Terminal aficionados
    • Extant and aspiring cypherpunks

    For deeper integrations with the ArDrive (opens new window) platform, consider using the ArDrive Core (opens new window) (Node) library's configurable and intuitive class interfaces directly within your application.

    - + diff --git a/docs/cli/using-the-cli.html b/docs/cli/using-the-cli.html index b506462..382ece7 100644 --- a/docs/cli/using-the-cli.html +++ b/docs/cli/using-the-cli.html @@ -12,7 +12,7 @@ - + @@ -468,6 +468,6 @@

    # Persistent Caching of ArFS Entity Metadata

    To avoid redundant requests to the Arweave network for immutable ArFS entity metadata, a persistent file cache is created and maintained at:

    Windows: <os.homedir()>/ardrive-caches/metadata
 Non-Windows: <os.homedir()>/.ardrive/caches/metadata

    The XDG_CACHE_HOME environment variable is honored, where applicable, and will be used in place of os.homedir() in the scenarios described above.

    Metadata cache logging to stderr can be enabled by setting the ARDRIVE_CACHE_LOG environment variable to 1.

    Cache performance is UNDEFINED for multi-process scenarios, but is presumed to be generally usable.

    The cache can be manually cleared safely at any time that any integrating app is not in operation.

    - + diff --git a/docs/core-sdk.html b/docs/core-sdk.html index f6b336e..76bc2bd 100644 --- a/docs/core-sdk.html +++ b/docs/core-sdk.html @@ -12,7 +12,7 @@ - + @@ -135,6 +135,6 @@ } );
    - + diff --git a/docs/index.html b/docs/index.html index cd66a07..de931ae 100644 --- a/docs/index.html +++ b/docs/index.html @@ -12,11 +12,11 @@ - +
    ArDrive Docs

    # placeholder

    Exercitation proident duis qui est veniam duis ullamco proident et veniam.

    - + diff --git a/docs/misc/deploy/deploy.html b/docs/misc/deploy/deploy.html index d658f2e..339a08f 100644 --- a/docs/misc/deploy/deploy.html +++ b/docs/misc/deploy/deploy.html @@ -12,11 +12,11 @@ - +
    ArDrive Docs

    # Deploying your dApp

    # Overview

    This guide will outline the steps needed to deploy your dApp onto the Arweave blockchain using the ArDrive web app. It assumes you have already prepared your dApp to use hash routing and relative file paths, and built static files for any dApp in a language or framework that requires it (like React).

    # Deploying

    # Step 1: Log into ArDrive

    Go to the ArDrive web app (opens new window) and log in using the method of your choosing. If you don't already have an account, you will need to follow the instructions to set one up.

    # Step 2: Select or Create a Drive

    Once logged in, navigate to the drive where you want your project to be hosted. If you haven't created a drive yet, or if you want a new one specifically for this project, click the big red "New" button at the top left and create a new drive. Remember, the drive needs to be set to public for your dApp to be accessible to others.

    # Step 3: Upload your project

    With your drive selected, click the big red "New" button again, but this time, select "Upload Folder". Navigate to your project's root directory, or the built directory if required, and select it. This will upload the entire directory, maintaining your project's file structure.

    # Step 4: Confirm Upload

    You'll be given a chance to review the upload and the associated cost. If everything looks right, click "Confirm". Remember, uploading to Arweave isnt free, but the cost is usually quite small and the benefits of having your dApp hosted on the permaweb are significant.

    # Step 5: Create the Manifest

    While ArDrive displays your uploaded files as a traditional file structure, with files and folders inside other folders, thats not how they actually exist on Arweave. The manifest acts as a map to all the files your dApp needs to function. After you confirm your upload, navigate into your newly created folder by double clicking on it. Click the big red "New" button again and select "Create manifest". You'll be prompted to name the manifest and choose where to save it. Be sure to save it inside the folder you just created.

    # Step 6: Get the Data TX ID

    Once the manifest is created, click on it to expand its details. On the bottom right, there's a line labeled "Data TX ID". This is the unique identifier for your uploaded dApp on Arweave. Copy this value.

    # Step 7: View and Share your dApp

    Your dApp is now available on the permaweb forever! Append the Data TX ID you just copied to the end of an Arweave gateway URL, like https://arweave.net/ . It might take a few minutes for all of your files to finish propagating through the network, but once they do your dApp will be accessible to anyone, anywhere, at any time.

    # Updating your dApp

    Files uploaded to Arweave are permanent and immutable. They cannot be changed. However, the Arweave File System (ArFS) protocol used (and created) by ArDrive lets you "replace" them with new versions while still being able to access the old ones. You can do this with entire dApps as well. The old files won't be displayed in the ArDrive web app unless you click on a file to view its history.

    Once you have made changes to your dApp, and built the static directory for it, you can upload the entire folder again to the same location where you uploaded the original. Follow all the same steps listed above for uploading your dApp. You will need to create a new manifest to correctly point to the updated files. Give it the same name as the old manifest in order to "replace" it. Creating the new manifest will generate a new TX ID used to view the updated dApp.

    The old version of the dApp will always be available to anyone who has the correct TX ID

    - + diff --git a/docs/misc/deploy/examples.html b/docs/misc/deploy/examples.html index 4a5a622..bf3d432 100644 --- a/docs/misc/deploy/examples.html +++ b/docs/misc/deploy/examples.html @@ -12,11 +12,11 @@ - +
    ArDrive Docs

    # Examples

    Below are some basic websites built with different languages or frameworks that provide more detailed information on how to configure your dApp for that framework. Each one has been deployed to Arweave itself to show that it functions correctly, and can be accessed through any Arweave gateway by using its TX ID. These are all very basic examples, but if you follow the principles explained, your dApp will function correctly when deployed to the permaweb no matter how big or complex it becomes.

    # Basic HTML

    A basic HTML website with a javascript script to facilitate hash routing:

    GPOX8dgUpFpt8IVUyyfBMiPpfWZ9eXHZjNi42W4-_50 (opens new window)

    # React

    A React dApp created using Create-React-App:

    BTjZhINTpCtWiE0PcfpAQ8a3QhL-1AwXfNJ9lhbaJj0 (opens new window)

    # Next

    A Nextjs dApp created using Create-Next-App:

    01hMcPNA_TEXh1S7p4f6jop7r4lrElF1mIlAwkzhJ_s (opens new window)

    # WordPress

    ilP8KEFm0jGAhjEP6e7ZlS7s6BV1NgGJnlw7OfiD5kU (opens new window)

    - + diff --git a/docs/misc/deploy/index.html b/docs/misc/deploy/index.html index 38ea741..2b9c610 100644 --- a/docs/misc/deploy/index.html +++ b/docs/misc/deploy/index.html @@ -12,11 +12,11 @@ - +
    ArDrive Docs

    # Preparing Your dApp

    To make sure dApps work correctly on the Arweave blockchain, they need to be set up in a specific manner. This is because, unlike traditional web hosting, there are no centralized servers for browsers to request files from. Your dApp needs to be able to handle navigation inside the client's browser instead of relying on communication between the client and a server, and not rely on a server as a point of origin for file paths. This is done by ensuring the following:

    Failure to properly implement either will result in your dApp not working the way it should once it is deployed onto Arweave.

    - + diff --git a/docs/misc/deploy/paths.html b/docs/misc/deploy/paths.html index cfc58ac..6bccf55 100644 --- a/docs/misc/deploy/paths.html +++ b/docs/misc/deploy/paths.html @@ -12,11 +12,11 @@ - +
    ArDrive Docs

    # File Paths

    # Overview

    File paths are needed to locate resources in your file system or on a server. There are two types of file paths: absolute and relative. Because there is no way to know exactly from where a user will access a dApp deployed on Arweave, all file paths used need to be relative.

    # Absolute Vs. Relative

    An absolute path is the full URL to a resource, starting from the root. For example, http://www.example.com/images/myImage.jpg is an absolute path. It points directly to the image no matter where the code referencing it is located.

    A relative path is a path relative to the current location. If you have an HTML file in the root directory (folder) and an image in a subdirectory called 'images', you could use the relative path images/myImage.jpg to reference the image.

    # Why Relative Paths

    When deploying dApps on Arweave, relative paths are essential because:

    • Domain agnostic: Arweave permaweb dApps can be accessed from various gateways, not just one domain. Absolute paths tied to a specific domain will not work.
    • Decentralized: Arweave is a decentralized network. There is no root directory or server configuration to reference. All file paths must be relative to the file trying to find an asset, or your dApp wont be able to find it.

    # Identifying Relative and Absolute Paths

    The key difference between relative and absolute file paths is where they start from:

    • Absolute Paths start with a slash (/) or a full URL (including the protocol, such as http://). For example, /images/myImage.jpg or http://www.example.com/images/myImage.jpg are absolute paths.
    • Relative Paths do not start with a slash. They are relative to the current directory. For example, images/myImage.jpg or ../myImage.jpg are relative paths.

    You can navigate around the files of your project with relative paths by following these principles:

    • Same Directory: If the file you're trying to reference is in the same directory as the current file, you can just use the filename. For example, if index.html and about.html are in the same directory, you can link to about.html just using about.html.

    • Subdirectory: If the file is in a subdirectory, you can use the directory name followed by the filename. For example, images/myImage.jpg will point to the myImage.jpg file in the images subdirectory.

    • Parent Directory: If the file is in a parent directory, you can use ../ to go up one level. For example, ../index.html will point to index.html in the parent directory. You can use multiple ../ to go up multiple levels, like ../../index.html.

    - + diff --git a/docs/misc/deploy/routing.html b/docs/misc/deploy/routing.html index 8183954..7842785 100644 --- a/docs/misc/deploy/routing.html +++ b/docs/misc/deploy/routing.html @@ -12,11 +12,11 @@ - +
    ArDrive Docs

    # Hash Routing

    # Overview

    Hash routing is a popular technique in single page applications (SPAs) where the site navigation is handled using JavaScript. The "hash" in hash routing refers to the hash symbol (#) inserted into the URL. The part of the URL after the hash symbol is used to determine which "page" to show.

    For example, if your URL is "http://www.example.com/#about", the part after the hash (about) would be used to show an app's "about" page.

    # Hash Routing Vs. History Routing

    Traditional web apps use history routing, where each unique URL represents a different source or asset contained in a server. The URL "http://www.example.com/about" would fetch the "about" page from the app's server and display it for a user. History routing requires a server be available to provide the correct files every time a user navigates around an app.

    In contrast, with hash routing, all navigation is handled by the client's browser, so no server is needed for navigation.

    # Why Hash Routing for dApps

    Hash routing is particularly useful for apps deployed on Arweave for several reasons:

    • Serverless: Arweave is a decentralized storage network. There's no server to process requests, so routing cannot be handled by a server.
    • Persistence: Once data is stored on Arweave, it can't be changed. Hash routing allows you to have "dynamic" content within this immutable structure.
    • Performance: With hash routing, all the necessary code is loaded once, reducing the number of network requests and improving performance.
    - + diff --git a/docs/misc/permasite.html b/docs/misc/permasite.html index 46ee11a..e478fe7 100644 --- a/docs/misc/permasite.html +++ b/docs/misc/permasite.html @@ -12,11 +12,11 @@ - +
    ArDrive Docs

    # How to Save a Website Permanently

    # Overview

    ArDrive offers the ability to save working copies of static websites permanently on Arweave (opens new window). This means that websites made on WordPress, Wix, SquareSpace and other CMS platforms can now be archived for hundreds of years without the need to pay for ongoing data storage.

    Resources like the Wayback Machine (opens new window) are useful to research the past life of old websites. But the Wayback Machine’s archives are not comprehensive and often only capture partial copies of historic sites. By leveraging the utility of Arweave manifests, ArDrive offers the ability to save full working copies of websites in an unchanging, permanent state without needing to code.

    The process to make a ‘permasite’ takes 10 steps which are outlined below. Advanced users can accomplish similar results by using manifests within the ArDrive CLI.

    You can view a permasite version of this information at permasite.arweave.dev (opens new window)

    # 1. Download Static Site Files

    ArDrive allows you to preserve full working copies of the static content of existing websites but there are a few limitations to be aware of:

    • Permanent sites will not enable backend interaction with your website’s CMS,
    • nor allow you to make further changes to the content of your site,
    • nor support dynamic functionality like contact forms and eCommerce.

    To generate your static site files, we recommend:

    # Windows Users

    WebCopy (opens new window) and HtTrack (opens new window) enable Windows users to download static copies of entire websites.

    # Mac Users

    Offline Pages Pro (opens new window) (Mac users only), which creates files that work well with this process. After saving your site with Offline Pages Pro, go to File > Export > Local Website to download the local static files.
    SiteSucker (opens new window) is another option for Mac users.

    # Command Line Utility

    Wget (opens new window) is a free tool that helps capture static versions of websites. While Wget isn't a traditional static site generator, it's great for downloading whole websites for offline use. It offers a simple way to save your site's current look and feel as static files at no cost.

    # WordPress

    Simply Static (opens new window) is a plugin that generates static files for WordPress websites. Some users note that Simply Static fails to properly associate CSS and JS files with your static site, but others have had success with this free WordPress plugin.

    # 2. Create an Account on ArDrive

    Account creation is free as are uploads of small files (currently up to 500 KB). Remember that ArDrive empowers you to be in control of your data; no one else has your password but you. Therefore, it is very important that you safely record your password and seed phrase as they cannot be recovered later.

    # 3. Create a New Public Drive

    Click on the red +New button and create a Drive. Name your Drive and set it as “Public”. ArDrive also offers “Private” file storage; however, permanent websites must be public in order to maintain functionality.

    # 4. Top Up

    To pay for permanent storage on the Arweave network you must either purchase ArDrive Turbo credits with a credit card or (or the advanced option) ensure your wallet has $AR, the native token of the Arweave ecosystem. Most websites will cost less than $1 to save permanently. See current prices (opens new window)

    # 5. Upload Static Files

    Upload the static files to your new Public Drive. Offline Pages Pro will generate an index.html file that is separate from a large folder of assets (images, css, fonts, etc). Simply Static will add the index.html file to the rest of your assets. Either way, upload all the files you receive from your static site generator to your new Public Drive.

    # 6. Wait

    Permanence takes patience. Once static files have been uploaded, they need to be sent to the Arweave network before being assembled together. This process can take as little as 5 seconds (when using Turbo credits) or up to 30 minutes or more (when using $AR). Make sure to keep your browser tab open and do not refresh your browser while you wait.

    To check on the status of your files, you can click the refresh icon in the top right of ArDrive. You’ll know your file is ready when the light on the icon turns from yellow to green. (Pro Tip: some files uploaded with Turbo are ready before they are green.)

    # 7. Create a Manifest

    Manifests (opens new window) are special .json files that instruct Arweave Gateways to map file data associated with specific, unique transaction IDs to customized, hosted paths relative to that of the manifest file itself. In other words, they are the secret sauce that brings a permasite together.

    Click on the red +New button and select Advanced > New Manifest. Select the location for your manifest, ensuring it is in the same place as your index.html file.

    Give your Manifest a name like “permasite”, it will be the main way you access your permanent website from ArDrive.

    # 8. Wait Again

    Now the manifest needs to be sent to the Arweave network. Again, this process can take just a few seconds or up to 30 minutes or more.

    After a bit, you can refresh your Drive by clicking on the icon in the upper right – and see if your manifest icon turns from yellow to green.

    # 9. Preview the Manifest

    Got a green light? You’re ready to go. Click on your manifest file and you will see a panel of options appear on the right side of your screen. Click on the Preview icon in the top right and it will open a new tab with your permasite.

    If a website appears with a long, random-looking URL in the browser bar, then congrats, you made a permasite!

    Try clicking around and make sure all your pages are preserved. If they are not it could be a limitation of your static site generator or an issue with the manifest (see Notes below).

    # 10. Add a Redirect or Domain Masking

    You’ll notice that your permasite has a long, random-looking URL generated by Arweave. These long URLs are designed to remain for decades, but they also are not very memorable.

    Try redirecting another domain to your permasite, or mask your permasite domain with a domain of your choosing. You can also acquire an ArNS name (opens new window) that enables you to create a custom, permanent name for your permasite.

    # Notes

    • There’s no delete button with Arweave. Once your permasite is up, it’s up forever. Make sure your content is something you want future humanity to have.

    • Only static sites can become permasites through the ArDrive web app. Advanced functionality is available for developers who use the ArDrive CLI (opens new window).

    • Links to content on external websites will not be permanent (unless they are also permasites) and if that external content becomes inaccessible or moves, you will not be able to update the links within your permasite.

    • Non-English characters in the URLs of your permasite can be problematic for ArDrive manifests, but non-English characters should work well on the permasite itself.

    # Other Use Cases

    Permasites can be used to archive web content before it disappears from the internet. Or they can be used to create working copies of websites before it a particular site is replaced by new versions.

    Manifests can also be used to make reliable perma-backups. Many web hosts offer good daily backups and some offer reliable offsite backups as well. Permasites enable you to have decentralized, highly-redundant backups of your website’s content for a very low cost.

    # Example

    You can view a permasite version of this information at permasite.arweave.dev (opens new window)

    - + diff --git a/docs/misc/price-calculator.html b/docs/misc/price-calculator.html index 3b9e074..6b08bf2 100644 --- a/docs/misc/price-calculator.html +++ b/docs/misc/price-calculator.html @@ -12,7 +12,7 @@ - + @@ -29,6 +29,6 @@ Run with the --watch flag (yarn test -- --watch) to run in interactive watch mode.

    # yarn run:prod

    Builds a fresh snowpack production build to the build/ folder Then launches that copy with http-server-spa for local testing The build will be available for preview at: http://localhost:8080 (opens new window)

    - + diff --git a/docs/turbo/api/payment.html b/docs/turbo/api/payment.html index be71ab6..2c22556 100644 --- a/docs/turbo/api/payment.html +++ b/docs/turbo/api/payment.html @@ -12,7 +12,7 @@ - + @@ -457,6 +457,6 @@ ] }

    * required

    - + diff --git a/docs/turbo/api/upload.html b/docs/turbo/api/upload.html index 448daa1..e4817eb 100644 --- a/docs/turbo/api/upload.html +++ b/docs/turbo/api/upload.html @@ -12,7 +12,7 @@ - + @@ -60,6 +60,6 @@ } ```

    * required

    - + diff --git a/docs/turbo/migrating.html b/docs/turbo/migrating.html index 172b94c..69ac079 100644 --- a/docs/turbo/migrating.html +++ b/docs/turbo/migrating.html @@ -12,7 +12,7 @@ - + @@ -43,6 +43,6 @@

    # Using Irys CLI with Turbo

    Selecting Turbo as the upload method using the Irys CLI is similarly simple. https://up.arweave.net can be set as the target node when using the upload or upload-dir CLI commands with the -h flag:

    irys upload importantFile.pdf -h https://up.arweave.net --tags superImportant needsPermanence
 
    irys upload-dir ./bigFolder -h https://up.arweave.net

    Other flags may be used as normal

    # Differences

    # Crypto Top Ups / Withdrawals

    Turbo does not natively support block chains other than Arweave. This means that some features dealing with other chains, like topping up your Irys balance with other coins, or withdrawing from your Irys balance are not currently supported.

    # Wallet Extensions and Providers

    Turbo is not yet designed to interact with wallet extensions and providers that are not a part of the Arweave ecosystem. While the ArDrive Web App does support generating an Arweave wallet from an EVM wallet using Metamask, Turbo cannot facilitate uploading using an EVM wallet directly.

    # GraphQL

    Projects that do claim to allow uploading from non-arweave wallets actually accept payment on their front ends and handle the actual uploading using an Arweave wallet. As such, the owner of an upload will not match the non-arweave wallet address and the upload cannot be found by searching for it in GraphQL. This value can, however, be added as a tag on the upload and searched in that way.

    - + diff --git a/docs/turbo/turbo-sdk/index.html b/docs/turbo/turbo-sdk/index.html index de1373c..54dc0c8 100644 --- a/docs/turbo/turbo-sdk/index.html +++ b/docs/turbo/turbo-sdk/index.html @@ -12,7 +12,7 @@ - + @@ -178,6 +178,6 @@ // no timeout or AbortSignal provided });

    # Contributions

    If you encounter any issues or have feature requests, please file an issue on our GitHub repository. Contributions, pull requests, and feedback are both welcome and encouraged.

    - + diff --git a/docs/turbo/turbo-sdk/release-notes.html b/docs/turbo/turbo-sdk/release-notes.html index 77678b3..234670b 100644 --- a/docs/turbo/turbo-sdk/release-notes.html +++ b/docs/turbo/turbo-sdk/release-notes.html @@ -12,11 +12,11 @@ - +
    ArDrive Docs

    # Turbo SDK Release Notes

    # Overview

    Welcome to the documentation page for the Turbo SDK release notes. Here, you will find detailed information about each version of the Turbo SDK, including the enhancements, bug fixes, and any other changes introduced in every release. This page serves as a comprehensive resource to keep you informed about the latest developments and updates in the Turbo SDK. For those interested in exploring the source code, each version's code is readily accessible at our GitHub repository: Turbo SDK Releases (opens new window). Stay updated with the continuous improvements and advancements in the Turbo SDK by referring to this page for all release-related information.

    # Releases

    # V1.3.0

    (2024-01-03)

    Bug Fixes

    • web: ensure we have the public key for arconnect wallets when signing data
    • web: remove reference to node:crypto in websigner, use signer to signer to sign header

    Features

    • signer: allow an optional signer to be passed instead of JWK for signing data items

    # V1.2.0

    (2023-12-15)

    Features

    • data item opts: init tags anchor and target support PE-5035

    # V1.1.1

    (2023-12-14)

    Bug Fixes

    • exports: use bundled export to avoid issue with polyfilled features needed for web
    • exports: web exports reference an invalid build path
    • polyfills: update esbuild script to include crypto polyfill

    # V1.1.0

    (2023-11-10)

    Bug Fixes

    • axios: set maxRedirects to 0 on our axios instances

    Features

    • logger: add configurable global logger

    # V1.0.2

    (2023-11-03)

    Bug Fixes

    • upload: update the default upload service URL

    # V1.0.1

    (2023-09-27)

    Bug Fixes

    • headers: add default headers for all HTTP requests
    • release: use script that updates built version.js files
    • version: update version.js to proper version on build and commit it back to git after a release

    # V1.0.0

    (2023-09-26)

    Bug Fixes

    • add command that removes type module from package.json
    • add command that removes type module from package.json
    • add main import and allow wildcard imports
    • add module to package.json and tweak types
    • add one more step to make esm useable
    • add owner to TurboUploadDataItemResponse and remove byteCount
    • add separate folder for types, use it in named exports
    • change name of public facing clients.
    • cjs: add separate cjs and esm outputs
    • content-length: require content length factory for uploads
    • exports: move turbo configurations to turbo.ts so it is available to clients
    • fix package.json
    • modify return type of signDataItem function, tweak implementation of ArweaveSigner header
    • move from getWincPriceForBytes to getUploadCosts
    • package.json: add back module to package.json
    • remove package.json from lib directory
    • remove postinstall command
    • replace retry-axios, add additional retry logic
    • retry-axios: pin retry-axios to 3.0.0
    • revert to single file upload/data item upload
    • swap adding package.json to esm to cjs
    • top up: export type PE-4465
    • type imports for web and node
    • types: finalize types, update default payment and upload URLs
    • update main and types path in package.json
    • update package.json output for esm
    • update web signer and cleanup examples
    • use .cjs as base for types to avoid reference require errors
    • use declare in sub-classes to overwrite parent class type
    • wildcard: allow wildcard exports for older projects
    • wrong path for types!

    Features

    • abstract axios to TurboHTTPService class
    • abstract JWKInterface used in AuthenticatedPayment and AuthenticatedUploadService
    • add remaining unauthenticated apis for payment service, introduce some new types, add tests
    • add uploadFiles implementation for node and web
    • break services into auth vs unauth
    • initial implementation of TurboWebClient and TurboNodeClient
    • introduce AbortController
    • introduce uploadSignedDataItem interface, implement for node
    • remove TurboDataItemVerifier
    • sdk: all uphill from here 🚀 PE-4064
    • top-up: init get checkout session PE-4465
    • winc for fiat: extend AmountMapper pattern and add promoCode support PE-4465
    - + diff --git a/docs/turbo/turbo-sdk/turbo-web.html b/docs/turbo/turbo-sdk/turbo-web.html index 46eeb2c..d147d2c 100644 --- a/docs/turbo/turbo-sdk/turbo-web.html +++ b/docs/turbo/turbo-sdk/turbo-web.html @@ -12,11 +12,11 @@ - +
    ArDrive Docs

    # Using Turbo SDK in a Browser Environment

    # Overview

    With Turbo-SDK v1.3.0, You can authenticate a Turbo instance by passing in an arweave signer instance instead of JWK. This supports the ArweaveSigner or ArconnectSigner classes from arbundles (opens new window).

    - + diff --git a/docs/turbo/what-is-turbo.html b/docs/turbo/what-is-turbo.html index 3a7df2c..9ad22a6 100644 --- a/docs/turbo/what-is-turbo.html +++ b/docs/turbo/what-is-turbo.html @@ -12,12 +12,12 @@ - +
    ArDrive Docs

    # What Is Turbo?

    Turbo, offered by ArDrive, is a streamlined service that simplifies permaweb storage, making it more accessible by allowing users to pay for uploads with credit or debit cards. It integrates two key components: a service that bundles uploads for efficiency and ease, and a payment system designed for straightforward transactions. Turbo Credits, which users can purchase within the ArDrive web app, enable a direct conversion from AR tokens, reflecting the amount of data one can upload. These credits are meticulously calibrated, with the Winston Credit (winc) representing the smallest unit, ensuring users have precise control over their storage needs. As an open-source technology, Turbo encourages community engagement, allowing developers to contribute to its continuous enhancement.

    Type Feature
    Access
    • Optimistic, instant data caching, using arweave.net.
    • Optimistic, near instant GraphQL indexing including cross-chain token address indexing, using arweave.net.
    • Irys-compatible transaction status endpoint for checking transaction finality.
    Development and Integration
    Enterprise Built for scale and trusted by enterprises
    Identity
    • Cryptographic sign in using Arweave, Ethereum, Solana or other Irys-compatible keys.
    • Arweave ecosystem supported web wallets and providers:
      • ✅ Arconnect
      • ✅ arweave.app
      • ✅ ArweaveWalletAdapter
    Maturity
    Payments
    • Instantly fund your Turbo account with your credit card.
    • Leverage other Turbo benefits like Gifting and Coupon Codes.
    Performance
    • Irys-compatible single request or multipart uploading.
    • Proven, high layer 2 transactional throughput with 860/sec sustained on 12/18 and 12/19
    Provenance Irys-compatible receipts with transaction id, high resolution timestamp, upload price and cryptographic signature.
    Transparency Open source infrastructure and software development kit with AGPL3.0 licensing.
    - + diff --git a/index.html b/index.html index 805cbbd..f379f7d 100644 --- a/index.html +++ b/index.html @@ -12,11 +12,11 @@ - +
    ArDrive Docs

    # About ArDrive

    ArDrive offers never-ending storage of your most valuable files. Pay once and save your memories forever.

    Feature ArDrive Traditional Cloud Storage
    One time payments for file storage ✓ ✗
    No monthly subscriptions ✓ ✗
    200+ years of file storage ✓ ✗
    Data available even if company disappears ✓ ✗
    Decentralized and open source ✓ ✗
    Inactive accounts never deleted ✓ ✗

    # Control Your Own Data

    # True Data Ownership

    With pay-once pricing you no longer have to add another subscription fee to your monthly budget. Save big when you only have to pay for what you use.

    # No More Lost Data

    Feel safe about the longevity of your files and avoid the horror stories of broken hard drives, deleted accounts, or lost files.

    # Decentralized Network

    Break free from Big Tech and leverage the power of the decentralized Arweave blockchain network that puts you back in control. Own your data instead of renting it.

    # Community Owned

    You're the boss. As a Web3 organization, ArDrive is owned collectively so you can have a say in our governance and share in our rewards.

    # How can Ardrive Help You?

    # Store Family Memories Forever

    Never lose a cherished photo or video again. Keep and pass along all of your most important photos and documents to the present or future generations. Learn more (opens new window)

    # Permanence

    In a digital world, how do you guarantee information is kept for long-periods of time? Just as the web connects data and people over vast distances, your data can now be kept over vast periods of time. Learn more (opens new window)

    # Totally Private or Totally Public

    It’s your choice in how you want to manage your data. Keep it private, share with select individuals, or make it public to the world. ArDrive is optimized for photography, digital art and NFT storage. Learn more (opens new window)

    # Eliminate Subscription Fees

    If you are paying monthly for cloud storage you are renting out your data. Get a digital wallet and move to full ownership of your data with our innovative pay once per file pricing. Learn more (opens new window)

    # Control Your Data

    Break free from the whims of centralized big tech and ever-changing terms of service. Enjoy the benefits of total privacy, security, and extreme data redundancy on a decentralized network. Learn more (opens new window)

    # Perfect Record Keeping

    Data integrity, accuracy and consistency for your most important files! Achieve regulatory compliance in any industry or your personal life by having an immutable (unchanging) and time-stamped record of all your files. Learn more (opens new window)

    # Durable NFTs

    NFTs make the internet ownable. But when you buy an NFT how do you know it is going to be around in 20 years? Who is paying to store it? And what if they stop? Learn more (opens new window)

    # Archive the Web

    Save a copy of any webpage you create or find! Each page will be given a unique url and saved on to Arweave’s permaweb (just like the web, but forever!). Learn more (opens new window)

    - +