@autonomys/auto-utils 0.1.5 → 0.1.6

package/README.md

@@ -1,56 +1,56 @@
-# Autonomys Auto SDK Utility
-
-## Overview
-
-The Autonomys Auto SDK Utility provides functionalities for wallet setup, network management, data storage, cryptographic operations, and API activation.
-
-## Wallet Management
-
-- `setupWallet(params: MnemonicOrURI): Promise<KeyringPair>`: Initializes a wallet using a mnemonic or URI.
-- `activateWallet(params: ActivateWalletParams): Promise<WalletActivated>`: Activates a wallet and returns API and accounts.
-- `mockWallets(network: NetworkParams | DomainParams): Promise<WalletActivated[]>`: Creates mock wallets for testing.
-- `getMockWallet(name: string, wallets: WalletActivated[]): WalletActivated`: Retrieves a mock wallet by name.
-
-## Network Management
-
-- `getNetworkDetails(input?: NetworkParams): Network`: Gets network details.
-- `getNetworkRpcUrls(input?: NetworkParams): string[]`: Gets network RPC URLs.
-- `getNetworkDomainDetails(params: DomainParams): Domain`: Gets domain details.
-- `getNetworkDomainRpcUrls(params: DomainParams): string[]`: Gets domain RPC URLs.
-
-## Data Storage
-
-- `save(key: string, value: any)`: Saves data to local storage or file system.
-- `read(key: string): any`: Reads data from local storage or file system.
-
-## Cryptographic Functions
-
-- `blake2b_256(data: Uint8Array): string`: Hashes data with BLAKE2b-256.
-- `stringToUint8Array(text: string): Uint8Array`: Converts a string to a Uint8Array.
-- `concatenateUint8Arrays(array1: Uint8Array, array2: Uint8Array): Uint8Array`: Concatenates two Uint8Arrays.
-
-## API Activation
-
-- `activate(input?: NetworkParams): Promise<ApiPromise>`: Activates the API for a network.
-- `activateDomain(params: DomainParams): Promise<ApiPromise>`: Activates the API for a domain.
-- `disconnect()`: Disconnects the API.
-- `disconnectDomain()`: Disconnects the domain API.
-
-## Constants
-
-- `networks`: Array of network configurations.
-- `defaultNetwork`: Default network configuration.
-- `mockURIs`: Array of mock URIs.
-
-## Types
-
-- `Network`, `Domain`, `Explorer`, `NetworkParams`, `DomainParams`
-- `Mnemonic`, `URI`, `AppName`, `MnemonicOrURI`
-
-For more details, refer to the source files in the `src` directory.
-
-## Import Example
-
-```typescript
-import { activateWallet } from '@autonomys/auto-utils'
-```
+# Autonomys Auto SDK Utility
+
+## Overview
+
+The Autonomys Auto SDK Utility provides functionalities for wallet setup, network management, data storage, cryptographic operations, and API activation.
+
+## Wallet Management
+
+- `setupWallet(params: MnemonicOrURI): Promise<KeyringPair>`: Initializes a wallet using a mnemonic or URI.
+- `activateWallet(params: ActivateWalletParams): Promise<WalletActivated>`: Activates a wallet and returns API and accounts.
+- `mockWallets(network: NetworkParams | DomainParams): Promise<WalletActivated[]>`: Creates mock wallets for testing.
+- `getMockWallet(name: string, wallets: WalletActivated[]): WalletActivated`: Retrieves a mock wallet by name.
+
+## Network Management
+
+- `getNetworkDetails(input?: NetworkParams): Network`: Gets network details.
+- `getNetworkRpcUrls(input?: NetworkParams): string[]`: Gets network RPC URLs.
+- `getNetworkDomainDetails(params: DomainParams): Domain`: Gets domain details.
+- `getNetworkDomainRpcUrls(params: DomainParams): string[]`: Gets domain RPC URLs.
+
+## Data Storage
+
+- `save(key: string, value: any)`: Saves data to local storage or file system.
+- `read(key: string): any`: Reads data from local storage or file system.
+
+## Cryptographic Functions
+
+- `blake2b_256(data: Uint8Array): string`: Hashes data with BLAKE2b-256.
+- `stringToUint8Array(text: string): Uint8Array`: Converts a string to a Uint8Array.
+- `concatenateUint8Arrays(array1: Uint8Array, array2: Uint8Array): Uint8Array`: Concatenates two Uint8Arrays.
+
+## API Activation
+
+- `activate(input?: NetworkParams): Promise<ApiPromise>`: Activates the API for a network.
+- `activateDomain(params: DomainParams): Promise<ApiPromise>`: Activates the API for a domain.
+- `disconnect()`: Disconnects the API.
+- `disconnectDomain()`: Disconnects the domain API.
+
+## Constants
+
+- `networks`: Array of network configurations.
+- `defaultNetwork`: Default network configuration.
+- `mockURIs`: Array of mock URIs.
+
+## Types
+
+- `Network`, `Domain`, `Explorer`, `NetworkParams`, `DomainParams`
+- `Mnemonic`, `URI`, `AppName`, `MnemonicOrURI`
+
+For more details, refer to the source files in the `src` directory.
+
+## Import Example
+
+```typescript
+import { activateWallet } from '@autonomys/auto-utils'
+```

package/dist/types/event.d.ts

@@ -1,3 +1,5 @@
 import type { EventRecord } from '@polkadot/types/interfaces';
+export type ActionEvents = string | string[];
+export type Events = ActionEvents | ActionEvents[];
 export type { EventRecord };
 //# sourceMappingURL=event.d.ts.map

package/dist/types/event.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"event.d.ts","sourceRoot":"","sources":["../../src/types/event.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAE7D,YAAY,EAAE,WAAW,EAAE,CAAA"}
+{"version":3,"file":"event.d.ts","sourceRoot":"","sources":["../../src/types/event.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAE7D,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,EAAE,CAAA;AAC5C,MAAM,MAAM,MAAM,GAAG,YAAY,GAAG,YAAY,EAAE,CAAA;AAElD,YAAY,EAAE,WAAW,EAAE,CAAA"}

package/dist/types/index.d.ts

@@ -2,6 +2,7 @@ import type { BN } from '@polkadot/util';
 export * from './event';
 export * from './extrinsic';
 export * from './network';
+export * from './transaction';
 export * from './wallet';
 export type { BN };
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAA;AAExC,cAAc,SAAS,CAAA;AACvB,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AAExB,YAAY,EAAE,EAAE,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAA;AAExC,cAAc,SAAS,CAAA;AACvB,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,eAAe,CAAA;AAC7B,cAAc,UAAU,CAAA;AAExB,YAAY,EAAE,EAAE,EAAE,CAAA"}

package/dist/types/index.js

@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./event"), exports);
 __exportStar(require("./extrinsic"), exports);
 __exportStar(require("./network"), exports);
+__exportStar(require("./transaction"), exports);
 __exportStar(require("./wallet"), exports);

package/dist/types/transaction.d.ts

@@ -0,0 +1,14 @@
+import type { SignerOptions } from '@polkadot/api/types';
+import type { ActionEvents } from '../types/event';
+export type EventsValidated = {
+    expected: ActionEvents[];
+    found: ActionEvents[];
+};
+export type TransactionSignedAndSend = {
+    success: boolean;
+    txHash: string | undefined;
+    blockHash: string | undefined;
+    events: EventsValidated;
+};
+export { SignerOptions };
+//# sourceMappingURL=transaction.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../../src/types/transaction.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAElD,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,YAAY,EAAE,CAAA;IACxB,KAAK,EAAE,YAAY,EAAE,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B,MAAM,EAAE,eAAe,CAAA;CACxB,CAAA;AAED,OAAO,EAAE,aAAa,EAAE,CAAA"}

package/dist/types/transaction.js

@@ -0,0 +1,3 @@
+"use strict";
+// file: src/types/transaction.ts
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/detectTxSuccess.d.ts

@@ -0,0 +1,3 @@
+import type { EventRecord } from '../types/event';
+export declare const detectTxSuccess: (events: EventRecord[]) => boolean;
+//# sourceMappingURL=detectTxSuccess.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"detectTxSuccess.d.ts","sourceRoot":"","sources":["../../src/utils/detectTxSuccess.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAGjD,eAAO,MAAM,eAAe,WAAY,WAAW,EAAE,KAAG,OAMvD,CAAA"}

package/dist/utils/detectTxSuccess.js

@@ -0,0 +1,13 @@
+"use strict";
+// file: src/utils/detectTxSuccess.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.detectTxSuccess = void 0;
+const events_1 = require("./events");
+const detectTxSuccess = (events) => {
+    events.forEach(({ event: { method, section } }) => {
+        if (events_1.expectSuccessfulTxEvent.indexOf(`${section}.${method}`) > -1)
+            return true;
+    });
+    return false;
+};
+exports.detectTxSuccess = detectTxSuccess;

package/dist/utils/events.d.ts

@@ -0,0 +1,11 @@
+export declare const enum Type {
+    system = "system"
+}
+export declare const eventName: (type: Type, event: string) => string;
+export declare const eventsGroup: {
+    system: {
+        [key: string]: string;
+    };
+};
+export declare const expectSuccessfulTxEvent: string[];
+//# sourceMappingURL=events.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/utils/events.ts"],"names":[],"mappings":"AAGA,0BAAkB,IAAI;IACpB,MAAM,WAAW;CAClB;AAGD,eAAO,MAAM,SAAS,SAAU,IAAI,SAAS,MAAM,WAAuB,CAAA;AAY1E,eAAO,MAAM,WAAW;;;;CAEvB,CAAA;AAGD,eAAO,MAAM,uBAAuB,UAAmB,CAAA"}

package/dist/utils/events.js

@@ -0,0 +1,19 @@
+"use strict";
+// file: src/utils/events.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.expectSuccessfulTxEvent = exports.eventsGroup = exports.eventName = void 0;
+// Utility Function for Event Names
+const eventName = (type, event) => `${type}.${event}`;
+exports.eventName = eventName;
+// System Events
+const system = {
+    failure: (0, exports.eventName)("system" /* Type.system */, 'ExtrinsicFailed'),
+    newAccount: (0, exports.eventName)("system" /* Type.system */, 'NewAccount'),
+    success: (0, exports.eventName)("system" /* Type.system */, 'ExtrinsicSuccess'),
+};
+// Group of Events
+exports.eventsGroup = {
+    system,
+};
+// Export a default success event
+exports.expectSuccessfulTxEvent = [system.success];

package/dist/utils/index.d.ts

@@ -1,6 +1,9 @@
 export * from './createType';
+export * from './events';
 export * from './format';
 export * from './ready';
 export * from './sign';
+export * from './signAndSendTx';
+export * from './validateEvents';
 export * from './verify';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA;AACvB,cAAc,QAAQ,CAAA;AACtB,cAAc,UAAU,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA;AACvB,cAAc,QAAQ,CAAA;AACtB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,kBAAkB,CAAA;AAChC,cAAc,UAAU,CAAA"}

package/dist/utils/index.js

@@ -15,7 +15,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./createType"), exports);
+__exportStar(require("./events"), exports);
 __exportStar(require("./format"), exports);
 __exportStar(require("./ready"), exports);
 __exportStar(require("./sign"), exports);
+__exportStar(require("./signAndSendTx"), exports);
+__exportStar(require("./validateEvents"), exports);
 __exportStar(require("./verify"), exports);

package/dist/utils/signAndSendTx.d.ts

@@ -0,0 +1,3 @@
+import type { AddressOrPair, Events, ISubmittableResult, SignerOptions, SubmittableExtrinsic, TransactionSignedAndSend } from '../types';
+export declare const signAndSendTx: (sender: AddressOrPair, tx: SubmittableExtrinsic<'promise', ISubmittableResult>, options?: Partial<SignerOptions>, eventsExpected?: Events, log?: boolean) => Promise<TransactionSignedAndSend>;
+//# sourceMappingURL=signAndSendTx.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"signAndSendTx.d.ts","sourceRoot":"","sources":["../../src/utils/signAndSendTx.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,aAAa,EACb,MAAM,EAEN,kBAAkB,EAClB,aAAa,EACb,oBAAoB,EACpB,wBAAwB,EACzB,MAAM,UAAU,CAAA;AAKjB,eAAO,MAAM,aAAa,WAChB,aAAa,MACjB,qBAAqB,SAAS,EAAE,kBAAkB,CAAC,YAC9C,QAAQ,aAAa,CAAC,mBACf,MAAM,QACjB,OAAO,KACX,QAAQ,wBAAwB,CAgClC,CAAA"}

package/dist/utils/signAndSendTx.js

@@ -0,0 +1,52 @@
+"use strict";
+// file: src/utils/signAndSendTx.ts
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.signAndSendTx = void 0;
+const detectTxSuccess_1 = require("./detectTxSuccess");
+const events_1 = require("./events");
+const validateEvents_1 = require("./validateEvents");
+const signAndSendTx = (sender_1, tx_1, ...args_1) => __awaiter(void 0, [sender_1, tx_1, ...args_1], void 0, function* (sender, tx, options = {}, eventsExpected = events_1.expectSuccessfulTxEvent, log = false) {
+    let success = false;
+    let txHashHex = undefined;
+    let blockHash = undefined;
+    let eventsValidated = { expected: [], found: [] };
+    yield new Promise((resolve, reject) => {
+        tx.signAndSend(sender, options, ({ events, status, txHash }) => {
+            if (status.isInBlock) {
+                txHashHex = txHash.toHex();
+                blockHash = status.asInBlock.toHex();
+                if (log)
+                    console.log('Successful tx', txHashHex, 'in block', blockHash);
+                success = (0, detectTxSuccess_1.detectTxSuccess)(events);
+                if (eventsExpected.length > 0) {
+                    const _events = (0, validateEvents_1.validateEvents)(events, eventsExpected, txHashHex, blockHash, log);
+                    if (_events.expected.length === 0)
+                        resolve();
+                    else
+                        reject(new Error('Events not found'));
+                }
+                else
+                    resolve();
+            }
+            else if (status.isRetracted ||
+                status.isFinalityTimeout ||
+                status.isDropped ||
+                status.isInvalid) {
+                if (log)
+                    console.error('Transaction failed');
+                reject(new Error('Transaction failed'));
+            }
+        });
+    });
+    return { success, txHash: txHashHex, blockHash, events: eventsValidated };
+});
+exports.signAndSendTx = signAndSendTx;

package/dist/utils/validateEvents.d.ts

@@ -0,0 +1,3 @@
+import type { EventRecord, Events, EventsValidated } from '../types';
+export declare const validateEvents: (events: EventRecord[], eventsExpected: Events | undefined, tx: string, block: string, log?: boolean) => EventsValidated;
+//# sourceMappingURL=validateEvents.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"validateEvents.d.ts","sourceRoot":"","sources":["../../src/utils/validateEvents.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAGpE,eAAO,MAAM,cAAc,WACjB,WAAW,EAAE,0CAEjB,MAAM,SACH,MAAM,QACR,OAAO,KACX,eAmBF,CAAA"}

package/dist/utils/validateEvents.js

@@ -0,0 +1,24 @@
+"use strict";
+// file: src/utils/validateEvents.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateEvents = void 0;
+const events_1 = require("./events");
+const validateEvents = (events, eventsExpected = events_1.expectSuccessfulTxEvent, tx, block, log = false) => {
+    const _eventsExpected = typeof eventsExpected === 'string'
+        ? [eventsExpected]
+        : eventsExpected.map((e) => (typeof e === 'string' ? [e] : e)).flat();
+    const found = [];
+    events.forEach(({ event: { data, method, section } }) => {
+        const index = _eventsExpected.indexOf(`${section}.${method}`);
+        if (index > -1) {
+            _eventsExpected.splice(index, 1);
+            found.push(`${section}.${method}`);
+        }
+        else if (log)
+            console.log('Event not expected', `${section}.${method}`, 'tx', tx, 'block', block);
+    });
+    if (_eventsExpected.length > 0)
+        console.log('Events not found', _eventsExpected, 'tx', tx, 'block', block);
+    return { expected: _eventsExpected, found };
+};
+exports.validateEvents = validateEvents;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autonomys/auto-utils",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "main": "dist/index.js",
   "scripts": {
     "build": "tsc",
@@ -36,5 +36,5 @@
   "browser": {
     "fs": false
   },
-  "gitHead": "8f1d6171a537e44d29aa19ff2f5c5176046ca0f9"
+  "gitHead": "eb9ee6dc6987a47bebb38c9ed073c4b99440a920"
 }