Merge pull request #291 from ar-io/primary-name-cost

fix(primary): support primary name in token cost API

README.md

@@ -1577,13 +1577,15 @@ const observers = await io.getPrescribedObservers({ epochIndex: 0 });
 
 #### `getPrimaryNames({ cursor, limit, sortBy, sortOrder })`
 
-Retrieves all primary names across all gateways, paginated and sorted by the specified criteria. The `cursor` used for pagination is the last name from the previous request.
+Retrieves all primary names paginated and sorted by the specified criteria. The `cursor` used for pagination is the last name from the previous request.
 
 ```typescript
 const io = IO.init();
 const names = await io.getPrimaryNames({
-  cursor: 'ar-io',
-  limit: 2,
+  cursor: 'ao', // this is the last name from the previous request
+  limit: 1,
+  sortBy: 'startTimestamp',
+  sortOrder: 'desc',
 });
 ```
 
@@ -1593,10 +1595,10 @@ const names = await io.getPrimaryNames({
 ```json
 {
   "sortOrder": "desc",
-  "hasMore": false,
-  "totalItems": 1,
-  "limit": 100,
-  "sortBy": "name",
+  "hasMore": true,
+  "totalItems": 100,
+  "limit": 1,
+  "sortBy": "startTimestamp",
   "items": [
     {
       "owner": "HwFceQaMQnOBgKDpnFqCqgwKwEU5LBme1oXRuQOWSRA",

src/common/io.ts

@@ -454,17 +454,30 @@ export class IOReadable implements AoIORead {
     quantity: number;
     name: string;
   }): Promise<number>;
+  async getTokenCost(params: {
+    intent: 'Upgrade-Name';
+    name: string;
+  }): Promise<number>;
+  async getTokenCost(params: {
+    intent: 'Primary-Name-Request';
+    name: string;
+  }): Promise<number>;
   async getTokenCost({
     intent,
     type,
     years,
     name,
     quantity,
   }: {
-    intent: 'Buy-Record' | 'Extend-Lease' | 'Increase-Undername-Limit';
+    intent:
+      | 'Buy-Record'
+      | 'Extend-Lease'
+      | 'Increase-Undername-Limit'
+      | 'Upgrade-Name'
+      | 'Primary-Name-Request';
     type?: 'permabuy' | 'lease';
     years?: number;
-    name?: string;
+    name: string;
     quantity?: number;
   }): Promise<number> {
     const allTags = [

src/types/io.ts

@@ -417,12 +417,17 @@ export interface AoIORead {
     name,
     quantity,
   }: {
-    intent: 'Buy-Record' | 'Extend-Lease' | 'Increase-Undername-Limit';
+    intent:
+      | 'Buy-Record'
+      | 'Extend-Lease'
+      | 'Increase-Undername-Limit'
+      | 'Upgrade-Name'
+      | 'Primary-Name-Request';
     type?: 'permabuy' | 'lease';
     years?: number;
-    name?: string;
+    name: string;
     quantity?: number;
-  }): Promise<number>;
+  }): Promise<number>; // TODO: add getCostDetails API that provides funding cost and discount details
   getRegistrationFees(): Promise<AoRegistrationFees>;
   getDemandFactor(): Promise<number>;
   getVaults(