dedot 0.0.1-alpha.22

package/extrinsic/SubmittableResult.d.ts

@@ -0,0 +1,19 @@
+import { IEventRecord, ISubmittableResult } from '@dedot/types';
+import { DispatchError, DispatchInfo, Hash, TransactionStatus } from '@dedot/codecs';
+import { FrameSystemEventRecord } from '@dedot/chaintypes/substrate';
+export interface SubmittableResultInputs<E extends IEventRecord = FrameSystemEventRecord> {
+    events?: E[];
+    status: TransactionStatus;
+    txHash: Hash;
+    txIndex?: number;
+}
+export declare class SubmittableResult<E extends IEventRecord = FrameSystemEventRecord> implements ISubmittableResult<E> {
+    #private;
+    dispatchInfo?: DispatchInfo;
+    dispatchError?: DispatchError;
+    events: E[];
+    status: TransactionStatus;
+    txHash: Hash;
+    txIndex?: number;
+    constructor({ events, status, txHash, txIndex }: SubmittableResultInputs<E>);
+}

package/extrinsic/SubmittableResult.js

@@ -0,0 +1,29 @@
+export class SubmittableResult {
+    dispatchInfo;
+    dispatchError;
+    events;
+    status;
+    txHash;
+    txIndex;
+    constructor({ events, status, txHash, txIndex }) {
+        this.events = events || [];
+        this.status = status;
+        this.txHash = txHash;
+        this.txIndex = txIndex;
+        [this.dispatchInfo, this.dispatchError] = this.#extractInfo();
+    }
+    #extractInfo() {
+        for (const { event } of this.events) {
+            const { pallet, palletEvent } = event;
+            if (pallet === 'System' && palletEvent.name === 'ExtrinsicFailed') {
+                const { dispatchInfo, dispatchError } = palletEvent.data;
+                return [dispatchInfo, dispatchError];
+            }
+            else if (pallet === 'System' && palletEvent.name === 'ExtrinsicSuccess') {
+                const { dispatchInfo } = palletEvent.data;
+                return [dispatchInfo, undefined];
+            }
+        }
+        return [undefined, undefined];
+    }
+}

package/extrinsic/extensions/ExtraSignedExtension.d.ts

@@ -0,0 +1,14 @@
+import { SignedExtension } from './SignedExtension';
+import { HexString } from '@dedot/utils';
+import * as $ from '@dedot/shape';
+import { SignerPayloadJSON, SignerPayloadRaw } from '@polkadot/types/types';
+export declare class ExtraSignedExtension extends SignedExtension<any[], any[]> {
+    #private;
+    init(): Promise<void>;
+    get identifier(): string;
+    get dataCodec(): $.AnyShape;
+    get additionalSignedCodec(): $.AnyShape;
+    get payloadCodec(): $.AnyShape;
+    toPayload(call?: HexString): SignerPayloadJSON;
+    toRawPayload(call?: HexString): SignerPayloadRaw;
+}

package/extrinsic/extensions/ExtraSignedExtension.js

@@ -0,0 +1,61 @@
+import { SignedExtension } from './SignedExtension';
+import { assert, ensurePresence } from '@dedot/utils';
+import * as $ from '@dedot/shape';
+import { knownSignedExtensions } from './known';
+import { objectSpread, u8aToHex } from '@polkadot/util';
+export class ExtraSignedExtension extends SignedExtension {
+    #signedExtensions;
+    async init() {
+        this.#signedExtensions = this.#getSignedExtensions();
+        await Promise.all(this.#signedExtensions.map((se) => se.init()));
+        this.data = this.#signedExtensions.map((se) => se.data);
+        this.additionalSigned = this.#signedExtensions.map((se) => se.additionalSigned);
+    }
+    get identifier() {
+        return 'ExtraSignedExtension';
+    }
+    get dataCodec() {
+        const { extraTypeId } = this.api.metadataLatest.extrinsic;
+        return ensurePresence(this.registry.findPortableCodec(extraTypeId));
+    }
+    get additionalSignedCodec() {
+        const $AdditionalSignedCodecs = this.#signedExtensionDefs.map((se) => this.registry.findPortableCodec(se.additionalSigned));
+        return $.Tuple(...$AdditionalSignedCodecs);
+    }
+    get payloadCodec() {
+        const { callTypeId } = this.api.metadataLatest.extrinsic;
+        const $Call = this.registry.findPortableCodec(callTypeId);
+        return $.Tuple($Call, this.dataCodec, this.additionalSignedCodec);
+    }
+    get #signedExtensionDefs() {
+        return this.api.metadataLatest.extrinsic.signedExtensions;
+    }
+    #getSignedExtensions() {
+        return this.#signedExtensionDefs.map((extDef) => {
+            const { signedExtensions: userSignedExtensions = {} } = this.api.options;
+            const Extension = userSignedExtensions[extDef.ident] ||
+                knownSignedExtensions[extDef.ident];
+            assert(Extension, `SignedExtension for ${extDef.ident} not found`);
+            return new Extension(this.api, {
+                ...ensurePresence(this.options),
+                def: extDef,
+            });
+        });
+    }
+    toPayload(call = '0x') {
+        const signedExtensions = this.#signedExtensions.map((se) => se.identifier);
+        const { version } = this.api.registry.metadata.extrinsic;
+        return objectSpread({ address: this.options.signerAddress, signedExtensions, version, method: call }, ...this.#signedExtensions.map((se) => se.toPayload()));
+    }
+    toRawPayload(call = '0x') {
+        const payload = this.toPayload(call);
+        const $ToSignPayload = $.Tuple($.RawHex, this.dataCodec, this.additionalSignedCodec);
+        const toSignPayload = [call, this.data, this.additionalSigned];
+        const rawPayload = $ToSignPayload.tryEncode(toSignPayload);
+        return {
+            address: payload.address,
+            data: u8aToHex(rawPayload),
+            type: 'payload',
+        };
+    }
+}

package/extrinsic/extensions/SignedExtension.d.ts

@@ -0,0 +1,40 @@
+import { Dedot } from '../../client';
+import { CodecRegistry, SignedExtensionDefLatest } from '@dedot/codecs';
+import * as $ from '@dedot/shape';
+import { PayloadOptions } from '@dedot/types';
+import { SignerPayloadJSON } from '@polkadot/types/types';
+export interface ISignedExtension {
+    identifier: string;
+    dataCodec: $.AnyShape;
+    additionalSignedCodec: $.AnyShape;
+    data: any;
+    additionalSigned: any;
+    init(): Promise<void>;
+    registry: CodecRegistry;
+    toPayload(...additional: any[]): Partial<SignerPayloadJSON>;
+}
+interface SignedExtensionOptions {
+    def?: SignedExtensionDefLatest;
+    signerAddress?: string;
+    payloadOptions?: Partial<PayloadOptions>;
+}
+export declare abstract class SignedExtension<Data extends any = {}, AdditionalSigned extends any = []> implements ISignedExtension {
+    api: Dedot;
+    options?: SignedExtensionOptions | undefined;
+    data: Data;
+    additionalSigned: AdditionalSigned;
+    constructor(api: Dedot, options?: SignedExtensionOptions | undefined);
+    init(): Promise<void>;
+    get identifier(): string;
+    get dataCodec(): $.AnyShape;
+    get additionalSignedCodec(): $.AnyShape;
+    get registry(): CodecRegistry;
+    get signedExtensionDef(): {
+        ident: string;
+        typeId: number;
+        additionalSigned: number;
+    };
+    get payloadOptions(): Partial<PayloadOptions>;
+    toPayload(...args: any[]): Partial<SignerPayloadJSON>;
+}
+export {};

package/extrinsic/extensions/SignedExtension.js

@@ -0,0 +1,37 @@
+import { ensurePresence } from '@dedot/utils';
+export class SignedExtension {
+    api;
+    options;
+    data;
+    additionalSigned;
+    constructor(api, options) {
+        this.api = api;
+        this.options = options;
+        this.data = {};
+        this.additionalSigned = [];
+    }
+    async init() {
+        // TODO implement this method
+    }
+    get identifier() {
+        return this.signedExtensionDef.ident;
+    }
+    get dataCodec() {
+        return ensurePresence(this.api.registry.findPortableCodec(this.signedExtensionDef.typeId));
+    }
+    get additionalSignedCodec() {
+        return ensurePresence(this.api.registry.findPortableCodec(this.signedExtensionDef.additionalSigned));
+    }
+    get registry() {
+        return this.api.registry;
+    }
+    get signedExtensionDef() {
+        return ensurePresence(this.options.def);
+    }
+    get payloadOptions() {
+        return this.options?.payloadOptions || {};
+    }
+    toPayload(...args) {
+        return {};
+    }
+}

package/extrinsic/extensions/index.d.ts

@@ -0,0 +1,3 @@
+export * from './SignedExtension';
+export * from './known';
+export * from './ExtraSignedExtension';

package/extrinsic/extensions/index.js

@@ -0,0 +1,3 @@
+export * from './SignedExtension';
+export * from './known';
+export * from './ExtraSignedExtension';

package/extrinsic/extensions/known/ChargeAssetTxPayment.d.ts

@@ -0,0 +1,14 @@
+import { SignedExtension } from '../SignedExtension';
+import { SignerPayloadJSON } from '@polkadot/types/types';
+/**
+ * @name ChargeAssetTxPayment
+ */
+export declare class ChargeAssetTxPayment extends SignedExtension<{
+    tip: bigint;
+    assetId?: number | object;
+}> {
+    #private;
+    init(): Promise<void>;
+    toPayload(): Partial<SignerPayloadJSON>;
+    $AssetId(): any;
+}

package/extrinsic/extensions/known/ChargeAssetTxPayment.js

@@ -0,0 +1,40 @@
+import { SignedExtension } from '../SignedExtension';
+import { bnToHex, u8aToHex } from '@polkadot/util';
+import { assert } from '@dedot/utils';
+/**
+ * @name ChargeAssetTxPayment
+ */
+export class ChargeAssetTxPayment extends SignedExtension {
+    async init() {
+        const { tip, assetId } = this.payloadOptions;
+        this.data = {
+            tip: tip || 0n,
+            assetId,
+        };
+    }
+    toPayload() {
+        const { tip, assetId } = this.data;
+        return {
+            tip: bnToHex(tip, { isLe: false }),
+            // @ts-ignore
+            assetId: this.#encodeAssetId(assetId),
+        };
+    }
+    #encodeAssetId(assetId) {
+        if (assetId === null || assetId === undefined) {
+            return undefined;
+        }
+        return u8aToHex(this.$AssetId().tryEncode(assetId));
+    }
+    $AssetId() {
+        const extensionTypeDef = this.registry.findPortableType(this.signedExtensionDef.typeId);
+        assert(extensionTypeDef.type.tag === 'Struct');
+        const assetIdTypeDef = extensionTypeDef.type.value.fields.find((f) => f.name === 'asset_id');
+        const $codec = this.registry.findPortableCodec(assetIdTypeDef.typeId);
+        const codecMetadata = $codec.metadata[0];
+        if (codecMetadata.name === '$.option') {
+            return codecMetadata.args[0]; // inner shape
+        }
+        return $codec;
+    }
+}

package/extrinsic/extensions/known/ChargeTransactionPayment.d.ts

@@ -0,0 +1,6 @@
+import { SignedExtension } from '../SignedExtension';
+import { SignerPayloadJSON } from '@polkadot/types/types';
+export declare class ChargeTransactionPayment extends SignedExtension<bigint> {
+    init(): Promise<void>;
+    toPayload(): Partial<SignerPayloadJSON>;
+}

package/extrinsic/extensions/known/ChargeTransactionPayment.js

@@ -0,0 +1,12 @@
+import { SignedExtension } from '../SignedExtension';
+import { bnToHex } from '@polkadot/util';
+export class ChargeTransactionPayment extends SignedExtension {
+    async init() {
+        this.data = this.payloadOptions.tip || 0n;
+    }
+    toPayload() {
+        return {
+            tip: bnToHex(this.data, { isLe: false }),
+        };
+    }
+}

package/extrinsic/extensions/known/CheckGenesis.d.ts

@@ -0,0 +1,10 @@
+import { SignedExtension } from '../SignedExtension';
+import { Hash } from '@dedot/codecs';
+import { SignerPayloadJSON } from '@polkadot/types/types';
+/**
+ * @description Genesis hash check to provide replay protection between different networks.
+ */
+export declare class CheckGenesis extends SignedExtension<{}, Hash> {
+    init(): Promise<void>;
+    toPayload(): Partial<SignerPayloadJSON>;
+}

package/extrinsic/extensions/known/CheckGenesis.js

@@ -0,0 +1,15 @@
+import { SignedExtension } from '../SignedExtension';
+import { ensurePresence } from '@dedot/utils';
+/**
+ * @description Genesis hash check to provide replay protection between different networks.
+ */
+export class CheckGenesis extends SignedExtension {
+    async init() {
+        this.additionalSigned = ensurePresence(this.api.genesisHash);
+    }
+    toPayload() {
+        return {
+            genesisHash: this.additionalSigned,
+        };
+    }
+}

package/extrinsic/extensions/known/CheckMortality.d.ts

@@ -0,0 +1,15 @@
+import { SignedExtension } from '../SignedExtension';
+import { EraLike, Hash } from '@dedot/codecs';
+import { SignerPayloadJSON } from '@polkadot/types/types';
+export declare const MAX_FINALITY_LAG: number;
+export declare const FALLBACK_MAX_HASH_COUNT: number;
+export declare const FALLBACK_PERIOD: number;
+export declare const MORTAL_PERIOD: number;
+/**
+ * @description Check for transaction mortality.
+ */
+export declare class CheckMortality extends SignedExtension<EraLike, Hash> {
+    #private;
+    init(): Promise<void>;
+    toPayload(): Partial<SignerPayloadJSON>;
+}

package/extrinsic/extensions/known/CheckMortality.js

@@ -0,0 +1,67 @@
+import { SignedExtension } from '../SignedExtension';
+import { assert, isZeroHash, min } from '@dedot/utils';
+import { numberToHex, u8aToHex } from '@polkadot/util';
+export const MAX_FINALITY_LAG = 5;
+export const FALLBACK_MAX_HASH_COUNT = 250;
+export const FALLBACK_PERIOD = 6 * 1000;
+export const MORTAL_PERIOD = 5 * 60 * 1000;
+/**
+ * @description Check for transaction mortality.
+ */
+export class CheckMortality extends SignedExtension {
+    #signingHeader;
+    async init() {
+        this.#signingHeader = await this.#determineSigningHeader();
+        this.data = { period: this.#calculateMortalLength(), current: BigInt(this.#signingHeader.number) };
+        this.additionalSigned = (await this.api.rpc.chain.getBlockHash(this.#signingHeader.number));
+    }
+    // Ref: https://github.com/polkadot-js/api/blob/3bdf49b0428a62f16b3222b9a31bfefa43c1ca55/packages/api-derive/src/tx/signingInfo.ts#L34-L64
+    async #determineSigningHeader() {
+        const [header, finalizedHash] = await Promise.all([
+            this.api.rpc.chain.getHeader(),
+            this.api.rpc.chain.getFinalizedHead(),
+        ]);
+        assert(header, 'Current header not found');
+        const [currentHeader, finalizedHeader] = await Promise.all([
+            Promise.resolve(header).then((header) => {
+                const { parentHash } = header;
+                if (parentHash.length === 0 || isZeroHash(parentHash)) {
+                    return header;
+                }
+                else {
+                    return this.api.rpc.chain.getHeader(parentHash);
+                }
+            }),
+            this.api.rpc.chain.getHeader(finalizedHash),
+        ]);
+        assert(currentHeader, 'Cannot determine current header');
+        if (!finalizedHeader || currentHeader.number - finalizedHeader.number > MAX_FINALITY_LAG) {
+            return currentHeader;
+        }
+        return finalizedHeader;
+    }
+    // Ref: https://github.com/polkadot-js/api/blob/3bdf49b0428a62f16b3222b9a31bfefa43c1ca55/packages/api-derive/src/tx/signingInfo.ts#L83-L93
+    #calculateMortalLength() {
+        return min(BigInt(this.#getConst('system', 'blockHashCount') || FALLBACK_MAX_HASH_COUNT), BigInt(MORTAL_PERIOD) /
+            BigInt(this.#getConst('babe', 'expectedBlockTime') ||
+                BigInt(this.#getConst('timestamp', 'minimumPeriod') || 0) * 2n ||
+                FALLBACK_PERIOD) +
+            BigInt(MAX_FINALITY_LAG));
+    }
+    #getConst(pallet, name) {
+        try {
+            return this.api.consts[pallet][name];
+        }
+        catch {
+            // ignore this on purpose
+        }
+        return undefined;
+    }
+    toPayload() {
+        return {
+            era: u8aToHex(this.dataCodec.tryEncode(this.data)),
+            blockHash: this.additionalSigned,
+            blockNumber: numberToHex(this.#signingHeader.number),
+        };
+    }
+}

package/extrinsic/extensions/known/CheckNonZeroSender.d.ts

@@ -0,0 +1,6 @@
+import { SignedExtension } from '../SignedExtension';
+/**
+ * @description Check to ensure that the sender is not the zero address
+ */
+export declare class CheckNonZeroSender extends SignedExtension {
+}

package/extrinsic/extensions/known/CheckNonZeroSender.js

@@ -0,0 +1,6 @@
+import { SignedExtension } from '../SignedExtension';
+/**
+ * @description Check to ensure that the sender is not the zero address
+ */
+export class CheckNonZeroSender extends SignedExtension {
+}

package/extrinsic/extensions/known/CheckNonce.d.ts

@@ -0,0 +1,10 @@
+import { SignedExtension } from '../SignedExtension';
+import { SignerPayloadJSON } from '@polkadot/types/types';
+/**
+ * @description Nonce check and increment to give replay protection for transactions.
+ */
+export declare class CheckNonce extends SignedExtension<number> {
+    #private;
+    init(): Promise<void>;
+    toPayload(): Partial<SignerPayloadJSON>;
+}

package/extrinsic/extensions/known/CheckNonce.js

@@ -0,0 +1,30 @@
+import { SignedExtension } from '../SignedExtension';
+import { numberToHex } from '@polkadot/util';
+import { assert } from '@dedot/utils';
+/**
+ * @description Nonce check and increment to give replay protection for transactions.
+ */
+export class CheckNonce extends SignedExtension {
+    async init() {
+        this.data = this.payloadOptions.nonce || (await this.#getNonce());
+    }
+    async #getNonce() {
+        const { signerAddress } = this.options || {};
+        assert(signerAddress, 'Signer address not found');
+        try {
+            return (await this.api.query.system.account(signerAddress)).nonce;
+        }
+        catch { }
+        try {
+            return await this.api.call.accountNonceApi.accountNonce(signerAddress);
+        }
+        catch { }
+        // TODO fallback to api.rpc.system.accountNextIndex if needed
+        return 0;
+    }
+    toPayload() {
+        return {
+            nonce: numberToHex(this.data),
+        };
+    }
+}

package/extrinsic/extensions/known/CheckSpecVersion.d.ts

@@ -0,0 +1,9 @@
+import { SignedExtension } from '../SignedExtension';
+import { SignerPayloadJSON } from '@polkadot/types/types';
+/**
+ * @description Ensure the runtime version registered in the transaction is the same as at present.
+ */
+export declare class CheckSpecVersion extends SignedExtension<{}, number> {
+    init(): Promise<void>;
+    toPayload(): Partial<SignerPayloadJSON>;
+}

package/extrinsic/extensions/known/CheckSpecVersion.js

@@ -0,0 +1,15 @@
+import { SignedExtension } from '../SignedExtension';
+import { numberToHex } from '@polkadot/util';
+/**
+ * @description Ensure the runtime version registered in the transaction is the same as at present.
+ */
+export class CheckSpecVersion extends SignedExtension {
+    async init() {
+        this.additionalSigned = this.api.runtimeVersion.specVersion;
+    }
+    toPayload() {
+        return {
+            specVersion: numberToHex(this.additionalSigned),
+        };
+    }
+}

package/extrinsic/extensions/known/CheckTxVersion.d.ts

@@ -0,0 +1,9 @@
+import { SignedExtension } from '../SignedExtension';
+import { SignerPayloadJSON } from '@polkadot/types/types';
+/**
+ * @description Ensure the transaction version registered in the transaction is the same as at present.
+ */
+export declare class CheckTxVersion extends SignedExtension<{}, number> {
+    init(): Promise<void>;
+    toPayload(): Partial<SignerPayloadJSON>;
+}

package/extrinsic/extensions/known/CheckTxVersion.js

@@ -0,0 +1,15 @@
+import { SignedExtension } from '../SignedExtension';
+import { numberToHex } from '@polkadot/util';
+/**
+ * @description Ensure the transaction version registered in the transaction is the same as at present.
+ */
+export class CheckTxVersion extends SignedExtension {
+    async init() {
+        this.additionalSigned = this.api.runtimeVersion.transactionVersion;
+    }
+    toPayload() {
+        return {
+            transactionVersion: numberToHex(this.additionalSigned),
+        };
+    }
+}

package/extrinsic/extensions/known/CheckWeight.d.ts

@@ -0,0 +1,6 @@
+import { SignedExtension } from '../SignedExtension';
+/**
+ * @description Block resource (weight) limit check.
+ */
+export declare class CheckWeight extends SignedExtension {
+}

package/extrinsic/extensions/known/CheckWeight.js

@@ -0,0 +1,6 @@
+import { SignedExtension } from '../SignedExtension';
+/**
+ * @description Block resource (weight) limit check.
+ */
+export class CheckWeight extends SignedExtension {
+}

package/extrinsic/extensions/known/PrevalidateAttests.d.ts

@@ -0,0 +1,7 @@
+import { SignedExtension } from '../SignedExtension';
+/**
+ * @description Validate `attest` calls prior to execution.
+ * Needed to avoid a DoS attack since they are otherwise free to place on chain.
+ */
+export declare class PrevalidateAttests extends SignedExtension {
+}

package/extrinsic/extensions/known/PrevalidateAttests.js

@@ -0,0 +1,7 @@
+import { SignedExtension } from '../SignedExtension';
+/**
+ * @description Validate `attest` calls prior to execution.
+ * Needed to avoid a DoS attack since they are otherwise free to place on chain.
+ */
+export class PrevalidateAttests extends SignedExtension {
+}

package/extrinsic/extensions/known/index.d.ts

@@ -0,0 +1,3 @@
+import { ISignedExtension } from '../SignedExtension';
+export type AnySignedExtension = new (...args: any[]) => ISignedExtension;
+export declare const knownSignedExtensions: Record<string, AnySignedExtension>;

package/extrinsic/extensions/known/index.js

@@ -0,0 +1,22 @@
+import { CheckNonZeroSender } from './CheckNonZeroSender';
+import { CheckSpecVersion } from './CheckSpecVersion';
+import { CheckTxVersion } from './CheckTxVersion';
+import { CheckGenesis } from './CheckGenesis';
+import { CheckMortality } from './CheckMortality';
+import { CheckNonce } from './CheckNonce';
+import { CheckWeight } from './CheckWeight';
+import { ChargeTransactionPayment } from './ChargeTransactionPayment';
+import { PrevalidateAttests } from './PrevalidateAttests';
+import { ChargeAssetTxPayment } from './ChargeAssetTxPayment';
+export const knownSignedExtensions = {
+    CheckNonZeroSender,
+    CheckSpecVersion,
+    CheckTxVersion,
+    CheckGenesis,
+    CheckMortality,
+    CheckNonce,
+    CheckWeight,
+    ChargeTransactionPayment,
+    PrevalidateAttests,
+    ChargeAssetTxPayment,
+};

package/extrinsic/index.d.ts

@@ -0,0 +1,2 @@
+export * from './extensions';
+export * from './SubmittableResult';

package/extrinsic/index.js

@@ -0,0 +1,2 @@
+export * from './extensions';
+export * from './SubmittableResult';

package/index.d.ts

@@ -0,0 +1,6 @@
+import { Dedot } from './client';
+export type * from './types';
+export * from './executor';
+export * from './extrinsic';
+export { Dedot };
+export { HttpProvider, ScProvider, WsProvider } from '@polkadot/rpc-provider';

package/index.js

@@ -0,0 +1,5 @@
+import { Dedot } from './client';
+export * from './executor';
+export * from './extrinsic';
+export { Dedot };
+export { HttpProvider, ScProvider, WsProvider } from '@polkadot/rpc-provider';