@pezkuwi/api-contract 16.5.17 → 16.5.18

package/build/base/Base.js

@@ -0,0 +1,40 @@
+import { isFunction } from '@pezkuwi/util';
+import { Abi } from '../Abi/index.js';
+export class Base {
+    abi;
+    api;
+    _decorateMethod;
+    _isWeightV1;
+    _isRevive;
+    constructor(api, abi, decorateMethod) {
+        if (!api || !api.isConnected || !api.tx) {
+            throw new Error('Your API has not been initialized correctly and is not connected to a chain');
+        }
+        this.abi = abi instanceof Abi
+            ? abi
+            : new Abi(abi, api.registry.getChainProperties());
+        this.api = api;
+        this._decorateMethod = decorateMethod;
+        this._isWeightV1 = !api.registry.createType('Weight').proofSize;
+        this._isRevive = this.abi.isRevive;
+        if (this._isRevive) {
+            if (!api.tx.revive || !isFunction(api.tx.revive.instantiateWithCode) || api.tx.revive.instantiateWithCode.meta.args.length !== 6) {
+                throw new Error('The runtime does not expose api.tx.revive.instantiateWithCode with storageDepositLimit');
+            }
+            else if (!api.call.reviveApi || !isFunction(api.call.reviveApi.call)) {
+                throw new Error('Your runtime does not expose the api.call.reviveApi.call runtime interfaces');
+            }
+        }
+        else {
+            if (!api.tx.contracts || !isFunction(api.tx.contracts.instantiateWithCode) || api.tx.contracts.instantiateWithCode.meta.args.length !== 6) {
+                throw new Error('The runtime does not expose api.tx.contracts.instantiateWithCode with storageDepositLimit');
+            }
+            else if (!api.call.contractsApi || !isFunction(api.call.contractsApi.call)) {
+                throw new Error('Your runtime does not expose the api.call.contractsApi.call runtime interfaces');
+            }
+        }
+    }
+    get registry() {
+        return this.api.registry;
+    }
+}

package/build/base/Blueprint.js

@@ -0,0 +1,51 @@
+import { SubmittableResult } from '@pezkuwi/api';
+import { BN_ZERO, isUndefined } from '@pezkuwi/util';
+import { applyOnEvent } from '../util.js';
+import { Base } from './Base.js';
+import { Contract } from './Contract.js';
+import { convertWeight, createBluePrintTx, encodeSalt } from './util.js';
+export class BlueprintSubmittableResult extends SubmittableResult {
+    contract;
+    constructor(result, contract) {
+        super(result);
+        this.contract = contract;
+    }
+}
+export class Blueprint extends Base {
+    /**
+     * @description The on-chain code hash for this blueprint
+     */
+    codeHash;
+    #tx = {};
+    constructor(api, abi, codeHash, decorateMethod) {
+        super(api, abi, decorateMethod);
+        this.codeHash = this.registry.createType('Hash', codeHash);
+        this.abi.constructors.forEach((c) => {
+            if (isUndefined(this.#tx[c.method])) {
+                this.#tx[c.method] = createBluePrintTx(c, (o, p) => this.#deploy(c, o, p));
+            }
+        });
+    }
+    get tx() {
+        return this.#tx;
+    }
+    #deploy = (constructorOrId, { gasLimit = BN_ZERO, salt, storageDepositLimit = null, value = BN_ZERO }, params) => {
+        const palletTx = this._isRevive
+            ? this.api.tx.revive
+            : this.api.tx.contracts;
+        return palletTx.instantiate(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.codeHash, this.abi.findConstructor(constructorOrId).toU8a(params), encodeSalt(salt)).withResultTransform((result) => new BlueprintSubmittableResult(result, applyOnEvent(result, ['Instantiated'], ([record]) => new Contract(this.api, this.abi, record.event.data[1], this._decorateMethod), this._isRevive)));
+    };
+}
+export function extendBlueprint(type, decorateMethod) {
+    return class extends Blueprint {
+        static __BlueprintType = type;
+        constructor(api, abi, codeHash) {
+            super(api, abi, codeHash, decorateMethod);
+        }
+    };
+}

package/build/base/Code.js

@@ -0,0 +1,74 @@
+import { SubmittableResult } from '@pezkuwi/api';
+import { BN_ZERO, compactAddLength, isRiscV, isUndefined, isWasm, u8aToU8a } from '@pezkuwi/util';
+import { applyOnEvent } from '../util.js';
+import { Base } from './Base.js';
+import { Blueprint } from './Blueprint.js';
+import { Contract } from './Contract.js';
+import { convertWeight, createBluePrintTx, encodeSalt } from './util.js';
+export class CodeSubmittableResult extends SubmittableResult {
+    blueprint;
+    contract;
+    constructor(result, blueprint, contract) {
+        super(result);
+        this.blueprint = blueprint;
+        this.contract = contract;
+    }
+}
+function isValidCode(code) {
+    return isWasm(code) || isRiscV(code);
+}
+export class Code extends Base {
+    code;
+    #tx = {};
+    constructor(api, abi, wasm, decorateMethod) {
+        super(api, abi, decorateMethod);
+        this.code = isValidCode(this.abi.info.source.wasm)
+            ? this.abi.info.source.wasm
+            : u8aToU8a(wasm);
+        if (!isValidCode(this.code)) {
+            throw new Error('Invalid code provided');
+        }
+        this.abi.constructors.forEach((c) => {
+            if (isUndefined(this.#tx[c.method])) {
+                this.#tx[c.method] = createBluePrintTx(c, (o, p) => this.#instantiate(c, o, p));
+            }
+        });
+    }
+    get tx() {
+        return this.#tx;
+    }
+    #instantiate = (constructorOrId, { gasLimit = BN_ZERO, salt, storageDepositLimit = null, value = BN_ZERO }, params) => {
+        const palletTx = this._isRevive ? this.api.tx.revive : this.api.tx.contracts;
+        if (this._isRevive) {
+            return palletTx.instantiateWithCode(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, compactAddLength(this.code), this.abi.findConstructor(constructorOrId).toU8a(params), encodeSalt(salt)).withResultTransform((result) => new CodeSubmittableResult(result, ...(applyOnEvent(result, ['Instantiated'], (records) => records.reduce(([blueprint, contract], { event }) => this.api.events.revive['Instantiated'].is(event)
+                ? [
+                    blueprint,
+                    new Contract(this.api, this.abi, event.data[1], this._decorateMethod)
+                ]
+                : [blueprint, contract], [undefined, undefined]), this._isRevive) || [undefined, undefined])));
+        }
+        return palletTx.instantiateWithCode(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, compactAddLength(this.code), this.abi.findConstructor(constructorOrId).toU8a(params), encodeSalt(salt)).withResultTransform((result) => new CodeSubmittableResult(result, ...(applyOnEvent(result, ['CodeStored', 'Instantiated'], (records) => records.reduce(([blueprint, contract], { event }) => this.api.events.contracts.Instantiated.is(event)
+            ? [blueprint, new Contract(this.api, this.abi, event.data[1], this._decorateMethod)]
+            : this.api.events.contracts.CodeStored.is(event)
+                ? [new Blueprint(this.api, this.abi, event.data[0], this._decorateMethod), contract]
+                : [blueprint, contract], [undefined, undefined]), this._isRevive) || [undefined, undefined])));
+    };
+}
+export function extendCode(type, decorateMethod) {
+    return class extends Code {
+        static __CodeType = type;
+        constructor(api, abi, wasm) {
+            super(api, abi, wasm, decorateMethod);
+        }
+    };
+}

package/build/base/Contract.js

@@ -0,0 +1,127 @@
+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/base/index.js

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

package/build/base/mock.js

@@ -0,0 +1,38 @@
+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/base/util.js

@@ -0,0 +1,33 @@
+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/{bundle-pezkuwi-api-contract.js → build/bundle-pezkuwi-api-contract.js}

@@ -440,7 +440,7 @@
         };
     }
 
-    const packageInfo = { name: '@pezkuwi/api-contract', path: (({ url: (typeof document === 'undefined' && typeof location === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : typeof document === 'undefined' ? location.href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('bundle-pezkuwi-api-contract.js', document.baseURI).href)) }) && (typeof document === 'undefined' && typeof location === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : typeof document === 'undefined' ? location.href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('bundle-pezkuwi-api-contract.js', document.baseURI).href))) ? new URL((typeof document === 'undefined' && typeof location === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : typeof document === 'undefined' ? location.href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('bundle-pezkuwi-api-contract.js', document.baseURI).href))).pathname.substring(0, new URL((typeof document === 'undefined' && typeof location === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : typeof document === 'undefined' ? location.href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('bundle-pezkuwi-api-contract.js', document.baseURI).href))).pathname.lastIndexOf('/') + 1) : 'auto', type: 'esm', version: '16.5.17' };
+    const packageInfo = { name: '@pezkuwi/api-contract', path: (({ url: (typeof document === 'undefined' && typeof location === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : typeof document === 'undefined' ? location.href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('bundle-pezkuwi-api-contract.js', document.baseURI).href)) }) && (typeof document === 'undefined' && typeof location === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : typeof document === 'undefined' ? location.href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('bundle-pezkuwi-api-contract.js', document.baseURI).href))) ? new URL((typeof document === 'undefined' && typeof location === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : typeof document === 'undefined' ? location.href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('bundle-pezkuwi-api-contract.js', document.baseURI).href))).pathname.substring(0, new URL((typeof document === 'undefined' && typeof location === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : typeof document === 'undefined' ? location.href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('bundle-pezkuwi-api-contract.js', document.baseURI).href))).pathname.lastIndexOf('/') + 1) : 'auto', type: 'esm', version: '16.5.18' };
 
     function applyOnEvent(result, types, fn, isRevive) {
         if (result.isInBlock || result.isFinalized) {

package/build/bundle.js

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

package/build/cjs/Abi/index.d.ts

@@ -0,0 +1,31 @@
+import type { ChainProperties, ContractMetadataV4, ContractMetadataV5, ContractMetadataV6, ContractProjectInfo, EventRecord } from '@pezkuwi/types/interfaces';
+import type { Codec, Registry, TypeDef } from '@pezkuwi/types/types';
+import type { AbiConstructor, AbiEvent, AbiMessage, DecodedEvent, DecodedMessage } from '../types.js';
+export type ContractMetadataSupported = ContractMetadataV4 | ContractMetadataV5 | ContractMetadataV6;
+export declare class Abi {
+    #private;
+    readonly events: AbiEvent[];
+    readonly constructors: AbiConstructor[];
+    readonly info: ContractProjectInfo;
+    readonly json: Record<string, unknown>;
+    readonly messages: AbiMessage[];
+    readonly metadata: ContractMetadataSupported;
+    readonly registry: Registry;
+    readonly environment: Map<string, TypeDef | Codec>;
+    readonly isRevive: boolean;
+    constructor(abiJson: Record<string, unknown> | string, chainProperties?: ChainProperties);
+    /**
+     * Warning: Unstable API, bound to change
+     */
+    decodeEvent(record: EventRecord): DecodedEvent;
+    /**
+     * Warning: Unstable API, bound to change
+     */
+    decodeConstructor(data: Uint8Array): DecodedMessage;
+    /**
+     * Warning: Unstable API, bound to change
+     */
+    decodeMessage(data: Uint8Array): DecodedMessage;
+    findConstructor(constructorOrId: AbiConstructor | string | number): AbiConstructor;
+    findMessage(messageOrId: AbiMessage | string | number): AbiMessage;
+}