Merge pull request #154 from perun-network/multi-backend

Multi backend

.github/workflows/ci.yml

@@ -13,34 +13,34 @@ jobs:
     steps:
       - name: "Checkout SDK"
         uses: actions/checkout@v3
-      - name: "Prettier Check"
-        uses: creyD/[email protected]
-        with:
-          dry: True
-          prettier_options: --config .prettierrc --check **/*.ts
+#      - name: "Prettier Check"
+#        uses: creyD/[email protected]
+#        with:
+#          dry: True
+#          prettier_options: --config .prettierrc --check **/*.ts
       - name: "Setup Node.js"
         uses: actions/setup-node@v3
         with:
-          node-version: "16"
+          node-version: "20"
           cache: "yarn"
       - name: "Install dependencies"
         run: yarn install
       - name: "Build"
         run: yarn build
       - name: "Test"
         run: yarn test
-      - name: "Checkout Erdstall Core"
-        uses: actions/checkout@v3
-        with:
-          ssh-key: ${{ secrets.SSH_PRIV_KEY }}
-          repository: "perun-network/erdstall-ext"
-          path: "erdstall"
-      - name: "Set up Go 1.x"
-        uses: actions/setup-go@v3
-        with:
-          go-version: ^1.17
-      - name: "Build walkthrough operator"
-        working-directory: "erdstall"
-        run: go build -o wo ./cmd/walkthrough/main.go
-      - name: "End-2-End Test"
-        run: ERDSTALL_EXE=erdstall/wo yarn test:e2e
+#      - name: "Checkout Erdstall Core"
+#        uses: actions/checkout@v3
+#        with:
+#          ssh-key: ${{ secrets.SSH_PRIV_KEY }}
+#          repository: "perun-network/erdstall-ext"
+#          path: "erdstall"
+#      - name: "Set up Go 1.x"
+#        uses: actions/setup-go@v3
+#        with:
+#          go-version: ^1.17
+#      - name: "Build walkthrough operator"
+#        working-directory: "erdstall"
+#        run: go build -o wo ./cmd/walkthrough/main.go
+#      - name: "End-2-End Test"
+#        run: ERDSTALL_EXE=erdstall/wo yarn test:e2e

.gitignore

@@ -102,7 +102,3 @@ dist
 
 # TernJS port file
 .tern-port
-
-# Generated abi bindings
-src/ledger/backend/ethereum/abi
-src/ledger/backend/ethereum/contracts

Makefile

@@ -4,7 +4,7 @@ all: ts
 
 ts:
 	@yarn install -s
-	@yarn run build -s
+	@yarn run build
 	@echo "Built erdstall-ts-sdk."
 
 bindings:
@@ -14,6 +14,10 @@ test:
 	@echo "Compiling and executing tests."
 	@yarn run test
 
+test-e2e:
+	@echo "Compiling and executing end-to-end tests."
+	@yarn run test:e2e:session
+
 integration:
 	@echo "Compiling and running integration test."
 	@yarn run test:integration

README.md

@@ -168,8 +168,6 @@ omitted after each event name in the following.
 -   **`"ChallengeResponded"`**: the Erdstall operator successfully responed with the correct balance proof.
 
 -   **`"TokenTypeRegistered"`**: a new token type (such as ETH, ERC20, ERC721, etc.) has been registered with Erdstall on-chain.
-
--   **`"TokenRegistered"`**: a specific token contract has been registered on-chain.
 </details>
 
 ## Development

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@polycrypt/erdstall",
-	"version": "0.3.0",
+	"version": "0.3.1",
 	"description": "SDK to interact with Erdstall Layer-2 Networks",
 	"main": "./index.js",
 	"exports": {
@@ -30,7 +30,9 @@
 		"lint": "eslint ./src --ext .ts",
 		"bindings": "./scripts/genbindings.sh",
 		"test:e2e": "env TS_NODE_PROJECT=\"tsconfig.e2e.json\" mocha -b --timeout 120000 -r jsdom-global/register -r ts-node/register -r tsconfig-paths/register 'src/e2e/**/*.spec.ts'",
+		"test:e2e:session": "env TS_NODE_PROJECT=\"tsconfig.e2e.json\" mocha -b --timeout 120000 -r jsdom-global/register -r ts-node/register -r tsconfig-paths/register 'src/e2e/operator_e2e.spec.ts'",
 		"test": "env TS_NODE_PROJECT=\"tsconfig.test.json\" mocha --timeout 15000 -r jsdom-global/register -r ts-node/register -r tsconfig-paths/register 'src/{,!(e2e)/**}/*.spec.ts'",
+		"test-file": "env TS_NODE_PROJECT=\"tsconfig.test.json\" mocha --timeout 15000 -r jsdom-global/register -r ts-node/register -r tsconfig-paths/register",
 		"prepack": "yarn build && tsc-alias -p tsconfig.json && ts-node ./scripts/prepack.ts ./package.json ./dist/package.json",
 		"devpub": "yarn prepack",
 		"doc": "typedoc ./src ./src/api ./src/enclave ./src/ledger ./src/ledger/backend ./src/test ./src/utils"
@@ -72,7 +74,7 @@
 		"ganache": "^7.0.2",
 		"ganache-cli": "^6.12.2",
 		"ganache-core": "^2.13.2",
-		"hardhat": "^2.4.0",
+		"hardhat": "^2.22.1",
 		"hardhat-waffle": "^0.0.1-security",
 		"jsdom": "^16.6.0",
 		"jsdom-global": "^3.0.2",
@@ -89,9 +91,13 @@
 		"walk": "^2.3.14"
 	},
 	"dependencies": {
+		"@polkadot/api": "^10.10.1",
+		"@polkadot/api-contract": "^10.10.1",
+		"@polkadot/util-crypto": "^12.5.1",
 		"axios": "^0.21.4",
+		"canonicalize": "^2.0.0",
 		"ethereum-waffle": "^3.4.0",
-		"ethers": "^5.4.1",
+		"ethers": "^6.11.1",
 		"isomorphic-ws": "^4.0.1",
 		"number-generator": "^4.0.5",
 		"reflect-metadata": "^0.1.13",

scripts/genbindings.sh

@@ -41,11 +41,11 @@ function compileTo() {
   # Clean up existing bindings.
   rm -rf "${2}"/contracts
   mkdir -p "${2}"/contracts/abi
-  yarn hardhat compile && cp -rl ./typechain/* "${2}"/contracts/ \
+  yarn hardhat compile && cp -rl ./typechain-types/* "${2}"/contracts/ \
     && find ./artifacts/contracts/*.sol/ \
     | grep -v ".dbg" | grep ".json" | xargs cp -l -t "${2}"/contracts/abi/
   # Clean up typechain generated files.
-  rm -rf ./artifacts ./cache ./typechain
+  rm -rf ./artifacts ./cache ./typechain-types
   cd "${CWD}"
 }
 
@@ -62,8 +62,7 @@ if [[ ! -d $CONTRACTSDIR ]]; then
 fi
 
 SRCDIR="${PWD}"
-ETHBACKEND="${SRCDIR}"/src/ledger/backend
-ETHBACKEND_TEST="${SRCDIR}"/src/test/ledger/backend
+ETHBACKEND="${SRCDIR}"/src/ledger/backend/ethereum
 
 checkInstalled npm
 checkInstalledLocally typechain

src/api/calls/getaccount.ts

@@ -3,15 +3,15 @@
 
 import { jsonObject, jsonMember } from "#erdstall/export/typedjson";
 import { ErdstallObject, registerErdstallType } from "#erdstall/api";
-import { Address } from "#erdstall/ledger";
+import { Address, Crypto } from "#erdstall/crypto";
 
 const getAccountTypeName = "GetAccount";
 
 @jsonObject
 export class GetAccount extends ErdstallObject {
-	@jsonMember(Address) who: Address;
+	@jsonMember(Address) who: Address<Crypto>;
 
-	constructor(who: Address) {
+	constructor(who: Address<Crypto>) {
 		super();
 		this.who = who;
 	}

src/api/calls/onboarding.ts

@@ -3,13 +3,13 @@
 
 import { jsonObject, jsonMember } from "#erdstall/export/typedjson";
 import { ErdstallObject } from "#erdstall/api";
-import { Address } from "#erdstall/ledger";
+import { Address, Crypto } from "#erdstall/crypto";
 
 @jsonObject
 export class Onboarding extends ErdstallObject {
-	@jsonMember(Address) who: Address;
+	@jsonMember(Address) who: Address<Crypto>;
 
-	constructor(who: Address) {
+	constructor(who: Address<Crypto>) {
 		super();
 		this.who = who;
 	}

src/api/calls/subscribe.ts

@@ -2,7 +2,7 @@
 "use strict";
 
 import { ErdstallObject, registerErdstallType } from "#erdstall/api";
-import { Address } from "#erdstall/ledger";
+import { Address, Crypto } from "#erdstall/crypto";
 import { jsonObject, jsonMember } from "#erdstall/export/typedjson";
 
 const subBPsTypeName = "SubscribeBalanceProofs";
@@ -11,10 +11,10 @@ const subPhaseShiftName = "SubscribePhaseShifts";
 
 @jsonObject
 export class SubscribeBalanceProofs extends ErdstallObject {
-	@jsonMember(Address) who?: Address;
+	@jsonMember(Address) who?: Address<Crypto>;
 	@jsonMember(Boolean) cancel?: boolean;
 
-	constructor(who?: Address, cancel?: boolean) {
+	constructor(who?: Address<Crypto>, cancel?: boolean) {
 		super();
 		this.who = who;
 		this.cancel = cancel;
@@ -23,17 +23,33 @@ export class SubscribeBalanceProofs extends ErdstallObject {
 	public objectType(): any {
 		return SubscribeBalanceProofs;
 	}
+
 	protected objectTypeName(): string {
 		return subBPsTypeName;
 	}
+
+	public static fromJSON(json: any): SubscribeBalanceProofs {
+		if (!json.who) {
+			throw new Error("expected who field in subscribe balance proofs");
+		}
+		const who = Address.ensure(json.who);
+		return new SubscribeBalanceProofs(who, json.cancel);
+	}
+
+	public static toJSON(obj: SubscribeBalanceProofs): any {
+		return {
+			who: obj.who?.toJSON(),
+			cancel: obj.cancel,
+		};
+	}
 }
 
 @jsonObject
 export class SubscribeTXs extends ErdstallObject {
-	@jsonMember(Address) who?: Address;
+	@jsonMember(Address) who?: Address<Crypto>;
 	@jsonMember(Boolean) cancel?: boolean;
 
-	constructor(who?: Address, cancel?: boolean) {
+	constructor(who?: Address<Crypto>, cancel?: boolean) {
 		super();
 		this.who = who;
 		this.cancel = cancel;
@@ -45,6 +61,21 @@ export class SubscribeTXs extends ErdstallObject {
 	protected objectTypeName(): string {
 		return subTXsTypeName;
 	}
+
+	// public static fromJSON(json: any): SubscribeTXs {
+	// 	if (!json.who) {
+	// 		throw new Error("expected who field in subscribe transaction");
+	// 	}
+	// 	const who = Address.ensure(json.who);
+	// 	return new SubscribeTXs(who, json.cancel);
+	// }
+
+	// public static toJSON(obj: SubscribeTXs): any {
+	// 	return {
+	// 		who: obj.who?.toJSON(),
+	// 		cancel: obj.cancel,
+	// 	};
+	// }
 }
 
 @jsonObject

src/api/index.ts

@@ -4,7 +4,6 @@
 export * from "./object";
 export * from "./call";
 export * from "./result";
-export * from "./signature";
 
 export * as calls from "./calls";
 export * as responses from "./responses";

src/api/object.ts

@@ -2,9 +2,9 @@
 "use strict";
 
 import {
-	jsonObject,
 	TypedJSON,
 	Serializable,
+	jsonObject,
 } from "#erdstall/export/typedjson";
 import { customJSON } from "./util";
 
@@ -34,7 +34,7 @@ export abstract class ErdstallObject {
 		return TypedJSON.parse(data, objectImpls.get(js.type)!)!;
 	}
 
-	static toJSON(me: ErdstallObject) {
+	static toJSON(me: ErdstallObject): any {
 		return {
 			type: me.objectTypeName(),
 			data: JSON.parse(TypedJSON.stringify(me, me.objectType())),

src/api/responses/account.ts

@@ -2,7 +2,7 @@
 "use strict";
 
 import {
-	jsonBigIntMember,
+	jsonU64Member,
 	jsonObject,
 	jsonMember,
 } from "#erdstall/export/typedjson";
@@ -14,7 +14,7 @@ const accountTypeName = "AccountResponse";
 @jsonObject
 export class Account extends ErdstallObject {
 	@jsonMember(ledger.Account) account: ledger.Account;
-	@jsonBigIntMember() epoch: bigint;
+	@jsonU64Member() epoch: bigint;
 
 	constructor(account: ledger.Account, epoch: bigint) {
 		super();
@@ -25,6 +25,7 @@ export class Account extends ErdstallObject {
 	public objectType(): any {
 		return Account;
 	}
+
 	protected objectTypeName(): string {
 		return accountTypeName;
 	}