radix-utils 1.1.1 → 1.2.0

package/README.md

@@ -177,6 +177,73 @@ Executes Promise.all with retry logic and exponential backoff.
 
 **Returns:** `Promise<T[]>`
 
+### Transaction Functions
+
+#### `getEventFromTransaction(gatewayApi, txId, eventName)`
+
+Extracts a specific event from a transaction's detailed events.
+
+**Parameters:**
+
+- `gatewayApi`: GatewayApiClient instance
+- `txId`: String - Transaction intent hash
+- `eventName`: String - Name of the event to extract
+
+**Returns:** `Promise<DetailedEventsItem>`
+
+**Example:**
+
+```typescript
+const event = await getEventFromTransaction(
+  gatewayApi,
+  'txid_rdx1...',
+  'WithdrawEvent'
+);
+console.log('Event data:', event);
+```
+
+#### `getEventKeyValuesFromTransaction(gatewayApi, txId, eventName)`
+
+Extracts key-value pairs from a specific event in a transaction.
+
+**Parameters:**
+
+- `gatewayApi`: GatewayApiClient instance
+- `txId`: String - Transaction intent hash
+- `eventName`: String - Name of the event to extract
+
+**Returns:** `Promise<Record<string, string>>`
+
+**Example:**
+
+```typescript
+const keyValues = await getEventKeyValuesFromTransaction(
+  gatewayApi,
+  'txid_rdx1...',
+  'TransferEvent'
+);
+console.log('Amount:', keyValues.amount);
+console.log('Recipient:', keyValues.recipient);
+```
+
+#### `extractValuesFromTxEvent(event)`
+
+Extracts key-value pairs from a transaction event's fields.
+
+**Parameters:**
+
+- `event`: DetailedEventsItem - The event object to extract values from
+
+**Returns:** `Record<string, string>`
+
+**Example:**
+
+```typescript
+const event = await getEventFromTransaction(gatewayApi, txId, 'MyEvent');
+const values = extractValuesFromTxEvent(event);
+console.log('Extracted values:', values);
+```
+
 ## TypeScript Types
 
 The library exports comprehensive TypeScript types:
@@ -264,6 +331,15 @@ For issues and feature requests, please use the GitHub issue tracker.
 
 ## Changelog
 
+### 1.2.0
+
+- Added transaction event handling utilities
+- Added `getEventFromTransaction` function for extracting specific events from transactions
+- Added `getEventKeyValuesFromTransaction` function for simplified key-value extraction
+- Added `extractValuesFromTxEvent` function for parsing event field data
+- Added comprehensive test coverage for transaction functionality
+- Updated documentation with transaction utility examples
+
 ### 1.1.0
 
 - Added `fetchWalletBalances` function for comprehensive wallet balance fetching

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export * from './types';
 export { BN, retryPromiseAll } from './utils/decimal';
 export { calculateEstimatedUnlockDate } from './utils/date';
 export { fetchWalletBalances } from './utils/wallet';
+export { getEventFromTransaction, getEventKeyValuesFromTransaction, extractValuesFromTxEvent, } from './utils/transaction';
 export { fetchValidatorInfo, checkResourceInUsersFungibleAssets, computeValidatorFeeFactor, } from './validators';
 export type { ValidatorInfo, ValidatorVaults, UnlockingRewards, UnlockingReward, NewFeeFactor, FeeFactor, ResourceCheckResult, LedgerStateVersion, WalletBalances, FungibleBalances, NonFungibleBalances, FungibleBalance, NonFungibleBalance, } from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,SAAS,CAAC;AAGxB,OAAO,EAAE,EAAE,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAAE,4BAA4B,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAGrD,OAAO,EACL,kBAAkB,EAClB,kCAAkC,EAClC,yBAAyB,GAC1B,MAAM,cAAc,CAAC;AAGtB,YAAY,EACV,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,SAAS,EACT,mBAAmB,EACnB,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,eAAe,EACf,kBAAkB,GACnB,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,SAAS,CAAC;AAGxB,OAAO,EAAE,EAAE,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAAE,4BAA4B,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EACL,uBAAuB,EACvB,gCAAgC,EAChC,wBAAwB,GACzB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EACL,kBAAkB,EAClB,kCAAkC,EAClC,yBAAyB,GAC1B,MAAM,cAAc,CAAC;AAGtB,YAAY,EACV,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,SAAS,EACT,mBAAmB,EACnB,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,eAAe,EACf,kBAAkB,GACnB,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.computeValidatorFeeFactor = exports.checkResourceInUsersFungibleAssets = exports.fetchValidatorInfo = exports.fetchWalletBalances = exports.calculateEstimatedUnlockDate = exports.retryPromiseAll = exports.BN = void 0;
+exports.computeValidatorFeeFactor = exports.checkResourceInUsersFungibleAssets = exports.fetchValidatorInfo = exports.extractValuesFromTxEvent = exports.getEventKeyValuesFromTransaction = exports.getEventFromTransaction = exports.fetchWalletBalances = exports.calculateEstimatedUnlockDate = exports.retryPromiseAll = exports.BN = void 0;
 // Export types
 __exportStar(require("./types"), exports);
 // Export utility functions
@@ -25,6 +25,10 @@ var date_1 = require("./utils/date");
 Object.defineProperty(exports, "calculateEstimatedUnlockDate", { enumerable: true, get: function () { return date_1.calculateEstimatedUnlockDate; } });
 var wallet_1 = require("./utils/wallet");
 Object.defineProperty(exports, "fetchWalletBalances", { enumerable: true, get: function () { return wallet_1.fetchWalletBalances; } });
+var transaction_1 = require("./utils/transaction");
+Object.defineProperty(exports, "getEventFromTransaction", { enumerable: true, get: function () { return transaction_1.getEventFromTransaction; } });
+Object.defineProperty(exports, "getEventKeyValuesFromTransaction", { enumerable: true, get: function () { return transaction_1.getEventKeyValuesFromTransaction; } });
+Object.defineProperty(exports, "extractValuesFromTxEvent", { enumerable: true, get: function () { return transaction_1.extractValuesFromTxEvent; } });
 // Export validator functions
 var validators_1 = require("./validators");
 Object.defineProperty(exports, "fetchValidatorInfo", { enumerable: true, get: function () { return validators_1.fetchValidatorInfo; } });

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,eAAe;AACf,0CAAwB;AAExB,2BAA2B;AAC3B,2CAAsD;AAA7C,6FAAA,EAAE,OAAA;AAAE,0GAAA,eAAe,OAAA;AAC5B,qCAA4D;AAAnD,oHAAA,4BAA4B,OAAA;AACrC,yCAAqD;AAA5C,6GAAA,mBAAmB,OAAA;AAE5B,6BAA6B;AAC7B,2CAIsB;AAHpB,gHAAA,kBAAkB,OAAA;AAClB,gIAAA,kCAAkC,OAAA;AAClC,uHAAA,yBAAyB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,eAAe;AACf,0CAAwB;AAExB,2BAA2B;AAC3B,2CAAsD;AAA7C,6FAAA,EAAE,OAAA;AAAE,0GAAA,eAAe,OAAA;AAC5B,qCAA4D;AAAnD,oHAAA,4BAA4B,OAAA;AACrC,yCAAqD;AAA5C,6GAAA,mBAAmB,OAAA;AAC5B,mDAI6B;AAH3B,sHAAA,uBAAuB,OAAA;AACvB,+HAAA,gCAAgC,OAAA;AAChC,uHAAA,wBAAwB,OAAA;AAG1B,6BAA6B;AAC7B,2CAIsB;AAHpB,gHAAA,kBAAkB,OAAA;AAClB,gIAAA,kCAAkC,OAAA;AAClC,uHAAA,yBAAyB,OAAA"}

package/dist/utils/transaction.d.ts

@@ -0,0 +1,5 @@
+import { DetailedEventsItem, GatewayApiClient } from '@radixdlt/babylon-gateway-api-sdk';
+export declare const getEventFromTransaction: (gatewayApi: GatewayApiClient, txId: string, eventName: string) => Promise<DetailedEventsItem>;
+export declare const getEventKeyValuesFromTransaction: (gatewayApi: GatewayApiClient, txId: string, eventName: string) => Promise<Record<string, string>>;
+export declare const extractValuesFromTxEvent: (event: DetailedEventsItem) => Record<string, string>;
+//# sourceMappingURL=transaction.d.ts.map

package/dist/utils/transaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../../src/utils/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EACjB,MAAM,mCAAmC,CAAC;AAE3C,eAAO,MAAM,uBAAuB,GAClC,YAAY,gBAAgB,EAC5B,MAAM,MAAM,EACZ,WAAW,MAAM,gCAuBlB,CAAC;AAEF,eAAO,MAAM,gCAAgC,GAC3C,YAAY,gBAAgB,EAC5B,MAAM,MAAM,EACZ,WAAW,MAAM,oCAIlB,CAAC;AAEF,eAAO,MAAM,wBAAwB,GAAI,OAAO,kBAAkB,2BAkBjE,CAAC"}

package/dist/utils/transaction.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractValuesFromTxEvent = exports.getEventKeyValuesFromTransaction = exports.getEventFromTransaction = void 0;
+const getEventFromTransaction = async (gatewayApi, txId, eventName) => {
+    const txDetails = await gatewayApi.transaction.innerClient.transactionCommittedDetails({
+        transactionCommittedDetailsRequest: {
+            intent_hash: txId,
+            opt_ins: { detailed_events: true },
+        },
+    });
+    const allEvents = txDetails.transaction.receipt?.detailed_events;
+    if (!allEvents) {
+        throw new Error('No events found in transaction receipt');
+    }
+    const event = allEvents.find((e) => e.identifier.event === eventName);
+    if (!event) {
+        throw new Error(`Event '${eventName}' not found in transaction receipt`);
+    }
+    return event;
+};
+exports.getEventFromTransaction = getEventFromTransaction;
+const getEventKeyValuesFromTransaction = async (gatewayApi, txId, eventName) => {
+    const event = await (0, exports.getEventFromTransaction)(gatewayApi, txId, eventName);
+    return (0, exports.extractValuesFromTxEvent)(event);
+};
+exports.getEventKeyValuesFromTransaction = getEventKeyValuesFromTransaction;
+const extractValuesFromTxEvent = (event) => {
+    const programmatic_json = event.payload.programmatic_json;
+    const keyValues = {};
+    if (programmatic_json.fields) {
+        programmatic_json.fields.forEach((field) => {
+            keyValues[field.field_name] = field.value;
+        });
+    }
+    return keyValues;
+};
+exports.extractValuesFromTxEvent = extractValuesFromTxEvent;
+//# sourceMappingURL=transaction.js.map

package/dist/utils/transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.js","sourceRoot":"","sources":["../../src/utils/transaction.ts"],"names":[],"mappings":";;;AAKO,MAAM,uBAAuB,GAAG,KAAK,EAC1C,UAA4B,EAC5B,IAAY,EACZ,SAAiB,EACjB,EAAE;IACF,MAAM,SAAS,GACb,MAAM,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,2BAA2B,CAAC;QACnE,kCAAkC,EAAE;YAClC,WAAW,EAAE,IAAI;YACjB,OAAO,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE;SACnC;KACF,CAAC,CAAC;IAEL,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,eAAe,CAAC;IAEjE,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;IAEtE,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,UAAU,SAAS,oCAAoC,CAAC,CAAC;IAC3E,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AA1BW,QAAA,uBAAuB,2BA0BlC;AAEK,MAAM,gCAAgC,GAAG,KAAK,EACnD,UAA4B,EAC5B,IAAY,EACZ,SAAiB,EACjB,EAAE;IACF,MAAM,KAAK,GAAG,MAAM,IAAA,+BAAuB,EAAC,UAAU,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IACzE,OAAO,IAAA,gCAAwB,EAAC,KAAK,CAAC,CAAC;AACzC,CAAC,CAAC;AAPW,QAAA,gCAAgC,oCAO3C;AAEK,MAAM,wBAAwB,GAAG,CAAC,KAAyB,EAAE,EAAE;IACpE,MAAM,iBAAiB,GAAG,KAAK,CAAC,OAAO,CAAC,iBAMvC,CAAC;IAEF,MAAM,SAAS,GAA2B,EAAE,CAAC;IAE7C,IAAI,iBAAiB,CAAC,MAAM,EAAE,CAAC;QAC7B,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACzC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC;QAC5C,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAlBW,QAAA,wBAAwB,4BAkBnC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "radix-utils",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Utility functions for Radix DLT blockchain development",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",