From cbe57d95cd334d29470d0290b9c7e70dff594e5e Mon Sep 17 00:00:00 2001 From: bobinstein Date: Fri, 22 Dec 2023 15:19:14 -0500 Subject: [PATCH] docs: added Turbo features table --- docs/src/.vuepress/theme/styles/index.styl | 13 ++++ docs/src/docs/turbo/migrating.md | 14 ++-- docs/src/docs/turbo/what-is-turbo.md | 83 ++++++++++++++++++++++ 3 files changed, 103 insertions(+), 7 deletions(-) diff --git a/docs/src/.vuepress/theme/styles/index.styl b/docs/src/.vuepress/theme/styles/index.styl index f3301e9..d419530 100644 --- a/docs/src/.vuepress/theme/styles/index.styl +++ b/docs/src/.vuepress/theme/styles/index.styl @@ -72,3 +72,16 @@ h2 .subHeaderGroupTitle color var(--TextColor) !important + + +/* Tip container customization */ +.theme-default-content .tip { + background-color: var(--BorderColor); + border-left-color: var(--AccentColor); + + .custom-block-title { + background-color: transparent; + color: var(--TextColor); + font-weight: bold; + } +} diff --git a/docs/src/docs/turbo/migrating.md b/docs/src/docs/turbo/migrating.md index 3974c85..b0fc72d 100644 --- a/docs/src/docs/turbo/migrating.md +++ b/docs/src/docs/turbo/migrating.md @@ -4,6 +4,10 @@ next: false # Migrating to Turbo From Irys +::: tip Irys Version Management +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. +::: + ## Overview 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. @@ -29,7 +33,7 @@ const wallet = JSON.parse( const init = async () => { const token = "arweave"; const irys = new Irys({ - url: "https://up.arweave.net", // URL of the node you want to connect to, up.arweave.net will facilitate upload using ArDrive Turbo. + url: "https://up.arweave.net", // URL of the node you want to connect to, https://up.arweave.net will facilitate upload using ArDrive Turbo. token, // Token used for payment and signing key: wallet, // Arweave wallet }); @@ -39,13 +43,11 @@ const init = async () => { } ``` -**NOTE**: This was tested using Irys SDK v0.1.1 Future versions of the Irys SDK may introduce breaking changes. It is suggested that developers lock their version. - ## Using Irys CLI with Turbo -Selecting Turbo as the upload method using the Irys CLI is similarly simple. `up.arweave.net` can be set as the target node when using the `upload` or `upload-dir` CLI commands with the `-h` flag: +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: -```terminal +``` irys upload importantFile.pdf -h https://up.arweave.net --tags superImportant needsPermanence ``` @@ -55,8 +57,6 @@ irys upload-dir ./bigFolder -h https://up.arweave.net Other flags may be used as normal -**NOTE**: 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. - ## Differences diff --git a/docs/src/docs/turbo/what-is-turbo.md b/docs/src/docs/turbo/what-is-turbo.md index 1fa8999..f79d9e5 100644 --- a/docs/src/docs/turbo/what-is-turbo.md +++ b/docs/src/docs/turbo/what-is-turbo.md @@ -6,3 +6,86 @@ prev: false 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. +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeFeature
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 + +
EnterpriseBuilt 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
    • +
+
ProvenanceIrys-compatible receipts with transaction id, high resolution timestamp, upload price and cryptographic signature.
TransparencyOpen source infrastructure and software development kit with AGPL3.0 licensing.
+