Skip to content

Commit

Permalink
chore(docs): update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dtfiedler authored and dtfiedler committed Oct 15, 2024
1 parent feab461 commit 4e9a0f4
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-)
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 4e9a0f4

Please sign in to comment.