@pezkuwi/api-contract 16.5.8 → 16.5.9

package/build-tsc-esm/base/Contract.js

@@ -1,127 +0,0 @@
-import { map } from 'rxjs';
-import { SubmittableResult } from '@pezkuwi/api';
-import { BN, BN_HUNDRED, BN_ONE, BN_ZERO, isUndefined, logger } from '@pezkuwi/util';
-import { applyOnEvent } from '../util.js';
-import { Base } from './Base.js';
-import { convertWeight, withMeta } from './util.js';
-const MAX_CALL_GAS = new BN(5_000_000_000_000).isub(BN_ONE);
-const l = logger('Contract');
-function createQuery(meta, fn) {
-    return withMeta(meta, (origin, options, ...params) => fn(origin, options, params));
-}
-function createTx(meta, fn) {
-    return withMeta(meta, (options, ...params) => fn(options, params));
-}
-export class ContractSubmittableResult extends SubmittableResult {
-    contractEvents;
-    constructor(result, contractEvents) {
-        super(result);
-        this.contractEvents = contractEvents;
-    }
-}
-export class Contract extends Base {
-    /**
-     * @description The on-chain address for this contract
-     */
-    address;
-    #query = {};
-    #tx = {};
-    constructor(api, abi, address, decorateMethod) {
-        super(api, abi, decorateMethod);
-        this.address = this.registry.createType(this._isRevive ? 'AccountId20' : 'AccountId', address);
-        this.abi.messages.forEach((m) => {
-            if (isUndefined(this.#tx[m.method])) {
-                this.#tx[m.method] = createTx(m, (o, p) => this.#exec(m, o, p));
-            }
-            if (isUndefined(this.#query[m.method])) {
-                this.#query[m.method] = createQuery(m, (f, o, p) => this.#read(m, o, p).send(f));
-            }
-        });
-    }
-    get query() {
-        return this.#query;
-    }
-    get tx() {
-        return this.#tx;
-    }
-    #getGas = (_gasLimit, isCall = false) => {
-        const weight = convertWeight(_gasLimit);
-        if (weight.v1Weight.gt(BN_ZERO)) {
-            return weight;
-        }
-        return convertWeight(isCall
-            ? MAX_CALL_GAS
-            : convertWeight(this.api.consts.system.blockWeights
-                ? this.api.consts.system.blockWeights.maxBlock
-                : this.api.consts.system['maximumBlockWeight']).v1Weight.muln(64).div(BN_HUNDRED));
-    };
-    #exec = (messageOrId, { gasLimit = BN_ZERO, storageDepositLimit = null, value = BN_ZERO }, params) => {
-        const palletTx = this._isRevive ? this.api.tx.revive : this.api.tx.contracts;
-        return palletTx.call(this.address, value, 
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore jiggle v1 weights, metadata points to latest
-        this._isWeightV1
-            ? convertWeight(gasLimit).v1Weight
-            : convertWeight(gasLimit).v2Weight, storageDepositLimit, this.abi.findMessage(messageOrId).toU8a(params)).withResultTransform((result) => 
-        // ContractEmitted is the current generation, ContractExecution is the previous generation
-        new ContractSubmittableResult(result, applyOnEvent(result, ['ContractEmitted', 'ContractExecution'], (records) => records
-            // Filter to only decode events emitted by this specific contract instance.
-            .filter((record) => {
-            try {
-                const contractAddress = record.event.data[0];
-                if (this.address.eq(contractAddress)) {
-                    return true;
-                }
-                l.debug(`Skipping event from different contract ${contractAddress.toString()} (this contract: ${this.address.toString()})`);
-                return false;
-            }
-            catch (error) {
-                l.warn(`Unable to extract contract address from event: ${error.message}`);
-                return false;
-            }
-        })
-            .map((record) => {
-            try {
-                return this.abi.decodeEvent(record);
-            }
-            catch (error) {
-                l.error(`Unable to decode contract event: ${error.message}`);
-                return null;
-            }
-        })
-            .filter((decoded) => !!decoded), this._isRevive)));
-    };
-    #read = (messageOrId, { gasLimit = BN_ZERO, storageDepositLimit = null, value = BN_ZERO }, params) => {
-        const message = this.abi.findMessage(messageOrId);
-        return {
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-            send: this._decorateMethod((origin) => (this._isRevive
-                ? this.api.rx.call.reviveApi.call
-                : this.api.rx.call.contractsApi.call)(origin, this.address, value, 
-            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-            // @ts-ignore jiggle v1 weights, metadata points to latest
-            this._isWeightV1
-                ? this.#getGas(gasLimit, true).v1Weight
-                : this.#getGas(gasLimit, true).v2Weight, storageDepositLimit, message.toU8a(params)).pipe(map(({ debugMessage, gasConsumed, gasRequired, result, storageDeposit }) => ({
-                debugMessage,
-                gasConsumed,
-                gasRequired: gasRequired && !convertWeight(gasRequired).v1Weight.isZero()
-                    ? gasRequired
-                    : gasConsumed,
-                output: result.isOk && message.returnType
-                    ? this.abi.registry.createTypeUnsafe(message.returnType.lookupName || message.returnType.type, [result.asOk.data.toU8a(true)], { isPedantic: true })
-                    : null,
-                result,
-                storageDeposit
-            }))))
-        };
-    };
-}
-export function extendContract(type, decorateMethod) {
-    return class extends Contract {
-        static __ContractType = type;
-        constructor(api, abi, address) {
-            super(api, abi, address, decorateMethod);
-        }
-    };
-}

package/build-tsc-esm/base/index.js

@@ -1,3 +0,0 @@
-export { Blueprint, BlueprintSubmittableResult, extendBlueprint } from './Blueprint.js';
-export { Code, CodeSubmittableResult, extendCode } from './Code.js';
-export { Contract, extendContract } from './Contract.js';

package/build-tsc-esm/base/mock.js

@@ -1,38 +0,0 @@
-import { TypeRegistry } from '@pezkuwi/types';
-const registry = new TypeRegistry();
-const instantiateWithCode = () => {
-    throw new Error('mock');
-};
-instantiateWithCode.meta = { args: new Array(6) };
-export const mockApi = {
-    call: {
-        contractsApi: {
-            call: () => {
-                throw new Error('mock');
-            }
-        }
-    },
-    isConnected: true,
-    registry,
-    tx: {
-        contracts: {
-            instantiateWithCode
-        }
-    }
-};
-export const mockReviveApi = {
-    call: {
-        reviveApi: {
-            call: () => {
-                throw new Error('mock');
-            }
-        }
-    },
-    isConnected: true,
-    registry,
-    tx: {
-        revive: {
-            instantiateWithCode
-        }
-    }
-};

package/build-tsc-esm/base/types.js

@@ -1 +0,0 @@
-export {};

package/build-tsc-esm/base/util.js

@@ -1,33 +0,0 @@
-import { Bytes } from '@pezkuwi/types';
-import { bnToBn, compactAddLength, u8aToU8a } from '@pezkuwi/util';
-import { randomAsU8a } from '@pezkuwi/util-crypto';
-export const EMPTY_SALT = new Uint8Array();
-export function withMeta(meta, creator) {
-    creator.meta = meta;
-    return creator;
-}
-export function createBluePrintTx(meta, fn) {
-    return withMeta(meta, (options, ...params) => fn(options, params));
-}
-export function createBluePrintWithId(fn) {
-    return (constructorOrId, options, ...params) => fn(constructorOrId, options, params);
-}
-export function encodeSalt(salt = randomAsU8a()) {
-    return salt instanceof Bytes
-        ? salt
-        : salt?.length
-            ? compactAddLength(u8aToU8a(salt))
-            : EMPTY_SALT;
-}
-export function convertWeight(weight) {
-    const [refTime, proofSize] = isWeightV2(weight)
-        ? [weight.refTime.toBn(), weight.proofSize.toBn()]
-        : [bnToBn(weight), undefined];
-    return {
-        v1Weight: refTime,
-        v2Weight: { proofSize, refTime }
-    };
-}
-export function isWeightV2(weight) {
-    return !!weight.proofSize;
-}

package/build-tsc-esm/bundle.js

@@ -1,4 +0,0 @@
-export { Abi } from './Abi/index.js';
-export { packageInfo } from './packageInfo.js';
-export * from './promise/index.js';
-export * from './rx/index.js';

package/build-tsc-esm/index.js

@@ -1,2 +0,0 @@
-import './packageDetect.js';
-export * from './bundle.js';

package/build-tsc-esm/packageDetect.js

@@ -1,5 +0,0 @@
-import { packageInfo as apiInfo } from '@pezkuwi/api/packageInfo';
-import { packageInfo as typesInfo } from '@pezkuwi/types/packageInfo';
-import { detectPackage } from '@pezkuwi/util';
-import { packageInfo } from './packageInfo.js';
-detectPackage(packageInfo, null, [apiInfo, typesInfo]);

package/build-tsc-esm/packageInfo.js

@@ -1 +0,0 @@
-export const packageInfo = { name: '@pezkuwi/api-contract', path: (import.meta && import.meta.url) ? new URL(import.meta.url).pathname.substring(0, new URL(import.meta.url).pathname.lastIndexOf('/') + 1) : 'auto', type: 'esm', version: '16.5.8' };

package/build-tsc-esm/promise/index.js

@@ -1,17 +0,0 @@
-import { toPromiseMethod } from '@pezkuwi/api';
-import { Blueprint, Code, Contract } from '../base/index.js';
-export class BlueprintPromise extends Blueprint {
-    constructor(api, abi, codeHash) {
-        super(api, abi, codeHash, toPromiseMethod);
-    }
-}
-export class CodePromise extends Code {
-    constructor(api, abi, wasm) {
-        super(api, abi, wasm, toPromiseMethod);
-    }
-}
-export class ContractPromise extends Contract {
-    constructor(api, abi, address) {
-        super(api, abi, address, toPromiseMethod);
-    }
-}

package/build-tsc-esm/promise/types.js

@@ -1 +0,0 @@
-export {};

package/build-tsc-esm/rx/index.js

@@ -1,17 +0,0 @@
-import { toRxMethod } from '@pezkuwi/api';
-import { Blueprint, Code, Contract } from '../base/index.js';
-export class BlueprintRx extends Blueprint {
-    constructor(api, abi, codeHash) {
-        super(api, abi, codeHash, toRxMethod);
-    }
-}
-export class CodeRx extends Code {
-    constructor(api, abi, wasm) {
-        super(api, abi, wasm, toRxMethod);
-    }
-}
-export class ContractRx extends Contract {
-    constructor(api, abi, address) {
-        super(api, abi, address, toRxMethod);
-    }
-}

package/build-tsc-esm/rx/types.js

@@ -1 +0,0 @@
-export {};

package/build-tsc-esm/types.js

@@ -1 +0,0 @@
-export {};

package/build-tsc-esm/util.js

@@ -1,10 +0,0 @@
-export function applyOnEvent(result, types, fn, isRevive) {
-    if (result.isInBlock || result.isFinalized) {
-        const section = isRevive ? 'revive' : 'contracts';
-        const records = result.filterRecords(section, types);
-        if (records.length) {
-            return fn(records);
-        }
-    }
-    return undefined;
-}

package/src/Abi/Abi.spec.ts

@@ -1,235 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/api-contract authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import type { Registry } from '@pezkuwi/types/types';
-
-import fs from 'node:fs';
-import process from 'node:process';
-
-import { TypeDefInfo } from '@pezkuwi/types/types';
-import rpcMetadata from '@pezkuwi/types-support/metadata/static-bizinikiwi-contracts-node';
-import { blake2AsHex } from '@pezkuwi/util-crypto';
-
-import { Metadata, TypeRegistry } from '../../../types/src/bundle.js';
-import abis from '../test/contracts/index.js';
-import { Abi } from './index.js';
-
-interface SpecDef {
-  messages: {
-    label: string;
-    name: string[] | string
-  }[]
-}
-
-interface JSONAbi {
-  source: {
-    compiler: string,
-    hash: string,
-    language: string,
-    wasm: string
-  },
-  spec: SpecDef;
-  V1: {
-    spec: SpecDef;
-  },
-  V2: {
-    spec: SpecDef;
-  },
-  V3: {
-    spec: SpecDef;
-  },
-  V4: {
-    spec: SpecDef;
-  }
-}
-
-function stringifyInfo (key: string, value: unknown): unknown {
-  return key === 'info' && typeof value === 'number'
-    ? TypeDefInfo[value]
-    : value;
-}
-
-function stringifyJson (registry: Registry): string {
-  const defs = registry.lookup.types.map(({ id }) =>
-    registry.lookup.getTypeDef(id)
-  );
-
-  return JSON.stringify(defs, stringifyInfo, 2);
-}
-
-describe('Abi', (): void => {
-  describe('ABI', (): void => {
-    Object.entries(abis).forEach(([abiName, _abi]) => {
-      const abi = _abi as unknown as JSONAbi;
-
-      it(`initializes from a contract ABI (${abiName})`, (): void => {
-        try {
-          const messageIds = (abi.V4 || abi.V3 || abi.V2 || abi.V1 || abi).spec.messages.map(({ label, name }) =>
-            label || (
-              Array.isArray(name)
-                ? name.join('::')
-                : name
-            )
-          );
-          const inkAbi = new Abi(abis[abiName]);
-
-          expect(inkAbi.messages.map(({ identifier }) => identifier)).toEqual(messageIds);
-        } catch (error) {
-          console.error(error);
-
-          throw error;
-        }
-      });
-    });
-  });
-
-  describe('TypeDef', (): void => {
-    for (const [abiName, abiJson] of Object.entries(abis)) {
-      it(`initializes from a contract ABI: ${abiName}`, (): void => {
-        const abi = new Abi(abiJson);
-        const registryJson = stringifyJson(abi.registry);
-        const cmpFile = new URL(`../test/compare/${abiName}.test.json`, import.meta.url);
-
-        try {
-          expect(
-            JSON.parse(registryJson)
-          ).toEqual(
-            JSON.parse(fs.readFileSync(cmpFile, 'utf-8'))
-          );
-        } catch (error) {
-          if (process.env['GITHUB_REPOSITORY']) {
-            console.error(registryJson);
-
-            throw error;
-          }
-
-          fs.writeFileSync(cmpFile, registryJson, { flag: 'w' });
-        }
-      });
-    }
-  });
-
-  it('has the correct hash for the source', (): void => {
-    const abi = new Abi(abis['ink_v0_flipperBundle']);
-    const bundle = abis['ink_v0_flipperBundle'] as unknown as JSONAbi;
-
-    // manual
-    expect(bundle.source.hash).toEqual(blake2AsHex(bundle.source.wasm));
-
-    // the Codec hash
-    expect(bundle.source.hash).toEqual(abi.info.source.wasm.hash.toHex());
-
-    // the hash as per the actual Abi
-    expect(bundle.source.hash).toEqual(abi.info.source.wasmHash.toHex());
-  });
-
-  describe('Events', (): void => {
-    const registry = new TypeRegistry();
-
-    beforeAll((): void => {
-      const metadata = new Metadata(registry, rpcMetadata);
-
-      registry.setMetadata(metadata);
-    });
-
-    it('decoding <=ink!v4 event', (): void => {
-      const abiJson = abis['ink_v4_erc20Metadata'];
-
-      expect(abiJson).toBeDefined();
-      const abi = new Abi(abiJson);
-
-      const eventRecordHex =
-      '0x0001000000080360951b8baf569bca905a279c12d6ce17db7cdce23a42563870ef585129ce5dc64d010001d43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d018eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a4800505a4f7e9f4eb106000000000000000c0045726332303a3a5472616e7366657200000000000000000000000000000000da2d695d3b5a304e0039e7fc4419c34fa0c1f239189c99bb72a6484f1634782b2b00c7d40fe6d84d660f3e6bed90f218e022a0909f7e1a7ea35ada8b6e003564';
-      const record = registry.createType('EventRecord', eventRecordHex);
-
-      const decodedEvent = abi.decodeEvent(record);
-
-      expect(decodedEvent.event.args.length).toEqual(3);
-      expect(decodedEvent.args.length).toEqual(3);
-      expect(decodedEvent.event.identifier).toEqual('Transfer');
-
-      const decodedEventHuman = decodedEvent.event.args.reduce((prev, cur, index) => {
-        return {
-          ...prev,
-          [cur.name]: decodedEvent.args[index].toHuman()
-        };
-      }, {});
-
-      const expectedEvent = {
-        from: '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY',
-        to: '5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty',
-        value: '123.4567 MUnit'
-      };
-
-      expect(decodedEventHuman).toEqual(expectedEvent);
-    });
-
-    it('decoding >=ink!v5 event', (): void => {
-      const abiJson = abis['ink_v5_erc20Metadata'];
-
-      expect(abiJson).toBeDefined();
-      const abi = new Abi(abiJson);
-
-      const eventRecordHex =
-    '0x00010000000803da17150e96b3955a4db6ad35ddeb495f722f9c1d84683113bfb096bf3faa30f2490101d43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d018eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a4800505a4f7e9f4eb106000000000000000cb5b61a3e6a21a16be4f044b517c28ac692492f73c5bfd3f60178ad98c767f4cbd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d8eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a48';
-      const record = registry.createType('EventRecord', eventRecordHex);
-
-      const decodedEvent = abi.decodeEvent(record);
-
-      expect(decodedEvent.event.args.length).toEqual(3);
-      expect(decodedEvent.args.length).toEqual(3);
-      expect(decodedEvent.event.identifier).toEqual('erc20::erc20::Transfer');
-
-      const decodedEventHuman = decodedEvent.event.args.reduce((prev, cur, index) => {
-        return {
-          ...prev,
-          [cur.name]: decodedEvent.args[index].toHuman()
-        };
-      }, {});
-
-      const expectedEvent = {
-        from: '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY',
-        to: '5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty',
-        value: '123.4567 MUnit'
-      };
-
-      expect(decodedEventHuman).toEqual(expectedEvent);
-    });
-
-    it('decoding >=ink!v5 anonymous event', (): void => {
-      const abiJson = abis['ink_v5_erc20AnonymousTransferMetadata'];
-
-      expect(abiJson).toBeDefined();
-      const abi = new Abi(abiJson);
-
-      expect(abi.events[0].identifier).toEqual('erc20::erc20::Transfer');
-      expect(abi.events[0].signatureTopic).toEqual(null);
-
-      const eventRecordWithAnonymousEventHex = '0x00010000000803538e726248a9c155911e7d99f4f474c3408630a2f6275dd501d4471c7067ad2c490101d43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d018eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a4800505a4f7e9f4eb1060000000000000008d43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d8eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a48';
-      const record = registry.createType('EventRecord', eventRecordWithAnonymousEventHex);
-
-      const decodedEvent = abi.decodeEvent(record);
-
-      expect(decodedEvent.event.args.length).toEqual(3);
-      expect(decodedEvent.args.length).toEqual(3);
-      expect(decodedEvent.event.identifier).toEqual('erc20::erc20::Transfer');
-
-      const decodedEventHuman = decodedEvent.event.args.reduce((prev, cur, index) => {
-        return {
-          ...prev,
-          [cur.name]: decodedEvent.args[index].toHuman()
-        };
-      }, {});
-
-      const expectedEvent = {
-        from: '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY',
-        to: '5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty',
-        value: '123.4567 MUnit'
-      };
-
-      expect(decodedEventHuman).toEqual(expectedEvent);
-    });
-  });
-});