@getpara/core-sdk 0.1.0

package/dist/types/PlatformUtils.d.ts

@@ -0,0 +1,48 @@
+/// <reference types="node" />
+import { BackupKitEmailProps, TPregenIdentifierType, WalletType } from '@getpara/user-management-client';
+import { Ctx } from './definitions.js';
+import { SignatureRes } from './types/walletTypes.js';
+import { StorageUtils } from './StorageUtils.js';
+import { PopupType } from './types/popupTypes.js';
+export interface PlatformUtils {
+    getPrivateKey(ctx: Ctx, userId: string, walletId: string, share: string, sessionCookie: string): Promise<string>;
+    keygen(ctx: Ctx, userId: string, type: Exclude<WalletType, WalletType.SOLANA>, secretKey: string | null, // should be acceptable as null in RN as we don't pre-gen them
+    sessionCookie: string, emailProps?: BackupKitEmailProps): Promise<{
+        signer: string;
+        walletId: string;
+    }>;
+    refresh(ctx: Ctx, sessionCookie: string, userId: string, walletId: string, signer: string, oldPartnerId?: string, newPartnerId?: string, keyShareProtocolId?: string): Promise<{
+        signer: string;
+        protocolId?: string;
+    }>;
+    preKeygen(ctx: Ctx, partnerId: string, pregenIdentifier: string, pregenIdentifierType: TPregenIdentifierType, type: Exclude<WalletType, WalletType.SOLANA>, secretKey: string | null, // should be acceptable as null in RN as we don't pre-gen them
+    sessionCookie: string): Promise<{
+        signer: string;
+        walletId: string;
+    }>;
+    signMessage(ctx: Ctx, userId: string, walletId: string, share: string, message: string, sessionCookie: string, isDKLS?: boolean, cosmosSignDoc?: string): Promise<SignatureRes>;
+    signTransaction(ctx: Ctx, userId: string, walletId: string, share: string, tx: string, chainId: string, sessionCookie: string, isDKLS?: boolean): Promise<SignatureRes>;
+    sendTransaction(ctx: Ctx, userId: string, walletId: string, share: string, tx: string, chainId: string, sessionCookie: string, isDKLS?: boolean): Promise<SignatureRes>;
+    signHash(address: string, hash: string): Promise<{
+        v: number;
+        r: Buffer;
+        s: Buffer;
+    }>;
+    ed25519Keygen(ctx: Ctx, userId: string, sessionCookie: string, emailProps?: BackupKitEmailProps): Promise<{
+        signer: string;
+        walletId: string;
+    }>;
+    ed25519Sign(ctx: Ctx, userId: string, walletId: string, share: string, base64Bytes: string, sessionCookie: string): Promise<SignatureRes>;
+    ed25519PreKeygen(ctx: Ctx, pregenIdentifier: string, pregenIdentifierType: TPregenIdentifierType, sessionCookie: string): Promise<{
+        signer: string;
+        walletId: string;
+    }>;
+    localStorage: StorageUtils;
+    sessionStorage: StorageUtils;
+    secureStorage?: StorageUtils;
+    isSyncStorage?: boolean;
+    disableProviderModal?: boolean;
+    openPopup(popupUrl: string, opts?: {
+        type: PopupType;
+    }): Window;
+}

package/dist/types/StorageUtils.d.ts

@@ -0,0 +1,20 @@
+export interface StorageUtils {
+    /**
+     * Retrieves a stored value.
+     *
+     * Returns undefined if the key does not exist.
+     */
+    get(key: string): Promise<string | null> | string | null;
+    /**
+     * Stores a value.
+     */
+    set(key: string, value?: string): Promise<void> | void;
+    /**
+     * Removes a single value from storage.
+     */
+    removeItem(key: string): Promise<void> | void;
+    /**
+     * Remove all items from storage that start with `prefix`.
+     */
+    clear(prefix: string): Promise<void> | void;
+}

package/dist/types/cryptography/utils.d.ts

@@ -0,0 +1,51 @@
+import forge from 'node-forge';
+import { Ctx } from '../definitions.js';
+interface EncryptedShare {
+    walletId: string;
+    walletScheme: string;
+    encryptedShare: string;
+    encryptedKey: string;
+    partnerId?: string;
+    protocolId?: string;
+}
+export declare function getSHA256HashHex(str: string): string;
+export declare function getPublicKeyHex(keyPair: forge.pki.rsa.KeyPair): string;
+export declare function publicKeyFromHex(publicKeyHex: string): forge.pki.rsa.PublicKey;
+export declare function publicKeyHexToPem(publicKeyHex: string): string;
+export declare function encodePrivateKeyToPemHex(keyPair: forge.pki.rsa.KeyPair): string;
+export declare function decodePrivateKeyPemHex(privateKeyPemHex: string): forge.pki.rsa.PrivateKey;
+export declare function encryptPrivateKey(keyPair: forge.pki.rsa.KeyPair, key: string): Promise<string>;
+export declare function decryptPrivateKey(encryptedPrivateKeyPemHex: string, key: string): Promise<forge.pki.rsa.PrivateKey>;
+export declare function getAsymmetricKeyPair(ctx: Ctx, seedValue?: string): Promise<forge.pki.rsa.KeyPair>;
+export declare function getPublicKeyFromSignature(ctx: Ctx, userHandle: Uint8Array): Promise<string>;
+export declare function symmetricKeyEncryptMessage(message: string): {
+    key: string;
+    encryptedMessageHex: string;
+};
+export declare function decryptWithKeyPair(keyPair: forge.pki.rsa.KeyPair, encryptedMessageHex: string, encryptedKeyHex: string): string;
+export declare function decryptWithPrivateKey(privateKey: forge.pki.rsa.PrivateKey, encryptedMessageHex: string, encryptedKeyHex: string): string;
+export declare function getDerivedPrivateKeyAndDecrypt(ctx: Ctx, seedValue: string, encryptedShares: EncryptedShare[]): Promise<{
+    walletId: string;
+    walletScheme: string;
+    signer: string;
+    partnerId?: string;
+    protocolId?: string;
+}[]>;
+export declare function decryptPrivateKeyAndDecryptShare(encryptionKey: string, encryptedShares: EncryptedShare[], encryptedPrivateKey: string): Promise<{
+    walletId: string;
+    walletScheme: string;
+    signer: string;
+    partnerId: string;
+    protocolId?: string;
+}[]>;
+export declare function encryptWithDerivedPublicKey(publicKeyHex: string, message: string): {
+    encryptedMessageHex: string;
+    encryptedKeyHex: string;
+};
+export declare function hashPasswordWithSalt(password: string): {
+    salt: string;
+    hash: string;
+};
+export declare function encryptPrivateKeyWithPassword(keyPair: forge.pki.rsa.KeyPair, hashedPassword: string): Promise<string>;
+export declare function decryptPrivateKeyWithPassword(encryptedPrivateKeyPemHex: string, hashedPassword: string): Promise<forge.pki.rsa.PrivateKey>;
+export {};

package/dist/types/definitions.d.ts

@@ -0,0 +1,88 @@
+import Client, { Network, OnRampAsset, OnRampProvider, OnRampPurchase, OnRampPurchaseStatus, OnRampPurchaseType, WalletScheme, WalletType } from '@getpara/user-management-client';
+import { AxiosInstance } from 'axios';
+export { Network, OnRampAsset, OnRampProvider, OnRampPurchaseStatus, type OnRampPurchase };
+export declare const is2FAEnabled = false;
+export declare enum Environment {
+    DEV = "DEV",
+    SANDBOX = "SANDBOX",
+    BETA = "BETA",
+    PROD = "PROD",
+    DEVELOPMENT = "BETA",
+    PRODUCTION = "PROD"
+}
+export interface Ctx {
+    env: Environment;
+    apiKey?: string;
+    client: Client;
+    disableWorkers?: boolean;
+    offloadMPCComputationURL?: string;
+    mpcComputationClient?: AxiosInstance;
+    useLocalFiles?: boolean;
+    useDKLS?: boolean;
+    disableWebSockets: boolean;
+    wasmOverride?: ArrayBuffer;
+    cosmosPrefix?: string;
+    isE2E?: boolean;
+}
+export type deprecated__NetworkProp = keyof typeof Network | Network;
+export type WalletTypeProp = keyof typeof WalletType | WalletType;
+export type WalletSchemeProp = keyof typeof WalletScheme | WalletScheme;
+export type WalletFilters = {
+    type?: WalletTypeProp[];
+    scheme?: WalletSchemeProp[];
+    forbidPregen?: boolean;
+};
+export type deprecated__OnRampProviderProp = keyof typeof OnRampProvider | OnRampProvider;
+export type deprecated__RampConfig = {
+    id: deprecated__OnRampProviderProp;
+    hostApiKey: string;
+};
+export type deprecated__StripeConfig = {
+    id: deprecated__OnRampProviderProp;
+};
+export type deprecated__OnRampAssetProp = keyof typeof OnRampAsset | OnRampAsset;
+export type deprecated__OnRampConfigProvider = deprecated__RampConfig | deprecated__StripeConfig;
+export declare enum EnabledFlow {
+    BUY = "BUY",
+    RECEIVE = "RECEIVE",
+    WITHDRAW = "WITHDRAW"
+}
+export type deprecated__EnabledFlowProp = keyof typeof EnabledFlow | EnabledFlow;
+export type deprecated__OnRampConfig = {
+    testMode?: boolean;
+    asset: deprecated__OnRampAssetProp;
+    network: deprecated__NetworkProp;
+    enabledFlows?: deprecated__EnabledFlowProp[];
+    providers: deprecated__OnRampConfigProvider[];
+};
+export declare enum OnRampMethod {
+    ACH = "ACH",
+    DEBIT = "Debit",
+    CREDIT = "Credit",
+    APPLE_PAY = "Apple Pay"
+}
+export declare const WalletSchemeTypeMap: Record<WalletScheme, Partial<Record<WalletType, true>>>;
+export declare function getPortalDomain(env: Environment, isE2E?: boolean): "localhost" | "app.sandbox.usecapsule.com" | "app.beta.usecapsule.com" | "app.usecapsule.com";
+export declare function getPortalBaseURL({ env, isE2E }: {
+    env: Environment;
+    isE2E?: boolean;
+}, useLocalIp?: boolean, isForWasm?: boolean): string;
+export declare function getParaConnectDomain(env: Environment): "localhost" | "connect.sandbox.getpara.com" | "connect.beta.getpara.com" | "connect.getpara.com";
+export declare function getParaConnectBaseUrl({ env }: {
+    env: Environment;
+}, useLocalIp?: boolean): string;
+export declare const EXTERNAL_WALLET_CHANGE_EVENT = "paraExternalWalletChange";
+export declare const CURRENT_WALLET_IDS_CHANGE_EVENT = "paraCurrentWalletIdsChange";
+export type ProviderAssetInfo = [string, Partial<Record<OnRampPurchaseType, boolean>>];
+export type OnRampAssetInfo = Record<WalletType, Partial<Record<Network, Partial<Record<OnRampAsset, Partial<Record<OnRampProvider, ProviderAssetInfo>>>>>>>;
+export type OnRampAssetInfoRow = [WalletType, Network, OnRampAsset, Partial<Record<OnRampProvider, ProviderAssetInfo>>];
+export declare function toAssetInfoArray(data: OnRampAssetInfo): OnRampAssetInfoRow[];
+export declare function getOnRampNetworks(data: OnRampAssetInfo, { walletType, allowed }?: {
+    walletType?: WalletType;
+    allowed?: Network[];
+}): Network[];
+export declare function getOnRampAssets(data: OnRampAssetInfo, { walletType, network, allowed, }?: {
+    walletType?: WalletType;
+    network?: Network;
+    allowed?: OnRampAsset[];
+}): OnRampAsset[];

package/dist/types/errors.d.ts

@@ -0,0 +1,12 @@
+export declare class TransactionReviewError extends Error {
+    transactionReviewUrl: string;
+    constructor(transactionReviewUrl: string);
+}
+export declare class TransactionReviewDenied extends Error {
+    constructor();
+}
+export declare class TransactionReviewTimeout extends Error {
+    pendingTransactionId: string;
+    transactionReviewUrl: string;
+    constructor(transactionReviewUrl: string, pendingTransactionId: string);
+}

package/dist/types/external/mpcComputationClient.d.ts

@@ -0,0 +1,2 @@
+import { AxiosInstance } from 'axios';
+export declare function initClient(baseURL: string, useAdapter: boolean): AxiosInstance;

package/dist/types/external/userManagementClient.d.ts

@@ -0,0 +1,13 @@
+import Client from '@getpara/user-management-client';
+import { Environment } from '../definitions.js';
+export declare function getBaseUrl(env: Environment): string;
+export declare function getBaseMPCNetworkUrl(env: Environment, useWebsocket?: boolean): string;
+export declare function initClient({ env, version, apiKey, partnerId, useFetchAdapter, retrieveSessionCookie, persistSessionCookie, }: {
+    env: Environment;
+    version?: string;
+    apiKey?: string;
+    partnerId?: string;
+    useFetchAdapter?: boolean;
+    retrieveSessionCookie?: () => string;
+    persistSessionCookie?: (cookie: string) => void;
+}): Client;

package/dist/types/index.d.ts

@@ -0,0 +1,22 @@
+import { ParaCore, PREFIX as STORAGE_PREFIX, PregenIdentifierType, isWalletSupported } from './ParaCore.js';
+export { AuthMethod, type CurrentWalletIds, EmailTheme, type PartnerEntity, type WalletEntity, WalletType, WalletScheme, OnRampPurchaseType, type OnRampConfig, type OnRampAllowedAssets, OAuthMethod, type TPregenIdentifierType, type PregenIds, NON_ED25519, PREGEN_IDENTIFIER_TYPES, } from '@getpara/user-management-client';
+export * from './definitions.js';
+export type { Ctx } from './definitions.js';
+export * from './types/index.js';
+export { distributeNewShare } from './shares/shareDistribution.js';
+export { KeyContainer } from './shares/KeyContainer.js';
+export { RecoveryStatus, stringToPhoneNumber, entityToWallet } from './ParaCore.js';
+export type { Wallet, ConstructorOpts, SupportedWalletTypes } from './ParaCore.js';
+export type { PlatformUtils } from './PlatformUtils.js';
+export type { StorageUtils } from './StorageUtils.js';
+export { getBaseUrl, initClient } from './external/userManagementClient.js';
+export * as mpcComputationClient from './external/mpcComputationClient.js';
+export { decryptWithKeyPair, decryptWithPrivateKey, getAsymmetricKeyPair, getPublicKeyHex, encryptWithDerivedPublicKey, encodePrivateKeyToPemHex, getDerivedPrivateKeyAndDecrypt, getPublicKeyFromSignature, getSHA256HashHex, encryptPrivateKey, decryptPrivateKey, decryptPrivateKeyAndDecryptShare, hashPasswordWithSalt, encryptPrivateKeyWithPassword, decryptPrivateKeyWithPassword, publicKeyFromHex, } from './cryptography/utils.js';
+export * from './external/userManagementClient.js';
+export * from './utils/pollingUtils.js';
+export * from './errors.js';
+export * from './utils/formattingUtils.js';
+export { retrieve as transmissionUtilsRetrieve } from './transmission/transmissionUtils.js';
+export { STORAGE_PREFIX, PregenIdentifierType, isWalletSupported };
+export declare const paraVersion: string;
+export default ParaCore;

package/dist/types/shares/KeyContainer.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="node" />
+export declare class KeyContainer {
+    walletId: string;
+    keyshare: string;
+    address: string;
+    backupDecryptionKey: string;
+    constructor(walletId: string, keyshare: string, address: string);
+    static buildFrom(serializedContainer: string): KeyContainer;
+    getPublicEncryptionKey(): Buffer;
+    getPublicEncryptionKeyHex(): string;
+    encryptForSelf(backup: string): string;
+    static encryptWithPublicKey(publicKey: Buffer, backup: string): string;
+    decrypt(encryptedBackup: string): string;
+}

package/dist/types/shares/recovery.d.ts

@@ -0,0 +1,12 @@
+import { BackupKitEmailProps, EncryptedKeyShare } from '@getpara/user-management-client';
+import { Ctx } from '../definitions.js';
+export declare function sendRecoveryForShare({ ctx, userId, walletId, otherEncryptedShares, userSigner, ignoreRedistributingBackupEncryptedShare, emailProps, forceRefresh, }: {
+    ctx: Ctx;
+    userId: string;
+    walletId: string;
+    otherEncryptedShares?: EncryptedKeyShare[];
+    userSigner: string;
+    ignoreRedistributingBackupEncryptedShare?: boolean;
+    emailProps?: BackupKitEmailProps;
+    forceRefresh?: boolean;
+}): Promise<string>;

package/dist/types/shares/shareDistribution.d.ts

@@ -0,0 +1,12 @@
+import { BackupKitEmailProps } from '@getpara/user-management-client';
+import { Ctx } from '../definitions.js';
+export declare function distributeNewShare({ ctx, userId, walletId, userShare, ignoreRedistributingBackupEncryptedShare, emailProps, partnerId, protocolId, }: {
+    ctx: Ctx;
+    userId: string;
+    walletId: string;
+    userShare: string;
+    ignoreRedistributingBackupEncryptedShare?: boolean;
+    emailProps?: BackupKitEmailProps;
+    partnerId?: string;
+    protocolId?: string;
+}): Promise<string>;

package/dist/types/transmission/transmissionUtils.d.ts

@@ -0,0 +1,3 @@
+import Client from '@getpara/user-management-client';
+export declare function upload(message: string, userManagementClient: Client): Promise<string>;
+export declare function retrieve(uriEncodedMessage: string, userManagementClient: Client): Promise<string>;

package/dist/types/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from './walletTypes.js';
+export * from './params.js';
+export * from './theme.js';
+export * from './popupTypes.js';

package/dist/types/types/params.d.ts

@@ -0,0 +1,24 @@
+import { AuthType, WalletType } from '@getpara/user-management-client';
+import { Theme } from './theme.js';
+export type EmbeddedWalletType = Exclude<WalletType, never>;
+export type ExternalWalletType = Exclude<WalletType, never>;
+export type ExternalWalletInfo = {
+    address: string;
+    type: ExternalWalletType;
+    provider?: string;
+    addressBech32?: string;
+};
+export type PortalUrlOptions = {
+    params?: Record<string, string | undefined | null>;
+    authType?: AuthType;
+    isForNewDevice?: boolean;
+    loginEncryptionPublicKey?: string;
+    newDeviceSessionId?: string;
+    newDeviceEncryptionKey?: string;
+    partnerId?: string;
+    sessionId?: string;
+    theme?: Theme;
+    pathId?: string;
+    displayName?: string;
+    pfpUrl?: string;
+};

package/dist/types/types/popupTypes.d.ts

@@ -0,0 +1,8 @@
+export declare enum PopupType {
+    SIGN_TRANSACTION_REVIEW = "SIGN_TRANSACTION_REVIEW",
+    SIGN_MESSAGE_REVIEW = "SIGN_MESSAGE_REVIEW",
+    LOGIN_PASSKEY = "LOGIN_PASSKEY",
+    CREATE_PASSKEY = "CREATE_PASSKEY",
+    OAUTH = "OAUTH",
+    ON_RAMP_TRANSACTION = "ON_RAMP_TRANSACTION"
+}

package/dist/types/types/theme.d.ts

@@ -0,0 +1,12 @@
+export type Theme = {
+    foregroundColor?: string;
+    backgroundColor?: string;
+    accentColor?: string;
+    darkForegroundColor?: string;
+    darkBackgroundColor?: string;
+    darkAccentColor?: string;
+    mode?: 'light' | 'dark';
+    borderRadius?: BorderRadius;
+    font?: string;
+};
+export type BorderRadius = 'none' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'full';

package/dist/types/types/walletTypes.d.ts

@@ -0,0 +1,11 @@
+export interface SuccessfulSignatureRes {
+    signature: string;
+}
+export interface DeniedSignatureRes {
+    pendingTransactionId: string;
+}
+export interface DeniedSignatureResWithUrl extends DeniedSignatureRes {
+    transactionReviewUrl: string;
+}
+export type SignatureRes = SuccessfulSignatureRes | DeniedSignatureRes;
+export type FullSignatureRes = SuccessfulSignatureRes | DeniedSignatureResWithUrl;

package/dist/types/utils/formattingUtils.d.ts

@@ -0,0 +1,16 @@
+import { WalletTypeProp } from '../definitions.js';
+export type Hex = `0x${string}`;
+export interface Signature {
+    r: Hex;
+    s: Hex;
+    v: bigint;
+}
+export declare function hexStringToBase64(hexString: string): string;
+export declare function hexToSignature(hexSig: string): Signature;
+export declare function hexToUint8Array(hex: string): Uint8Array;
+export declare function hexToDecimal(hex: string): string;
+export declare function decimalToHex(decimal: string): Hex;
+export declare function getCosmosAddress(publicKey: string, prefix: string): string;
+export declare function truncateAddress(str: string, addressType: WalletTypeProp, { prefix }?: {
+    prefix?: string;
+}): string;

package/dist/types/utils/pollingUtils.d.ts

@@ -0,0 +1 @@
+export declare function waitUntilTrue(condition: () => Promise<boolean>, timeoutMs: number, intervalMs: number): Promise<boolean>;

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@getpara/core-sdk",
+  "version": "0.1.0",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "typings": "dist/types/index.d.ts",
+  "sideEffects": false,
+  "dependencies": {
+    "@celo/utils": "^8.0.0",
+    "@cosmjs/encoding": "^0.32.4",
+    "@getpara/user-management-client": "0.1.0",
+    "@noble/hashes": "^1.5.0",
+    "base64url": "^3.0.1",
+    "buffer": "6.0.3",
+    "ethereumjs-util": "7.1.5",
+    "libphonenumber-js": "1.11.2",
+    "node-forge": "^1.3.1",
+    "qs": "^6.12.0"
+  },
+  "scripts": {
+    "build": "yarn build:cjs && yarn build:esm && yarn build:types; yarn post-build",
+    "post-build": "./scripts/set-version.sh",
+    "build:cjs": "rm -rf dist/cjs && tsc --module commonjs --outDir dist/cjs && printf '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
+    "build:esm": "rm -rf dist/esm && tsc --module es6 --outDir dist/esm && printf '{\"type\":\"module\",\"sideEffects\":false}' > dist/esm/package.json",
+    "build:types": "rm -rf dist/types && tsc --module es6 --declarationDir dist/types --emitDeclarationOnly --declaration",
+    "test": "vitest run --coverage"
+  },
+  "devDependencies": {
+    "typescript": "5.1.6"
+  },
+  "files": [
+    "dist",
+    "package.json"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "gitHead": "625aaa94001a5461dcde8d6775c3b73f3862c76c"
+}