@orb-labs/orby-core 0.0.1

package/dist/utils/utils.js

@@ -0,0 +1,319 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBlockchainFromName = exports.getBlockchainIdFromBlockchain = exports.getChainIdFromOrbyChainId = exports.extractGasSponsorshipData = exports.extractGasSponsorshipInformation = exports.extractGasSpendForInstance = exports.extractGasSpendForInstances = exports.extractGasSponsorshipPolicy = exports.extractAllowlistWithOpenFallback = exports.extractMaxAmountPerInterval = exports.extractBlockchainInformation = exports.extractBlockchainInformations = exports.extractStandardizedToken = exports.extractStandardizedTokens = exports.extractStandardizedBalance = exports.extractStandardizedBalances = exports.extractFungibleTokenOverview = exports.extractActivities = exports.extractOperationStatus = exports.extractOperationStatuses = exports.extractIntent = exports.extractOnchainOperation = exports.extractOperationSet = exports.extractAccountCluster = void 0;
+const enums_1 = require("../enums");
+const constants_1 = require("../constants");
+const currency_amount_1 = require("../entities/financial/currency_amount");
+const state_1 = require("../entities/state");
+const currency_1 = require("../entities/financial/currency");
+const fungible_token_amount_1 = require("../entities/financial/fungible_token_amount");
+const fungible_token_1 = require("../entities/financial/fungible_token");
+const account_1 = require("../entities/account");
+const extractAccountCluster = (accountCluster) => {
+    var _a;
+    if (!accountCluster) {
+        return undefined;
+    }
+    return {
+        accountClusterId: accountCluster.accountClusterId,
+        accounts: (_a = accountCluster === null || accountCluster === void 0 ? void 0 : accountCluster.accounts) === null || _a === void 0 ? void 0 : _a.map((account) => account_1.Account.toAccount(account)),
+    };
+};
+exports.extractAccountCluster = extractAccountCluster;
+const extractOperationSet = (operations) => {
+    if (!operations) {
+        return undefined;
+    }
+    return operations.map((operation) => {
+        var _a;
+        return {
+            status: operation.status,
+            primaryOperation: (0, exports.extractOnchainOperation)(operation.primaryOperation),
+            primaryOperationPreconditions: state_1.State.toState(operation.primaryOperationPreconditions),
+            inputState: state_1.State.toState(operation.inputState),
+            outputState: state_1.State.toState(operation.outputState),
+            intents: (_a = operation.intents) === null || _a === void 0 ? void 0 : _a.map((intent) => (0, exports.extractIntent)(intent)),
+            aggregateNetworkFeeInFiatCurrency: currency_amount_1.CurrencyAmount.toCurrencyAmount(operation.aggregateNetworkFeeInFiatCurrency),
+            aggregateOperationFeeInFiatCurrency: currency_amount_1.CurrencyAmount.toCurrencyAmount(operation.aggregateOperationFeeInFiatCurrency),
+            aggregateEstimatedTimeInMs: operation.aggregateEstimatedTimeInMs,
+        };
+    });
+};
+exports.extractOperationSet = extractOperationSet;
+const extractOnchainOperation = (onchainOperation) => {
+    if (!onchainOperation) {
+        return undefined;
+    }
+    return {
+        chainId: (0, exports.getChainIdFromOrbyChainId)(onchainOperation.chainId),
+        data: onchainOperation.data,
+        estimatedNetworkFees: currency_amount_1.CurrencyAmount.toCurrencyAmount(onchainOperation.estimatedNetworkFees),
+        estimatedNetworkFeesInFiatCurrency: currency_amount_1.CurrencyAmount.toCurrencyAmount(onchainOperation.estimatedNetworkFeesInFiatCurrency),
+        estimatedTimeInMs: onchainOperation.estimatedTimeInMs
+            ? BigInt(onchainOperation.estimatedTimeInMs)
+            : undefined,
+        format: onchainOperation.format,
+        from: onchainOperation.from,
+        gasLimit: onchainOperation.gasLimit
+            ? BigInt(onchainOperation.gasLimit)
+            : undefined,
+        gasPrice: onchainOperation.gasPrice
+            ? BigInt(onchainOperation.gasPrice)
+            : undefined,
+        inputState: state_1.State.toState(onchainOperation.inputState),
+        maxFeePerGas: onchainOperation.maxFeePerGas
+            ? BigInt(onchainOperation.maxFeePerGas)
+            : undefined,
+        maxPriorityFeePerGas: onchainOperation.maxPriorityFeePerGas
+            ? BigInt(onchainOperation.maxPriorityFeePerGas)
+            : undefined,
+        nativeCurrency: currency_1.Currency.toCurrency(onchainOperation.nativeCurrency),
+        nonce: onchainOperation.nonce ? BigInt(onchainOperation.nonce) : undefined,
+        outputState: state_1.State.toState(onchainOperation.outputState),
+        to: onchainOperation.to,
+        txRpcUrl: onchainOperation.txRpcUrl,
+        type: onchainOperation.type,
+        value: onchainOperation.value ? BigInt(onchainOperation.value) : undefined,
+    };
+};
+exports.extractOnchainOperation = extractOnchainOperation;
+const extractIntent = (intent) => {
+    if (!intent) {
+        return undefined;
+    }
+    return {
+        estimatedProtocolFees: fungible_token_amount_1.FungibleTokenAmount.toFungibleTokenAmount(intent.estimatedProtocolFees),
+        estimatedProtocolFeesInFiatCurrency: currency_amount_1.CurrencyAmount.toCurrencyAmount(intent.estimatedProtocolFeesInFiatCurrency),
+        inputState: state_1.State.toState(intent.inputState),
+        intentOperations: intent.intentOperations.map((operation) => (0, exports.extractOnchainOperation)(operation)),
+        outputState: state_1.State.toState(intent.outputState),
+    };
+};
+exports.extractIntent = extractIntent;
+const extractOperationStatuses = (operationStatus) => {
+    return operationStatus === null || operationStatus === void 0 ? void 0 : operationStatus.map((status) => (0, exports.extractOperationStatus)(status));
+};
+exports.extractOperationStatuses = extractOperationStatuses;
+const extractOperationStatus = (status) => {
+    if (!status) {
+        return undefined;
+    }
+    return {
+        blockHash: status.blockHash,
+        blockNumber: status.blockNumber ? BigInt(status.blockNumber) : undefined,
+        chainId: status.chainId
+            ? (0, exports.getChainIdFromOrbyChainId)(status.chainId)
+            : undefined,
+        errorReason: status.errorReason,
+        hash: status.hash,
+        id: status.id,
+        status: status.status,
+        type: status.type,
+    };
+};
+exports.extractOperationStatus = extractOperationStatus;
+const extractActivities = (activities) => {
+    if (!activities) {
+        return undefined;
+    }
+    return activities.map((activity) => {
+        return {
+            aggregateFiatValueOfInputState: currency_amount_1.CurrencyAmount.toCurrencyAmount(activity.aggregateFiatValueOfInputState),
+            aggregateFiatValueOfOutputState: currency_amount_1.CurrencyAmount.toCurrencyAmount(activity.aggregateFiatValueOfOutputState),
+            aggregateNetworkFeesInFiatCurrency: currency_amount_1.CurrencyAmount.toCurrencyAmount(activity.aggregateNetworkFeesInFiatCurrency),
+            aggregateProtocolFeesInFiatCurrency: currency_amount_1.CurrencyAmount.toCurrencyAmount(activity.aggregateProtocolFeesInFiatCurrency),
+            category: activity.category,
+            initiateAt: activity.initiateAt,
+            inputState: state_1.State.toState(activity.inputState),
+            operationStatuses: (0, exports.extractOperationStatus)(activity.operationStatuses),
+            outputState: state_1.State.toState(activity.outputState),
+            overallStatus: activity.overallStatus,
+        };
+    });
+};
+exports.extractActivities = extractActivities;
+const extractFungibleTokenOverview = (overview) => {
+    if (!overview) {
+        return undefined;
+    }
+    return {
+        tokenCount: overview.tokenCount,
+        hiddenTokenCount: overview.hiddenTokenCount,
+        totalValueInFiat: currency_amount_1.CurrencyAmount.toCurrencyAmount(overview.totalValueInFiat),
+    };
+};
+exports.extractFungibleTokenOverview = extractFungibleTokenOverview;
+const extractStandardizedBalances = (balances) => {
+    return balances === null || balances === void 0 ? void 0 : balances.map((balance) => (0, exports.extractStandardizedBalance)(balance));
+};
+exports.extractStandardizedBalances = extractStandardizedBalances;
+const extractStandardizedBalance = (balance) => {
+    if (!balance) {
+        return undefined;
+    }
+    return {
+        standardizedTokenId: balance.standardizedTokenId,
+        tokenBalances: balance.tokenBalances.map((ft) => fungible_token_amount_1.FungibleTokenAmount.toFungibleTokenAmount(ft)),
+        tokenBalancesOnChains: balance.tokenBalancesOnChains.map((ft) => fungible_token_amount_1.FungibleTokenAmount.toFungibleTokenAmount(ft)),
+        total: currency_amount_1.CurrencyAmount.toCurrencyAmount(balance.total),
+        totalValueInFiat: currency_amount_1.CurrencyAmount.toCurrencyAmount(balance.totalValueInFiat),
+    };
+};
+exports.extractStandardizedBalance = extractStandardizedBalance;
+const extractStandardizedTokens = (tokens) => {
+    return tokens === null || tokens === void 0 ? void 0 : tokens.map((token) => (0, exports.extractStandardizedToken)(token));
+};
+exports.extractStandardizedTokens = extractStandardizedTokens;
+const extractStandardizedToken = (token) => {
+    if (!token) {
+        return undefined;
+    }
+    return {
+        stardardizedTokenId: token.stardardizedTokenId,
+        currency: currency_1.Currency.toCurrency(token.currency),
+        priceInFiat: currency_amount_1.CurrencyAmount.toCurrencyAmount(token.priceInFiat),
+        tokens: token.tokens.map((ft) => fungible_token_1.FungibleToken.toFungibleToken(ft)),
+    };
+};
+exports.extractStandardizedToken = extractStandardizedToken;
+const extractBlockchainInformations = (blockchainInformation) => {
+    return blockchainInformation === null || blockchainInformation === void 0 ? void 0 : blockchainInformation.map((info) => (0, exports.extractBlockchainInformation)(info));
+};
+exports.extractBlockchainInformations = extractBlockchainInformations;
+const extractBlockchainInformation = (blockchainInformation) => {
+    if (!blockchainInformation) {
+        return undefined;
+    }
+    return {
+        chainId: (0, exports.getChainIdFromOrbyChainId)(blockchainInformation.chainId),
+        environment: blockchainInformation.environment,
+        logoUrl: blockchainInformation.logoUrl,
+        name: blockchainInformation.name,
+    };
+};
+exports.extractBlockchainInformation = extractBlockchainInformation;
+const extractMaxAmountPerInterval = (maxAmountPerInterval) => {
+    if (!maxAmountPerInterval) {
+        return undefined;
+    }
+    return {
+        amount: maxAmountPerInterval.amount,
+        interval: {
+            amount: maxAmountPerInterval.interval.amount,
+            unit: maxAmountPerInterval.interval.unit,
+        },
+    };
+};
+exports.extractMaxAmountPerInterval = extractMaxAmountPerInterval;
+const extractAllowlistWithOpenFallback = (allowlist) => {
+    if (!allowlist) {
+        return undefined;
+    }
+    return {
+        tokenAllowlist: {
+            tokenAllowlistType: allowlist.tokenAllowlist.tokenAllowlistType,
+            sponsoredFunctions: allowlist.tokenAllowlist.sponsoredFunctions,
+        },
+        arbitraryContractAllowlist: allowlist.arbitraryContractAllowlist,
+    };
+};
+exports.extractAllowlistWithOpenFallback = extractAllowlistWithOpenFallback;
+const extractGasSponsorshipPolicy = (gasSponsorshipPolicy) => {
+    if (!gasSponsorshipPolicy) {
+        return undefined;
+    }
+    return {
+        maxTotalGasSpendForInstance: (0, exports.extractMaxAmountPerInterval)(gasSponsorshipPolicy.maxTotalGasSpendForInstance),
+        maxGasSpendPerTransaction: gasSponsorshipPolicy.maxGasSpendPerTransaction,
+        allowlistWithOpenFallback: (0, exports.extractAllowlistWithOpenFallback)(gasSponsorshipPolicy.allowlistWithOpenFallback),
+        maxTotalTransactionCountForInstance: (0, exports.extractMaxAmountPerInterval)(gasSponsorshipPolicy.maxTotalTransactionCountForInstance),
+        maxTotalGasSpendPerUser: (0, exports.extractMaxAmountPerInterval)(gasSponsorshipPolicy.maxTotalGasSpendPerUser),
+        maxTotalTransactionCountPerUser: (0, exports.extractMaxAmountPerInterval)(gasSponsorshipPolicy.maxTotalTransactionCountPerUser),
+    };
+};
+exports.extractGasSponsorshipPolicy = extractGasSponsorshipPolicy;
+const extractGasSpendForInstances = (gasSpendForInstances) => {
+    return gasSpendForInstances === null || gasSpendForInstances === void 0 ? void 0 : gasSpendForInstances.map((data) => (0, exports.extractGasSpendForInstance)(data));
+};
+exports.extractGasSpendForInstances = extractGasSpendForInstances;
+const extractGasSpendForInstance = (gasSpendForInstance) => {
+    if (!gasSpendForInstance) {
+        return;
+    }
+    return {
+        instanceName: gasSpendForInstance.instanceName,
+        gasSpentForInstance: (0, exports.extractGasSponsorshipData)(gasSpendForInstance.gasSpentForInstance),
+    };
+};
+exports.extractGasSpendForInstance = extractGasSpendForInstance;
+const extractGasSponsorshipInformation = (gasSponsorshipData) => {
+    return gasSponsorshipData === null || gasSponsorshipData === void 0 ? void 0 : gasSponsorshipData.map((data) => (0, exports.extractGasSponsorshipData)(data));
+};
+exports.extractGasSponsorshipInformation = extractGasSponsorshipInformation;
+const extractGasSponsorshipData = (gasSponsorshipData) => {
+    if (!gasSponsorshipData) {
+        return undefined;
+    }
+    return {
+        totalGasSpent: currency_amount_1.CurrencyAmount.toCurrencyAmount(gasSponsorshipData.totalGasSpent),
+        totalTransactionCount: gasSponsorshipData.totalTransactionCount,
+    };
+};
+exports.extractGasSponsorshipData = extractGasSponsorshipData;
+const getChainIdFromOrbyChainId = (value) => {
+    var _a;
+    let chainId = undefined;
+    const formattedValue = (_a = value === null || value === void 0 ? void 0 : value.trim()) === null || _a === void 0 ? void 0 : _a.toLowerCase();
+    if (formattedValue === null || formattedValue === void 0 ? void 0 : formattedValue.includes("eip155")) {
+        const publicIdElements = formattedValue.split("eip155-");
+        const potentialId = (publicIdElements === null || publicIdElements === void 0 ? void 0 : publicIdElements.length) > 1 ? publicIdElements[1] : undefined;
+        chainId = !Number.isNaN(Number(potentialId))
+            ? BigInt(potentialId)
+            : undefined;
+    }
+    else {
+        const blockchain = (0, exports.getBlockchainFromName)(formattedValue);
+        const potentialId = blockchain
+            ? (0, exports.getBlockchainIdFromBlockchain)(blockchain)
+            : undefined;
+        chainId = potentialId ? BigInt(potentialId) : undefined;
+    }
+    return chainId;
+};
+exports.getChainIdFromOrbyChainId = getChainIdFromOrbyChainId;
+const getBlockchainIdFromBlockchain = (blockchain) => {
+    return constants_1.BLOCKCHAIN_ID[blockchain];
+};
+exports.getBlockchainIdFromBlockchain = getBlockchainIdFromBlockchain;
+const getBlockchainFromName = (chainName) => {
+    var _a;
+    const formattedChainName = (_a = chainName === null || chainName === void 0 ? void 0 : chainName.toLowerCase()) === null || _a === void 0 ? void 0 : _a.replace("-", "_");
+    switch (formattedChainName) {
+        case "bnbt": {
+            return enums_1.Blockchain.BINANCE_TESTNET;
+        }
+        case "matic_amoy": {
+            return enums_1.Blockchain.POLYGON_AMOY;
+        }
+        case "matic": {
+            return enums_1.Blockchain.POLYGON;
+        }
+        case "mainnet": {
+            return enums_1.Blockchain.ETHEREUM;
+        }
+        case "holesky": {
+            return enums_1.Blockchain.ETHEREUM_HOLESKY;
+        }
+        case "sepolia": {
+            return enums_1.Blockchain.ETHEREUM_SEPOLIA;
+        }
+        case "unknown": {
+            return undefined;
+        }
+        default: {
+            //statements;
+            return formattedChainName;
+        }
+    }
+};
+exports.getBlockchainFromName = getBlockchainFromName;

package/dist/utils/validateAndParseAddress.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Validates an address and returns the parsed (checksummed) version of that address
+ * @param address the unchecksummed hex address
+ */
+export declare function validateAndParseAddress(address: string): string;
+/**
+ * Checks if an address is valid by checking 0x prefix, length === 42 and hex encoding.
+ * @param address the unchecksummed hex address
+ */
+export declare function checkValidAddress(address: string): string;

package/dist/utils/validateAndParseAddress.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateAndParseAddress = validateAndParseAddress;
+exports.checkValidAddress = checkValidAddress;
+const address_1 = require("@ethersproject/address");
+/**
+ * Validates an address and returns the parsed (checksummed) version of that address
+ * @param address the unchecksummed hex address
+ */
+function validateAndParseAddress(address) {
+    try {
+        return (0, address_1.getAddress)(address);
+    }
+    catch (error) {
+        throw new Error(`${address} is not a valid address.`);
+    }
+}
+// Checks a string starts with 0x, is 42 characters long and contains only hex characters after 0x
+const startsWith0xLen42HexRegex = /^0x[0-9a-fA-F]{40}$/;
+/**
+ * Checks if an address is valid by checking 0x prefix, length === 42 and hex encoding.
+ * @param address the unchecksummed hex address
+ */
+function checkValidAddress(address) {
+    if (startsWith0xLen42HexRegex.test(address)) {
+        return address;
+    }
+    throw new Error(`${address} is not a valid address.`);
+}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@orb-labs/orby-core",
+  "version": "0.0.1",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc && tsc-alias",
+    "dev": "concurrently \"yarn:watch:tsc\" \"yarn:watch:alias\"",
+    "watch:tsc": "tsc -w",
+    "watch:alias": "nodemon --watch dist --exec \"tsc-alias -p tsconfig.json\""
+  },
+  "devDependencies": {
+    "@types/lodash": "^4.17.13",
+    "eslint": "^8",
+    "javascript-obfuscator": "^4.1.1",
+    "nodemon": "^3.0.3",
+    "tsc-alias": "^1.8.10",
+    "typescript": "^5.6.3"
+  }
+}