@rabby-wallet/rabby-action 0.1.0

package/dist/types/parsedActionData.d.ts

@@ -0,0 +1,161 @@
+import { TokenItem, NFTItem, RevokeTokenApproveAction, PushMultiSigAction, ApproveNFTAction, BatchSellNFTOrderAction, BuyNFTOrderAction, CreateCoboSafeAction, CreateKeyAction, SellNFTOrderAction, SendAction, SignMultiSigActions, SubmitDelegatedAddressModificationAction, SubmitSafeRoleModificationAction, SubmitTokenApprovalModificationAction, VerifyAddressAction, BatchPermit2Action, Permit2Action, PermitAction, RevokeNFTAction, SendNFTAction, ApproveAction, ApproveNFTCollectionAction, RevokeNFTCollectionAction, RevokePermit2Action } from '@rabby-wallet/rabby-api/dist/types';
+import { ActionType } from './parseAction';
+export interface ReceiveTokenItem extends TokenItem {
+    min_amount: number;
+    min_raw_amount: string;
+}
+interface PermitActionData extends PermitAction {
+    expire_at: number | undefined;
+}
+interface Permit2ActionData extends Permit2Action {
+    sig_expire_at: number | undefined;
+}
+interface BatchPermit2ActionData extends BatchPermit2Action {
+    sig_expire_at: number | undefined;
+}
+export type ParsedTransactionActionData = {
+    swap?: {
+        payToken: TokenItem;
+        receiveToken: ReceiveTokenItem;
+        minReceive: TokenItem;
+        slippageTolerance: number | null;
+        receiver: string;
+        usdValueDiff: string | null;
+        usdValuePercentage: number | null;
+        balanceChange: {
+            support: boolean;
+            success: boolean;
+        };
+    };
+    crossToken?: {
+        payToken: TokenItem;
+        receiveToken: ReceiveTokenItem;
+        receiver: string;
+        usdValueDiff: string;
+        usdValuePercentage: number;
+    };
+    crossSwapToken?: {
+        payToken: TokenItem;
+        receiveToken: ReceiveTokenItem;
+        receiver: string;
+        usdValueDiff: string;
+        usdValuePercentage: number;
+    };
+    approveToken?: ApproveAction;
+    sendNFT?: SendNFTAction;
+    revokeNFT?: RevokeNFTAction;
+    approveNFTCollection?: ApproveNFTCollectionAction;
+    revokeNFTCollection?: RevokeNFTCollectionAction;
+    revokeToken?: {
+        spender: string;
+        token: TokenItem;
+        gasUsed: number;
+    };
+    revokePermit2?: RevokePermit2Action;
+    wrapToken?: {
+        payToken: TokenItem;
+        receiveToken: ReceiveTokenItem;
+        slippageTolerance: number;
+        receiver: string;
+    };
+    unWrapToken?: {
+        payToken: TokenItem;
+        receiveToken: ReceiveTokenItem;
+        slippageTolerance: number;
+        receiver: string;
+    };
+    deployContract?: Record<string, never>;
+    cancelTx?: {
+        nonce: string;
+    };
+    pushMultiSig?: PushMultiSigAction;
+    permit2BatchRevokeToken?: {
+        permit2_id: string;
+        revoke_list: RevokeTokenApproveAction[];
+    };
+    approveNFT?: ApproveNFTAction;
+    send?: SendAction;
+    contractCall?: object;
+    assetOrder?: {
+        payTokenList: TokenItem[];
+        payNFTList: NFTItem[];
+        receiveTokenList: TokenItem[];
+        receiveNFTList: NFTItem[];
+        takers: string[];
+        receiver: string | null;
+        expireAt: string | null;
+    };
+    common?: {
+        title: string;
+        desc: string;
+        is_asset_changed: boolean;
+        is_involving_privacy: boolean;
+        receiver?: string;
+        from: string;
+    };
+};
+export type ParsedTypedDataActionData = {
+    chainId?: string;
+    brand?: {
+        logo_url: string;
+        name: string;
+    };
+    contractId?: string;
+    sender: string;
+    actionType: string | null;
+    sellNFT?: SellNFTOrderAction;
+    batchSellNFT?: BatchSellNFTOrderAction;
+    signMultiSig?: SignMultiSigActions;
+    buyNFT?: BuyNFTOrderAction;
+    permit?: PermitActionData;
+    permit2?: Permit2ActionData;
+    batchPermit2?: BatchPermit2ActionData;
+    swapTokenOrder?: {
+        payToken: TokenItem;
+        receiveToken: TokenItem;
+        receiver: string;
+        usdValueDiff: string;
+        usdValuePercentage: number;
+        expireAt: number | null;
+    };
+    createKey?: CreateKeyAction;
+    verifyAddress?: VerifyAddressAction;
+    coboSafeCreate?: CreateCoboSafeAction;
+    coboSafeModificationDelegatedAddress?: SubmitSafeRoleModificationAction;
+    coboSafeModificationRole?: SubmitDelegatedAddressModificationAction;
+    coboSafeModificationTokenApproval?: SubmitTokenApprovalModificationAction;
+    revokePermit?: RevokeTokenApproveAction;
+    approveNFT?: ApproveNFTAction;
+    send?: SendAction;
+    contractCall?: object;
+    assetOrder?: {
+        payTokenList: TokenItem[];
+        payNFTList: NFTItem[];
+        receiveTokenList: TokenItem[];
+        receiveNFTList: NFTItem[];
+        takers: string[];
+        receiver: string | null;
+        expireAt: string | null;
+    };
+    common?: {
+        title: string;
+        desc: string;
+        is_asset_changed: boolean;
+        is_involving_privacy: boolean;
+        receiver?: string;
+        from: string;
+    };
+};
+export type ParsedTextActionData = {
+    sender: string;
+    createKey?: CreateKeyAction;
+    verifyAddress?: VerifyAddressAction;
+    common?: {
+        desc: string;
+        title: string;
+        is_asset_changed: boolean;
+        is_involving_privacy: boolean;
+    };
+};
+export type ParsedActionData<T extends ActionType | undefined = undefined> = T extends 'typed_data' ? ParsedTypedDataActionData : T extends 'transaction' ? ParsedTransactionActionData : T extends 'text' ? ParsedTextActionData : ParsedTransactionActionData | ParsedTypedDataActionData | ParsedTextActionData;
+export {};

package/dist/types/parsedActionData.js

@@ -0,0 +1 @@
+export {};

package/dist/types/walletProvider.d.ts

@@ -0,0 +1,79 @@
+import { Tx, TxPushType, ExplainTxResponse, BasicDappInfo } from '@rabby-wallet/rabby-api/dist/types';
+import { ParsedActionData } from './parsedActionData';
+import { ActionRequireData } from './actionRequireData';
+import { CHAINS_ENUM, Chain } from '@debank/common';
+export interface ConnectedSite {
+    origin: string;
+    icon: string;
+    name: string;
+    chain: CHAINS_ENUM;
+    e?: number;
+    isSigned: boolean;
+    isTop: boolean;
+    order?: number;
+    isConnected: boolean;
+    preferMetamask?: boolean;
+    isFavorite?: boolean;
+    info?: BasicDappInfo;
+}
+export interface TransactionHistoryItem {
+    rawTx: Tx;
+    createdAt: number;
+    isCompleted: boolean;
+    hash?: string;
+    failed: boolean;
+    gasUsed?: number;
+    isSubmitFailed?: boolean;
+    site?: ConnectedSite;
+    pushType?: TxPushType;
+    reqId?: string;
+    isWithdrawed?: boolean;
+    explain?: TransactionGroup['explain'];
+    action?: TransactionGroup['action'];
+}
+export interface TransactionSigningItem {
+    rawTx: Tx;
+    explain?: ExplainTxResponse & {
+        approvalId: string;
+        calcSuccess: boolean;
+    };
+    action?: {
+        actionData: ParsedActionData;
+        requiredData: ActionRequireData;
+    };
+    id: string;
+    isSubmitted?: boolean;
+}
+export interface TransactionGroup {
+    chainId: number;
+    nonce: number;
+    txs: TransactionHistoryItem[];
+    isPending: boolean;
+    createdAt: number;
+    explain?: ExplainTxResponse & {
+        approvalId: string;
+        calcSuccess: boolean;
+    };
+    action?: {
+        actionData: ParsedActionData;
+        requiredData: ActionRequireData;
+    };
+    isFailed: boolean;
+    isSubmitFailed?: boolean;
+    $ctx?: any;
+}
+export type WalletProvider = {
+    hasAddress: (address: string) => Promise<boolean>;
+    hasPrivateKeyInWallet: (address: string) => Promise<string>;
+    getWhitelist: () => Promise<string[]>;
+    isWhitelistEnabled: () => Promise<boolean>;
+    getPendingTxsByNonce: (address: string, chainId: number, nonce: number) => Promise<any[]>;
+    findChain: (params: {
+        enum?: CHAINS_ENUM | string | null;
+        id?: number | null;
+        serverId?: string | null;
+        hex?: string | null;
+        networkId?: string | null;
+    }) => Chain | null | undefined;
+    ALIAS_ADDRESS: Record<string, string>;
+};

package/dist/types/walletProvider.js

@@ -0,0 +1 @@
+export {};

package/dist/utils/calcSlippageTolerance.d.ts

@@ -0,0 +1 @@
+export declare const calcSlippageTolerance: (base: string, actual: string) => number;

package/dist/utils/calcSlippageTolerance.js

@@ -0,0 +1,12 @@
+import BigNumber from 'bignumber.js';
+export const calcSlippageTolerance = (base, actual) => {
+    const baseBn = new BigNumber(base);
+    const actualBn = new BigNumber(actual);
+    if (baseBn.eq(0) && actualBn.eq(0))
+        return 0;
+    if (baseBn.eq(0))
+        return 1;
+    if (actualBn.eq(0))
+        return -1;
+    return baseBn.minus(actualBn).div(baseBn).toNumber();
+};

package/dist/utils/calcUSDValueChange.d.ts

@@ -0,0 +1 @@
+export declare const calcUSDValueChange: (pay: string, receive: string) => number;

package/dist/utils/calcUSDValueChange.js

@@ -0,0 +1,12 @@
+import BigNumber from 'bignumber.js';
+export const calcUSDValueChange = (pay, receive) => {
+    const payBn = new BigNumber(pay);
+    const receiveBn = new BigNumber(receive);
+    if (payBn.eq(0) && receiveBn.eq(0))
+        return 0;
+    if (payBn.eq(0))
+        return 1;
+    if (receiveBn.eq(0))
+        return -1;
+    return receiveBn.minus(payBn).div(payBn).toNumber();
+};

package/dist/utils/getProtocol.d.ts

@@ -0,0 +1,6 @@
+import { AddrDescResponse } from '@rabby-wallet/rabby-api/dist/types';
+export declare const getProtocol: (protocolMap: AddrDescResponse["desc"]["protocol"], chainId: string) => {
+    id: string;
+    logo_url: string;
+    name: string;
+} | null;

package/dist/utils/getProtocol.js

@@ -0,0 +1,7 @@
+export const getProtocol = (protocolMap, chainId) => {
+    if (!protocolMap)
+        return null;
+    if (protocolMap[chainId])
+        return protocolMap[chainId];
+    return null;
+};

package/dist/utils/isSameAddress.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @description compare address is same, ignore case
+ */
+export declare const isSameAddress: (a: string, b: string) => boolean;

package/dist/utils/isSameAddress.js

@@ -0,0 +1,8 @@
+/**
+ * @description compare address is same, ignore case
+ */
+export const isSameAddress = (a, b) => {
+    if (!a || !b)
+        return false;
+    return a.toLowerCase() === b.toLowerCase();
+};

package/dist/utils/keyring.d.ts

@@ -0,0 +1,10 @@
+export declare const KEYRING_TYPE: {
+    readonly HdKeyring: "HD Key Tree";
+    readonly SimpleKeyring: "Simple Key Pair";
+    readonly HardwareKeyring: "hardware";
+    readonly WatchAddressKeyring: "Watch Address";
+    readonly WalletConnectKeyring: "WalletConnect";
+    readonly GnosisKeyring: "Gnosis";
+    readonly CoboArgusKeyring: "CoboArgus";
+    readonly CoinbaseKeyring: "Coinbase";
+};

package/dist/utils/keyring.js

@@ -0,0 +1,10 @@
+export const KEYRING_TYPE = {
+    HdKeyring: 'HD Key Tree',
+    SimpleKeyring: 'Simple Key Pair',
+    HardwareKeyring: 'hardware',
+    WatchAddressKeyring: 'Watch Address',
+    WalletConnectKeyring: 'WalletConnect',
+    GnosisKeyring: 'Gnosis',
+    CoboArgusKeyring: 'CoboArgus',
+    CoinbaseKeyring: 'Coinbase',
+};

package/dist/utils/parseTextAction.d.ts

@@ -0,0 +1,2 @@
+import { ParseAction, ParsedActionData, ParseTextActionParameters } from '../types';
+export declare const parseTextAction: (fn: (options: ParseTextActionParameters) => Partial<ParsedActionData>) => ParseAction<"text">;

package/dist/utils/parseTextAction.js

@@ -0,0 +1,9 @@
+export const parseTextAction = (fn) => {
+    return (options) => {
+        const { sender } = options;
+        const result = {
+            sender,
+        };
+        return Object.assign(Object.assign({}, result), fn(options));
+    };
+};

package/dist/utils/parseTypedDataAction.d.ts

@@ -0,0 +1,2 @@
+import { ParseAction, ParsedActionData, ParseTypedDataActionParameters } from '../types';
+export declare const parseTypedDataAction: (fn: (options: ParseTypedDataActionParameters) => Partial<ParsedActionData>) => ParseAction<"typed_data">;

package/dist/utils/parseTypedDataAction.js

@@ -0,0 +1,25 @@
+export const parseTypedDataAction = (fn) => {
+    return (options) => {
+        var _a;
+        const { data, typedData, sender } = options;
+        const result = {
+            sender,
+            actionType: null,
+            brand: (_a = data === null || data === void 0 ? void 0 : data.data) === null || _a === void 0 ? void 0 : _a.brand,
+        };
+        if (typedData === null || typedData === void 0 ? void 0 : typedData.domain) {
+            if (typedData.domain.verifyingContract) {
+                result.contractId = typedData.domain.verifyingContract;
+            }
+            if (typedData.domain.chainId) {
+                result.chainId = typedData.domain.chainId;
+            }
+        }
+        result.actionType = (data === null || data === void 0 ? void 0 : data.type) || null;
+        const action = fn(options);
+        if ('contractCall' in action && action.contractCall && result.actionType) {
+            result.actionType = 'contractCall';
+        }
+        return Object.assign(Object.assign({}, result), action);
+    };
+};

package/dist/utils/waitQueueFinished.d.ts

@@ -0,0 +1,2 @@
+import PQueue from 'p-queue';
+export declare const waitQueueFinished: (q: PQueue) => Promise<unknown>;

package/dist/utils/waitQueueFinished.js

@@ -0,0 +1,8 @@
+export const waitQueueFinished = (q) => {
+    return new Promise((resolve) => {
+        q.on('empty', () => {
+            if (q.pending <= 0)
+                resolve(null);
+        });
+    });
+};

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@rabby-wallet/rabby-action",
+  "version": "0.1.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "p-queue": "^8.0.1"
+  },
+  "devDependencies": {
+    "@babel/preset-env": "^7.19.1",
+    "@debank/common": "^0.3.60",
+    "@rabby-wallet/rabby-api": "^0.7.26",
+    "@rabby-wallet/rabby-security-engine": "^2.0.5",
+    "@types/jest": "^29.0.3",
+    "@types/lodash": "^4.14.185",
+    "@types/node": "^18.7.18",
+    "babel-jest": "^29.0.3",
+    "bignumber.js": "^9.1.2",
+    "husky": ">=6",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "jest-mock-axios": "^4.7.0-beta",
+    "lint-staged": ">=10",
+    "prettier": "^2.7.1",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^29.2.4",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.5.4"
+  },
+  "scripts": {
+    "test": "jest",
+    "build": "rimraf dist && tsc",
+    "preversion": "npm run build",
+    "prepublishOnly": "npm run build && npm run test",
+    "prepare": "husky install"
+  },
+  "peerDependencies": {
+    "@debank/common": "^0.3.60",
+    "@rabby-wallet/rabby-api": "^0.7.26",
+    "@rabby-wallet/rabby-security-engine": "^2.0.5",
+    "bignumber.js": "*"
+  },
+  "author": "rabby",
+  "description": "",
+  "license": "MIT",
+  "lint-staged": {
+    "*.{ts,css,md}": "prettier --write"
+  },
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
+}