@ardrive/turbo-sdk 1.4.1 → 1.5.0-alpha.1

package/README.md

@@ -119,7 +119,7 @@ const rates = await turbo.getFiatRates();
 ESM:
 
 ```javascript
-import { TurboFactory } from '@ardrive/turbo-sdk/web';
+import { TurboFactory } from '@ardrive/turbo-sdk/<node/web>';
 
 const turbo = TurboFactory.unauthenticated();
 const rates = await turbo.getFiatRates();
@@ -140,85 +140,18 @@ const rates = await turbo.getFiatRates();
 
 #### CommonJS
 
-Project's `package.json`:
-
-```json
-{
-  "type": "commonjs" // or absent
-}
-```
-
-Project's `tsconfig.json`:
-
-```json
-{
-  "compilerOptions": {
-    "module": "CommonJS",
-    "moduleResolution": "Node",
-    "skipLibCheck": true
-  }
-}
-```
-
-Usage (Node & Web):
-
-```javascript
-const { TurboFactory } = require('@ardrive/turbo-sdk');
-
-const turbo = TurboFactory.unauthenticated();
-const rates = await turbo.getFiatRates();
-```
+Example available in the [examples/typescript/cjs].
 
 #### ESM
 
-Project's `package.json`:
-
-```json
-{
-  "type": "module"
-}
-```
-
-Project's `tsconfig.json`:
-
-```json
-{
-  "compilerOptions": {
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
-    "skipLibCheck": true
-  }
-}
-```
-
-#### Usage
-
-Node:
-
-```javascript
-import { TurboFactory } from '@ardrive/turbo-sdk/node';
-
-const turbo = TurboFactory.unauthenticated();
-const rates = await turbo.getFiatRates();
-```
-
-Web:
-
-```javascript
-import { TurboFactory } from '@ardrive/turbo-sdk/web';
-
-const turbo = TurboFactory.unauthenticated();
-const rates = await turbo.getFiatRates();
-```
+Example available in the [examples/typescript/esm].
 
 ### Typescript
 
 The SDK provides TypeScript types. When you import the SDK in a TypeScript project:
 
 ```typescript
-import { TurboFactory } from '@ardrive/turbo-sdk/web';
-
-// or '@ardrive/turbo-sdk/node' for Node.js projects
+import { TurboFactory } from '@ardrive/turbo-sdk/<node/web>';
 ```
 
 Types are exported from `./lib/types/[node/web]/index.d.ts` and should be automatically recognized, offering benefits such as type-checking and autocompletion.
@@ -325,6 +258,17 @@ Types are exported from `./lib/types/[node/web]/index.d.ts` and should be automa
   }
   ```
 
+- `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.
+
+  - Note: Use this API if you've already executed your token transfer to the Turbo wallet. Otherwise, consider using `topUpWithTokens` to execute a new token transfer to the Turbo wallet and submit its resulting transaction ID for top up processing all in one go
+
+  ```typescript
+  const turbo = TurboFactory.unauthenticated(); // defaults to arweave token type
+  const { status, id, ...fundResult } = await turbo.submitFundTransaction({
+    txId: 'my-valid-arweave-fund-transaction-id',
+  });
+  ```
+
 ### TurboAuthenticatedClient
 
 - `getBalance()` - Issues a signed request to get the credit balance of a wallet measured in AR (measured in Winston Credits, or winc).
@@ -391,6 +335,20 @@ Types are exported from `./lib/types/[node/web]/index.d.ts` and should be automa
   });
   ```
 
+- `topUpWithTokens({ tokenAmount, feeMultiplier })` - Tops up the connected wallet with Credits by submitting a payment transaction for the token amount to the Turbo wallet and then submitting that transaction id to Turbo Payment Service for top up processing.
+
+  - 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.
+
+  ```typescript
+  const turbo = TurboFactory.authenticated({ signer, token: 'arweave' });
+
+  const { winc, status, id, ...fundResult } = await turbo.topUpWithTokens({
+    tokenAmount: WinstonToTokenAmount(100_000_000), // 0.0001 AR
+    feeMultiplier: 1.1, // 10% increase in reward for improved mining chances
+  });
+  ```
+
 ## Developers
 
 ### Requirements
@@ -406,7 +364,8 @@ Types are exported from `./lib/types/[node/web]/index.d.ts` and should be automa
 
 ### Testing
 
-- `yarn test` - runs integration tests
+- `yarn test` - runs integration tests against dev environment (e.g. `https://payment.ardrive.dev` and `https://upload.ardrive.dev`)
+- `yarn test:docker` - runs integration tests against locally running docker containers (recommended)
 - `yarn example:web` - opens up the example web page
 - `yarn example:cjs` - runs example CJS node script
 - `yarn example:esm` - runs example ESM node script
@@ -429,6 +388,8 @@ For more information on how to contribute, please see [CONTRIBUTING.md].
 
 [package.json]: ./package.json
 [examples]: ./examples
+[examples/typescript/cjs]: ./examples/typescript/cjs
+[examples/typescript/esm]: ./examples/typescript/esm
 [TurboAuthenticatedClient]: #turboauthenticatedclient
 [AbortSignal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
 [CONTRIBUTING.md]: ./CONTRIBUTING.md