Skip to content

Commit

Permalink
docs: Updated Turbo docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Bobinstein committed Sep 23, 2024
1 parent 1042d0c commit 36aa96a
Show file tree
Hide file tree
Showing 6 changed files with 118 additions and 10 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/.vuepress/public/images/top-up-app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/src/.vuepress/theme/configs/default_sidebar_config.js
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,10 @@ module.exports = [
title: "What is Turbo?",
path: "/docs/turbo/what-is-turbo"
},
{
title: "Turbo Credits",
path: "/docs/turbo/credits"
},
{
title: "Payment API",
path: "/docs/turbo/api/payment"
Expand Down
2 changes: 1 addition & 1 deletion docs/src/docs/turbo/api/upload.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
next: false

---

# Upload API
Expand Down
105 changes: 105 additions & 0 deletions docs/src/docs/turbo/credits.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
---
permalink: "/docs/turbo/credits"
---

# Turbo Credits

## Overview

Turbo Credits are the payment medium used by the Turbo Upload Service. Each credit represents a 1:1 conversion from the upload power of the Arweave native token (AR), before any subsidies. Turbo Credits are divisible down to units of 1 trillionth of a credit, called a Winston Credit (winc), and can be purchased using a variety of fiat currencies or crypto tokens.

Turbo Credits are not, themselves, a crypto token, in the sense that they cannot be traded, transferred, sold, or exchanged.

## Fees and Benefits

When purchasing Turbo Credits, using either fiat currencies or crypto tokens, there is a `23.4%` fee applied to the purchase price. This fee helps to develop and maintain the infrastructure used to provide a number of benefits over direct-to-network uploads (uploads using AR directly). There is no additional fee at the time of using Turbo Credits for upload. At the time of upload, Credits having the same, or better, value per GiB of storage as AR as priced by the Arweave network regardless of fluctuations in the fiat value of AR since the time of purchase.

- **Per-Byte Pricing**: Arweave requires payment for every chunk of data (256 KiB) uploaded. This means that many direct-to-network uploads have a small portion of the upload costs paying for empty space in the final chunk of the data. Turbo subsidizes this empty space, allowing users to pay only for the exact amount of data being uploaded.

- **Fast Finality**: Data uploaded to Arweave nodes propagates over time to other nodes in the network so that they, and the gateways that interface with them, may serve and index that data. These retrieval and indexing latencies, lasting minutes or even hours, are eliminated by Turbo via direct integrations with leading Arweave gateways, allowing you to retrieve data immediately and query for it via GQL APIs within seconds of upload time. Additionally, Turbo uploads to gateways that seed data to various nodes on the Arweave network, facilitating more rapid and durable propagation of your data into the network.

- **Failed Upload Protection**: In rare occasions, transactions committed to the Arweave network are dropped when network nodes opt to reorganize the chain. And while AR value is restored to the transaction uploaders in this process, the dropped transactions may need to be recomposed and have to be resubmitted to the network. Turbo ensures that your data obtains the necessary number of confirmations on chain that mitigate the risk of reorganization and will retain and, if necessary, later submit your data in the unlikely event of a chain reorganization or network outage.

- **Subsidies**: Data item uploads through Turbo under 100 KiB in size are currently fully subsidized, allowing users to upload small files for free. Subsidized uploads are not possible with direct-to-network transactions.

- **Easy-to-use Tooling**: Turbo offers a user-friendly [SDK and CLI](./turbo-sdk/index.md) for effortless uploading to Arweave. These tools simplify advanced workflows as well such as Arweave Path Manifest generation during folder uploads, streamlining the process of putting entire websites or dApps on the permaweb.

- **Open Source**: All of the code bases for the Turbo [Upload service](https://github.com/ardriveapp/turbo-upload-service), [Payment service](https://github.com/ardriveapp/turbo-payment-service), and [tooling](https://github.com/ardriveapp/turbo-sdk) are fully open source. The infrastructure uses an AGPL 3.0 license, while the SDK tooling uses an Apache 2.0 license.

<div style="text-align: center">
<table class="inline-table">
<tr>
<th>Feature</th>
<th colspan="2">Upload Method</th>
</tr>
<tr>
<th></th>
<th>Turbo</th>
<th>Direct-To-Network</th>
</tr>
<tr>
<th>Permanent Storage</th>
<td>✅</td>
<td>✅</td>
</tr>
<tr>
<th>SDK available for uploading</th>
<td>✅</td>
<td>✅ - <a href="https://github.com/ArweaveTeam/arweave-js" target="_blank" rel="noreferrer">arweave-js</a></td>
</tr>
<tr>
<th>Open Source Infrastructure</th>
<td>✅</td>
<td>✅</td>
</tr>
<tr>
<th>Per-Byte Pricing</th>
<td>✅</td>
<td></td>
</tr>
<tr>
<th>Instant Data Availability</th>
<td>✅</td>
<td></td>
</tr>
<tr>
<th>Failed Upload Protection</th>
<td>✅</td>
<td></td>
</tr>
<tr>
<th>Subsidized Uploads</th>
<td>✅</td>
<td></td>
</tr>
<tr>
<th>Sign Upload Transactions From Ethereum or Solana Wallets</th>
<td>✅</td>
<td></td>
</tr>
</table>
</div>

## How to Purchase Credits

### Top Up App

The [Turbo Top Up app](https://turbo-topup.com/) is an easy "one stop shop" for purchasing Turbo Credits. From this app, user's can purchase credits using USD or AR tokens. Credits can even be purchased "into" Ethereum or Solana wallets, as opposed to Arweave wallets, which allows users to pay for and sign upload transactions directly with their preferred wallet.

<img :src="$withBase('/images/top-up-app.png')" class="amazingdiagram" style="width: 75%">

### ArDrive App

[ArDrive](https://app.ardrive.io/) is a web and mobile app for easily uploading data to Arweave, and organizing your uploaded files in a traditional file structure using [ArFS](../arfs/overview.md). ArDrive allows uploads using either AR tokens or Turbo Credits, and provides a simple "add" button under your user profile (top right) to purchase Turbo Credits using United States Dollars.

<img :src="$withBase('/images/ardrive-turbo-buy-image.png')" class="amazingdiagram" style="width: 75%">

### Turbo SDK/CLI

The [Turbo SDK](./turbo-sdk/index.md) and included [CLI](./turbo-sdk/index.md#cli) offers the most flexible option for purchasing Turbo Credits. Credits can be purchased with any of the supported fiat currencies or crypto tokens. These purchases can be done on demand or programmatically, allowing you to build novel Permaweb integrations powered by simple, reliable uploads to Arweave.

### Turbo API

Users can also send requests for a Stripe checkout session (purchasing credits with fiat) directly to the [Turbo Payment Service API](./api/payment.md#get-quote-for-credits). This will return a url for users to finish their purchase using Stripe and a valid credit/debit card.


17 changes: 8 additions & 9 deletions docs/src/docs/turbo/what-is-turbo.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ prev: false

# 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 in a variety of ways, including with credit or debit cards, ETH, SOL, or the traditional AR. 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.
Turbo is a ultrahigh-throughput Permaweb service that streamlines the funding, indexing, and transmission of data to and from Arweave. It provides graphical and programmatic interfaces for payment options in fiat currency with credit or debit cards as well as cryptocurrencies such as ETH, SOL, and AR. 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, the [Turbo Top Up App](https://turbo-topup.com/), or by using the [Turbo SDK/CLI](./turbo-sdk/index.md), have the same storage purchasing power of AR tokens, along with the additional benefits provided by Turbo. 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.

<div style="text-align: center">
<table class="inline-table">
Expand All @@ -18,7 +18,7 @@ Turbo, offered by ArDrive, is a streamlined service that simplifies permaweb sto
<ul>
<li>Optimistic, instant data caching, using arweave.net.</li>
<li>Optimistic, near instant GraphQL indexing including cross-chain token address indexing, using arweave.net.</li>
<li>Irys-compatible transaction status endpoint for checking transaction finality.</li>
<li>Transaction status endpoint for checking transaction finality. (Irys compatible)</li>
</ul>
</td>
</tr>
Expand All @@ -30,7 +30,6 @@ Turbo, offered by ArDrive, is a streamlined service that simplifies permaweb sto
<li>Deploy your own upload and payment service for bundling data and sending it to Arweave. <ul><li><a target="_blank" href="https://github.com/ardriveapp/turbo-upload-service">GitHub - ardriveapp/turbo-upload-service: Turbo Upload service that allows users to upload data items using fiat currencies.</a></li><li><a target="_blank" href="https://github.com/ardriveapp/turbo-payment-service">GitHub - ardriveapp/turbo-payment-service: ArDrive Turbo Payment Service that manages Turbo balances.</a></li></ul>
<li>Flexible typescript SDK for seamless web and NodeJS integration.</li>
<li><a target="_blank" href="https://github.com/ardriveapp/turbo-sdk">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.</a></li>
<li>Development and testing environment.</li>
</ul>
</td>
</tr>
Expand All @@ -42,7 +41,7 @@ Turbo, offered by ArDrive, is a streamlined service that simplifies permaweb sto
<th>Identity</th>
<td style="text-align:left">
<ul>
<li>Cryptographic sign in using Arweave, Ethereum, Solana or other Irys-compatible keys.</li>
<li>Cryptographic identity management using Arweave, Ethereum, Solana, Polygon or other Irys-compatible keys.</li>
<li>Arweave ecosystem supported web wallets and providers: <ul><li>✅ Arconnect</li><li>✅ arweave.app</li><li>✅ ArweaveWalletAdapter</li></ul></li>
</ul>
</td>
Expand All @@ -51,7 +50,7 @@ Turbo, offered by ArDrive, is a streamlined service that simplifies permaweb sto
<th>Maturity</th>
<td style="text-align:left">
<ul>
<li>Run by PDS, the same team that has been operating arweave.net since March 2022, with over 5.55B transactions indexed and accessible.</li>
<li>Run by PDS, the same team that has been operating arweave.net since March 2022, with over 9B transactions indexed and accessible.</li>
<li>First bundling services launched in October 2022, with as ArDrive Turbo launching in July 2023.
<ul>
<li><a target="_blank" href="https://viewblock.io/arweave/address/yCxjLRyXjzHJ4gMZK8HFYiW146dykI9QgP6CSsVXFwk">ar.io Meta Bundler | Arweave Explorer | ViewBlock</a></li>
Expand All @@ -66,7 +65,7 @@ Turbo, offered by ArDrive, is a streamlined service that simplifies permaweb sto
<td style="text-align:left">
<ul>
<li>Instantly fund your Turbo account with your credit card or popular crypto tokens.</li>
<li>ETH, SOL, and AR are supported for funding your Turbo account.</li>
<li>ETH, SOL, POL, and AR are supported for funding your Turbo account.</li>
<li>Leverage other Turbo benefits like Gifting and Coupon Codes.</li>
</ul>
</td>
Expand All @@ -75,18 +74,18 @@ Turbo, offered by ArDrive, is a streamlined service that simplifies permaweb sto
<th>Performance</th>
<td style="text-align:left">
<ul>
<li>Irys-compatible single request or multipart uploading.</li>
<li>Cryptographic upload receipts with transaction id, high resolution timestamp, upload price and cryptographic signature. (Irys compatible)</li>
<li>Proven, high layer 2 transactional throughput with 860/sec sustained on 12/18 and 12/19</li>
</ul>
</td>
</tr>
<tr>
<th>Provenance</th>
<td style="text-align:left">Irys-compatible receipts with transaction id, high resolution timestamp, upload price and cryptographic signature.</td>
<td style="text-align:left">Receipts with transaction id, high resolution timestamp, upload price and cryptographic signature. (Irys compatible)</td>
</tr>
<tr>
<th>Transparency</th>
<td style="text-align:left">Open source infrastructure and software development kit with AGPL3.0 licensing.</td>
<td style="text-align:left">Open source infrastructure with AGPL3.0 licensing, as well as software development kit with Apache2.0 licensing.</td>
</tr>
</table>
</div>

0 comments on commit 36aa96a

Please sign in to comment.