@ar.io/sdk 3.4.0-alpha.2 → 3.4.0-alpha.4

package/README.md

@@ -35,6 +35,9 @@ This is the home of [ar.io] SDK. This SDK provides functionality for interacting
     - [`getVaults({ cursor, limit, sortBy, sortOrder })`](#getvaults-cursor-limit-sortby-sortorder-)
     - [`vaultedTransfer({ recipient, quantity, lockLengthMs, revokable })`](#vaultedtransfer-recipient-quantity-locklengthms-revokable-)
     - [`revokeVault({ recipient, vaultId })`](#revokevault-recipient-vaultid-)
+    - [`createVault({ lockLengthMs, quantity })`](#createvault-locklengthms-quantity-)
+    - [`extendVault({ vaultId, extendLengthMs })`](#extendvault-vaultid-extendlengthms-)
+    - [`increaseVault({ vaultId, quantity })`](#increasevault-vaultid-quantity-)
   - [Gateways](#gateways)
     - [`getGateway({ address })`](#getgateway-address-)
     - [`getGateways({ cursor, limit, sortBy, sortOrder })`](#getgateways-cursor-limit-sortby-sortorder-)
@@ -550,6 +553,45 @@ const { id: txId } = await ario.revokeVault({
 });
 ```
 
+#### `createVault({ lockLengthMs, quantity })`
+
+Creates a vault for the specified `quantity` of mARIO from the signer's balance and locks it for the specified `lockLengthMs` milliseconds.
+
+```typescript
+const ario = ARIO.init({ signer: new ArweaveSigner(jwk) });
+
+const { id: txId } = await ario.createVault({
+  lockLengthMs: 1000 * 60 * 60 * 24 * 365, // 1 year
+  quantity: new ARIOToken(1000).toMARIO(),
+});
+```
+
+#### `extendVault({ vaultId, extendLengthMs })`
+
+Extends the lock length of a signer's vault by the specified `extendLengthMs` milliseconds.
+
+```typescript
+const ario = ARIO.init({ signer: new ArweaveSigner(jwk) });
+
+const { id: txId } = await ario.extendVault({
+  vaultId: 'vaultIdOne',
+  extendLengthMs: 1000 * 60 * 60 * 24 * 365, // 1 year
+});
+```
+
+#### `increaseVault({ vaultId, quantity })`
+
+Increases the balance of a signer's vault by the specified `quantity` of mARIO.
+
+```typescript
+const ario = ARIO.init({ signer: new ArweaveSigner(jwk) });
+
+const { id: txId } = await ario.increaseVault({
+  vaultId: 'vaultIdOne',
+  quantity: new ARIOToken(1000).toMARIO(),
+});
+```
+
 ### Gateways
 
 #### `getGateway({ address })`