feat: SDK Manager package

.github/workflows/react-widget.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     if: github.event_name == 'push' && github.ref == 'refs/heads/main'
     steps:
-        # you should probably do this after your regular CI checks passes
+      # you should probably do this after your regular CI checks passes
       - uses: google-github-actions/release-please-action@v3 # it will analyze commits and create PR with new version and updated CHANGELOG:md file. On merging it will create github release page with changelog
         id: release
         with:
@@ -44,15 +44,15 @@ jobs:
       - name: Enable corepack
         run: corepack enable
         if: ${{ steps.release.outputs.releases_created }}
-      
+
       - name: Install yarn
         run: yarn set version stable
         if: ${{ steps.release.outputs.releases_created }}
 
       - name: Install dependencies
         run: yarn install
         if: ${{ steps.release.outputs.releases_created }}
-        
+
       - name: Build all packages
         run: yarn build:all
         if: ${{ steps.release.outputs.releases_created }}

.github/workflows/sdk-manager.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     if: github.event_name == 'push' && github.ref == 'refs/heads/main'
     steps:
-        # you should probably do this after your regular CI checks passes
+      # you should probably do this after your regular CI checks passes
       - uses: google-github-actions/release-please-action@v3 # it will analyze commits and create PR with new version and updated CHANGELOG:md file. On merging it will create github release page with changelog
         id: release
         with:
@@ -23,7 +23,7 @@ jobs:
           path: packages/sdk-manager
           monorepo-tags: true
           default-branch: main
-          package-name: '@buildwithsygma/sdk-manager'
+          package-name: '@buildwithsygma/sygmaprotocol-sdk-manager'
           changelog-types: '[{"type":"feat","section":"Features","hidden":false},{"type":"fix","section":"Bug Fixes","hidden":false},{"type":"chore","section":"Miscellaneous","hidden":false},{"type":"revert","hidden":true}]'
 
       - uses: actions/checkout@v3
@@ -43,7 +43,7 @@ jobs:
       - name: Enable corepack
         run: corepack enable
         if: ${{ steps.release.outputs.releases_created }}
-      
+
       - name: Install yarn
         run: yarn set version stable
         if: ${{ steps.release.outputs.releases_created }}
@@ -60,4 +60,3 @@ jobs:
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
         if: ${{ steps.release.outputs.releases_created }}
-

.github/workflows/wallet-manager.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     if: github.event_name == 'push' && github.ref == 'refs/heads/main'
     steps:
-        # you should probably do this after your regular CI checks passes
+      # you should probably do this after your regular CI checks passes
       - uses: google-github-actions/release-please-action@v3 # it will analyze commits and create PR with new version and updated CHANGELOG:md file. On merging it will create github release page with changelog
         id: release
         with:
@@ -23,7 +23,7 @@ jobs:
           path: packages/wallet-manager
           monorepo-tags: true
           default-branch: main
-          package-name: '@buildwithsygma/wallet-manager'
+          package-name: '@buildwithsygma/sygmaprotocol-wallet-manager'
           changelog-types: '[{"type":"feat","section":"Features","hidden":false},{"type":"fix","section":"Bug Fixes","hidden":false},{"type":"chore","section":"Miscellaneous","hidden":false},{"type":"revert","hidden":true}]'
 
       - uses: actions/checkout@v3
@@ -43,7 +43,7 @@ jobs:
       - name: Enable corepack
         run: corepack enable
         if: ${{ steps.release.outputs.releases_created }}
-      
+
       - name: Install yarn
         run: yarn set version stable
         if: ${{ steps.release.outputs.releases_created }}
@@ -60,4 +60,3 @@ jobs:
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
         if: ${{ steps.release.outputs.releases_created }}
-

.yarnrc.yml

@@ -6,4 +6,4 @@ nodeLinker: node-modules
 
 yarnPath: .yarn/releases/yarn-4.0.1.cjs
 
-checksumBehavior: update
+checksumBehavior: update

packages/sdk-manager/package.json

@@ -6,6 +6,7 @@
   "module": "build/index.js",
   "license": "LGPL-3.0-or-later",
   "type": "module",
+  "types": "./build/index.d.ts",
   "scripts": {
     "build": "tsc --build --clean && tsc --build ./tsconfig.json",
     "dev": "tsc --build --clean && tsc --build ./tsconfig.json --watch",
@@ -15,10 +16,12 @@
   },
   "author": "Sygmaprotocol Product Team",
   "dependencies": {
-    "@buildwithsygma/sygma-sdk-core": "^2.2.0",
+    "@buildwithsygma/sygma-sdk-core": "2.4.0",
     "@ethersproject/contracts": "^5.7.0",
     "@ethersproject/transactions": "^5.7.0",
-    "@polkadot/api": "10.7.2"
+    "@lit/context": "1.0.0",
+    "@polkadot/api": "10.7.2",
+    "lit": "3.0.0"
   },
   "devDependencies": {
     "@polkadot/types": "10.7.2",

packages/sdk-manager/src/SdkManager.ts

@@ -0,0 +1,126 @@
+import {
+  EVMAssetTransfer,
+  Environment,
+  EvmFee,
+  Fungible,
+  Transfer
+} from '@buildwithsygma/sygma-sdk-core';
+import { BaseProvider, TransactionRequest } from '@ethersproject/providers';
+import { Signer } from 'ethers';
+import { UnsignedTransaction } from '@ethersproject/transactions';
+import { SdkManagerState, SdkManagerStatus } from './types';
+
+export class SdkManager implements SdkManagerState {
+  assetTransfer: EVMAssetTransfer;
+  status: SdkManagerStatus;
+  transfer?: Transfer<Fungible>;
+  fee?: EvmFee;
+  approvalTxs?: UnsignedTransaction[];
+  depositTx?: UnsignedTransaction;
+
+  constructor() {
+    this.assetTransfer = new EVMAssetTransfer();
+    this.status = 'idle';
+  }
+
+  async checkSourceNetwork(provider: BaseProvider) {
+    const providerChainId = (await provider.getNetwork()).chainId;
+    const validEnvDomains = this.assetTransfer.config
+      .getDomains()
+      .map((domain) => domain.chainId);
+
+    if (!validEnvDomains.includes(providerChainId)) {
+      this.status = 'invalidSourceNetwork';
+    } else {
+      this.status = 'initialized';
+    }
+  }
+
+  async initializeSdk(
+    provider: BaseProvider,
+    env: Environment = Environment.MAINNET
+  ) {
+    await this.assetTransfer.init(provider, env);
+    await this.checkSourceNetwork(provider);
+  }
+
+  async initializeTransfer(
+    fromAddress: string,
+    destinationChainId: number,
+    destinationAddress: string,
+    resourceId: string,
+    amount: string
+  ) {
+    const transfer = await this.assetTransfer.createFungibleTransfer(
+      fromAddress,
+      destinationChainId,
+      destinationAddress,
+      resourceId,
+      amount
+    );
+
+    const fee = await this.assetTransfer.getFee(transfer);
+
+    const approvals = await this.assetTransfer.buildApprovals(transfer, fee);
+
+    this.transfer = transfer;
+    this.fee = fee;
+    this.approvalTxs = approvals;
+    this.status =
+      approvals.length > 0 ? 'transferCreated' : 'approvalsCompleted';
+
+    this.depositTx = await this.assetTransfer.buildTransferTransaction(
+      transfer,
+      fee
+    );
+  }
+
+  async performApprovals(signer: Signer) {
+    if (!this.transfer) {
+      throw new Error('No transfer');
+    }
+
+    if (!this.approvalTxs) {
+      throw new Error('No approvals');
+    }
+
+    if (!this.fee) {
+      throw new Error('No fee');
+    }
+
+    for (const approval of this.approvalTxs) {
+      await (
+        await signer.sendTransaction(approval as TransactionRequest)
+      ).wait();
+    }
+
+    const approvals = await this.assetTransfer.buildApprovals(
+      this.transfer,
+      this.fee
+    );
+
+    this.approvalTxs = approvals;
+    if (!approvals?.length) {
+      this.status = 'approvalsCompleted';
+      this.depositTx = await this.assetTransfer.buildTransferTransaction(
+        this.transfer,
+        this.fee
+      );
+    }
+  }
+
+  async performDeposit(signer: Signer) {
+    if (!this.transfer) {
+      throw new Error('No transfer');
+    }
+
+    if (!this.depositTx) {
+      throw new Error('No deposit');
+    }
+
+    await (
+      await signer.sendTransaction(this.depositTx as TransactionRequest)
+    ).wait();
+    this.status = 'deposited';
+  }
+}

packages/sdk-manager/src/SdkManagerContextProvider.ts

@@ -0,0 +1,100 @@
+import { Environment } from '@buildwithsygma/sygma-sdk-core';
+import { consume, createContext, provide } from '@lit/context';
+import { LitElement, html } from 'lit';
+import { customElement, state } from 'lit/decorators.js';
+import {
+  WalletManagerContext,
+  WalletManagerController
+} from '@buildwithsygma/sygmaprotocol-wallet-manager';
+import { SdkManagerState } from './types';
+import { SdkManager } from './SdkManager';
+
+export const SdkManagerContext = createContext<SdkManagerState | undefined>(
+  'sdk-context'
+);
+
+/**
+ * @name SdkManagerContextProvider
+ * @description This component is responsible for providing the SdkManagerController as a context to all its children.
+ *
+ * @example
+ * For you to consume the context objects, you need to wrap up your component with the sdk-manager-context on your render method.
+ *
+ * <wallet-manager-context>
+ *   <sdk-manager-context-provider>
+ *     <your-component></your-component>
+ *   </sdk-manager-context-provider>
+ * </wallet-manager-context>
+ */
+
+@customElement('sdk-manager-context-provider')
+export class SdkManagerContextProvider extends LitElement {
+  @consume({ context: WalletManagerContext, subscribe: true })
+  @state()
+  walletManager?: WalletManagerController;
+
+  @provide({ context: SdkManagerContext })
+  @state()
+  sdkManager?: SdkManager;
+
+  constructor() {
+    super();
+    this.sdkManager = new SdkManager();
+  }
+
+  async initializeSdk(env?: Environment) {
+    if (!this.walletManager?.provider) {
+      throw new Error('No wallet connected');
+    }
+
+    await this.sdkManager?.initializeSdk(this.walletManager.provider, env);
+  }
+
+  async initializeTransfer(
+    fromAddress: string,
+    destinationChainId: number,
+    destinationAddress: string,
+    resourceId: string,
+    amount: string
+  ) {
+    if (!this.walletManager?.provider) {
+      throw new Error('No wallet connected');
+    }
+
+    if (!this.sdkManager) {
+      throw new Error('SdkManager not initialized');
+    }
+
+    if (this.sdkManager.status !== 'initialized') {
+      throw new Error('SdkManager not initialized');
+    }
+
+    await this.sdkManager.initializeTransfer(
+      fromAddress,
+      destinationChainId,
+      destinationAddress,
+      resourceId,
+      amount
+    );
+  }
+
+  async connectedCallback(): Promise<void> {
+    super.connectedCallback();
+
+    this.walletManager?.addAccountChangedEventListener(() => {
+      this.requestUpdate();
+    });
+
+    this.walletManager?.addChainChangedEventListener(async () => {
+      const provider = this.walletManager?.evmWallet?.web3Provider;
+      if (provider) {
+        this.sdkManager?.checkSourceNetwork(provider);
+      }
+      this.requestUpdate();
+    });
+  }
+
+  render() {
+    return html`<slot></slot>`;
+  }
+}

packages/sdk-manager/src/index.ts

@@ -0,0 +1,8 @@
+export {
+  SdkManagerContext,
+  SdkManagerContextProvider
+} from './SdkManagerContextProvider';
+
+export { SdkManager } from './SdkManager';
+
+export type { SdkManagerState, SdkManagerStatus } from './types/index';

packages/sdk-manager/src/types/SdkManagerState.ts

@@ -0,0 +1,33 @@
+import {
+  EVMAssetTransfer,
+  Environment,
+  EvmFee,
+  Fungible,
+  Transfer
+} from '@buildwithsygma/sygma-sdk-core';
+import { UnsignedTransaction } from '@ethersproject/transactions';
+import { SdkManagerStatus } from './SdkManagerStatus';
+import { BaseProvider } from '@ethersproject/providers';
+import { Signer } from 'ethers';
+
+export type SdkManagerState = {
+  assetTransfer: EVMAssetTransfer;
+  status: SdkManagerStatus;
+  transfer?: Transfer<Fungible>;
+  fee?: EvmFee;
+  approvalTxs?: UnsignedTransaction[];
+  depositTx?: UnsignedTransaction;
+
+  initializeSdk: (provider: BaseProvider, env?: Environment) => Promise<void>;
+  initializeTransfer: (
+    fromAddress: string,
+    destinationChainId: number,
+    destinationAddress: string,
+    resourceId: string,
+    amount: string
+  ) => Promise<void>;
+
+  performApprovals(signer: Signer): Promise<void>;
+  performDeposit(signer: Signer): Promise<void>;
+  checkSourceNetwork(provider: BaseProvider): Promise<void>;
+};