@ar.io/sdk 3.12.2 → 3.13.0-beta.1

package/README.md

@@ -1240,7 +1240,32 @@ _Note: Requires `signer` to be provided on `ARIO.init` to sign the transaction._
 ```typescript
 const ario = ARIO.mainnet({ signer });
 const record = await ario.buyRecord(
-  { name: 'ardrive', type: 'lease', years: 1 },
+  {
+    name: 'ardrive',
+    type: 'lease',
+    years: 1,
+    referrer: 'my-app.com', // optional: track purchase referrals for analytics
+  },
+  {
+    // optional tags
+    tags: [{ name: 'App-Name', value: 'ArNS-App' }],
+  },
+);
+```
+
+#### `upgradeRecord({ name })`
+
+Upgrades an existing leased ArNS record to a permanent ownership. The record must be currently owned by the caller and be of type "lease".
+
+_Note: Requires `signer` to be provided on `ARIO.init` to sign the transaction._
+
+```typescript
+const ario = ARIO.mainnet({ signer });
+const record = await ario.upgradeRecord(
+  {
+    name: 'ardrive',
+    referrer: 'my-app.com', // optional: track purchase referrals for analytics
+  },
   {
     // optional tags
     tags: [{ name: 'App-Name', value: 'ArNS-App' }],
@@ -1363,6 +1388,7 @@ const { id: txId } = await ario.increaseUndernameLimit(
   {
     name: 'ar-io',
     qty: 420,
+    referrer: 'my-app.com', // optional: track purchase referrals for analytics
   },
   // optional additional tags
   { tags: [{ name: 'App-Name', value: 'My-Awesome-App' }] },
@@ -1379,6 +1405,7 @@ const { id: txId } = await ario.extendLease(
   {
     name: 'ar-io',
     years: 1,
+    referrer: 'my-app.com', // optional: track purchase referrals for analytics
   },
   // optional additional tags
   { tags: [{ name: 'App-Name', value: 'My-Awesome-App' }] },