chore: release 3.1.0

CHANGELOG.md

@@ -1,3 +1,53 @@
+# [3.1.0-alpha.6](https://github.com/ar-io/ar-io-sdk/compare/v3.1.0-alpha.5...v3.1.0-alpha.6) (2024-12-17)
+
+
+### Bug Fixes
+
+* **io:** fix `AoEpochData` type, add prescribedNames ([1ba3588](https://github.com/ar-io/ar-io-sdk/commit/1ba358814d7019475ce049e0d5d8af1f76c429fc))
+
+# [3.1.0-alpha.5](https://github.com/ar-io/ar-io-sdk/compare/v3.1.0-alpha.4...v3.1.0-alpha.5) (2024-12-17)
+
+
+### Bug Fixes
+
+* **tags:** prune out empty tags ([de0ec83](https://github.com/ar-io/ar-io-sdk/commit/de0ec83803ad536121cb8e1a2c269e50dec9341f))
+
+# [3.1.0-alpha.4](https://github.com/ar-io/ar-io-sdk/compare/v3.1.0-alpha.3...v3.1.0-alpha.4) (2024-12-17)
+
+
+### Bug Fixes
+
+* dont return null when stringified null is found in message data on ao.read ([c5873e6](https://github.com/ar-io/ar-io-sdk/commit/c5873e6b686efa547b006e248337fcca0793446d))
+
+# [3.1.0-alpha.3](https://github.com/ar-io/ar-io-sdk/compare/v3.1.0-alpha.2...v3.1.0-alpha.3) (2024-12-16)
+
+
+### Features
+
+* **primary names:** add processID to read APIs PE-7307 ([e01e6ce](https://github.com/ar-io/ar-io-sdk/commit/e01e6cee4e39c2e17eb38a04818e28770f7cbf97))
+
+# [3.1.0-alpha.2](https://github.com/ar-io/ar-io-sdk/compare/v3.1.0-alpha.1...v3.1.0-alpha.2) (2024-12-12)
+
+
+### Features
+
+* **fund-from:** add Fund-From tag to eligible methods/commands PE-7291 ([4d47270](https://github.com/ar-io/ar-io-sdk/commit/4d4727082f408c523be5c2f01d21907c93e2e098))
+
+# [3.1.0-alpha.1](https://github.com/ar-io/ar-io-sdk/compare/v3.0.1-alpha.1...v3.1.0-alpha.1) (2024-12-12)
+
+
+### Features
+
+* **cost-details:** init cli command get-cost-details PE-7114 ([674626e](https://github.com/ar-io/ar-io-sdk/commit/674626eaef7863b1601452e15b84c82f1f2a621c))
+* **cost-details:** init new cost method for exposing fundingPlan and discounts PE-7114 ([c6910c8](https://github.com/ar-io/ar-io-sdk/commit/c6910c85b9cb801c86b2f5f754e567f0fe0c35d3))
+
+## [3.0.1-alpha.1](https://github.com/ar-io/ar-io-sdk/compare/v3.0.0...v3.0.1-alpha.1) (2024-12-11)
+
+
+### Bug Fixes
+
+* **eth signer:** use a unique anchor in ans-104 headers ([8cd5587](https://github.com/ar-io/ar-io-sdk/commit/8cd5587630141b8eb048505ffa424e9a37add80f))
+
 # [3.0.0](https://github.com/ar-io/ar-io-sdk/compare/v2.6.0...v3.0.0) (2024-12-10)
 
 

README.md

@@ -58,6 +58,7 @@ This is the home of [ar.io] SDK. This SDK provides functionality for interacting
     - [`increaseUndernameLimit({ name, qty })`](#increaseundernamelimit-name-qty-)
     - [`extendLease({ name, years })`](#extendlease-name-years-)
     - [`getTokenCost({ intent, ...args })`](#gettokencost-intent-args-)
+    - [`getCostDetails({ intent, fromAddress, fundFrom, ...args})`](#getcostdetails-intent-fromaddress-fundfrom-args)
     - [`getDemandFactor()`](#getdemandfactor)
     - [`getArNSReturnedNames({ cursor, limit, sortBy, sortOrder })`](#getarnsreturnednames-cursor-limit-sortby-sortorder-)
     - [`getArNSReturnedName({ name })`](#getarnsreturnedname-name-)
@@ -1200,6 +1201,43 @@ const price = await ario
 
 </details>
 
+#### `getCostDetails({ intent, fromAddress, fundFrom, ...args})`
+
+Calculates the expanded cost details for the interaction in question, e.g a 'Buy-Record' interaction, where args are the specific params for that interaction. The fromAddress is the address that would be charged for the interaction, and fundFrom is where the funds would be taken from, either `balance`, `stakes`, or `any`.
+
+```typescript
+const costDetails = await ario.getCostDetails({
+  intent: 'Buy-Record',
+  fromAddress: 't4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3',
+  fundFrom: 'stakes',
+  name: 'ar-io',
+  type: 'permabuy',
+});
+```
+
+<details>
+  <summary>Output</summary>
+
+```json
+{
+  "tokenCost": 2384252273,
+  "fundingPlan": {
+    "address": "t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3",
+    "balance": 0,
+    "stakes": {
+      "Rc80LG6h27Y3p9TN6J5hwDeG5M51cu671YwZpU9uAVE": {
+        "vaults": [],
+        "delegatedStake": 2384252273
+      }
+    },
+    "shortfall": 0
+  },
+  "discounts": []
+}
+```
+
+</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.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "3.0.0",
+  "version": "3.1.0-alpha.6",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"
@@ -127,7 +127,7 @@
     "@dha-team/arbundles": "^1.0.1",
     "@permaweb/aoconnect": "^0.0.57",
     "arweave": "1.14.4",
-    "axios": "1.7.8",
+    "axios": "1.7.9",
     "axios-retry": "^4.3.0",
     "commander": "^12.1.0",
     "eventemitter3": "^5.0.1",