@haechi-labs/face-types - npm Package Compare versions

Comparing version 1.2.1 to 1.3.0-alpha.0

package.json

 {
   "name": "@haechi-labs/face-types",
-  "version": "1.2.1",
+  "version": "1.3.0-alpha.0",
   "description": "",
   "author": "",
   "license": "ISC",
-  "main": "./lib/index.js",
-  "types": "./lib/index.d.ts",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "files": [
-    "lib",
+    "dist",
     "src"
@@ -15,3 +15,4 @@ ],
     "build": "tsc -p . --sourceMap true",
-    "build:watch": "tsc -p . --sourceMap true --watch"
+    "build:watch": "tsc -p . --sourceMap true --watch",
+    "dev": "yarn run build:watch"
   },
@@ -24,5 +25,7 @@ "devDependencies": {
   "dependencies": {
-    "ethers": "^5.6.8"
+    "bn.js": "^5.2.1",
+    "ethers": "^5.6.8",
+    "near-api-js": "^1.1.0"
   },
-  "gitHead": "77355be5218d5d6eb887ad4ea984ce347d12e451",
+  "gitHead": "12d83f8a2483eaff0e61786a70de9507e1a62b9f",
   "publishConfig": {
@@ -29,0 +32,0 @@ "access": "public"

src/blockchain.ts

@@ -14,2 +14,6 @@ export enum Network {
   SOLANA_DEVNET = 'solana_devnet',
+  NEAR = 'near',
+  NEAR_TESTNET = 'near_testnet',
+  BORA = 'bora',
+  BORA_TESTNET = 'bora_testnet',
   /** @deprecated use ETHEREUM */
@@ -45,2 +49,6 @@ ETH_MAINNET = 'ethereum',
     case Network.SOLANA_DEVNET:
+    case Network.NEAR:
+    case Network.NEAR_TESTNET:
+    case Network.BORA:
+    case Network.BORA_TESTNET:
       return true;
@@ -64,2 +72,6 @@ default:
   [Network.SOLANA_DEVNET]: 0,
+  [Network.NEAR]: 0,
+  [Network.NEAR_TESTNET]: 0,
+  [Network.BORA]: 77001,
+  [Network.BORA_TESTNET]: 99001,
 
@@ -75,2 +87,4 @@ 1: Network.ETHEREUM,
   1001: Network.BAOBAB,
+  77001: Network.BORA,
+  99001: Network.BORA_TESTNET,
 };
@@ -84,2 +98,4 @@
   SOLANA = 'SOLANA',
+  NEAR = 'NEAR',
+  BORA = 'BORA',
 }
@@ -92,6 +108,58 @@
   Blockchain.KLAYTN,
+  Blockchain.BORA,
 ];
 
+export function networkToBlockchain(network: Network): Blockchain {
+  switch (network) {
+    case Network.ETHEREUM:
+    case Network.ROPSTEN:
+    case Network.GOERLI:
+      return Blockchain.ETHEREUM;
+    case Network.POLYGON:
+    case Network.MUMBAI:
+      return Blockchain.POLYGON;
+    case Network.BNB_SMART_CHAIN:
+    case Network.BNB_SMART_CHAIN_TESTNET:
+      return Blockchain.BNB_SMART_CHAIN;
+    case Network.KLAYTN:
+    case Network.BAOBAB:
+      return Blockchain.KLAYTN;
+    case Network.SOLANA:
+    case Network.SOLANA_DEVNET:
+      return Blockchain.SOLANA;
+    case Network.BORA:
+    case Network.BORA_TESTNET:
+      return Blockchain.BORA;
+    case Network.NEAR:
+    case Network.NEAR_TESTNET:
+      return Blockchain.NEAR;
+  }
+
+  throw new Error(`Unsupported network: ${network}`);
+}
+
 export function isEthlikeBlockchain(blockchain: Blockchain): boolean {
   return EthLikeBlockchains.indexOf(blockchain) !== -1;
 }
+
+export interface KeyPair {
+  privateKey: Uint8Array;
+  publicKey: Uint8Array;
+}
+
+export const getPlatFormCoinDecimalByBlockchain = (blockchain: Blockchain): number => {
+  switch (blockchain) {
+    case Blockchain.ETHEREUM:
+    case Blockchain.POLYGON:
+    case Blockchain.KLAYTN:
+    case Blockchain.BNB_SMART_CHAIN:
+    case Blockchain.BORA:
+      return 18;
+    case Blockchain.SOLANA:
+      return 9;
+    case Blockchain.NEAR:
+      return 24;
+    default:
+      throw new Error('unsupported blockchain');
+  }
+};

src/error.ts

@@ -23,2 +23,3 @@ import { JsonRpcError, RpcErrorCode } from './json-rpc';
   CHAIN_DISCONNECTED = 4901,
+  SEND_TRANCTION_FAILED = 4902,
 
@@ -29,4 +30,4 @@ INTERNAL = 5000,
 export class FaceError extends Error {
-  private readonly code: FaceErrorCode | RpcErrorCode | number;
-  public data?: Record<string, any>;
+  public readonly code: FaceErrorCode | RpcErrorCode | number;
+  public data?: any;
   public origin: any;
@@ -42,3 +43,3 @@
     origin?: any;
-    data?: Record<string, any>;
+    data?: any;
   }) {
@@ -58,2 +59,10 @@ super();
 
+export function sendTransactionError(err: JsonRpcError) {
+  return new FaceError({
+    message: err.message,
+    code: FaceErrorCode.SEND_TRANCTION_FAILED,
+    data: err.data,
+  });
+}
+
 export function jsonRpcError(err: JsonRpcError) {
@@ -67,3 +76,3 @@ return new FaceError({
 
-export function faceServerError(message: string, origin?: any, data?: Record<string, any>) {
+export function faceServerError(message: string, origin?: any, data?: any) {
   return new FaceError({
@@ -77,3 +86,3 @@ message: `face server error: ${message}`,
 
-export function nitroEnclaveError(message: string, origin?: any, data?: Record<string, any>) {
+export function nitroEnclaveError(message: string, origin?: any, data?: any) {
   return new FaceError({
@@ -87,3 +96,3 @@ message: `nitro enclave error: ${message}`,
 
-export function firebaseError(message: string, origin?: any, data?: Record<string, any>) {
+export function firebaseError(message: string, origin?: any, data?: any) {
   return new FaceError({
@@ -97,3 +106,3 @@ message: `firebase error: ${message}`,
 
-export function invalidEnvironmentError(data?: Record<string, any>) {
+export function invalidEnvironmentError(data?: any) {
   return new FaceError({
@@ -106,3 +115,3 @@ message: 'invalid environment',
 
-export function cryptoError(message: string, origin?: any, data?: Record<string, any>) {
+export function cryptoError(message: string, origin?: any, data?: any) {
   return new FaceError({
@@ -116,3 +125,3 @@ message: `crypto error: ${message}`,
 
-export function invalidFormatError(message: string, origin?: any, data?: Record<string, any>) {
+export function invalidFormatError(message: string, origin?: any, data?: any) {
   return new FaceError({
@@ -126,3 +135,3 @@ message: `invalid format error: ${message}`,
 
-export function invalidParameterError(message: string, origin?: any, data?: Record<string, any>) {
+export function invalidParameterError(message: string, origin?: any, data?: any) {
   return new FaceError({
@@ -136,3 +145,3 @@ message: `invalid params error: ${message}`,
 
-export function localStorageError(message: string, origin?: any, data?: Record<string, any>) {
+export function localStorageError(message: string, origin?: any, data?: any) {
   return new FaceError({
@@ -184,1 +193,9 @@ message: `local storage error: ${message}`,
 }
+
+export function invalidAddressWithWalletError() {
+  return new FaceError({
+    message: `invalid address compared with wallet address`,
+    code: FaceErrorCode.INTERNAL,
+    origin,
+  });
+}

src/face-event.ts

 import { BigNumber, BigNumberish } from 'ethers';
 
-export type FaceTransactionPayload = FaceEthereumTransactionPayload | FaceSolanaTransactionPayload;
+export type FaceTransactionPayload =
+  | FaceEthereumTransactionPayload
+  | FaceSolanaNearTransactionPayload;
 
@@ -13,7 +15,29 @@ export interface FaceEthereumTransactionPayload {
 
-export interface FaceSolanaTransactionPayload {
+export interface FaceSolanaNearTransactionPayload {
   serializedHex: string;
 }
 
+export function parseFaceSolanaNearTransactionPayload(arg: unknown) {
+  if (arg == null || typeof arg !== 'object') {
+    return null;
+  }
+  if ((arg as any)['serializedHex'] == null || typeof (arg as any)['serializedHex'] !== 'string') {
+    return null;
+  }
+
+  return arg as FaceSolanaNearTransactionPayload;
+}
+
 export interface FaceLoginResponse {
+  wallet:
+    | {
+        id?: string;
+        userId?: string;
+        keyId?: string;
+        path?: string;
+        address?: string;
+        ecdsaPublicKey?: string;
+        eddsaPublicKey?: string;
+      }
+    | undefined;
   faceUserId: string;
@@ -20,0 +44,0 @@ }

src/index.ts

@@ -0,1 +1,2 @@
+export * from './auth';
 export * from './blockchain';
@@ -2,0 +3,0 @@ export * from './crypto';

src/json-rpc.ts

@@ -11,2 +11,3 @@ export enum JsonRpcMethod {
   face_openWalletConnect = 'face_openWalletConnect',
+  face_socialLogin = 'face_socialLogin',
 
@@ -18,4 +19,6 @@ eth_sendTransaction = 'eth_sendTransaction',
   eth_sign = 'eth_sign',
+  eth_accounts = 'eth_accounts',
 
   personal_sign = 'personal_sign',
+  personal_listAccounts = 'personal_listAccounts',
 
@@ -25,2 +28,4 @@ wallet_switchEthereumChain = 'wallet_switchEthereumChain',
   solana_sendTransaction = 'solana_sendTransaction',
+
+  near_broadcast_tx_async = 'near_broadcast_tx_async',
 }
@@ -32,2 +37,3 @@
   FACE_WALLET_CONNECT = 'FACE_WALLET_CONNECT',
+  FACE_NATIVE_SDK = 'FACE_NATIVE_SDK',
 }
@@ -65,5 +71,14 @@
 export interface JsonRpcResponsePayload<ResultType = any> {
+  jsonrpc?: string;
   id?: string | number | null;
   result?: ResultType | null;
   error?: JsonRpcError | null;
+  // Originally, we were going to work with JSONRPC standard,
+  // and wrap ethereum rpc in one more layer.
+  // However, the process of handling data became complicated,
+  // so we decided to extend JSONRPC standard.
+  // Link for internal discussion:
+  // https://haechilabs.slack.com/archives/C03EVTP0RSB/p1666330252362169?thread_ts=1666329876.458129&cid=C03EVTP0RSB
+  to?: JsonRpcSource;
+  from?: JsonRpcSource;
 }
@@ -70,0 +85,0 @@

src/transaction.ts

@@ -0,1 +1,4 @@
+import { BigNumberish } from 'ethers';
+import { BytesLike } from 'ethers/lib/utils';
+
 export enum TxType {
@@ -7,1 +10,14 @@ COIN = 'COIN',
 }
+
+export type EthTransactionRequest = {
+  to?: string;
+  from?: string;
+  path?: string;
+  nonce?: BigNumberish;
+
+  gasLimit?: BigNumberish;
+  gasPrice?: BigNumberish;
+
+  data?: BytesLike;
+  value?: BigNumberish;
+};

src/user.ts

@@ -6,2 +6,3 @@ import { CryptoBuffer } from './crypto';
 export const FaceShare1LocalKey = 'Face-Share1';
+export const FaceVersionLocalKey = 'Face-Version';
 export const WalletPath = `m/44'/60'/1'/0/0`;
@@ -8,0 +9,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

81678

increased by18.54%

Number of package files

62

increased by8.77%

Lines of code

1674

increased by19.83%

Worsened metrics

Dependency count

3

increased by200%

Number of low quality alerts

2

increased by100%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedbn.js@^5.2.1

• + Addednear-api-js@^1.1.0

• + Addedbase-x@3.0.10(transitive)

• + Addedborsh@0.7.0(transitive)

• + Addedbs58@4.0.1(transitive)

• + Addedcapability@0.2.5(transitive)

• + Addeddepd@1.1.22.0.0(transitive)

• + Addederror-polyfill@0.1.3(transitive)

• + Addedhttp-errors@1.8.1(transitive)

• + Addedjs-sha256@0.9.0(transitive)

• + Addedmustache@4.2.0(transitive)

• + Addednear-api-js@1.1.0(transitive)

• + Addednode-fetch@2.7.0(transitive)

• + Addedo3@1.0.3(transitive)

• + Addedsafe-buffer@5.2.1(transitive)

• + Addedsetprototypeof@1.2.0(transitive)

• + Addedstatuses@1.5.0(transitive)

• + Addedtext-encoding-utf-8@1.0.2(transitive)

• + Addedtoidentifier@1.0.1(transitive)

• + Addedtr46@0.0.3(transitive)

• + Addedtweetnacl@1.0.3(transitive)

• + Addedu3@0.1.1(transitive)

• + Addedwebidl-conversions@3.0.1(transitive)

• + Addedwhatwg-url@5.0.0(transitive)