@orb-labs/orby-core 0.0.18 → 0.0.20

package/dist/esm/constants.js

@@ -14,6 +14,7 @@ export const BLOCKCHAIN_ID = {
     [Blockchain.MOONBEAM]: 1284,
     [Blockchain.BASE]: 8453,
     [Blockchain.AVALANCHE]: 43114,
+    [Blockchain.SOLANA]: 101,
     // testnets
     [Blockchain.ETHEREUM_SEPOLIA]: 11155111,
     [Blockchain.ETHEREUM_HOLESKY]: 17000,
@@ -70,6 +71,10 @@ export const CHAIN_CONFIGS = {
         environment: BlockchainEnvironment.MAINNET,
         chainId: BigInt(43114),
     },
+    [Blockchain.SOLANA]: {
+        environment: BlockchainEnvironment.MAINNET,
+        chainId: BigInt(101),
+    },
     // testnets
     [Blockchain.ETHEREUM_SEPOLIA]: {
         environment: BlockchainEnvironment.TESTNET,
@@ -119,6 +124,7 @@ export const BLOCKCHAIN_ID_TO_BLOCKCHAIN = {
     [1284]: Blockchain.MOONBEAM,
     [8453]: Blockchain.BASE,
     [43114]: Blockchain.AVALANCHE,
+    [101]: Blockchain.SOLANA,
     // testnets
     [11155111]: Blockchain.ETHEREUM_SEPOLIA,
     [84532]: Blockchain.BASE_SEPOLIA,

package/dist/esm/entities/account.js

@@ -1,19 +1,21 @@
 import { AccountType } from "../enums.js";
 import { getChainIdFromOrbyChainId } from "../utils/utils.js";
+import { validateAndFormatAddress } from "../utils/validateAndParseAddress.js";
 export class Account {
     static toAccount(account) {
         const chainId = account?.chainId
             ? getChainIdFromOrbyChainId(account.chainId)
             : undefined;
-        if (!chainId && account?.type == AccountType.SCA) {
+        if (!chainId && account?.accountType == AccountType.SCA) {
             return undefined;
         }
-        return new Account(account.address, account?.type, account.vmType, chainId);
+        return new Account(account.address, account?.accountType, // backend uses accountType, frontend uses type
+        account.vmType, chainId);
     }
     constructor(address, type, vmType, chainId) {
         // TODO(felix): add this back
         // invariant(!_.isUndefined(getBlockchainFromBlockchainId(chainId)), "CHAIN_ID");
-        this.address = address?.toLowerCase(); // validateAndParseAddress(address)?.toLowerCase();
+        this.address = validateAndFormatAddress(address);
         this.chainId = chainId ? BigInt(chainId) : undefined;
         this.type = type;
         this.vmType = vmType;
@@ -27,13 +29,13 @@ export class Account {
     }
     static key(address, chainId) {
         return chainId
-            ? `${chainId?.toString()?.toLowerCase()}-${address}`
+            ? `${chainId?.toString()}-${validateAndFormatAddress(address)}`
             : address;
     }
     toAccountModel() {
         return {
             address: this.address,
-            type: this.type?.toUpperCase(),
+            accountType: this.type?.toUpperCase(), // backend uses accountType, frontend uses type
             vmType: this.vmType?.toUpperCase(),
             chainId: this.chainId ? "EIP155-" + this.chainId : undefined,
         };

package/dist/esm/entities/financial/fungible_token.js

@@ -1,5 +1,5 @@
 import { Currency } from "./currency.js";
-import { checkValidAddress, validateAndParseAddress, } from "../../utils/validateAndParseAddress.js";
+import { validateAndFormatAddress, } from "../../utils/validateAndParseAddress.js";
 import { TokenType } from "../../enums.js";
 /**
  * Represents an ERC20 token with a unique address and some metadata.
@@ -28,10 +28,10 @@ export class FungibleToken extends Currency {
         // TODO(felix): bypassChecksum is a little confusing since when bypassChecksum is true, we still validate the address
         // bypassChecksum is derived from the isNative parameter, so we should remove it and just check if isNative here
         if (bypassChecksum) {
-            this.address = checkValidAddress(address)?.toLowerCase();
+            this.address = validateAndFormatAddress(address);
         }
         else if (!isNative) {
-            this.address = validateAndParseAddress(address)?.toLowerCase();
+            this.address = validateAndFormatAddress(address);
         }
         else {
             this.address = address;
@@ -47,7 +47,8 @@ export class FungibleToken extends Currency {
         if (this === other)
             return true;
         return (this.chainId == other?.chainId &&
-            this.address.toLowerCase() == other?.address?.toLowerCase());
+            validateAndFormatAddress(this.address) ==
+                validateAndFormatAddress(other?.address));
     }
     /**
      * Returns the currency object that this token represents
@@ -59,6 +60,6 @@ export class FungibleToken extends Currency {
         return TokenType.FUNGIBLE_TOKEN;
     }
     identifier() {
-        return `${this.chainId}+${this.address.toLowerCase()}`;
+        return `${this.chainId}+${validateAndFormatAddress(this.address)}`;
     }
 }

package/dist/esm/entities/financial/non_fungible_token.js

@@ -1,5 +1,5 @@
 import { Asset } from "./asset.js";
-import { checkValidAddress, validateAndParseAddress, } from "../../utils/validateAndParseAddress.js";
+import { validateAndFormatAddress, } from "../../utils/validateAndParseAddress.js";
 import { TokenType } from "../../enums.js";
 /**
  * Represents an ERC721 token with a unique address and some metadata.
@@ -20,10 +20,10 @@ export class NonFungibleToken extends Asset {
         this.isNative = false;
         this.isToken = true;
         if (bypassChecksum) {
-            this.address = checkValidAddress(address)?.toLowerCase();
+            this.address = validateAndFormatAddress(address);
         }
         else {
-            this.address = validateAndParseAddress(address)?.toLowerCase();
+            this.address = validateAndFormatAddress(address);
         }
         this.chainId = chainId;
         this.url = url;
@@ -44,7 +44,7 @@ export class NonFungibleToken extends Asset {
         if (this === other)
             return true;
         return (this.chainId === other.chainId &&
-            this.address === other.address.toLowerCase());
+            this.address === validateAndFormatAddress(other.address));
     }
     /**
      * Returns the asset representation of this currency
@@ -56,6 +56,6 @@ export class NonFungibleToken extends Asset {
         return TokenType.NON_FUNGIBLE_TOKEN;
     }
     identifier() {
-        return `${this.chainId}+${this.address.toLowerCase()}`;
+        return `${this.chainId}+${validateAndFormatAddress(this.address)}`;
     }
 }

package/dist/esm/entities/financial/semi_fungible_token.js

@@ -1,5 +1,5 @@
 import { Currency } from "./currency.js";
-import { checkValidAddress, validateAndParseAddress, } from "../../utils/validateAndParseAddress.js";
+import { validateAndFormatAddress, } from "../../utils/validateAndParseAddress.js";
 import { TokenType } from "../../enums.js";
 /**
  * Represents an ERC1155 token with a unique address and some metadata.
@@ -22,10 +22,10 @@ export class SemiFungibleToken extends Currency {
         this.isNative = false;
         this.isToken = true;
         if (bypassChecksum) {
-            this.address = checkValidAddress(address)?.toLowerCase();
+            this.address = validateAndFormatAddress(address);
         }
         else {
-            this.address = validateAndParseAddress(address)?.toLowerCase();
+            this.address = validateAndFormatAddress(address);
         }
         this.chainId = chainId;
         this.url = url;
@@ -46,7 +46,7 @@ export class SemiFungibleToken extends Currency {
         if (this === other)
             return true;
         return (this.chainId === other.chainId &&
-            this.address === other.address.toLowerCase());
+            this.address === validateAndFormatAddress(other.address));
     }
     /**
      * Returns the currency object that this token represents
@@ -58,6 +58,6 @@ export class SemiFungibleToken extends Currency {
         return TokenType.SEMI_FUNGIBLE_TOKEN;
     }
     identifier() {
-        return `${this.chainId}+${this.address.toLowerCase()}`;
+        return `${this.chainId}+${validateAndFormatAddress(this.address)}`;
     }
 }

package/dist/esm/enums.d.ts

@@ -9,6 +9,7 @@ export declare enum Blockchain {
     OPTIMISM = "optimism",
     EVMOS = "evmos",
     MOONBEAM = "moonbeam",
+    SOLANA = "solana",
     ETHEREUM_SEPOLIA = "ethereum_sepolia",
     ETHEREUM_HOLESKY = "ethereum_holesky",
     BASE_SEPOLIA = "base_sepolia",
@@ -33,7 +34,8 @@ export declare enum AccountType {
     SCA = "SCA"
 }
 export declare enum VMType {
-    EVM = "EVM"
+    EVM = "EVM",
+    SVM = "SVM"
 }
 export declare enum ChainSupportStatus {
     CHAIN_SUPPORTED = "CHAIN_SUPPORTED",

package/dist/esm/enums.js

@@ -10,6 +10,7 @@ export var Blockchain;
     Blockchain["OPTIMISM"] = "optimism";
     Blockchain["EVMOS"] = "evmos";
     Blockchain["MOONBEAM"] = "moonbeam";
+    Blockchain["SOLANA"] = "solana";
     // testnets
     Blockchain["ETHEREUM_SEPOLIA"] = "ethereum_sepolia";
     Blockchain["ETHEREUM_HOLESKY"] = "ethereum_holesky";
@@ -40,6 +41,7 @@ export var AccountType;
 export var VMType;
 (function (VMType) {
     VMType["EVM"] = "EVM";
+    VMType["SVM"] = "SVM";
 })(VMType || (VMType = {}));
 export var ChainSupportStatus;
 (function (ChainSupportStatus) {

package/dist/esm/index.d.ts

@@ -27,3 +27,4 @@ export * from "./enums.js";
 export * from "./types.js";
 export * from "./constants.js";
 export * from "./utils/utils.js";
+export * from "./utils/validateAndParseAddress.js";

package/dist/esm/index.js

@@ -31,3 +31,4 @@ export * from "./enums.js";
 export * from "./types.js";
 export * from "./constants.js";
 export * from "./utils/utils.js";
+export * from "./utils/validateAndParseAddress.js";

package/dist/esm/interfaces/operation.d.ts

@@ -2,7 +2,7 @@ import { AccountCluster, OnchainOperation, OperationSet, OperationStatus, Signed
 import { CurrencyAmount } from "../entities/financial/currency_amount.js";
 import { OperationStatusType, QuoteType } from "../enums.js";
 export interface IOperationActions {
-    getOperationsToExecuteTransaction(accountClusterId: string, to: string, data: string, value?: bigint, gasToken?: {
+    getOperationsToExecuteTransaction(accountClusterId: string, data: string, to?: string, value?: bigint, gasToken?: {
         standardizedTokenId: string;
         tokenSources?: {
             chainId: bigint;
@@ -16,15 +16,22 @@ export interface IOperationActions {
             address?: string;
         }[];
     }): Promise<OperationSet>;
+    getOperationsToSignTransactionOrSignTypedData(accountClusterId: string, data: string, to?: string, value?: bigint, gasToken?: {
+        standardizedTokenId: string;
+        tokenSources?: {
+            chainId: bigint;
+            address?: string;
+        }[];
+    }): Promise<OperationSet>;
     getOperationsToCancelTransaction(accountClusterId: string, operationSetId: string): Promise<OperationSet>;
-    isTransactionPreconditionSatisfied(accountClusterId: string, to: string, data: string, value?: bigint): Promise<boolean>;
+    isTransactionPreconditionSatisfied(accountClusterId: string, data: string, to?: string, value?: bigint): Promise<boolean>;
     isTypedDataPreconditionSatisfied(accountClusterId: string, data: string): Promise<boolean>;
     sendSignedOperations(accountClusterId: string, signedOperations: SignedOperation[]): Promise<{
         operationSetId: string;
         operationResponses: OperationStatus[];
     }>;
     getOperationStatuses(operationIds: string[]): Promise<OperationStatus[]>;
-    estimateFiatCostToExecuteTransaction(to: string, data: string, value?: bigint): Promise<CurrencyAmount>;
+    estimateFiatCostToExecuteTransaction(data: string, to?: string, value?: bigint): Promise<CurrencyAmount>;
     estimateFiatCostToSignTypedData(data: string): Promise<CurrencyAmount>;
     getOperationsToTransferToken(accountClusterId: string, standardizedTokenId: string, amount: bigint, recipient: {
         chainId: bigint;

package/dist/esm/utils/utils.d.ts

@@ -1,5 +1,6 @@
-import { Blockchain } from "../enums.js";
+import { Blockchain, VMType } from "../enums.js";
 export declare const getChainIdFromOrbyChainId: (value: string) => bigint | undefined;
+export declare const getVirtualEnvironment: (id: bigint) => VMType;
 export declare const getOrbyChainId: (chainId: bigint) => string;
 export declare const getBlockchainIdFromBlockchain: (blockchain: Blockchain) => number;
 export declare const hasError: (data: any) => {

package/dist/esm/utils/utils.js

@@ -1,8 +1,9 @@
-import { Blockchain, BlockchainEnvironment } from "../enums.js";
+import { Blockchain, BlockchainEnvironment, VMType } from "../enums.js";
 import { BLOCKCHAIN_ID, BLOCKCHAIN_ID_TO_BLOCKCHAIN, CHAIN_CONFIGS, } from "../constants.js";
+import { validateAndLowerCase } from "./validateAndParseAddress.js";
 export const getChainIdFromOrbyChainId = (value) => {
     let chainId = undefined;
-    const formattedValue = value?.trim()?.toLowerCase();
+    const formattedValue = validateAndLowerCase(value);
     if (formattedValue?.includes("eip155")) {
         const publicIdElements = formattedValue.split("eip155-");
         const potentialId = publicIdElements?.length > 1 ? publicIdElements[1] : undefined;
@@ -10,6 +11,13 @@ export const getChainIdFromOrbyChainId = (value) => {
             ? BigInt(potentialId)
             : undefined;
     }
+    else if (formattedValue?.includes("svm")) {
+        const publicIdElements = formattedValue.split("svm-");
+        const potentialId = publicIdElements?.length > 1 ? publicIdElements[1] : undefined;
+        chainId = !Number.isNaN(Number(potentialId))
+            ? BigInt(potentialId)
+            : undefined;
+    }
     else {
         const blockchain = getBlockchainFromName(formattedValue);
         const potentialId = blockchain
@@ -19,11 +27,26 @@ export const getChainIdFromOrbyChainId = (value) => {
     }
     return chainId;
 };
+export const getVirtualEnvironment = (id) => {
+    const blockchain = id ? BLOCKCHAIN_ID_TO_BLOCKCHAIN[Number(id)] : undefined;
+    switch (blockchain) {
+        case undefined:
+            return undefined;
+        case Blockchain.SOLANA:
+            return VMType.SVM;
+        default:
+            return VMType.EVM;
+    }
+};
 export const getOrbyChainId = (chainId) => {
-    if (!chainId) {
-        return undefined;
+    switch (getVirtualEnvironment(chainId)) {
+        case VMType.SVM:
+            return `SVM-${chainId.toString()}`;
+        case VMType.EVM:
+            return `EIP155-${chainId.toString()}`;
+        default:
+            return undefined;
     }
-    return `EIP155-${chainId.toString()}`;
 };
 export const getBlockchainIdFromBlockchain = (blockchain) => {
     return BLOCKCHAIN_ID[blockchain];
@@ -35,7 +58,7 @@ export const hasError = (data) => {
     return undefined;
 };
 export const getBlockchainFromName = (chainName) => {
-    const formattedChainName = chainName?.toLowerCase()?.replace("-", "_");
+    const formattedChainName = validateAndLowerCase(chainName)?.replace("-", "_");
     switch (formattedChainName) {
         case "bnbt": {
             return Blockchain.BINANCE_TESTNET;

package/dist/esm/utils/validateAndParseAddress.d.ts

@@ -8,3 +8,11 @@ export declare function validateAndParseAddress(address: string): string;
  * @param address the unchecksummed hex address
  */
 export declare function checkValidAddress(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 checkValidEVMAddress(address: string): string;
+export declare function checkValidSVMAddress(address: string): string;
+export declare function validateAndFormatAddress(address?: string): string;
+export declare function validateAndLowerCase(value?: string): string;

package/dist/esm/utils/validateAndParseAddress.js

@@ -23,3 +23,51 @@ export function checkValidAddress(address) {
     }
     throw new Error(`${address} is not a valid address.`);
 }
+/**
+ * Checks if an address is valid by checking 0x prefix, length === 42 and hex encoding.
+ * @param address the unchecksummed hex address
+ */
+export function checkValidEVMAddress(address) {
+    if (startsWith0xLen42HexRegex.test(address)) {
+        return address.toLowerCase();
+    }
+    throw new Error(`${address} is not a valid address.`);
+}
+// Solana address validation
+// Base58 character set: [1-9A-HJ-NP-Za-km-z]
+// Standard Solana addresses are 32-44 characters long
+const solanaRegex = /^[1-9A-HJ-NP-Za-km-z]{32,44}$/;
+export function checkValidSVMAddress(address) {
+    if (solanaRegex.test(address)) {
+        return address;
+    }
+    throw new Error(`${address} is not a valid address.`);
+}
+// for ETH and SOL addresses.
+// ETH addresses are 42 characters long, starting with 0x
+// SOL addresses are 32-44 characters long, containing only alphanumeric characters
+export function validateAndFormatAddress(address) {
+    if (!address) {
+        return undefined;
+    }
+    // Remove any whitespace
+    address = address?.trim();
+    if (startsWith0xLen42HexRegex.test(address)) {
+        return address.toLowerCase();
+    }
+    else if (solanaRegex.test(address)) {
+        return address;
+    }
+    return undefined;
+}
+export function validateAndLowerCase(value) {
+    if (!value) {
+        return undefined;
+    }
+    // Remove any whitespace
+    value = value?.trim();
+    if (solanaRegex.test(value)) {
+        throw new Error(`should not lowwercase solana address: ${value}`);
+    }
+    return value?.toLowerCase();
+}