feat(contracts)!: experimental support for pallet-revive

.github/workflows/e2e-contracts-tests.yml

@@ -0,0 +1,49 @@
+name: E2E Contracts API Tests
+
+on:
+  push:
+  workflow_dispatch:
+  merge_group:
+
+jobs:
+  e2e-tests:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'yarn'
+      - run: yarn install --immutable
+      - run: yarn build
+      - name: Download executables
+        run: |
+          curl -L -O https://github.com/paritytech/substrate-contracts-node/releases/download/v0.42.0/substrate-contracts-node-linux.tar.gz 
+          tar -xzf substrate-contracts-node-linux.tar.gz
+          mv ./substrate-contracts-node-linux/substrate-contracts-node ./substrate-contracts-node
+          chmod +x substrate-contracts-node
+
+          curl -L -O https://github.com/use-ink/ink-node/releases/download/v0.43.2/ink-node-linux.tar.gz
+          tar -xzf ink-node-linux.tar.gz
+          mv ./ink-node-linux/ink-node ./ink-node
+          chmod +x ink-node
+
+      - name: Spawn networks
+        run: |
+          export PATH=$(pwd):$PATH
+          export RUST_BACKTRACE=full
+          ./ink-node --rpc-port=9955 & 
+          ./substrate-contracts-node --dev --rpc-port=9944 &
+
+          chmod +x ./e2e/contracts/wait-for-port.sh
+          ./e2e/contracts/wait-for-port.sh 9944 30
+          ./e2e/contracts/wait-for-port.sh 9955 30
+
+      - name: Run tests
+        run: yarn workspace e2e-contracts run e2e:test

e2e/contracts/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "e2e-contracts",
+  "author": "Tung Vu <tung@dedot.dev>",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "e2e:test": "npx vitest --watch=false --no-file-parallelism"
+  },
+  "dependencies": {
+   "@dedot/chaintypes": "^0.101.0",
+    "@polkadot/keyring": "^13.5.1",
+    "dedot": "workspace:*"
+  },
+  "license": "Apache-2.0"
+}

e2e/contracts/src/contracts/README.md

@@ -0,0 +1,7 @@
+## Contracts
+
+### Generate types for `flipper` contracts
+```shell
+# Run from project's root folder
+yarn cli typink -m ./e2e/contracts/src/contracts/flipper_v5.json -o ./e2e/contracts/src/contracts/
+```

e2e/contracts/src/contracts/flipper/constructor-query.d.ts

@@ -0,0 +1,58 @@
+// Generated by dedot cli
+
+import type { Hash, Result } from 'dedot/codecs';
+import type {
+  ConstructorCallOptions,
+  ContractInstantiateResult,
+  GenericConstructorCallResult,
+  GenericConstructorQuery,
+  GenericConstructorQueryCall,
+} from 'dedot/contracts';
+import type { GenericSubstrateApi } from 'dedot/types';
+import type { FlipperFlipperError } from './types.js';
+
+export interface ConstructorQuery<ChainApi extends GenericSubstrateApi> extends GenericConstructorQuery<ChainApi> {
+  /**
+   * Creates a new flipper smart contract initialized with the given value.
+   *
+   * @param {boolean} initValue
+   * @param {ConstructorCallOptions} options
+   *
+   * @selector 0x9bae9d5e
+   **/
+  new: GenericConstructorQueryCall<
+    ChainApi,
+    (
+      initValue: boolean,
+      options?: ConstructorCallOptions,
+    ) => Promise<GenericConstructorCallResult<[], ContractInstantiateResult<ChainApi>>>
+  >;
+
+  /**
+   * Creates a new flipper smart contract initialized to `false`.
+   *
+   * @param {ConstructorCallOptions} options
+   *
+   * @selector 0x61ef7e3e
+   **/
+  newDefault: GenericConstructorQueryCall<
+    ChainApi,
+    (options?: ConstructorCallOptions) => Promise<GenericConstructorCallResult<[], ContractInstantiateResult<ChainApi>>>
+  >;
+
+  /**
+   * Creates a new flipper smart contract with the value being calculate using provided seed.
+   *
+   * @param {Hash} seed
+   * @param {ConstructorCallOptions} options
+   *
+   * @selector 0x6d4cae81
+   **/
+  fromSeed: GenericConstructorQueryCall<
+    ChainApi,
+    (
+      seed: Hash,
+      options?: ConstructorCallOptions,
+    ) => Promise<GenericConstructorCallResult<Result<[], FlipperFlipperError>, ContractInstantiateResult<ChainApi>>>
+  >;
+}

e2e/contracts/src/contracts/flipper/constructor-tx.d.ts

@@ -0,0 +1,50 @@
+// Generated by dedot cli
+
+import type { Hash } from 'dedot/codecs';
+import type {
+  ConstructorTxOptions,
+  GenericConstructorTx,
+  GenericConstructorTxCall,
+  GenericInstantiateSubmittableExtrinsic,
+} from 'dedot/contracts';
+import type { GenericSubstrateApi } from 'dedot/types';
+
+export interface ConstructorTx<ChainApi extends GenericSubstrateApi> extends GenericConstructorTx<ChainApi> {
+  /**
+   * Creates a new flipper smart contract initialized with the given value.
+   *
+   * @param {boolean} initValue
+   * @param {ConstructorTxOptions} options
+   *
+   * @selector 0x9bae9d5e
+   **/
+  new: GenericConstructorTxCall<
+    ChainApi,
+    (initValue: boolean, options: ConstructorTxOptions) => GenericInstantiateSubmittableExtrinsic<ChainApi>
+  >;
+
+  /**
+   * Creates a new flipper smart contract initialized to `false`.
+   *
+   * @param {ConstructorTxOptions} options
+   *
+   * @selector 0x61ef7e3e
+   **/
+  newDefault: GenericConstructorTxCall<
+    ChainApi,
+    (options: ConstructorTxOptions) => GenericInstantiateSubmittableExtrinsic<ChainApi>
+  >;
+
+  /**
+   * Creates a new flipper smart contract with the value being calculate using provided seed.
+   *
+   * @param {Hash} seed
+   * @param {ConstructorTxOptions} options
+   *
+   * @selector 0x6d4cae81
+   **/
+  fromSeed: GenericConstructorTxCall<
+    ChainApi,
+    (seed: Hash, options: ConstructorTxOptions) => GenericInstantiateSubmittableExtrinsic<ChainApi>
+  >;
+}

e2e/contracts/src/contracts/flipper/events.d.ts

@@ -0,0 +1,29 @@
+// Generated by dedot cli
+
+import type { GenericContractEvent, GenericContractEvents } from 'dedot/contracts';
+import type { GenericSubstrateApi } from 'dedot/types';
+
+export interface ContractEvents<ChainApi extends GenericSubstrateApi> extends GenericContractEvents<ChainApi> {
+  /**
+   * Emitted when the flip function is called.
+   *
+   * @signature_topic: 0x0a39b5ca0b8b3a5172476100ae7b9168b269cc91d5648efe180c75d935d3e886
+   **/
+  Flipped: GenericContractEvent<
+    'Flipped',
+    {
+      /**
+       * The previous state of the flip.
+       *
+       * @indexed: false
+       **/
+      old: boolean;
+      /**
+       * The new state of the flip.
+       *
+       * @indexed: false
+       **/
+      new: boolean;
+    }
+  >;
+}

e2e/contracts/src/contracts/flipper/index.d.ts

@@ -0,0 +1,42 @@
+// Generated by dedot cli
+
+import type { SubstrateApi } from 'dedot/chaintypes';
+import type { GenericContractApi, WithLazyStorage } from 'dedot/contracts';
+import type { RpcVersion, VersionedGenericSubstrateApi } from 'dedot/types';
+import { ConstructorQuery } from './constructor-query.js';
+import { ConstructorTx } from './constructor-tx.js';
+import { ContractEvents } from './events.js';
+import { ContractQuery } from './query.js';
+import { ContractTx } from './tx.js';
+import type { Flipper, InkPrimitivesLangError } from './types.js';
+
+export * from './types.js';
+
+/**
+ * @name: FlipperContractApi
+ * @contractName: flipper
+ * @contractVersion: 5.0.0
+ * @authors: Parity Technologies <admin@parity.io>
+ * @language: ink! 5.0.0
+ **/
+export interface FlipperContractApi<
+  Rv extends RpcVersion = RpcVersion,
+  ChainApi extends VersionedGenericSubstrateApi = SubstrateApi,
+> extends GenericContractApi<Rv, ChainApi> {
+  query: ContractQuery<ChainApi[Rv]>;
+  tx: ContractTx<ChainApi[Rv]>;
+  constructorQuery: ConstructorQuery<ChainApi[Rv]>;
+  constructorTx: ConstructorTx<ChainApi[Rv]>;
+  events: ContractEvents<ChainApi[Rv]>;
+  storage: {
+    root(): Promise<Flipper>;
+    lazy(): WithLazyStorage<Flipper>;
+  };
+
+  types: {
+    RootStorage: Flipper;
+    LazyStorage: WithLazyStorage<Flipper>;
+    LangError: InkPrimitivesLangError;
+    ChainApi: ChainApi[Rv];
+  };
+}

e2e/contracts/src/contracts/flipper/query.d.ts

@@ -0,0 +1,54 @@
+// Generated by dedot cli
+
+import type { Hash, Result } from 'dedot/codecs';
+import type {
+  ContractCallOptions,
+  ContractCallResult,
+  GenericContractCallResult,
+  GenericContractQuery,
+  GenericContractQueryCall,
+} from 'dedot/contracts';
+import type { GenericSubstrateApi } from 'dedot/types';
+import type { FlipperFlipperError } from './types.js';
+
+export interface ContractQuery<ChainApi extends GenericSubstrateApi> extends GenericContractQuery<ChainApi> {
+  /**
+   * Flips the current value, value based on seed.
+   *
+   * @param {Hash} seed
+   * @param {ContractCallOptions} options
+   *
+   * @selector 0x847d0968
+   **/
+  flipWithSeed: GenericContractQueryCall<
+    ChainApi,
+    (
+      seed: Hash,
+      options?: ContractCallOptions,
+    ) => Promise<GenericContractCallResult<Result<boolean, FlipperFlipperError>, ContractCallResult<ChainApi>>>
+  >;
+
+  /**
+   * Flips the current value of the Flipper's boolean.
+   *
+   * @param {ContractCallOptions} options
+   *
+   * @selector 0x633aa551
+   **/
+  flip: GenericContractQueryCall<
+    ChainApi,
+    (options?: ContractCallOptions) => Promise<GenericContractCallResult<[], ContractCallResult<ChainApi>>>
+  >;
+
+  /**
+   * Returns the current value of the Flipper's boolean.
+   *
+   * @param {ContractCallOptions} options
+   *
+   * @selector 0x2f865bd9
+   **/
+  get: GenericContractQueryCall<
+    ChainApi,
+    (options?: ContractCallOptions) => Promise<GenericContractCallResult<boolean, ContractCallResult<ChainApi>>>
+  >;
+}

e2e/contracts/src/contracts/flipper/tx.d.ts

@@ -0,0 +1,34 @@
+// Generated by dedot cli
+
+import type { Hash } from 'dedot/codecs';
+import type {
+  ContractSubmittableExtrinsic,
+  ContractTxOptions,
+  GenericContractTx,
+  GenericContractTxCall,
+} from 'dedot/contracts';
+import type { GenericSubstrateApi } from 'dedot/types';
+
+export interface ContractTx<ChainApi extends GenericSubstrateApi> extends GenericContractTx<ChainApi> {
+  /**
+   * Flips the current value, value based on seed.
+   *
+   * @param {Hash} seed
+   * @param {ContractTxOptions} options
+   *
+   * @selector 0x847d0968
+   **/
+  flipWithSeed: GenericContractTxCall<
+    ChainApi,
+    (seed: Hash, options: ContractTxOptions) => ContractSubmittableExtrinsic<ChainApi>
+  >;
+
+  /**
+   * Flips the current value of the Flipper's boolean.
+   *
+   * @param {ContractTxOptions} options
+   *
+   * @selector 0x633aa551
+   **/
+  flip: GenericContractTxCall<ChainApi, (options: ContractTxOptions) => ContractSubmittableExtrinsic<ChainApi>>;
+}

e2e/contracts/src/contracts/flipper/types.d.ts

@@ -0,0 +1,9 @@
+// Generated by dedot cli
+
+export type Flipper = { value: boolean };
+
+export type InkPrimitivesLangError = 'CouldNotReadInput';
+
+export type FlipperFlipperError = 'ZeroSum';
+
+export type InkEnvNoChainExtension = null;

e2e/contracts/src/global.d.ts

@@ -0,0 +1,8 @@
+import { LegacyClient } from 'dedot';
+
+declare global {
+  var contractsClient: LegacyClient;
+  var reviveClient: LegacyClient;
+}
+
+export {};

e2e/contracts/src/setup.ts

@@ -0,0 +1,25 @@
+import { LegacyClient, WsProvider } from 'dedot';
+import { afterAll, beforeAll } from 'vitest';
+import { devPairs } from './utils';
+
+const CONTRACTS_NODE_ENDPOINT = 'ws://127.0.0.1:9944';
+const INK_NODE_ENDPOINT = 'ws://127.0.0.1:9955';
+
+beforeAll(async () => {
+  console.log(`Connect to ${CONTRACTS_NODE_ENDPOINT}`);
+  global.contractsClient = await LegacyClient.new(new WsProvider(CONTRACTS_NODE_ENDPOINT));
+
+  console.log(`Connect to ${INK_NODE_ENDPOINT}`);
+  global.reviveClient = await LegacyClient.new(new WsProvider(INK_NODE_ENDPOINT));
+
+  const alicePair = devPairs().alice;
+  await reviveClient.tx.revive.mapAccount().signAndSend(alicePair).untilFinalized();
+}, 120_000);
+
+afterAll(async () => {
+  await global.contractsClient.disconnect();
+  console.log(`Disconnected from ${CONTRACTS_NODE_ENDPOINT}`);
+
+  await global.reviveClient.disconnect();
+  console.log(`Disconnected from ${INK_NODE_ENDPOINT}`);
+});