@ardrive/turbo-sdk 1.11.0-alpha.2 → 1.11.0-alpha.3

package/README.md

@@ -31,6 +31,8 @@ Welcome to the `@ardrive/turbo-sdk`! This SDK provides functionality for interac
       - [Ethereum Private Key](#ethereum-private-key)
       - [HexSolanaSigner](#hexsolanasigner)
       - [Solana Secret Key](#solana-secret-key)
+      - [KYVE Private Key](#kyve-private-key)
+      - [KYVE Mnemonic](#kyve-mnemonic)
   - [TurboUnauthenticatedClient](#turbounauthenticatedclient)
     - [`getSupportedCurrencies()`](#getsupportedcurrencies)
     - [`getSupportedCountries()`](#getsupportedcountries)
@@ -40,9 +42,10 @@ Welcome to the `@ardrive/turbo-sdk`! This SDK provides functionality for interac
     - [`getUploadCosts({ bytes })`](#getuploadcosts-bytes-)
     - [`uploadSignedDataItem({ dataItemStreamFactory, dataItemSizeFactory, signal })`](#uploadsigneddataitem-dataitemstreamfactory-dataitemsizefactory-signal-)
     - [`createCheckoutSession({ amount, owner })`](#createcheckoutsession-amount-owner-)
-      - [Arweave (AR)](#arweave-ar)
-      - [Ethereum (ETH)](#ethereum-eth)
-      - [Solana (SOL)](#solana-sol)
+      - [Arweave (AR) Fiat Top Up](#arweave-ar-fiat-top-up)
+      - [Ethereum (ETH) Fiat Top Up](#ethereum-eth-fiat-top-up)
+      - [Solana (SOL) Fiat Top Up](#solana-sol-fiat-top-up)
+      - [KYVE Fiat Top Up](#kyve-fiat-top-up)
     - [`submitFundTransaction({ txId })`](#submitfundtransaction-txid-)
   - [TurboAuthenticatedClient](#turboauthenticatedclient)
     - [`getBalance()`](#getbalance)
@@ -53,8 +56,16 @@ Welcome to the `@ardrive/turbo-sdk`! This SDK provides functionality for interac
       - [NodeJS Upload Folder](#nodejs-upload-folder)
       - [Browser Upload Folder](#browser-upload-folder)
     - [`topUpWithTokens({ tokenAmount, feeMultiplier })`](#topupwithtokens-tokenamount-feemultiplier-)
-      - [Ethereum (ETH)](#ethereum-eth-1)
-      - [Solana (SOL)](#solana-sol-1)
+      - [Arweave (AR) Crypto Top Up](#arweave-ar-crypto-top-up)
+      - [Ethereum (ETH) Crypto Top Up](#ethereum-eth-crypto-top-up)
+      - [Solana (SOL) Crypto Top Up](#solana-sol-crypto-top-up)
+      - [KYVE Crypto Top Up](#kyve-crypto-top-up)
+- [CLI](#cli)
+  - [Install CLI](#install-cli)
+  - [CLI Usage](#cli-usage)
+    - [Options](#options)
+    - [Commands](#commands)
+      - [`crypto-fund`](#crypto-fund)
 - [Developers](#developers)
   - [Requirements](#requirements)
   - [Setup & Build](#setup--build)
@@ -268,6 +279,26 @@ const turbo = TurboFactory.authenticated({
 });
 ```
 
+##### KYVE Private Key
+
+```typescript
+const turbo = TurboFactory.authenticated({
+  privateKey: kyveHexadecimalPrivateKey,
+  token: 'kyve',
+});
+```
+
+##### KYVE Mnemonic
+
+```typescript
+import { privateKeyFromKyveMnemonic } from '@ardrive/turbo-sdk';
+
+const turbo = TurboFactory.authenticated({
+  privateKey: privateKeyFromKyveMnemonic(mnemonic),
+  token: 'kyve',
+});
+```
+
 ### TurboUnauthenticatedClient
 
 #### `getSupportedCurrencies()`
@@ -341,7 +372,7 @@ const uploadResponse = await turbo.uploadSignedDataItem({
 
 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 [TurboAuthenticatedClient].
 
-##### Arweave (AR)
+##### Arweave (AR) Fiat Top Up
 
 ```typescript
 const { url, winc, paymentAmount, quotedPaymentAmount, adjustments } =
@@ -364,7 +395,7 @@ if (process.platform === 'darwin') {
 }
 ```
 
-##### Ethereum (ETH)
+##### Ethereum (ETH) Fiat Top Up
 
 ```ts
 const turbo = TurboFactory.unauthenticated({ token: 'ethereum' });
@@ -375,7 +406,7 @@ const { url, winc, paymentAmount } = await turbo.createCheckoutSession({
 });
 ```
 
-##### Solana (SOL)
+##### Solana (SOL) Fiat Top Up
 
 ```ts
 const turbo = TurboFactory.unauthenticated({ token: 'solana' });
@@ -386,6 +417,17 @@ const { url, winc, paymentAmount } = await turbo.createCheckoutSession({
 });
 ```
 
+##### KYVE Fiat Top Up
+
+```ts
+const turbo = TurboFactory.unauthenticated({ token: 'kyve' });
+
+const { url, winc, paymentAmount } = await turbo.createCheckoutSession({
+  amount: USD(10.0), // $10.00 USD
+  owner: publicKyveAddress,
+});
+```
+
 #### `submitFundTransaction({ txId })`
 
 Submits the transaction ID of a funding transaction to Turbo Payment Service for top up processing. The `txId` is the transaction ID of the transaction to be submitted.
@@ -536,6 +578,8 @@ Tops up the connected wallet with Credits by submitting a payment transaction fo
 - The `tokenAmount` is the amount of tokens in the token type's smallest unit value (e.g: Winston for arweave token type) to fund the wallet with.
 - The `feeMultiplier` (optional) is the multiplier to apply to the reward for the transaction to modify its chances of being mined. Credits will be added to the wallet balance after the transaction is confirmed on the given blockchain. Defaults to 1.0, meaning no multiplier.
 
+##### Arweave (AR) Crypto Top Up
+
 ```typescript
 const turbo = TurboFactory.authenticated({ signer, token: 'arweave' });
 
@@ -545,7 +589,7 @@ const { winc, status, id, ...fundResult } = await turbo.topUpWithTokens({
 });
 ```
 
-##### Ethereum (ETH)
+##### Ethereum (ETH) Crypto Top Up
 
 ```ts
 const turbo = TurboFactory.authenticated({ signer, token: 'ethereum' });
@@ -555,7 +599,7 @@ const { winc, status, id, ...fundResult } = await turbo.topUpWithTokens({
 });
 ```
 
-##### Solana (SOL)
+##### Solana (SOL) Crypto Top Up
 
 ```ts
 const turbo = TurboFactory.authenticated({ signer, token: 'solana' });
@@ -565,6 +609,88 @@ const { winc, status, id, ...fundResult } = await turbo.topUpWithTokens({
 });
 ```
 
+##### KYVE Crypto Top Up
+
+```ts
+const turbo = TurboFactory.authenticated({ signer, token: 'kyve' });
+
+const { winc, status, id, ...fundResult } = await turbo.topUpWithTokens({
+  tokenAmount: KYVEToTokenAmount(0.00001), // 0.00001 KYVE
+});
+```
+
+## CLI
+
+### Install CLI
+
+Global installation:
+
+```shell
+npm install -g @ardrive/turbo-sdk
+```
+
+or
+
+```shell
+yarn global add @ardrive/turbo-sdk
+```
+
+or install locally as a dev dependency:
+
+```shell
+npm install --save-dev @ardrive/turbo-sdk
+```
+
+or
+
+```shell
+yarn add -D @ardrive/turbo-sdk
+```
+
+### CLI Usage
+
+```shell
+turbo --help
+```
+
+or from local installation:
+
+```shell
+yarn turbo --help
+```
+
+```shell
+npx turbo --help
+```
+
+#### Options
+
+- `-V, --version` - output the version number
+- `-h, --help` - display help for command
+- `--dev` - Enable development endpoints (default: false)
+- `-g, --gateway <url>` - Set a custom crypto gateway URL
+- `-t, --token <token>` - Token type for the command or connected wallet (default: "arweave")
+
+- `-w, --wallet-file <filePath>` - Wallet file to use with the action. Formats accepted: JWK.json, KYVE or ETH private key as a string, or SOL Secret Key as a Uint8Array
+- `-m, --mnemonic <phrase>` - Mnemonic to use with the action (KYVE only)
+- `-p, --private-key <key>` - Private key to use with the action
+
+#### Commands
+
+##### `crypto-fund`
+
+Fund a wallet with Turbo Credits by submitting a payment transaction for the crypto amount to the Turbo wallet and then submitting that transaction id to Turbo Payment Service for top up processing.
+
+Command Options:
+
+- `-v, --value <value>` - Amount of tokens in the token type's smallest unit value to fund the wallet with
+
+e.g:
+
+```shell
+turbo crypto-fund --value 0.0001 --token kyve --private-key 'b27...45c'
+```
+
 ## Developers
 
 ### Requirements

package/bundles/web.bundle.min.js

@@ -312251,7 +312251,7 @@ var import_winston = __toESM(require_winston(), 1);
 init_dirname();
 init_buffer2();
 init_process2();
-var version16 = "1.11.0-alpha.1";
+var version16 = "1.11.0-alpha.2";
 
 // src/common/logger.ts
 var TurboWinstonLogger = class _TurboWinstonLogger {

package/lib/cjs/cli/cli.js

@@ -33,7 +33,7 @@ const utils_js_1 = require("./utils.js");
 (0, utils_js_1.applyOptions)(commander_1.program.command('top-up').description('Top up a Turbo address with Fiat'), [utils_js_1.optionMap.address, utils_js_1.optionMap.value, utils_js_1.optionMap.token]).action((options) => {
     console.log('TODO: fiat top-up', options.address, options.token, options.value);
 });
-(0, utils_js_1.applyOptions)(commander_1.program.command('crypto-fund').description('Top up a wallet with crypto'), [...utils_js_1.walletOptions, utils_js_1.optionMap.token, utils_js_1.optionMap.value]).action(async (_commandOptions, command) => {
+(0, utils_js_1.applyOptions)(commander_1.program.command('crypto-fund').description('Top up a wallet with crypto'), [...utils_js_1.walletOptions, utils_js_1.optionMap.value]).action(async (_commandOptions, command) => {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const options = command.optsWithGlobals();
     const token = (0, utils_js_1.tokenFromOptions)(options);
@@ -48,7 +48,7 @@ const utils_js_1 = require("./utils.js");
     .argument('<folderPath>', 'Directory to upload'), [...utils_js_1.walletOptions, utils_js_1.optionMap.token]).action((directory, options) => {
     console.log('upload-folder TODO', directory, options);
 });
-if (process.argv[1].includes('.bin/turbo') || // Running from global .bin
+if (process.argv[1].includes('bin/turbo') || // Running from global .bin
     process.argv[1].includes('cli/cli') // Running from source
 ) {
     commander_1.program.parse(process.argv);

package/lib/cjs/cli/utils.js

@@ -92,6 +92,7 @@ exports.globalOptions = [
     exports.optionMap.gateway,
     exports.optionMap.debug,
     exports.optionMap.quiet,
+    exports.optionMap.token,
 ];
 function applyOptions(command, options) {
     [...options].forEach((option) => {
@@ -122,6 +123,7 @@ async function privateKeyFromOptions({ mnemonic, privateKey, walletFile, }, toke
             return (0, index_js_1.privateKeyFromKyveMnemonic)(mnemonic);
         }
         else {
+            // TODO: Implement other token types mnemonic to wallet
             throw new Error('mnemonic provided but this token type mnemonic to wallet is not supported');
         }
     }
@@ -132,7 +134,9 @@ async function privateKeyFromOptions({ mnemonic, privateKey, walletFile, }, toke
     else if (privateKey !== undefined) {
         return privateKey;
     }
-    throw new Error('mnemonic or wallet file required');
+    // TODO: Get TURBO_WALLET_FILE, TURBO_MNEMONIC, TURBO_PRIVATE_KEY or similar from ENV variables
+    // TODO: Add prompts for selecting wallet type and secure input
+    throw new Error('mnemonic or wallet file or private key is required');
 }
 const tokenToDevGatewayMap = {
     arweave: 'https://arweave.net', // No arweave test net

package/lib/cjs/version.js

@@ -18,4 +18,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-exports.version = '1.11.0-alpha.2';
+exports.version = '1.11.0-alpha.3';

package/lib/esm/cli/cli.js

@@ -31,7 +31,7 @@ applyOptions(program.command('get-balance').description('Get balance of a Turbo
 applyOptions(program.command('top-up').description('Top up a Turbo address with Fiat'), [optionMap.address, optionMap.value, optionMap.token]).action((options) => {
     console.log('TODO: fiat top-up', options.address, options.token, options.value);
 });
-applyOptions(program.command('crypto-fund').description('Top up a wallet with crypto'), [...walletOptions, optionMap.token, optionMap.value]).action(async (_commandOptions, command) => {
+applyOptions(program.command('crypto-fund').description('Top up a wallet with crypto'), [...walletOptions, optionMap.value]).action(async (_commandOptions, command) => {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const options = command.optsWithGlobals();
     const token = tokenFromOptions(options);
@@ -46,7 +46,7 @@ applyOptions(program
     .argument('<folderPath>', 'Directory to upload'), [...walletOptions, optionMap.token]).action((directory, options) => {
     console.log('upload-folder TODO', directory, options);
 });
-if (process.argv[1].includes('.bin/turbo') || // Running from global .bin
+if (process.argv[1].includes('bin/turbo') || // Running from global .bin
     process.argv[1].includes('cli/cli') // Running from source
 ) {
     program.parse(process.argv);

package/lib/esm/cli/utils.js

@@ -81,6 +81,7 @@ export const globalOptions = [
     optionMap.gateway,
     optionMap.debug,
     optionMap.quiet,
+    optionMap.token,
 ];
 export function applyOptions(command, options) {
     [...options].forEach((option) => {
@@ -111,6 +112,7 @@ export async function privateKeyFromOptions({ mnemonic, privateKey, walletFile,
             return privateKeyFromKyveMnemonic(mnemonic);
         }
         else {
+            // TODO: Implement other token types mnemonic to wallet
             throw new Error('mnemonic provided but this token type mnemonic to wallet is not supported');
         }
     }
@@ -121,7 +123,9 @@ export async function privateKeyFromOptions({ mnemonic, privateKey, walletFile,
     else if (privateKey !== undefined) {
         return privateKey;
     }
-    throw new Error('mnemonic or wallet file required');
+    // TODO: Get TURBO_WALLET_FILE, TURBO_MNEMONIC, TURBO_PRIVATE_KEY or similar from ENV variables
+    // TODO: Add prompts for selecting wallet type and secure input
+    throw new Error('mnemonic or wallet file or private key is required');
 }
 const tokenToDevGatewayMap = {
     arweave: 'https://arweave.net', // No arweave test net

package/lib/esm/version.js

@@ -15,4 +15,4 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-export const version = '1.11.0-alpha.2';
+export const version = '1.11.0-alpha.3';

package/lib/types/cli/utils.d.ts

@@ -68,6 +68,10 @@ export declare const walletOptions: ({
     readonly description: "Private key to use with the action";
 })[];
 export declare const globalOptions: ({
+    readonly alias: "-t, --token <type>";
+    readonly description: "Token type for wallet or action";
+    readonly default: "arweave";
+} | {
     readonly alias: "-g, --gateway <url>";
     readonly description: "Set a custom crypto gateway URL";
     readonly default: undefined;

package/lib/types/cli/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/cli/utils.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAGpC,OAAO,EACL,SAAS,EACT,iCAAiC,EAKlC,MAAM,kBAAkB,CAAC;AAE1B,UAAU,eAAe;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC5B;AAED,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuDZ,CAAC;AAEX,eAAO,MAAM,aAAa;;;;;;;;;IAIzB,CAAC;AAEF,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;IAKzB,CAAC;AAEF,wBAAgB,YAAY,CAC1B,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,eAAe,EAAE,GACzB,OAAO,CAKT;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,CAU5D;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAMzD;AAED,wBAAsB,qBAAqB,CACzC,EACE,QAAQ,EACR,UAAU,EACV,UAAU,GACX,EAAE;IACD,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC,EACD,KAAK,EAAE,SAAS,GACf,OAAO,CAAC,MAAM,CAAC,CAkBjB;AASD,wBAAgB,iBAAiB,CAAC,EAChC,OAAO,EACP,GAAG,EACH,KAAK,GACN,EAAE;IACD,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,GAAG,EAAE,OAAO,GAAG,SAAS,CAAC;IACzB,KAAK,EAAE,SAAS,CAAC;CAClB,GAAG,iCAAiC,CAgBpC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/cli/utils.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAGpC,OAAO,EACL,SAAS,EACT,iCAAiC,EAKlC,MAAM,kBAAkB,CAAC;AAE1B,UAAU,eAAe;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC5B;AAED,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuDZ,CAAC;AAEX,eAAO,MAAM,aAAa;;;;;;;;;IAIzB,CAAC;AAEF,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;IAMzB,CAAC;AAEF,wBAAgB,YAAY,CAC1B,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,eAAe,EAAE,GACzB,OAAO,CAKT;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,CAU5D;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAMzD;AAED,wBAAsB,qBAAqB,CACzC,EACE,QAAQ,EACR,UAAU,EACV,UAAU,GACX,EAAE;IACD,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC,EACD,KAAK,EAAE,SAAS,GACf,OAAO,CAAC,MAAM,CAAC,CAqBjB;AASD,wBAAgB,iBAAiB,CAAC,EAChC,OAAO,EACP,GAAG,EACH,KAAK,GACN,EAAE;IACD,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,GAAG,EAAE,OAAO,GAAG,SAAS,CAAC;IACzB,KAAK,EAAE,SAAS,CAAC;CAClB,GAAG,iCAAiC,CAgBpC"}

package/lib/types/version.d.ts

@@ -14,5 +14,5 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-export declare const version = "1.11.0-alpha.1";
+export declare const version = "1.11.0-alpha.2";
 //# sourceMappingURL=version.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ardrive/turbo-sdk",
-  "version": "1.11.0-alpha.2",
+  "version": "1.11.0-alpha.3",
   "main": "./lib/cjs/node/index.js",
   "types": "./lib/types/node/index.d.ts",
   "module": "./lib/esm/node/index.js",