Feat/papi support (#440)

* zombienet doesnt require connected parachains

* prescript errors halt runs

* feat: ✨ basic papi support

* fix

* lint

* lint

* ci-fix

* papi dev

* docs: 📝 Add PAPI docs

* cs fix

* chopsticks fix

Author: timbrinded

.changeset/olive-lions-enjoy.md

@@ -0,0 +1,11 @@
+---
+"@moonwall/cli": minor
+"@moonwall/tests": minor
+"@moonwall/types": minor
+"@moonwall/util": minor
+---
+
+November Update
+- [[#435](https://github.com/Moonsong-Labs/moonwall/issues/435)] Zombienets dont require parachains anymore
+- [[#408](https://github.com/Moonsong-Labs/moonwall/issues/408)] preScript failures halt test runs
+- [[#405](https://github.com/Moonsong-Labs/moonwall/issues/405)] Add PAPI Support

.github/workflows/main.yml

@@ -114,7 +114,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        suite: ["dev_test", "dev_multi", "dev_seq", "dev_smoke"]
+        suite: ["dev_test", "dev_multi", "dev_seq", "dev_smoke", "papi_dev"]
         shard: [1, 2, 3, 4]
     steps:
       - uses: actions/checkout@v4
@@ -142,6 +142,7 @@ jobs:
       - name: Run ${{matrix.suite}} dev test
         run: |
           cd test
+          bun papi generate
           bun moonwall test ${{matrix.suite}}  --ts ${{ matrix.shard }}/4
 
   test_chopsticks:
@@ -188,7 +189,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        suite: ["eth_test", "viem_test"]
+        suite: ["eth_test", "viem_test", "papi_readonly"]
     steps:
       - uses: actions/checkout@v4
       - uses: pnpm/action-setup@v4
@@ -208,6 +209,7 @@ jobs:
       - name: Run standard ${{matrix.suite}}
         run: |
           cd test
+          bun papi add dot -n polkadot
           bun moonwall test ${{matrix.suite}}
       #  disabled until web3.js fix their stuff
       # - name: Run standard web3 run

.gitignore

@@ -23,4 +23,3 @@ artifacts
 
 .idea
 db.sqlite*
-polkadot*

docs/guide/intro/providers.md

@@ -17,6 +17,9 @@ At time of writing, Moonwall supports the following providers:
 
 PolkadotJs is a suite of tools, including a JavaScript library, for interacting with the Polkadot network and other Substrate-based blockchains. To learn more about PolkadotJs, you can check out the [PolkadotJs docs](https://polkadot.js.org/docs/api/){target=_blank}
 
+### Polkadot-API (PAPI)
+
+[Polkadot-API](https://github.com/polkadot-api/polkadot-api){target=_blank} is a modern, lightweight, and fast alternative to the PolkadotJs library for interacting with Substrate-based blockchains. It is designed to be more performant and have a smaller bundle size compared to PolkadotJs, while maintaining compatibility with the Polkadot ecosystem. For more information about Polkadot-API, check out the [Polkadot-API docs](https://papi.how/){target=_blank}.
 
 ### Ethers
 

package.json

@@ -12,7 +12,7 @@
     "lint": "pnpm -r --filter='./packages/**' run lint",
     "lint:fix": "pnpm -r --filter='./packages/**' run lint:fix",
     "changeset": "changeset",
-    "changeset:release": "changeset publish",
+    "changeset:release": "sleep 1 && pnpm changeset publish",
     "changeset:version": "changeset version",
     "clean-all": "rm -rf node_modules && pnpm -r --filter='./packages/**' run clean && pnpm store prune",
     "pristine-build": "pnpm clean-all && pnpm i && pnpm build && pnpm generate-types",

packages/cli/package.json

@@ -87,6 +87,7 @@
     "inquirer-press-to-continue": "*",
     "jsonc-parser": "3.3.1",
     "minimatch": "9.0.5",
+    "polkadot-api": "^1.7.4",
     "semver": "*",
     "tiny-invariant": "*",
     "viem": "*",

packages/cli/src/internal/providerFactories.ts

@@ -7,6 +7,8 @@ import { createWalletClient, http, publicActions } from "viem";
 import { privateKeyToAccount } from "viem/accounts";
 import { Web3 } from "web3";
 import { WebSocketProvider } from "web3-providers-ws";
+import { createClient, type PolkadotClient } from "polkadot-api";
+import { getWsProvider, WsEvent } from "polkadot-api/ws-provider/web";
 import Debug from "debug";
 const debug = Debug("global:providers");
 
@@ -31,6 +33,8 @@ export class ProviderFactory {
         return this.createEthers();
       case "viem":
         return this.createViem();
+      case "papi":
+        return this.createPapi();
       default:
         return this.createDefault();
     }
@@ -105,6 +109,33 @@ export class ProviderFactory {
     };
   }
 
+  private createPapi(): MoonwallProvider {
+    debug(`🟢  Papi provider ${this.providerConfig.name} details prepared`);
+    return {
+      name: this.providerConfig.name,
+      type: this.providerConfig.type,
+      connect: () => {
+        const provider = getWsProvider(this.url, (status) => {
+          switch (status.type) {
+            case WsEvent.CONNECTING:
+              console.log("Connecting... 🔌");
+              break;
+            case WsEvent.CONNECTED:
+              console.log("Connected! ⚡");
+              break;
+            case WsEvent.ERROR:
+              console.log("Errored... 😢");
+              break;
+            case WsEvent.CLOSE:
+              console.log("Closed 🚪");
+              break;
+          }
+        });
+        return createClient(provider);
+      },
+    };
+  }
+
   private createDefault(): MoonwallProvider {
     debug(`🟢  Default provider ${this.providerConfig.name} details prepared`);
     return {
@@ -211,15 +242,21 @@ export interface ProviderInterface {
   name: string;
   api: any;
   type: ProviderType;
-  greet: () => void | Promise<void> | { rtVersion: number; rtName: string };
+  greet: () => Promise<void> | Promise<{ rtVersion: number; rtName: string }>;
   disconnect: () => void | Promise<void> | any;
 }
 
 export class ProviderInterfaceFactory {
   constructor(
     private name: string,
     private type: ProviderType,
-    private connect: () => Promise<ApiPromise> | Wallet | Web3 | Promise<ViemClient> | null
+    private connect: () =>
+      | Promise<ApiPromise>
+      | Wallet
+      | Web3
+      | Promise<ViemClient>
+      | PolkadotClient
+      | null
   ) {}
 
   public async create(): Promise<ProviderInterface> {
@@ -232,6 +269,8 @@ export class ProviderInterfaceFactory {
         return this.createEthers();
       case "viem":
         return this.createViem();
+      case "papi":
+        return this.createPapi();
       default:
         throw new Error("UNKNOWN TYPE");
     }
@@ -246,7 +285,7 @@ export class ProviderInterfaceFactory {
       name: this.name,
       api,
       type: this.type,
-      greet: () => {
+      greet: async () => {
         debug(
           `👋  Provider ${this.name} is connected to chain` +
             ` ${(api.consts.system.version as any).specName.toString()} ` +
@@ -319,10 +358,27 @@ export class ProviderInterfaceFactory {
     };
   }
 
+  private async createPapi(): Promise<ProviderInterface> {
+    const api = (await this.connect()) as PolkadotClient;
+    return {
+      name: this.name,
+      api,
+      type: this.type,
+      greet: async () => {
+        const unsafeApi = await api.getUnsafeApi();
+        const { spec_version, spec_name } = await unsafeApi.constants.System.Version();
+        return { rtVersion: spec_version as number, rtName: spec_name as string };
+      },
+      async disconnect() {
+        api.destroy();
+      },
+    };
+  }
+
   public static async populate(
     name: string,
     type: ProviderType,
-    connect: () => Promise<ApiPromise> | Wallet | Web3 | Promise<ViemClient> | null
+    connect: () => Promise<ApiPromise> | Wallet | Web3 | Promise<ViemClient> | PolkadotClient | null
   ): Promise<ProviderInterface> {
     debug(`🔄 Populating provider: ${name} of type: ${type}`);
     try {

packages/cli/src/lib/runnerContext.ts

@@ -24,6 +24,7 @@ import { chopsticksHandler } from "./handlers/chopsticksHandler";
 import { devHandler } from "./handlers/devHandler";
 import { readOnlyHandler } from "./handlers/readOnlyHandler";
 import { zombieHandler } from "./handlers/zombieHandler";
+import type { PolkadotClient } from "polkadot-api";
 
 const RT_VERSION = Number(process.env.MOON_RTVERSION);
 const RT_NAME = process.env.MOON_RTNAME;
@@ -150,6 +151,7 @@ export function describeSuite<T extends FoundationType>({
       polkadotJs: (apiName?: string): ApiPromise => getApi("polkadotJs", apiName),
       ethers: (apiName?: string): Wallet => getApi("ethers", apiName),
       web3: (apiName?: string): Web3 => getApi("web3", apiName),
+      papi: (apiName?: string): PolkadotClient => getApi("papi", apiName),
     };
 
     const foundationHandlers: Record<FoundationType, FoundationHandler<any>> = {

packages/types/config_schema.json

@@ -307,8 +307,8 @@
       "type": "object"
     },
     "ProviderType": {
-      "description": "The type of provider. Can be \"polkadotJs\", \"ethers\", \"web3\", \"viem\"",
-      "enum": ["ethers", "polkadotJs", "viem", "web3"],
+      "description": "The type of provider. Can be \"polkadotJs\", \"ethers\", \"web3\", \"viem\", \"papi\"",
+      "enum": ["ethers", "papi", "polkadotJs", "viem", "web3"],
       "type": "string"
     },
     "ReadOnlyLaunchSpec": {

packages/types/package.json

@@ -56,14 +56,15 @@
     "@polkadot/api": "*",
     "@polkadot/api-base": "*",
     "@polkadot/keyring": "*",
-    "@polkadot/util-crypto": "*",
     "@polkadot/types": "*",
     "@polkadot/util": "*",
+    "@polkadot/util-crypto": "*",
     "@types/node": "*",
     "@zombienet/utils": "*",
     "bottleneck": "*",
     "debug": "*",
     "ethers": "*",
+    "polkadot-api": "^1.7.4",
     "viem": "*",
     "web3": "*"
   },