moonwall 1.0.0-dev.0

package/dist/api/types/context.d.ts

@@ -0,0 +1,125 @@
+import "@polkadot/api-base/types/events";
+import type { ApiPromise, WsProvider } from "@polkadot/api";
+import type { ApiTypes, AugmentedEvent, SubmittableExtrinsic } from "@polkadot/api-base/types";
+import type { KeyringPair } from "@polkadot/keyring/types";
+import type { GenericExtrinsic } from "@polkadot/types";
+import type { EventRecord } from "@polkadot/types/interfaces";
+import type { AnyTuple, RegistryError } from "@polkadot/types/types";
+import type { Logger, LogFn } from "pino";
+import type { Wallet } from "ethers";
+import type { Web3 } from "web3";
+import type { FoundationType, ProviderType } from "./config.js";
+import type { CallType } from "./foundations.js";
+import type { ViemClient } from "./runner.js";
+import type { PolkadotClient } from "polkadot-api";
+/**
+ * @name MoonwallEnvironment
+ * @description The Moonwall environment object.
+ * @property name - The name of the environment.
+ * @property providers - An array of MoonwallProvider objects.
+ * @property foundationType - The type of foundation in use.
+ * @property nodes - An array of Node objects.
+ */
+export type MoonwallEnvironment = {
+    name: string;
+    providers: MoonwallProvider[];
+    foundationType: FoundationType;
+    nodes: Node[];
+};
+/**
+ * @name MoonwallProvider
+ * @description The Moonwall provider object.
+ * @property name - The name of the provider.
+ * @property type - The type of the provider.
+ * @property connect - A function that returns a Promise resolving to a connected API instance.
+ * @property ws - An optional function returning a WebSocket provider.
+ */
+export interface MoonwallProvider {
+    name: string;
+    type: ProviderType;
+    connect: () => Promise<ApiPromise> | Wallet | Web3<any> | Promise<ViemClient> | PolkadotClient | null;
+    ws?: (timeout?: number) => WsProvider;
+}
+/**
+ * @name ConnectedProvider
+ * @description The connected provider object.
+ * @property name - The name of the provider.
+ * @property type - The type of the provider.
+ * @property api - The connected API instance.
+ * @property disconnect - A function that returns a Promise resolving when the provider is disconnected.
+ * @property greet - A function that returns a greeting message or an object containing runtime information.
+ */
+export interface ConnectedProvider {
+    name: string;
+    type: ProviderType;
+    api: ProviderApi;
+    disconnect: () => Promise<void> | void;
+    greet: () => Promise<void> | Promise<{
+        rtName: string;
+        rtVersion: number;
+    }>;
+}
+export type ProviderApi = {
+    [P in keyof ProviderMap]: ProviderMap[P];
+}[keyof ProviderMap];
+export type ProviderMap = {
+    polkadotJs: ApiPromise;
+    ethers: Wallet;
+    web3: Web3;
+    moon: ApiPromise;
+    viem: ViemClient;
+    papi: PolkadotClient;
+};
+/**
+ * @name Node
+ * @description The Node object.
+ * @property name - The optional name of the node.
+ * @property cmd - The command to start the node.
+ * @property args - The arguments for the command.
+ * @property rtUpgradePath - The optional runtime upgrade path.
+ * @property launch - UNUSED
+ */
+export type Node = {
+    name?: string;
+    cmd: string;
+    args: string[];
+    rtUpgradePath?: string;
+    launch?: boolean;
+};
+export interface ChopsticksBlockCreation {
+    providerName?: string;
+    count?: number;
+    to?: number;
+    expectEvents?: AugmentedEvent<ApiTypes>[];
+    allowFailures?: boolean;
+    logger?: Logger | LogFn;
+    /** Optional timeout in milliseconds for the new block RPC request */
+    timeout?: number;
+}
+export interface BlockCreation {
+    parentHash?: string;
+    finalize?: boolean;
+    allowFailures?: boolean;
+    expectEvents?: AugmentedEvent<ApiTypes>[];
+    logger?: Logger | LogFn;
+    signer?: {
+        type: "ethereum" | "sr25519" | "ed25519";
+        privateKey: string;
+    } | KeyringPair;
+}
+export interface BlockCreationResponse<ApiType extends ApiTypes, Calls extends CallType<ApiType> | CallType<ApiType>[]> {
+    block: {
+        duration: number;
+        hash: string;
+        proofSize?: number;
+    };
+    result?: Calls extends (string | SubmittableExtrinsic<ApiType>)[] ? ExtrinsicCreation[] : ExtrinsicCreation;
+}
+export interface ExtrinsicCreation {
+    extrinsic: GenericExtrinsic<AnyTuple> | null;
+    events: EventRecord[];
+    error: RegistryError | undefined;
+    successful: boolean;
+    hash: string;
+}
+//# sourceMappingURL=context.d.ts.map

package/dist/api/types/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../../src/api/types/context.ts"],"names":[],"mappings":"AAAA,OAAO,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAC/F,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAC1C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AACjC,OAAO,KAAK,EAAE,cAAc,EAAE,YAAY,EAAE,oBAAoB;AAChE,OAAO,KAAK,EAAE,QAAQ,EAAE,yBAAyB;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,oBAAoB;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAEnD;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,gBAAgB,EAAE,CAAC;IAC9B,cAAc,EAAE,cAAc,CAAC;IAC/B,KAAK,EAAE,IAAI,EAAE,CAAC;CACf,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,MACL,OAAO,CAAC,UAAU,CAAC,GACnB,MAAM,GACN,IAAI,CAAC,GAAG,CAAC,GACT,OAAO,CAAC,UAAU,CAAC,GACnB,cAAc,GACd,IAAI,CAAC;IACT,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,UAAU,CAAC;CACvC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,YAAY,CAAC;IACnB,GAAG,EAAE,WAAW,CAAC;IACjB,UAAU,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IACvC,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC7E;AAED,MAAM,MAAM,WAAW,GAAG;KACvB,CAAC,IAAI,MAAM,WAAW,GAAG,WAAW,CAAC,CAAC,CAAC;CACzC,CAAC,MAAM,WAAW,CAAC,CAAC;AAErB,MAAM,MAAM,WAAW,GAAG;IACxB,UAAU,EAAE,UAAU,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,cAAc,CAAC;CACtB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,MAAM,WAAW,uBAAuB;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,YAAY,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC1C,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IACxB,qEAAqE;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,YAAY,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC1C,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IACxB,MAAM,CAAC,EAAE;QAAE,IAAI,EAAE,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,WAAW,CAAC;CACzF;AAED,MAAM,WAAW,qBAAqB,CACpC,OAAO,SAAS,QAAQ,EACxB,KAAK,SAAS,QAAQ,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,EAAE;IAErD,KAAK,EAAE;QACL,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,MAAM,CAAC,EAAE,KAAK,SAAS,CAAC,MAAM,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC,EAAE,GAC7D,iBAAiB,EAAE,GACnB,iBAAiB,CAAC;CACvB;AAED,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,gBAAgB,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAC7C,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB,KAAK,EAAE,aAAa,GAAG,SAAS,CAAC;IACjC,UAAU,EAAE,OAAO,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;CACd"}

package/dist/api/types/context.js

@@ -0,0 +1 @@
+import "@polkadot/api-base/types/events";

package/dist/api/types/contracts.d.ts

@@ -0,0 +1,66 @@
+import type { Abi, DeployContractParameters } from "viem";
+import type { DeepPartial } from "./helpers.js";
+import type { TransactionType } from "./eth.js";
+/**
+ * Type representing a Moonwall Contract.
+ *
+ * @typedef {Object} MoonwallContract
+ * @property {TAbi} abi - The contract's ABI (Application Binary Interface).
+ * @property {`0x${string}`} bytecode - The bytecode of the contract.
+ * @property {Record<string, string>[]} methods - An array of contract's methods.
+ * @property {`0x${string}`} deployedBytecode - The bytecode of the deployed contract.
+ */
+export type MoonwallContract<TAbi extends Abi> = {
+    abi: TAbi;
+    bytecode: `0x${string}`;
+    methods: Record<string, string>[];
+    deployedBytecode: `0x${string}`;
+};
+/**
+ * Type representing a compiled contract.
+ *
+ * @typedef {Object} CompiledContract
+ * @property {`0x${string}`} byteCode - The bytecode of the contract.
+ * @property {ContractObject<TAbi>} contract - The compiled contract object.
+ * @property {string} sourceCode - The source code of the contract.
+ */
+export type CompiledContract<TAbi extends Abi> = {
+    byteCode: `0x${string}`;
+    contract: ContractObject<TAbi>;
+    sourceCode: string;
+};
+/**
+ * Type representing a contract object.
+ *
+ * @typedef {Object} ContractObject
+ * @property {TAbi} abi - The contract's ABI (Application Binary Interface).
+ * @property {any} devdoc - Developer documentation for the contract.
+ * @property {any} evm - Information about the EVM (Ethereum Virtual Machine) aspect of the contract.
+ * @property {any} ewasm - Information about the EWASM (Ethereum Web Assembly) aspect of the contract.
+ * @property {any} metadata - The contract's metadata.
+ * @property {any} storageLayout - The layout of the contract's storage.
+ * @property {any} userdoc - User documentation for the contract.
+ */
+export type ContractObject<TAbi extends Abi> = {
+    abi: TAbi;
+    devdoc: any;
+    evm: any;
+    ewasm: any;
+    metadata: any;
+    storageLayout: any;
+    userdoc: any;
+};
+/**
+ * Type representing options for a contract deployment.
+ *
+ * @typedef {Object} ContractDeploymentOptions
+ * @property {`0x${string}`} privateKey - (optional) The private key to use for the deployment.
+ * @property {any[]} args - (optional) Any arguments to pass to the contract's constructor.
+ * @property {TransactionType} txnType - (optional) The type of the transaction.
+ */
+export type ContractDeploymentOptions = DeepPartial<Omit<DeployContractParameters, "abi" | "bytecode" | "privateKey">> & {
+    privateKey?: `0x${string}`;
+    args?: any[];
+    txnType?: TransactionType;
+};
+//# sourceMappingURL=contracts.d.ts.map

package/dist/api/types/contracts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contracts.d.ts","sourceRoot":"","sources":["../../../src/api/types/contracts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB,EAAE,MAAM,MAAM,CAAC;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,qBAAqB;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,iBAAiB;AAEhD;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,CAAC,IAAI,SAAS,GAAG,IAAI;IAC/C,GAAG,EAAE,IAAI,CAAC;IACV,QAAQ,EAAE,KAAK,MAAM,EAAE,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;IAClC,gBAAgB,EAAE,KAAK,MAAM,EAAE,CAAC;CACjC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,CAAC,IAAI,SAAS,GAAG,IAAI;IAC/C,QAAQ,EAAE,KAAK,MAAM,EAAE,CAAC;IACxB,QAAQ,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;IAC/B,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,cAAc,CAAC,IAAI,SAAS,GAAG,IAAI;IAC7C,GAAG,EAAE,IAAI,CAAC;IACV,MAAM,EAAE,GAAG,CAAC;IACZ,GAAG,EAAE,GAAG,CAAC;IACT,KAAK,EAAE,GAAG,CAAC;IACX,QAAQ,EAAE,GAAG,CAAC;IACd,aAAa,EAAE,GAAG,CAAC;IACnB,OAAO,EAAE,GAAG,CAAC;CACd,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,yBAAyB,GAAG,WAAW,CACjD,IAAI,CAAC,wBAAwB,EAAE,KAAK,GAAG,UAAU,GAAG,YAAY,CAAC,CAClE,GAAG;IACF,UAAU,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACb,OAAO,CAAC,EAAE,eAAe,CAAC;CAC3B,CAAC"}

package/dist/api/types/contracts.js

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

package/dist/api/types/eth.d.ts

@@ -0,0 +1,3 @@
+export declare const TransactionTypes: readonly ["eip1559", "eip2930", "legacy"];
+export type TransactionType = (typeof TransactionTypes)[number];
+//# sourceMappingURL=eth.d.ts.map

package/dist/api/types/eth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eth.d.ts","sourceRoot":"","sources":["../../../src/api/types/eth.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,gBAAgB,2CAA4C,CAAC;AAC1E,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC"}

package/dist/api/types/eth.js

@@ -0,0 +1 @@
+export const TransactionTypes = ["eip1559", "eip2930", "legacy"];

package/dist/api/types/foundations.d.ts

@@ -0,0 +1,11 @@
+import type { ApiTypes, SubmittableExtrinsic } from "@polkadot/api/types";
+import type { ExtrinsicCreation } from "./context.js";
+export type CreatedBlockResult = {
+    block: {
+        duration: number;
+        hash: string;
+    };
+    result: ExtrinsicCreation | ExtrinsicCreation[] | null;
+};
+export type CallType<TApi extends ApiTypes> = SubmittableExtrinsic<TApi> | Promise<SubmittableExtrinsic<TApi>> | `0x${string}` | Promise<string>;
+//# sourceMappingURL=foundations.d.ts.map

package/dist/api/types/foundations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"foundations.d.ts","sourceRoot":"","sources":["../../../src/api/types/foundations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAqB;AAEtD,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE;QACL,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,MAAM,EAAE,iBAAiB,GAAG,iBAAiB,EAAE,GAAG,IAAI,CAAC;CACxD,CAAC;AAEF,MAAM,MAAM,QAAQ,CAAC,IAAI,SAAS,QAAQ,IACtC,oBAAoB,CAAC,IAAI,CAAC,GAC1B,OAAO,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,GACnC,KAAK,MAAM,EAAE,GACb,OAAO,CAAC,MAAM,CAAC,CAAC"}

package/dist/api/types/foundations.js

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

package/dist/api/types/helpers.d.ts

@@ -0,0 +1,7 @@
+export type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends (infer U)[] ? DeepPartial<U>[] : T[P] extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : DeepPartial<T[P]>;
+};
+export type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+//# sourceMappingURL=helpers.d.ts.map

package/dist/api/types/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/api/types/helpers.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;KAC1B,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GACrC,WAAW,CAAC,CAAC,CAAC,EAAE,GAChB,CAAC,CAAC,CAAC,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,CAAC,GACjC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAC7B,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI;KACvB,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACrB,GAAG,EAAE,CAAC"}

package/dist/api/types/helpers.js

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

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

@@ -0,0 +1,8 @@
+export * from "./config.js";
+export * from "./context.js";
+export * from "./contracts.js";
+export * from "./runner.js";
+export * from "./foundations.js";
+export * from "./eth.js";
+export * from "./helpers.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/types/index.ts"],"names":[],"mappings":"AAAA,4BAA4B;AAC5B,6BAA6B;AAC7B,+BAA+B;AAC/B,4BAA4B;AAC5B,iCAAiC;AACjC,yBAAyB;AACzB,6BAA6B"}

package/dist/api/types/index.js

@@ -0,0 +1,7 @@
+export * from "./config.js";
+export * from "./context.js";
+export * from "./contracts.js";
+export * from "./runner.js";
+export * from "./foundations.js";
+export * from "./eth.js";
+export * from "./helpers.js";