Merge pull request #229 from ar-io/demand-factor-api

fix(io): add getDemandFactor api

README.md

@@ -33,6 +33,7 @@ This is the home of [ar.io] SDK. This SDK provides functionality for interacting
     - [`getGateways({ cursor, limit, sortBy, sortOrder })`](#getgateways-cursor-limit-sortby-sortorder-)
     - [`getArNSRecord({ name })`](#getarnsrecord-name-)
     - [`getArNSRecords({ cursor, limit, sortBy, sortOrder })`](#getarnsrecords-cursor-limit-sortby-sortorder-)
+    - [`getDemandFactor()`](#getdemandfactor)
     - [`getObservations({ epochIndex })`](#getobservations-epochindex-)
     - [`getDistributions({ epochIndex })`](#getdistributions-epochindex-)
     - [`getEpoch({ epochIndex })`](#getepoch-epochindex-)
@@ -571,6 +572,24 @@ Available `sortBy` options are any of the keys on the record object, e.g. `name`
 
 </details>
 
+#### `getDemandFactor()`
+
+Retrieves the current demand factor of the network. The demand factor is a multiplier applied to the cost of ArNS interactions based on the current network demand.
+
+```typescript
+const io = IO.init();
+const demandFactor = await io.getDemandFactor();
+```
+
+<details>
+  <summary>Output</summary>
+
+```json
+1.05256
+```
+
+</details>
+
 #### `getObservations({ epochIndex })`
 
 Returns the epoch-indexed observation list.

src/common/io.ts

@@ -583,6 +583,12 @@ export class IOReadable implements AoIORead {
       tags: [{ name: 'Action', value: 'Get-Registration-Fees' }],
     });
   }
+
+  async getDemandFactor(): Promise<number> {
+    return this.process.read<number>({
+      tags: [{ name: 'Action', value: 'Demand-Factor' }],
+    });
+  }
 }
 
 export class IOWriteable extends IOReadable implements AoIOWrite {

src/io.ts

@@ -372,6 +372,7 @@ export interface AoIORead {
     quantity?: number;
   }): Promise<number>;
   getRegistrationFees(): Promise<AoRegistrationFees>;
+  getDemandFactor(): Promise<number>;
 }
 
 export interface AoIOWrite extends AoIORead {