Merge pull request #1 from luoquanquan/feat/integrate-okx-wallet

Feat/integrate okx wallet

examples/angular/project.json

@@ -103,6 +103,11 @@
             "glob": "**/*",
             "input": "packages/near-mobile-wallet/assets/",
             "output": "assets/"
+          },
+          {
+            "glob": "**/*",
+            "input": "packages/okx-wallet/assets/",
+            "output": "assets/"
           }
         ],
         "styles": ["examples/angular/src/styles.scss"],

examples/angular/src/app/pages/wallet-selector/wallet-selector.component.ts

@@ -23,6 +23,7 @@ import { setupRamperWallet } from "@near-wallet-selector/ramper-wallet";
 import { setupLedger } from "@near-wallet-selector/ledger";
 import { setupNearMobileWallet } from "@near-wallet-selector/near-mobile-wallet";
 import { setupMintbaseWallet } from "@near-wallet-selector/mintbase-wallet";
+import { setupOKXWallet } from "@near-wallet-selector/okx-wallet";
 import { CONTRACT_ID } from "../../../constants";
 
 declare global {
@@ -55,6 +56,7 @@ export class WalletSelectorComponent implements OnInit {
       network: "testnet",
       debug: true,
       modules: [
+        setupOKXWallet(),
         setupMyNearWallet(),
         setupLedger(),
         setupSender(),

examples/react/contexts/WalletSelectorContext.tsx

@@ -21,6 +21,7 @@ import { setupXDEFI } from "@near-wallet-selector/xdefi";
 import { setupRamperWallet } from "@near-wallet-selector/ramper-wallet";
 import { setupNearMobileWallet } from "@near-wallet-selector/near-mobile-wallet";
 import { setupMintbaseWallet } from "@near-wallet-selector/mintbase-wallet";
+import { setupOKXWallet } from "@near-wallet-selector/okx-wallet";
 
 import type { ReactNode } from "react";
 import React, {
@@ -65,6 +66,7 @@ export const WalletSelectorContextProvider: React.FC<{
       network: "testnet",
       debug: true,
       modules: [
+        setupOKXWallet(),
         setupMyNearWallet(),
         setupLedger(),
         setupSender(),

examples/react/project.json

@@ -96,6 +96,11 @@
             "glob": "**/*",
             "input": "packages/near-mobile-wallet/assets/",
             "output": "assets/"
+          },
+          {
+            "glob": "**/*",
+            "input": "packages/okx-wallet/assets/",
+            "output": "assets/"
           }
         ]
       },

package.json

@@ -23,7 +23,8 @@
     "welldone-wallet",
     "ramper-wallet",
     "near-mobile-wallet",
-    "mintbase-wallet"
+    "mintbase-wallet",
+    "okx-wallet"
   ],
   "homepage": "https://github.com/near/wallet-selector#README",
   "bugs": {
@@ -64,6 +65,7 @@
     "build:ramper-wallet": "nx run-many --target=build --projects=ramper-wallet --configuration=production",
     "build:near-mobile-wallet": "nx run-many --target=build --projects=near-mobile-wallet --configuration=production",
     "build:mintbase-wallet": "nx run-many --target=build --projects=mintbase-wallet --configuration=production",
+    "build:okx-wallet": "nx run-many --target=build --projects=okx-wallet --configuration=production",
     "examples:vanillajs:generateimportmap": "(cd examples/vanillajs && jspm link index.html -o index.html)",
     "serve:vanillajs": "yarn examples:vanillajs:generateimportmap && http-server -c-1 examples/vanillajs",
     "lint": "nx workspace-lint && nx run-many --target=lint --all --parallel",

packages/okx-wallet/.babelrc

@@ -0,0 +1,10 @@
+{
+  "presets": [
+    [
+      "@nrwl/js/babel",
+      {
+        "useBuiltIns": "usage"
+      }
+    ]
+  ]
+}

packages/okx-wallet/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

packages/okx-wallet/README.md

@@ -0,0 +1,71 @@
+# @near-wallet-selector/okx-wallet
+
+This is the [OKX Wallet](https://chromewebstore.google.com/detail/%E6%AC%A7%E6%98%93-web3-%E9%92%B1%E5%8C%85/mcohilncbfahbmgdjkbpemcciiolgcge) package for NEAR Wallet Selector.
+
+## Install OKX Wallet
+
+- [Chrome](https://chromewebstore.google.com/detail/%E6%AC%A7%E6%98%93-web3-%E9%92%B1%E5%8C%85/mcohilncbfahbmgdjkbpemcciiolgcge)
+- [Safari](https://apps.apple.com/us/app/okx-wallet/id6463797825)
+- [Edge](https://microsoftedge.microsoft.com/addons/detail/%E6%AC%A7%E6%98%93-web3-%E9%92%B1%E5%8C%85/pbpjkcldjiffchgbbndmhojiacbgflha)
+
+## Installation and Usage
+
+The easiest way to use this package is to install it from the NPM registry, this package requires `near-api-js` v1.0.0 or above:
+
+```bash
+# Using Yarn
+yarn add near-api-js
+
+# Using NPM.
+npm install near-api-js
+```
+```bash
+# Using Yarn
+yarn add @near-wallet-selector/okx-wallet
+
+# Using NPM.
+npm install @near-wallet-selector/okx-wallet
+```
+
+Then use it in your dApp:
+
+```ts
+import { setupWalletSelector } from "@near-wallet-selector/core";
+import { setupOKXWallet } from "@near-wallet-selector/okx-wallet";
+
+// OKX Wallet for Wallet Selector can be setup without any params or it can take few optional params, see options below.
+const okxWallet = setupOKXWallet({
+  iconUrl: "https://<Wallet Icon URL Here>" // optional
+});
+
+const selector = await setupWalletSelector({
+  network: "mainnet", // OKX Wallet only supports NEAR Mainnet at the moment.
+  modules: [okxWallet],
+});
+```
+
+## Options
+
+- `iconUrl`: (`string?`): Image URL for the icon shown in the modal. This can also be a relative path or base64 encoded image. Defaults is `./assets/okx-wallet.png`.
+- `deprecated`: (`boolean?`): Deprecated is optional. Default is `false`.
+
+## Assets
+
+Assets such as icons can be found in the `/assets` directory of the package. Below is an example using Webpack:
+
+```ts
+import { setupOKXWallet } from "@near-wallet-selector/okx-wallet";
+import okxIconUrl from "@near-wallet-selector/okx-wallet/assets/okx-wallet.png";
+
+const okxWallet = setupOKXWallet({
+  iconUrl: okxIconUrl
+});
+```
+
+## Tip
+
+OKX Wallet only supports NEAR Mainnet at the moment.
+
+## License
+
+This repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

packages/okx-wallet/jest.config.ts

@@ -0,0 +1,16 @@
+/* eslint-disable */
+export default {
+  displayName: "okx-wallet",
+  preset: "../../jest.preset.js",
+  globals: {},
+  transform: {
+    "^.+\\.[tj]s$": [
+      "ts-jest",
+      {
+        tsconfig: "<rootDir>/tsconfig.spec.json",
+      },
+    ],
+  },
+  moduleFileExtensions: ["ts", "tsx", "js", "jsx"],
+  coverageDirectory: "../../coverage/packages/okx-wallet",
+};

packages/okx-wallet/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@near-wallet-selector/okx-wallet",
+  "version": "1.0.0",
+  "description": "OKX Wallet package for NEAR Wallet Selector.",
+  "keywords": [
+    "near",
+    "blockchain",
+    "wallets",
+    "dapps",
+    "near-protocol",
+    "near-blockchain",
+    "wallet selector",
+    "injected wallet",
+    "okx wallet"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/near/wallet-selector.git"
+  },
+  "bugs": {
+    "url": "https://github.com/near/wallet-selector/issues"
+  },
+  "homepage": "https://github.com/near/wallet-selector/tree/main/packages/okx-wallet",
+  "peerDependencies": {
+    "near-api-js": "^1.0.0 || ^2.0.0"
+  }
+}

packages/okx-wallet/project.json

@@ -0,0 +1,56 @@
+{
+  "name": "okx-wallet",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "packages/okx-wallet/src",
+  "projectType": "library",
+  "targets": {
+    "build": {
+      "executor": "@nrwl/rollup:rollup",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/packages/okx-wallet",
+        "tsConfig": "packages/okx-wallet/tsconfig.lib.json",
+        "project": "packages/okx-wallet/package.json",
+        "entryFile": "packages/okx-wallet/src/index.ts",
+        "buildableProjectDepsInPackageJsonType": "dependencies",
+        "compiler": "babel",
+        "format": ["esm", "cjs"],
+        "assets": [
+          {
+            "glob": "packages/okx-wallet/README.md",
+            "input": ".",
+            "output": "."
+          },
+          {
+            "glob": "packages/okx-wallet/assets/*",
+            "input": ".",
+            "output": "assets"
+          }
+        ]
+      }
+    },
+    "lint": {
+      "executor": "@nx/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["packages/okx-wallet/**/*.ts"]
+      }
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/packages/okx-wallet"],
+      "options": {
+        "jestConfig": "packages/okx-wallet/jest.config.ts",
+        "passWithNoTests": true
+      }
+    },
+    "deploy": {
+      "executor": "ngx-deploy-npm:deploy",
+      "options": {
+        "access": "public"
+      },
+      "dependsOn": ["^deploy"]
+    }
+  },
+  "tags": ["injected-wallet"]
+}

packages/okx-wallet/src/index.ts

@@ -0,0 +1,2 @@
+export { setupOKXWallet } from "./lib/okx-wallet";
+export type { OKXWalletParams } from "./lib/okx-wallet";

packages/okx-wallet/src/lib/icon.ts

@@ -0,0 +1 @@
+export default `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQ4AAAEOCAYAAAB4sfmlAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAsuSURBVHgB7d0/exvXlQfgo6RJJ7rbctRtZ6pLZ6jLVma63YrMJ1i53Grtap+tRH0CSV22it1tKsJdOlFdOkw+AakuqZC5HMCCIP7BIQlyBvd9n+eQtEjJHAzmh3Pv3Bk8id2w19V+V01XXy/+u1nU8vt7AQ+j7ep8pT4sPp8u6jxG7kmM0yT6oPgmPgUGjEUbfYD8vPg8jZEZS3CUbuGoq2+jDwrdA7ukdCDTrn5afG5j4IYcHKthMQmox7SrdzHgEBlicEy6OuzqIHQW8DY+hQiXmHR10tVcKfVFvY++A2dh0tUsxrUTlXqsmkXlATIJHYZSt61ZVDb314TAUOq+6k08wnKEX8fD+s+u/tjVvwZwH8ryhKOufhP9upAH8VBnVZrok3ESwLa0Xb2IBziF+xAdhy4DHsZy7dM/uvpLbNE2g6NsxP909X30bRSwfeVY+130x9+fY0u2NVRpuvpT9OMv4HG0saWhyzaCo4RFCY0mgMfWxhbC41dxv8oy8ZMQGjAUTfSrTg/iHt3nHMdh9JOg5jNgWMox+e/Rdx0f4h7cV3CU0HgbwJCVrqONewiP+wgOoQHjcS/hcdfJ0fJL/CmAsfl9Vz/GLd0lOJroJ13cMwPGp9x1rJxtOY1buO1ZlSb6sydCA8apHLu3XjZx245jFk65wi4oHUfpPFJ3Xr/N5Oir6Je0AuP3L9Gfrk0tT88GR7lg7fsAdslvu/oYiQvjMkOVJkyGwq4qQ5XnseHS9ExwmNeA3TaNfr7jRpsOVf477nmtOzA4TWw4ZNmk42jCEAVqsdGQZZN1HKXbEBpQh3Ksv7nph27qOCbRL/QC6lLmOqZXffOm4DAhCnWaxjUTpdcNVY5CaECtJnHNuxJc13HoNqBubVfPLvvGVR3HUQgNqF0TV3QdV3Uc5fSrO5QD07hkruOyjmMSQgPoTeKSruOy4DgMgE++yIT1oUoT/aQowFJZTfosVu7Zsd5xTALgc8v3pP3FenAMcpjSNE28evUqzs7OYj6f73SdnJzEZDIJeuWxKI/JmPbhbao8t9+8eXPxXB+ob6/6RtPVfGjVPZDz2Ww2r83h4eHg9sVD18HBwbw25blenvMD3SeXXrN2NLBf8qK6FJ7XqHsFmu/t7Q1ufzxk1fiCURwfHw91n7yMhdWhypWtyGPqXnWiRl1oxP5+vWfFyxBlwG37VnXdZgzULxmxGhyTGKByANWq1gOnqHnbB/yc/+WVbBkck3DPDeB6JSMm5YtlcFgpCmziIiuWwfFNANxsUj7oOICMr8uHEhxl3NIEwM2arvZKcOg2gIx9wQFkNcuhCsCmLjqOrwNgc091HECWoQqQJjiAvBIcTQBsbm+TN50GWCU4gDzBAaQJDiBNcABpggNIExxAmuAA0gQHkCY4gDTBAaQJDiBNcABpggNIExxAmuAA0gQHkCY4gDTBAaQJDiBNcABpggNIExxAmuAA0gQHkCY4gDTBAaQJDiBNcABpggNIExxAmuAA0gQHkCY4gDTBAaQJDiBNcABpggNIExxAmuAA0gQHkCY4Buz8/DxqVfO2j8Hgg2M6nUatTk9Po1Y17/cxbPvgg+OHH36IGr1+/Trato1alY6jPAY1Gstzfj70Ojg4mM9ms3ktjo+PB79PHqrKY1GLs7Oz+dHR0Sj2y5PFF6MwmUyiaZrYVeVVtrSp6+P7ss2Hh4c7ve3FsstY77TKdu/v78fe3l7sqrLNZWg6prmdUSRcrdUFxsUrUU1evnw5qn1UY42q46hNeaXthmhRo+fPn1c9OTx0TscOWDfejVrVvO1jIDgGbNfnNK5T87aPgeBgkJ4+fRoMl+AA0gQHkCY4gDTBAaQJDiBNcABpggNIExxAmuAA0gQHkCY4gDTBAaQJDiBNcABpggNIExxAmuAA0gQHkCY4gDTBAaQJDiBNcABpggNIExxAmuAA0gQHkCY4gDTBAaQJDiBNcABpggNIExxAmuAA0gQHkCY4gDTBAaQJDiBNcABpggNIExxAmuAA0gQHkCY4gDTBAaQJDiBNcABpggNIExxAmuAA0gQHkCY4gDTBAaQJDiBNcABpgmPA2raNWn348CEYriddzYNBapom3r9/H3t7e1GbZ8+eVR2cQ6fjGLBy4Hz33XdRm7LNQmPYRtNxlFfd/f39i1fhXXV+fh6np6dfHDRlm1++fBlPnz6NXfbx48c4Pj7+YvvLvp9MJjvdeZVtnk6nMSbzodfh4eH87OxsXotXr14Nfp88VJXHohaz2Wx+cHAwln0z7F+we6WZ10h41BUaq8pzfuj7ZvBDlZOTk4s2tUZfffXVxfClRmV41r0CR43KkOXFixcxZIOfHK01NIqat73MZ9VqDPvdWZUBq/E07FLN2z4GggNIExxAmuAA0gQHkCY4gDTBAaQJDiBNcABpggNIExxAmuAA0gQHkCY4gDTBAaQJDiBNcABpggNIExxAmuAA0gQHkCY4gDTBAaQJDiBNcABpggNIExxAmuAA0gQHkCY4gDTBAaQJDiBNcABpggNIExxAmuAA0gQHkCY4gDTBAaQJDiBNcABpJTjOAyBBcABZraEKkHVegqMNgM1dBMffAmBzH81xAFmnJThOA2Bz5jiANB0HkHa6nONoA+BmbSyGKoWuA9jEh/JhGRw/B8DNpuWDjgPIuMiKZXBMw3oO4HolI6bli9VrVQbZdZyf15tnbdtGrWre9gE/53+Z0lgNjp9igN69exc1KgfOdDqNWp2enlb7ovHjjz/GQF36i+11NR9aNU0zn81m89ocHBwMbl88dB0dHc1rU57r5Tk/0H3SxBVOBvaLXlR5IN++fTs/Ozub77qTk5P5ZDIZ3D54rCqPRXlMdl15bh8fHw85NE5ixZP43MuuXgXA5/7Q1dvlf6wHRxmuzBafAZaexcoK8/U7gJXZqEFOkgKP5m2sXZbyqyt+CGDpi1ObT674wTIRMgmgdmV91/P1P7zqZsU/BEDE68v+8Mk1f6FMkjYB1KqNflL0C9e9PcIfAqjZlSOP6zqOwlwH1KmNK7qN4qY3ZDLXAXW6dsRxU3BMFwXU423ccNzfNFQpmq7eh9WkUIOyCLScfm2v+6Ffx2b/0D+6+l0Au+5/44rL51dt0nEsmSiF3dbGNROiqzLB0YQhC+yqjYYoS5sMVVb/YUMW2E3/1dX/b/rDmeAo/tLVV139NoBdUZaVf5/5C5mhylIZqpT5jv0Axq6NfoiSusHrTes4LlP+B78PbxsJY9d29SJu8dYot+k4lkrHUToPk6UwPqnJ0HW36TiWynX6LoSDcSrHbhu3lJ0cXffXrv7W1UEAY1FC449xB3cNjqJ0HsIDxuGzu5Xf1n0ERyE8YPjuJTSK+wqOooTHh+gXiP0mgKEoE6H/EXccnqy6y1mVqzTRn21pAnhsbfTLJ+71TeW3ERxFE8IDHlsJi62subrL6djrtNFfZfc6gMdQjr2yuKuNLbjPOY7LlItmPkZ/bYt5D9i+Mp9RLlj7vqu/x5Zsa6iyrglDF9i2adxxYdemtjVUWddGP3QpNz9Or4sHrlWOqe9ii0OTddseqqybdvV/0V+a7+pauLtpV/8WiXtpjN0k+neLmyul0nUSld/K8ygEiFKb1izc+/czR9Hf03QsO1Cph6yTGFBgPNRZlYxJ9CFyGFC3MulZ3qrgXQzsjdGGGBxLTfQhchhaM+oy7eqn6C9IG+RZyCEHx6om+vD4dvHZXcfYJSUcyvLwQYfFqrEEx7pJ9Kdzv1l8bgLGo40+KH5efJ7GyIw1ONaVDmR/UeXrrxefl9UEPIzz+NQxtIsql12cxqfAGP0iyH8CbFx/Rn8af3IAAAAASUVORK5CYII=`;

packages/okx-wallet/src/lib/injected-okx-wallet.ts

@@ -0,0 +1,73 @@
+export interface AccessKey {
+  publicKey: string;
+  secretKey: string;
+}
+
+interface RequestSignInResponse {
+  accessKey: AccessKey;
+  accountId: string;
+  error: string | { type: string };
+}
+
+export type SignOutResponse = true | { error: string | { type: string } };
+
+interface RequestSignInParams {
+  contractId?: string;
+  methodNames?: Array<string>;
+}
+
+interface Action {
+  methodName: string;
+  args: object;
+  gas: string;
+  deposit: string;
+}
+
+interface SignAndSendTransactionParams {
+  receiverId: string;
+  actions: Array<Action>;
+}
+
+export interface SignAndSendTransactionResponse {
+  method: string;
+  txHash: string;
+  code: number;
+}
+
+interface Transaction {
+  receiverId: string;
+  actions: Array<Action>;
+}
+
+interface RequestSignTransactionsParams {
+  transactions: Array<Transaction>;
+}
+
+interface RequestSignTransactionsResponse {
+  txs: Array<{
+    signedTx: string;
+  }>;
+}
+
+export interface OkxEvents {
+  signIn: () => void;
+  signOut: () => void;
+  accountChanged: (changedAccountId: string) => void;
+}
+
+export interface InjectedOkx {
+  getAccountId: () => string | null;
+  requestSignIn: (
+    params: RequestSignInParams
+  ) => Promise<RequestSignInResponse>;
+  signOut: () => Promise<SignOutResponse>;
+  isSignedIn: () => boolean;
+  on: <Event extends keyof OkxEvents>(
+    event: Event,
+    callback: OkxEvents[Event]
+  ) => void;
+  signTransaction: (params: SignAndSendTransactionParams) => Promise<string>;
+  requestSignTransactions: (
+    params: RequestSignTransactionsParams
+  ) => Promise<RequestSignTransactionsResponse>;
+}