Skip to content

Commit

Permalink
docs: added 'only AR' disclaimer to topUpWithTokens
Browse files Browse the repository at this point in the history
  • Loading branch information
Bobinstein committed Apr 19, 2024
1 parent 5d314d0 commit d305dfa
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/src/docs/turbo/turbo-sdk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -491,7 +491,8 @@ 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.
- Note: As of release 1.5.0, only AR tokens are supported with `topUpWithTokens`.
- 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" });
Expand Down

0 comments on commit d305dfa

Please sign in to comment.