client-sdk: add OmniAccount helpers (#3161)

* update to [email protected] Signed-off-by: Jonathan Alvarez <[email protected]> * add requestor for intent Signed-off-by: Jonathan Alvarez <[email protected]> * update PalletTeebagEnclave to CorePrimitivesTeebagTypesEnclave Signed-off-by: Jonathan Alvarez <[email protected]> * expose remark Signed-off-by: Jonathan Alvarez <[email protected]> * client-sdk: add request.createAccountStore Signed-off-by: Jonathan Alvarez <[email protected]> * remark: remove unused signer Signed-off-by: Jonathan Alvarez <[email protected]> * remark: use omniAccount Signed-off-by: Jonathan Alvarez <[email protected]> * add request.transferNative Signed-off-by: Jonathan Alvarez <[email protected]> * transfer: rename value to amount Signed-off-by: Jonathan Alvarez <[email protected]> * add request.transferEthereum Signed-off-by: Jonathan Alvarez <[email protected]> * add request.callEthereum Signed-off-by: Jonathan Alvarez <[email protected]> * update changelog Signed-off-by: Jonathan Alvarez <[email protected]> * bump version to preview .0 Signed-off-by: Jonathan Alvarez <[email protected]> * client-api: update readme Signed-off-by: Jonathan Alvarez <[email protected]> --------- Signed-off-by: Jonathan Alvarez <[email protected]>
litentry · Nov 6, 2024 · dc1ef96 · dc1ef96
1 parent 88b3a90
commit dc1ef96
Show file tree

Hide file tree

Showing 15 changed files with 661 additions and 53 deletions.
diff --git a/tee-worker/identity/client-api/parachain-api/README.md b/tee-worker/identity/client-api/parachain-api/README.md
@@ -15,9 +15,15 @@ These types were auto generated using [Polkadot.js Type Generation](https://polk
 2. Extend and decorate the API's types with:
 
     ```typescript
-    import { identity, vc, trusted_operations, sidechain } from "parachain-api";
-
-    const types = { ...identity.types, ...vc.types, ...trusted_operations.types, ...sidechain.types };
+    import { identity, vc, trusted_operations, sidechain, omniAccount } from "parachain-api";
+
+    const types = {
+        ...identity.types,
+        ...vc.types,
+        ...omniAccount.types,
+        ...trusted_operations.types,
+        ...sidechain.types,
+    };
 
     const api = await ApiPromise.create({
         provider,

diff --git a/tee-worker/identity/client-sdk/packages/client-sdk/CHANGELOG.md b/tee-worker/identity/client-sdk/packages/client-sdk/CHANGELOG.md
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+-   Add OmniAccount requestors for `createAccountStore`, `remark`, `transferNative`, `transferEthereum`, and `callEthereum`.
+
 ## 2024-10-14
 
 Initial version. Merge [@litentry/enclave](https://www.npmjs.com/package/@litentry/enclave) and [@litentry/vc-sdk](https://www.npmjs.com/package/@litentry/vc-sdk) into this one.
diff --git a/tee-worker/identity/client-sdk/packages/client-sdk/package.json b/tee-worker/identity/client-sdk/packages/client-sdk/package.json
@@ -1,15 +1,15 @@
 {
   "name": "@litentry/client-sdk",
   "description": "This package provides helpers for dApps to interact with the Litentry Protocol.",
-  "version": "1.0.0",
+  "version": "1.0.0-next.0",
   "license": "GPL-3.0-or-later",
   "dependencies": {},
   "devDependencies": {
     "@polkadot/rpc-provider": "^10.9.1"
   },
   "peerDependencies": {
-    "@litentry/parachain-api": "0.9.20-4.1",
-    "@litentry/sidechain-api": "0.9.20-4",
+    "@litentry/parachain-api": "0.9.20-next.5",
+    "@litentry/sidechain-api": "0.9.20-next.5",
     "@litentry/chaindata": "*",
     "@polkadot/api": "^10.9.1",
     "@polkadot/types": "^10.9.1",

diff --git a/tee-worker/identity/client-sdk/packages/client-sdk/src/index.ts b/tee-worker/identity/client-sdk/packages/client-sdk/src/index.ts
@@ -19,9 +19,9 @@ export { ID_GRAPH_STRUCT } from './lib/type-creators/id-graph';
 // vc
 export {
   validateVc,
-  VerifiableCredentialLike,
+  type VerifiableCredentialLike,
 } from './lib/vc-validator/validator';
-export {
+export type {
   ValidationResultDetail,
   ValidationResult,
 } from './lib/vc-validator/validator.types';

diff --git a/tee-worker/identity/client-sdk/packages/client-sdk/src/lib/requests/call-ethereum.request.ts b/tee-worker/identity/client-sdk/packages/client-sdk/src/lib/requests/call-ethereum.request.ts
@@ -0,0 +1,108 @@
+import { assert, hexToU8a } from '@polkadot/util';
+import { randomAsHex } from '@polkadot/util-crypto';
+
+import type { ApiPromise } from '@polkadot/api';
+import type {
+  LitentryIdentity,
+  WorkerRpcReturnValue,
+} from '@litentry/parachain-api';
+
+import { enclave } from '../enclave';
+import { createPayloadToSign } from '../util/create-payload-to-sign';
+import { createTrustedCallType } from '../type-creators/trusted-call';
+import { createRequestType } from '../type-creators/request';
+
+import type { JsonRpcRequest } from '../util/types';
+import type { U8aLike } from '@polkadot/util/types';
+
+/**
+ * OmniAccount: Call an Ethereum contract.
+ */
+export async function callEthereum(
+  /** Litentry Parachain API instance from Polkadot.js */
+  api: ApiPromise,
+  data: {
+    /** The user's omniAccount.  Use `createLitentryIdentityType` helper to create this struct */
+    omniAccount: LitentryIdentity;
+    /** The user's account.  Use `createLitentryIdentityType` helper to create this struct */
+    who: LitentryIdentity;
+    /** Ethereum contract address */
+    address: string;
+    /** Contract input data */
+    input: U8aLike;
+  }
+): Promise<{
+  payloadToSign: string;
+  txHash: string;
+  send: (args: { signedPayload: string }) => Promise<{
+    response: Array<WorkerRpcReturnValue>;
+    txHash: string;
+  }>;
+}> {
+  const { who, omniAccount } = data;
+
+  assert(omniAccount.isSubstrate, 'OmniAccount must be a Substrate identity');
+
+  const shard = await enclave.getShard(api);
+  const shardU8 = hexToU8a(shard);
+  const txHash = randomAsHex();
+
+  const { call } = await createTrustedCallType(api.registry, {
+    method: 'request_intent',
+    params: {
+      who,
+      intent: api.createType('Intent', {
+        CallEthereum: api.createType('IntentCallEthereum', {
+          address: data.address,
+          input: data.input,
+        }),
+      }),
+    },
+  });
+
+  const nonce = await api.rpc.system.accountNextIndex(omniAccount.asSubstrate);
+
+  const payloadToSign = createPayloadToSign({
+    who,
+    call,
+    nonce,
+    shard: shardU8,
+  });
+
+  const send = async (args: {
+    signedPayload: string;
+  }): Promise<{
+    response: Array<WorkerRpcReturnValue>;
+    txHash: string;
+  }> => {
+    // prepare and encrypt request
+
+    const request = await createRequestType(api, {
+      signer: who,
+      signature: args.signedPayload,
+      call,
+      nonce,
+      shard: shardU8,
+    });
+
+    // send the request to the Enclave
+    const rpcRequest: JsonRpcRequest = {
+      jsonrpc: '2.0',
+      method: 'author_submitNativeRequest',
+      params: [request.toHex()],
+    };
+
+    const enclaveResult = await enclave.send(api, rpcRequest);
+
+    return {
+      txHash,
+      response: enclaveResult,
+    };
+  };
+
+  return {
+    txHash,
+    payloadToSign,
+    send,
+  };
+}
diff --git a/.../identity/client-sdk/packages/client-sdk/src/lib/requests/create-account-store.request.ts b/.../identity/client-sdk/packages/client-sdk/src/lib/requests/create-account-store.request.ts
@@ -0,0 +1,97 @@
+import { hexToU8a } from '@polkadot/util';
+import { randomAsHex } from '@polkadot/util-crypto';
+
+import type { ApiPromise } from '@polkadot/api';
+import type {
+  LitentryIdentity,
+  WorkerRpcReturnValue,
+} from '@litentry/parachain-api';
+
+import { enclave } from '../enclave';
+import { createPayloadToSign } from '../util/create-payload-to-sign';
+import { createTrustedCallType } from '../type-creators/trusted-call';
+import { createRequestType } from '../type-creators/request';
+
+import type { JsonRpcRequest } from '../util/types';
+
+/**
+ * OmniAccount: Create the OmniAccount for the given Identity
+ */
+export async function createAccountStore(
+  /** Litentry Parachain API instance from Polkadot.js */
+  api: ApiPromise,
+  data: {
+    /** The user's OmniAccount.  Use `createLitentryIdentityType` helper to create this struct */
+    omniAccount: LitentryIdentity;
+    /** The user's account.  Use `createLitentryIdentityType` helper to create this struct */
+    who: LitentryIdentity;
+  }
+): Promise<{
+  payloadToSign: string;
+  txHash: string;
+  send: (args: { signedPayload: string }) => Promise<{
+    response: Array<WorkerRpcReturnValue>;
+    txHash: string;
+  }>;
+}> {
+  const { who, omniAccount } = data;
+
+  const shard = await enclave.getShard(api);
+  const shardU8 = hexToU8a(shard);
+  const txHash = randomAsHex();
+
+  const { call } = await createTrustedCallType(api.registry, {
+    method: 'create_account_store',
+    params: {
+      who,
+    },
+  });
+
+  const nonce = await api.rpc.system.accountNextIndex(
+    omniAccount.asSubstrate.toHex()
+  );
+
+  const payloadToSign = createPayloadToSign({
+    who,
+    call,
+    nonce,
+    shard: shardU8,
+  });
+
+  const send = async (args: {
+    signedPayload: string;
+  }): Promise<{
+    response: Array<WorkerRpcReturnValue>;
+    txHash: string;
+  }> => {
+    // prepare and encrypt request
+
+    const request = await createRequestType(api, {
+      signer: who,
+      signature: args.signedPayload,
+      call,
+      nonce,
+      shard: shardU8,
+    });
+
+    // send the request to the Enclave
+    const rpcRequest: JsonRpcRequest = {
+      jsonrpc: '2.0',
+      method: 'author_submitNativeRequest',
+      params: [request.toHex()],
+    };
+
+    const enclaveResult = await enclave.send(api, rpcRequest);
+
+    return {
+      txHash,
+      response: enclaveResult,
+    };
+  };
+
+  return {
+    txHash,
+    payloadToSign,
+    send,
+  };
+}
diff --git a/...r/identity/client-sdk/packages/client-sdk/src/lib/requests/get-last-registered-enclave.ts b/...r/identity/client-sdk/packages/client-sdk/src/lib/requests/get-last-registered-enclave.ts
@@ -1,17 +1,20 @@
 import type { ApiPromise } from '@polkadot/api';
 import { AccountId32 } from '@polkadot/types/interfaces';
 import type {
-  PalletTeebagEnclave,
-  PalletTeebagWorkerType,
+  CorePrimitivesTeebagTypesEnclave,
+  CorePrimitivesTeebagTypesWorkerType,
 } from '@polkadot/types/lookup';
 
 /**
  * Return the Enclave registry information of the latest registered TEE worker.
  */
 export async function getLastRegisteredEnclave(
   api: ApiPromise,
-  workerType: PalletTeebagWorkerType['type'] = 'Identity'
-): Promise<{ account: AccountId32; enclave: PalletTeebagEnclave }> {
+  workerType: CorePrimitivesTeebagTypesWorkerType['type'] = 'Identity'
+): Promise<{
+  account: AccountId32;
+  enclave: CorePrimitivesTeebagTypesEnclave;
+}> {
   const identifiers = await api.query.teebag.enclaveIdentifier(workerType);
   const latestEnclaveId = identifiers[identifiers.length - 1];
 

diff --git a/tee-worker/identity/client-sdk/packages/client-sdk/src/lib/requests/index.ts b/tee-worker/identity/client-sdk/packages/client-sdk/src/lib/requests/index.ts
@@ -2,6 +2,12 @@ export { createChallengeCode, linkIdentity } from './link-identity.request';
 export { linkIdentityCallback } from './link-identity-callback.request';
 export { setIdentityNetworks } from './set-identity-networks.request';
 export { requestBatchVC } from './request-batch-vc.request';
+export { remark } from './remark.request';
+export { transferNative } from './transfer-native.request';
+export { transferEthereum } from './transfer-ethereum.request';
+export { callEthereum } from './call-ethereum.request';
+
+export { createAccountStore } from './create-account-store.request';
 export { getIdGraph } from './get-id-graph.request';
 export { getIdGraphHash } from './get-id-graph-hash';
 export { getLastRegisteredEnclave } from './get-last-registered-enclave';