@ardrive/turbo-sdk 1.2.0-alpha.1 → 1.3.0-alpha.1

package/README.md

@@ -1,5 +1,7 @@
 # @ardriveapp/turbo-sdk 🚀
 
+[![codecov](https://codecov.io/gh/ardriveapp/turbo-sdk/graph/badge.svg?token=CXS48HM8Y8)](https://codecov.io/gh/ardriveapp/turbo-sdk)
+
 Welcome to the `@ardrive/turbo-sdk`! This SDK provides functionality for interacting with the Turbo Upload and Payment Services and is available for both NodeJS and Web environments.
 
 ## Table of Contents
@@ -47,11 +49,15 @@ yarn add @ardrive/turbo-sdk
 ```typescript
 import { TurboFactory } from '@ardrive/turbo-sdk';
 
-// load your JWK from a file or generate a new one
+// load your JWK directly to authenticate
 const jwk = fs.readFileSync('./my-jwk.json');
 const address = arweave.wallets.jwkToAddress(jwk);
 const turbo = TurboFactory.authenticated({ privateKey: jwk });
 
+// or provide your own signer
+const signer = new ArweaveSigner(jwk);
+const turbo = TurboFactory.authenticated({ signer });
+
 // get the wallet balance
 const { winc: balance } = await turbo.getBalance();
 
@@ -227,13 +233,20 @@ Types are exported from `./lib/types/[node/web]/index.d.ts` and should be automa
   const turbo = TurboFactory.unauthenticated();
   ```
 
-- `authenticated()` - Creates an instance of a client that accesses Turbo's authenticated and unauthenticated services.
+- `authenticated()` - Creates an instance of a client that accesses Turbo's authenticated and unauthenticated services. Requires either a signer, or private key to be provided.
 
   ```typescript
   const jwk = await arweave.crypto.generateJWK();
   const turbo = TurboFactory.authenticated({ privateKey: jwk });
   ```
 
+  or
+
+  ```typescript
+  const signer = new ArweaveSigner(jwk);
+  const turbo = TurboFactory.authenticated({ signer });
+  ```
+
 ### TurboUnauthenticatedClient
 
 - `getSupportedCurrencies()` - 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).
@@ -353,7 +366,7 @@ Types are exported from `./lib/types/[node/web]/index.d.ts` and should be automa
   }
   ```
 
-- `uploadFile({ fileStreamFactory, fileSizeFactory, signal })` - Signs and uploads a raw file. The provided `fileStreamFactory` should produce a NEW file data stream each time is it invoked. The `fileSizeFactory` is a function that returns the size of the file. The `signal` is an optional [AbortSignal] that can be used to cancel the upload or timeout the request.
+- `uploadFile({ fileStreamFactory, fileSizeFactory, signal, dataItemOpts })` - Signs and uploads a raw file. The provided `fileStreamFactory` should produce a NEW file data stream each time is it invoked. The `fileSizeFactory` is a function that returns the size of the file. The `signal` is an optional [AbortSignal] that can be used to cancel the upload or timeout the request. `dataItemOpts` is an optional object that can be used to configure tags, target, and anchor for the data item upload.
 
   ```typescript
   const filePath = path.join(__dirname, './my-unsigned-file.txt');
@@ -361,7 +374,20 @@ Types are exported from `./lib/types/[node/web]/index.d.ts` and should be automa
   const uploadResult = await turbo.uploadFile({
     fileStreamFactory: () => fs.createReadStream(filePath),
     fileSizeFactory: () => fileSize,
-    // no timeout or AbortSignal provided
+    dataItemOpts: {
+      // optional
+      tags: [
+        {
+          name: 'Content-Type',
+          value: 'text/plain',
+        },
+        {
+          name: 'My-Custom-Tag',
+          value: 'my-custom-value',
+        },
+      ],
+      // no timeout or AbortSignal provided
+    },
   });
   ```