@dedot/contracts 0.2.0 → 0.3.0

package/Contract.d.ts

@@ -7,6 +7,7 @@ export declare class Contract<ContractApi extends GenericContractApi = GenericCo
     #private;
     constructor(api: ISubstrateClient, metadata: ContractMetadata | string, address: AccountId32Like);
     decodeEvent(eventRecord: IEventRecord): ContractEvent;
+    decodeEvents(eventRecords: IEventRecord[]): ContractEvent[];
     get metadata(): ContractMetadata;
     get address(): AccountId32;
     get registry(): TypinkRegistry;

package/Contract.js

@@ -17,6 +17,9 @@ export class Contract {
     decodeEvent(eventRecord) {
         return this.#registry.decodeEvent(eventRecord);
     }
+    decodeEvents(eventRecords) {
+        return this.#registry.decodeEvents(eventRecords);
+    }
     get metadata() {
         return this.#metadata;
     }

package/TypinkRegistry.d.ts

@@ -5,5 +5,6 @@ export declare class TypinkRegistry extends TypeRegistry {
     #private;
     constructor(metadata: ContractMetadata);
     get metadata(): ContractMetadata;
+    decodeEvents(records: IEventRecord[]): ContractEvent[];
     decodeEvent(eventRecord: IEventRecord): ContractEvent;
 }

package/TypinkRegistry.js

@@ -11,6 +11,11 @@ export class TypinkRegistry extends TypeRegistry {
     get metadata() {
         return this.#metadata;
     }
+    decodeEvents(records) {
+        return records
+            .filter(({ event }) => this.#isContractEmittedEvent(event)) // prettier-end-here
+            .map((record) => this.decodeEvent(record));
+    }
     decodeEvent(eventRecord) {
         const { version } = this.#metadata;
         switch (version) {
@@ -22,9 +27,9 @@ export class TypinkRegistry extends TypeRegistry {
                 throw new DedotError('Unsupported metadata version!');
         }
     }
-    #isContractEmittedEvent(eventRecord) {
+    #isContractEmittedEvent(event) {
         // @ts-ignore
-        return eventRecord.pallet === 'Contracts' && eventRecord.palletEvent.name === 'ContractEmitted';
+        return event.pallet === 'Contracts' && event.palletEvent.name === 'ContractEmitted';
     }
     #decodeEventV4(eventRecord) {
         assert(this.#metadata.version === '4', 'Invalid metadata version!');

package/cjs/Contract.js

@@ -20,6 +20,9 @@ class Contract {
     decodeEvent(eventRecord) {
         return this.#registry.decodeEvent(eventRecord);
     }
+    decodeEvents(eventRecords) {
+        return this.#registry.decodeEvents(eventRecords);
+    }
     get metadata() {
         return this.#metadata;
     }

package/cjs/TypinkRegistry.js

@@ -37,6 +37,11 @@ class TypinkRegistry extends codecs_1.TypeRegistry {
     get metadata() {
         return this.#metadata;
     }
+    decodeEvents(records) {
+        return records
+            .filter(({ event }) => this.#isContractEmittedEvent(event)) // prettier-end-here
+            .map((record) => this.decodeEvent(record));
+    }
     decodeEvent(eventRecord) {
         const { version } = this.#metadata;
         switch (version) {
@@ -48,9 +53,9 @@ class TypinkRegistry extends codecs_1.TypeRegistry {
                 throw new utils_1.DedotError('Unsupported metadata version!');
         }
     }
-    #isContractEmittedEvent(eventRecord) {
+    #isContractEmittedEvent(event) {
         // @ts-ignore
-        return eventRecord.pallet === 'Contracts' && eventRecord.palletEvent.name === 'ContractEmitted';
+        return event.pallet === 'Contracts' && event.palletEvent.name === 'ContractEmitted';
     }
     #decodeEventV4(eventRecord) {
         (0, utils_1.assert)(this.#metadata.version === '4', 'Invalid metadata version!');

package/cjs/errors.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isContractInstantiateLangError = exports.isContractInstantiateDispatchError = exports.isContractInstantiateError = exports.isContractLangError = exports.isContractDispatchError = exports.isContractExecutionError = exports.ContractLangError = exports.ContractDispatchError = exports.ContractExecutionError = exports.ContractInstantiateLangError = exports.ContractInstantiateDispatchError = exports.ContractInstantiateError = void 0;
 const utils_1 = require("@dedot/utils");
+const utils_js_1 = require("./utils.js");
 /**
  * Represents an error that occurred during the instantiation of a smart contract.
  * This class extends the base `DedotError` and includes a `raw` property of type `ContractInstantiateResult`.
@@ -66,6 +67,10 @@ class ContractInstantiateLangError extends ContractInstantiateError {
      * The language-specific error that occurred during the instantiation.
      */
     langError;
+    /**
+     * Decoded `ReturnFlags` from contract call result.
+     */
+    flags;
     /**
      * Constructs a new `ContractInstantiateLangError` instance.
      *
@@ -73,8 +78,10 @@ class ContractInstantiateLangError extends ContractInstantiateError {
      * @param raw - The raw result of the contract instantiation.
      */
     constructor(err, raw) {
+        (0, utils_1.assert)(raw.result.isOk, 'Should not throw DispatchError!');
         super(raw);
         this.langError = err;
+        this.flags = (0, utils_js_1.toReturnFlags)(raw.result.value.result.flags.bits);
     }
 }
 exports.ContractInstantiateLangError = ContractInstantiateLangError;
@@ -142,6 +149,10 @@ class ContractLangError extends ContractExecutionError {
      * The language-specific error that occurred during the execution.
      */
     langError;
+    /**
+     * Decoded `ReturnFlags` from contract call result.
+     */
+    flags;
     /**
      * Constructs a new `ContractLangError` instance.
      *
@@ -149,8 +160,10 @@ class ContractLangError extends ContractExecutionError {
      * @param raw - The raw result of the contract call.
      */
     constructor(err, raw) {
+        (0, utils_1.assert)(raw.result.isOk, 'Should not throw DispatchError!');
         super(raw);
         this.langError = err;
+        this.flags = (0, utils_js_1.toReturnFlags)(raw.result.value.flags.bits);
     }
 }
 exports.ContractLangError = ContractLangError;

package/cjs/executor/ConstructorQueryExecutor.js

@@ -35,10 +35,12 @@ class ConstructorQueryExecutor extends Executor_js_1.Executor {
             if (data.isErr) {
                 throw new errors_js_1.ContractInstantiateLangError(data.err, raw);
             }
+            const bits = raw.result.value.result.flags.bits;
             return {
-                raw,
                 data: data.value,
+                raw,
                 address: raw.result.value.accountId,
+                flags: (0, utils_js_1.toReturnFlags)(bits),
             };
         };
         callFn.meta = meta;

package/cjs/executor/EventExecutor.js

@@ -1,26 +1,51 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EventExecutor = void 0;
-const Executor_js_1 = require("./Executor.js");
+const api_1 = require("@dedot/api");
 const utils_1 = require("@dedot/utils");
+const Executor_js_1 = require("./Executor.js");
 class EventExecutor extends Executor_js_1.Executor {
     doExecute(eventName) {
-        const eventMeta = this.#findEventMeta(eventName);
-        (0, utils_1.assert)(eventMeta, "Contract event metadata not found!");
+        const meta = this.#findEventMeta(eventName);
+        (0, utils_1.assert)(meta, 'Contract event metadata not found!');
         const is = (event) => {
+            if ((0, api_1.isEventRecord)(event)) {
+                try {
+                    event = this.registry.decodeEvent(event);
+                }
+                catch {
+                    return false;
+                }
+            }
             return event.name === eventName;
         };
-        const as = (event) => {
-            return is(event) ? event : undefined;
+        const find = (events) => {
+            if (!events || events.length === 0)
+                return undefined;
+            if ((0, api_1.isEventRecord)(events[0])) {
+                return this.registry.decodeEvents(events).find(is);
+            }
+            else {
+                return events.find(is);
+            }
+        };
+        const filter = (events) => {
+            if ((0, api_1.isEventRecord)(events[0])) {
+                return this.registry.decodeEvents(events).filter(is);
+            }
+            else {
+                return events.filter(is);
+            }
         };
         return {
             is,
-            as,
-            meta: eventMeta,
+            find,
+            filter,
+            meta,
         };
     }
     #findEventMeta(eventName) {
-        return this.registry.metadata.spec.events.find(one => (0, utils_1.stringPascalCase)(one.label) === eventName);
+        return this.registry.metadata.spec.events.find((one) => (0, utils_1.stringPascalCase)(one.label) === eventName);
     }
 }
 exports.EventExecutor = EventExecutor;

package/cjs/executor/QueryExecutor.js

@@ -25,9 +25,11 @@ class QueryExecutor extends Executor_js_1.Executor {
             if (data.isErr) {
                 throw new errors_js_1.ContractLangError(data.err, raw);
             }
+            const bits = raw.result.value.flags.bits;
             return {
                 data: data.value,
                 raw,
+                flags: (0, utils_js_1.toReturnFlags)(bits),
             };
         };
         callFn.meta = meta;

package/cjs/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeLabel = exports.ensureSupportContractsPallet = exports.newProxyChain = exports.parseRawMetadata = exports.normalizeContractTypeDef = exports.extractContractTypes = void 0;
+exports.toReturnFlags = exports.normalizeLabel = exports.ensureSupportContractsPallet = exports.newProxyChain = exports.parseRawMetadata = exports.normalizeContractTypeDef = exports.extractContractTypes = void 0;
 const utils_1 = require("@dedot/utils");
 const extractContractTypes = (contractMetadata) => {
     const { types } = contractMetadata;
@@ -106,3 +106,12 @@ function normalizeLabel(label) {
     return (0, utils_1.stringCamelCase)(label.replaceAll('::', '_'));
 }
 exports.normalizeLabel = normalizeLabel;
+// https://github.com/paritytech/polkadot-sdk/blob/d2fd53645654d3b8e12cbf735b67b93078d70113/substrate/frame/contracts/uapi/src/flags.rs#L23-L26
+const REVERT_FLAG = 1;
+function toReturnFlags(bits) {
+    return {
+        bits,
+        revert: bits === REVERT_FLAG,
+    };
+}
+exports.toReturnFlags = toReturnFlags;

package/errors.d.ts

@@ -1,6 +1,6 @@
 import { DispatchError } from '@dedot/codecs';
 import { DedotError } from '@dedot/utils';
-import { ContractCallResult, ContractInstantiateResult, GenericContractApi } from './types';
+import { ContractCallResult, ContractInstantiateResult, GenericContractApi, ReturnFlags } from './types/index.js';
 /**
  * Represents an error that occurred during the instantiation of a smart contract.
  * This class extends the base `DedotError` and includes a `raw` property of type `ContractInstantiateResult`.
@@ -57,6 +57,10 @@ export declare class ContractInstantiateLangError<ContractApi extends GenericCon
      * The language-specific error that occurred during the instantiation.
      */
     langError: ContractApi['types']['LangError'];
+    /**
+     * Decoded `ReturnFlags` from contract call result.
+     */
+    flags: ReturnFlags;
     /**
      * Constructs a new `ContractInstantiateLangError` instance.
      *
@@ -121,6 +125,10 @@ export declare class ContractLangError<ContractApi extends GenericContractApi =
      * The language-specific error that occurred during the execution.
      */
     langError: ContractApi['types']['LangError'];
+    /**
+     * Decoded `ReturnFlags` from contract call result.
+     */
+    flags: ReturnFlags;
     /**
      * Constructs a new `ContractLangError` instance.
      *

package/errors.js

@@ -1,4 +1,5 @@
-import { DedotError } from '@dedot/utils';
+import { DedotError, assert } from '@dedot/utils';
+import { toReturnFlags } from './utils.js';
 /**
  * Represents an error that occurred during the instantiation of a smart contract.
  * This class extends the base `DedotError` and includes a `raw` property of type `ContractInstantiateResult`.
@@ -61,6 +62,10 @@ export class ContractInstantiateLangError extends ContractInstantiateError {
      * The language-specific error that occurred during the instantiation.
      */
     langError;
+    /**
+     * Decoded `ReturnFlags` from contract call result.
+     */
+    flags;
     /**
      * Constructs a new `ContractInstantiateLangError` instance.
      *
@@ -68,8 +73,10 @@ export class ContractInstantiateLangError extends ContractInstantiateError {
      * @param raw - The raw result of the contract instantiation.
      */
     constructor(err, raw) {
+        assert(raw.result.isOk, 'Should not throw DispatchError!');
         super(raw);
         this.langError = err;
+        this.flags = toReturnFlags(raw.result.value.result.flags.bits);
     }
 }
 /**
@@ -134,6 +141,10 @@ export class ContractLangError extends ContractExecutionError {
      * The language-specific error that occurred during the execution.
      */
     langError;
+    /**
+     * Decoded `ReturnFlags` from contract call result.
+     */
+    flags;
     /**
      * Constructs a new `ContractLangError` instance.
      *
@@ -141,8 +152,10 @@ export class ContractLangError extends ContractExecutionError {
      * @param raw - The raw result of the contract call.
      */
     constructor(err, raw) {
+        assert(raw.result.isOk, 'Should not throw DispatchError!');
         super(raw);
         this.langError = err;
+        this.flags = toReturnFlags(raw.result.value.flags.bits);
     }
 }
 /**

package/executor/ConstructorQueryExecutor.js

@@ -1,6 +1,6 @@
 import { assert, concatU8a, hexToU8a, isWasm, u8aToHex } from '@dedot/utils';
 import { ContractInstantiateDispatchError, ContractInstantiateLangError } from '../errors.js';
-import { normalizeLabel } from '../utils.js';
+import { normalizeLabel, toReturnFlags } from '../utils.js';
 import { Executor } from './Executor.js';
 export class ConstructorQueryExecutor extends Executor {
     code;
@@ -32,10 +32,12 @@ export class ConstructorQueryExecutor extends Executor {
             if (data.isErr) {
                 throw new ContractInstantiateLangError(data.err, raw);
             }
+            const bits = raw.result.value.result.flags.bits;
             return {
-                raw,
                 data: data.value,
+                raw,
                 address: raw.result.value.accountId,
+                flags: toReturnFlags(bits),
             };
         };
         callFn.meta = meta;

package/executor/EventExecutor.d.ts

@@ -1,6 +1,6 @@
-import { GenericSubstrateApi } from "@dedot/types";
-import { Executor } from "./Executor.js";
-import { GenericContractEvent } from "../types/index.js";
+import { GenericSubstrateApi } from '@dedot/types';
+import { GenericContractEvent } from '../types/index.js';
+import { Executor } from './Executor.js';
 export declare class EventExecutor<ChainApi extends GenericSubstrateApi> extends Executor<ChainApi> {
     #private;
     doExecute(eventName: string): GenericContractEvent;

package/executor/EventExecutor.js

@@ -1,22 +1,47 @@
-import { Executor } from "./Executor.js";
-import { assert, stringPascalCase } from "@dedot/utils";
+import { isEventRecord } from '@dedot/api';
+import { assert, stringPascalCase } from '@dedot/utils';
+import { Executor } from './Executor.js';
 export class EventExecutor extends Executor {
     doExecute(eventName) {
-        const eventMeta = this.#findEventMeta(eventName);
-        assert(eventMeta, "Contract event metadata not found!");
+        const meta = this.#findEventMeta(eventName);
+        assert(meta, 'Contract event metadata not found!');
         const is = (event) => {
+            if (isEventRecord(event)) {
+                try {
+                    event = this.registry.decodeEvent(event);
+                }
+                catch {
+                    return false;
+                }
+            }
             return event.name === eventName;
         };
-        const as = (event) => {
-            return is(event) ? event : undefined;
+        const find = (events) => {
+            if (!events || events.length === 0)
+                return undefined;
+            if (isEventRecord(events[0])) {
+                return this.registry.decodeEvents(events).find(is);
+            }
+            else {
+                return events.find(is);
+            }
+        };
+        const filter = (events) => {
+            if (isEventRecord(events[0])) {
+                return this.registry.decodeEvents(events).filter(is);
+            }
+            else {
+                return events.filter(is);
+            }
         };
         return {
             is,
-            as,
-            meta: eventMeta,
+            find,
+            filter,
+            meta,
         };
     }
     #findEventMeta(eventName) {
-        return this.registry.metadata.spec.events.find(one => stringPascalCase(one.label) === eventName);
+        return this.registry.metadata.spec.events.find((one) => stringPascalCase(one.label) === eventName);
     }
 }

package/executor/QueryExecutor.js

@@ -1,6 +1,6 @@
 import { assert, concatU8a, hexToU8a, u8aToHex } from '@dedot/utils';
 import { ContractDispatchError, ContractLangError } from '../errors.js';
-import { normalizeLabel } from '../utils.js';
+import { normalizeLabel, toReturnFlags } from '../utils.js';
 import { Executor } from './Executor.js';
 export class QueryExecutor extends Executor {
     doExecute(message) {
@@ -22,9 +22,11 @@ export class QueryExecutor extends Executor {
             if (data.isErr) {
                 throw new ContractLangError(data.err, raw);
             }
+            const bits = raw.result.value.flags.bits;
             return {
                 data: data.value,
                 raw,
+                flags: toReturnFlags(bits),
             };
         };
         callFn.meta = meta;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dedot/contracts",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Delightful ink! Contract APIs",
   "author": "Tung Vu <tung@coongcrafts.io>",
   "homepage": "https://github.com/dedotdev/dedot/tree/main/packages/contracts",
@@ -18,17 +18,17 @@
     "test": "vitest --watch=false"
   },
   "dependencies": {
-    "@dedot/api": "0.2.0",
-    "@dedot/codecs": "0.2.0",
-    "@dedot/types": "0.2.0",
-    "@dedot/utils": "0.2.0"
+    "@dedot/api": "0.3.0",
+    "@dedot/codecs": "0.3.0",
+    "@dedot/types": "0.3.0",
+    "@dedot/utils": "0.3.0"
   },
   "publishConfig": {
     "access": "public",
     "directory": "dist"
   },
   "license": "Apache-2.0",
-  "gitHead": "f29e8784997251518df1e33ef782f1d87207b126",
+  "gitHead": "40d0f3c7eee292b7615649e6a5d54887bee75fe2",
   "module": "./index.js",
   "types": "./index.d.ts",
   "exports": {

package/types/index.d.ts

@@ -1,20 +1,27 @@
 import { SubstrateApi } from '@dedot/api/chaintypes';
 import { AccountId32, AccountId32Like, BytesLike, Weight } from '@dedot/codecs';
-import { AnyFunc, AsyncMethod, GenericSubstrateApi, RpcVersion, VersionedGenericSubstrateApi } from '@dedot/types';
+import { AnyFunc, AsyncMethod, GenericSubstrateApi, IEventRecord, RpcVersion, VersionedGenericSubstrateApi } from '@dedot/types';
 import { ContractCallMessage, ContractConstructorMessage } from './shared.js';
 import { ContractEventV4, ContractMetadataV4 } from './v4.js';
 import { ContractEventV5, ContractMetadataV5 } from './v5.js';
 export * from './shared.js';
 export type ContractEventMeta = ContractEventV4 | ContractEventV5;
-export type GenericContractCallResult<DecodedData = any, ContractResult = any> = {
-    data: DecodedData;
-    raw: ContractResult;
+/**
+ * Flags used by a contract to customize exit behaviour.
+ * Ref: https://github.com/paritytech/polkadot-sdk/blob/d2fd53645654d3b8e12cbf735b67b93078d70113/substrate/frame/contracts/uapi/src/flags.rs#L23-L26
+ */
+export type ReturnFlags = {
+    bits: number;
+    revert: boolean;
 };
-export type GenericConstructorCallResult<DecodedData = any, ContractResult = any> = {
+export interface GenericContractCallResult<DecodedData = any, ContractResult = any> {
     data: DecodedData;
     raw: ContractResult;
+    flags: ReturnFlags;
+}
+export interface GenericConstructorCallResult<DecodedData = any, ContractResult = any> extends GenericContractCallResult<DecodedData, ContractResult> {
     address: AccountId32;
-};
+}
 export type ContractCallResult<ChainApi extends GenericSubstrateApi> = Awaited<ReturnType<ChainApi['call']['contractsApi']['call']>>;
 export type ContractInstantiateResult<ChainApi extends GenericSubstrateApi> = Awaited<ReturnType<ChainApi['call']['contractsApi']['instantiate']>>;
 export type ContractSubmittableExtrinsic<ChainApi extends GenericSubstrateApi> = ReturnType<ChainApi['tx']['contracts']['call']>;
@@ -72,8 +79,9 @@ export type ContractEvent<EventName extends string = string, Data extends any =
     data: Data;
 };
 export interface GenericContractEvent<EventName extends string = string, Data extends any = any> {
-    is: (event: ContractEvent) => event is ContractEvent<EventName, Data>;
-    as: (event: ContractEvent) => ContractEvent<EventName, Data> | undefined;
+    is: (event: IEventRecord | ContractEvent) => event is ContractEvent<EventName, Data>;
+    find: (events: IEventRecord[] | ContractEvent[]) => ContractEvent<EventName, Data> | undefined;
+    filter: (events: IEventRecord[] | ContractEvent[]) => ContractEvent<EventName, Data>[];
     meta: ContractEventMeta;
 }
 export interface GenericContractEvents<_ extends GenericSubstrateApi> {

package/utils.d.ts

@@ -2,10 +2,11 @@ import { ISubstrateClient } from '@dedot/api';
 import { PortableType, TypeDef } from '@dedot/codecs';
 import { GenericSubstrateApi } from '@dedot/types';
 import { Executor } from './executor/index.js';
-import { ContractMetadata, ContractTypeDef } from './types/index.js';
+import { ContractMetadata, ContractTypeDef, ReturnFlags } from './types/index.js';
 export declare const extractContractTypes: (contractMetadata: ContractMetadata) => PortableType[];
 export declare const normalizeContractTypeDef: (def: ContractTypeDef) => TypeDef;
 export declare const parseRawMetadata: (rawMetadata: string) => ContractMetadata;
 export declare function newProxyChain<ChainApi extends GenericSubstrateApi>(carrier: Executor<ChainApi>): unknown;
 export declare function ensureSupportContractsPallet<ChainApi extends GenericSubstrateApi>(api: ISubstrateClient<ChainApi>): void;
 export declare function normalizeLabel(label?: string): string;
+export declare function toReturnFlags(bits: number): ReturnFlags;

package/utils.js

@@ -97,3 +97,11 @@ export function normalizeLabel(label) {
         return '';
     return stringCamelCase(label.replaceAll('::', '_'));
 }
+// https://github.com/paritytech/polkadot-sdk/blob/d2fd53645654d3b8e12cbf735b67b93078d70113/substrate/frame/contracts/uapi/src/flags.rs#L23-L26
+const REVERT_FLAG = 1;
+export function toReturnFlags(bits) {
+    return {
+        bits,
+        revert: bits === REVERT_FLAG,
+    };
+}