@getpara/core-sdk 2.0.0-dev.0 → 2.0.0-dev.2

package/dist/types/types/events.d.ts

@@ -1,6 +1,7 @@
 import { CurrentWalletIds } from '@getpara/user-management-client';
 import { FullSignatureRes } from './wallet.js';
 import { Wallet } from './wallet.js';
+import { CoreMethodResponse } from './coreApi.js';
 export declare enum ParaEvent {
     LOGIN_EVENT = "paraLogin",
     ACCOUNT_CREATION_EVENT = "paraAccountCreation",
@@ -11,7 +12,8 @@ export declare enum ParaEvent {
     EXTERNAL_WALLET_CHANGE_EVENT = "paraExternalWalletChange",
     WALLETS_CHANGE_EVENT = "paraWalletsChange",
     WALLET_CREATED = "paraWalletCreated",
-    PREGEN_WALLET_CLAIMED = "paraPregenWalletClaimed"
+    PREGEN_WALLET_CLAIMED = "paraPregenWalletClaimed",
+    GUEST_WALLETS_CREATED = "paraGuestWalletsCreated"
 }
 export type BaseEvent<T> = {
     data: T;
@@ -45,3 +47,4 @@ export type PregenWalletClaimedResponse = {
     recoverySecret?: string;
 };
 export type PregenWalletClaimedEvent = CustomEventInit<BaseEvent<WalletCreatedResponse>>;
+export type GuestWalletsCreatedEvent = CustomEventInit<BaseEvent<CoreMethodResponse<'createGuestWallets'>>>;

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

@@ -1,4 +1,6 @@
+export * from './auth.js';
 export * from './config.js';
+export * from './coreApi.js';
 export * from './wallet.js';
 export * from './methods.js';
 export * from './theme.js';

package/dist/types/types/methods.d.ts

@@ -1,80 +1,183 @@
-import { AuthType, PrimaryAuthInfo, WalletType } from '@getpara/user-management-client';
+import { PrimaryAuthInfo, ServerAuthStateLogin, ServerAuthStateSignup, AuthMethod, ServerAuthStateVerify, VerifiedAuth, AuthExtras, TOAuthMethod, TWalletType, TelegramAuthResponse } 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;
-    withFullParaAuth?: boolean;
+import { RecoveryStatus } from './recovery.js';
+import { Wallet } from './wallet.js';
+type Device = {
+    sessionId: string;
+    encryptionKey: string;
 };
-export type VerifyExternalWallet = {
+export type EmbeddedWalletType = Exclude<TWalletType, never>;
+export type ExternalWalletType = Exclude<TWalletType, never>;
+export type VerifyExternalWalletV1 = {
     address: string;
     signedMessage: string;
     cosmosPublicKeyHex?: string;
     cosmosSigner?: string;
 };
+export type PortalUrlType = 'createAuth' | 'createPassword' | 'loginAuth' | 'loginPassword' | 'txReview' | 'onRamp' | 'telegramLogin';
 export type PortalUrlOptions = {
     params?: Record<string, string | undefined | null>;
-    authType?: AuthType;
     isForNewDevice?: boolean;
-    loginEncryptionPublicKey?: string;
-    newDeviceSessionId?: string;
-    newDeviceEncryptionKey?: string;
-    partnerId?: string;
+    thisDevice?: Device;
+    newDevice?: Device;
     sessionId?: string;
-    theme?: Theme;
+    portalTheme?: Theme;
     pathId?: string;
-    displayName?: string;
-    pfpUrl?: string;
+    shorten?: boolean;
+    isEmbedded?: boolean;
 };
-export type AuthExtras = {
+export type WithAuthMethod = {
     /**
-     * The current user's third-party username.
+     * Which authorization method to use for the URL, either `'passkey'` or `'passwprd'`.
      */
-    username?: string;
+    authMethod?: Uppercase<AuthMethod>;
+};
+export type WithCustomTheme = {
     /**
-     * The current user's third-party display name.
+     * The theme to apply to generated URLs, if different from your configured theme.
      */
-    displayName?: string;
+    portalTheme?: Theme;
+};
+export type WithUseShortUrls = {
     /**
-     * The current user's third-party profile picture URL.
+     * Whether to shorten generated URLs. This may correct any issues with generated QR codes. Defaults to `false`.
      */
-    pfpUrl?: string;
+    useShortUrls?: boolean;
 };
-export type GetWebAuthUrlForLoginParams = {
+export type WithShorten = {
     /**
-     * The session ID for the URL.
+     * Whether to shorten the generated URL. This may correct any issues with generated QR codes. Defaults to `false`.
      */
-    sessionId: string;
+    shorten?: boolean;
+};
+export type WithIsPasskeySupported = {
+    /**
+     * Whether the current device supports WebAuth passkeys.
+     */
+    isPasskeySupported: boolean;
+};
+export type PollParams = {
+    /**
+     * A callback function that will be invoked on each method poll.
+     */
+    onPoll?: () => void;
+    /**
+     * A callback function that will be invoked if the method call is canceled.
+     */
+    onCancel?: () => void;
+};
+export type FarcasterParams = PollParams & {
+    /**
+     * A function returning a boolean, indicating whether the Farcaster login process should be cancelled.
+     */
+    isCanceled?: () => boolean;
+    /**
+     * A callback function that will be invoked with the Farcaster Connect URI when it is available.
+     * You will need to display the URI as a QR code.
+     */
+    onConnectUri?: (uri: string) => void;
+};
+export type TelegramParams = {
+    /**
+     * The response received from the Telegram login bot.
+     */
+    telegramAuthResponse: TelegramAuthResponse;
+};
+export type LoginUrlParams = WithAuthMethod & WithCustomTheme & WithShorten & {
+    sessionId?: string;
+};
+export type NewCredentialUrlParams = WithAuthMethod & WithCustomTheme & WithShorten & {
+    /**
+     * Whether the URL is meant to add a passkey for a previous user on a new device. Defaults to `false`.
+     */
+    isForNewDevice?: boolean;
+};
+export type OAuthUrlParams = {
     /**
-     * Either 'email' | 'phone' | 'farcaster' | 'telegram'
+     * The third-party OAuth service.
      */
-    authType?: AuthType;
+    method: Exclude<TOAuthMethod, 'TELEGRAM' | 'FARCASTER'>;
     /**
-     * The public key to use for encrypting the login encryption key.
+     * The app scheme to redirect to after OAuth is complete.
      */
-    loginEncryptionPublicKey: string;
+    appScheme?: string;
+};
+export type OAuthParams = OAuthUrlParams & PollParams & {
     /**
-     * The partner ID for the URL.
+     * A function returning a boolean, indicating whether the OAuth process should be cancelled.
      */
-    partnerId?: string;
+    isCanceled?: () => boolean;
     /**
-     * The session ID for the new device being registered.
+     * A callback function that will be invoked with the OAuth URL when it is available.
+     * For example, you can use this to open the URL in a new window or tab.
      */
-    newDeviceSessionId?: string;
+    onOAuthUrl?: (url: string) => void;
+};
+export type AuthStateBaseParams = WithCustomTheme & WithUseShortUrls;
+export type AuthStateVerify = ServerAuthStateVerify;
+export type AuthStateLogin = Omit<ServerAuthStateLogin, 'loginAuthMethods'> & WithIsPasskeySupported & {
     /**
-     * The public key for the new device being registered.
+     * A Para Portal URL for logging in via a WebAuth passkey. For best compatibility, you should open this URL in a new window or tab.
      */
-    newDeviceEncryptionKey?: string;
+    passkeyUrl?: string;
     /**
-     * The Telegram or Farcaster display name for the user.
+     * A Para Portal URL for authorizing a new device using a WebAuth passkey located elsewhere, to be visited using that other device.
      */
-    displayName?: string;
+    passkeyKnownDeviceUrl?: string;
     /**
-     * The Telegram or Farcaster URL for the user's profile picture.
+     * A Para Portal URL for logging in via a password.
      */
-    pfpUrl?: string;
+    passwordUrl?: string;
+};
+export type AuthStateSignup = Omit<ServerAuthStateSignup, 'signupAuthMethods'> & WithIsPasskeySupported & {
+    /**
+     * A Para Portal URL for creating a new WebAuth passkey.
+     */
+    passkeyUrl?: string;
+    /**
+     * A Para Portal URL for creating a new user password.
+     */
+    passwordUrl?: string;
+    /**
+     * The Para system ID for the newly generated passkey.
+     */
+    passkeyId?: string;
+    /**
+     * The Para system ID for the newly generated password.
+     */
+    passwordId?: string;
+};
+export type AuthStateVerifyOrLogin = AuthStateVerify | AuthStateLogin;
+export type AuthStateSignupOrLogin = AuthStateSignup | AuthStateLogin;
+export type OAuthResponse = AuthStateSignupOrLogin;
+export type AuthState = AuthStateVerify | AuthStateLogin | AuthStateSignup;
+export type Verify2faParams = {
+    auth: VerifiedAuth;
+    verificationCode: string;
+};
+export type Verify2faResponse = {
+    /**
+     * When the 2FA verification code was sent.
+     */
+    initiatedAt?: Date;
+    /**
+     * The status for the 2FA process.
+     */
+    status?: RecoveryStatus;
+    /**
+     * The matched user ID.
+     */
+    userId: string;
+    /**
+     * The wallets protected by this 2FA instance.
+     */
+    wallets: Pick<Wallet, 'address' | 'id'>[];
 };
 export type CoreAuthInfo = PrimaryAuthInfo & AuthExtras;
+export type StorageType = 'local' | 'session' | 'secure' | 'all';
+export type GetWalletBalanceParams = {
+    walletId: string;
+    rpcUrl?: string;
+};
+export type GetWalletBalanceResponse = Promise<string | undefined>;
+export {};

package/dist/types/types/onRamps.d.ts

@@ -1,7 +1,7 @@
-import { Network, OnRampAsset, OnRampProvider, OnRampPurchaseType, WalletType } from '@getpara/user-management-client';
+import { Network, OnRampAsset, OnRampProvider, OnRampPurchaseType, TWalletType } from '@getpara/user-management-client';
 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 type OnRampAssetInfo = Record<TWalletType, Partial<Record<Network, Partial<Record<OnRampAsset, Partial<Record<OnRampProvider, ProviderAssetInfo>>>>>>>;
+export type OnRampAssetInfoRow = [TWalletType, Network, OnRampAsset, Partial<Record<OnRampProvider, ProviderAssetInfo>>];
 export declare enum OnRampMethod {
     ACH = "ACH",
     DEBIT = "Debit",

package/dist/types/types/wallet.d.ts

@@ -1,5 +1,4 @@
-import { PartnerEntity, TPregenIdentifierType, WalletScheme } from '@getpara/user-management-client';
-import { EmbeddedWalletType, ExternalWalletType } from './methods.js';
+import { EmbeddedWalletType, ExternalWalletType, PartnerEntity, TExternalWallet, TPregenIdentifierType, TWalletScheme } from '@getpara/user-management-client';
 export interface Wallet {
     createdAt?: string;
     id: string;
@@ -8,7 +7,7 @@ export interface Wallet {
     address?: string;
     addressSecondary?: string;
     publicKey?: string;
-    scheme?: WalletScheme;
+    scheme?: TWalletScheme;
     type?: EmbeddedWalletType | ExternalWalletType;
     isPregen?: boolean;
     pregenIdentifier?: string;
@@ -21,6 +20,11 @@ export interface Wallet {
     lastUsedPartnerId?: string;
     isExternal?: boolean;
     isExternalWithParaAuth?: boolean;
+    externalProviderId?: TExternalWallet;
+    isExternalWithVerification?: boolean;
+    isExternalConnectionOnly?: boolean;
+    ensName?: string | null;
+    ensAvatar?: string | null;
 }
 /** @deprecated */
 export declare enum PregenIdentifierType {
@@ -38,4 +42,4 @@ export interface DeniedSignatureResWithUrl extends DeniedSignatureRes {
 }
 export type SignatureRes = SuccessfulSignatureRes | DeniedSignatureRes;
 export type FullSignatureRes = SuccessfulSignatureRes | DeniedSignatureResWithUrl;
-export type ExternalWalletConnectionType = 'NONE' | 'CONNECTION_ONLY' | 'AUTHENTICATED';
+export type ExternalWalletConnectionType = 'NONE' | 'CONNECTION_ONLY' | 'AUTHENTICATED' | 'VERIFICATION';

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

@@ -1,4 +1,4 @@
-import { WalletTypeProp } from '../types/index.js';
+import { TWalletType } from '@getpara/user-management-client';
 export type Hex = `0x${string}`;
 export interface Signature {
     r: Hex;
@@ -10,7 +10,10 @@ 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 compressPubkey(pubkey: Uint8Array): Uint8Array;
+export declare function rawSecp256k1PubkeyToRawAddress(pubkeyData: Uint8Array): Uint8Array;
 export declare function getCosmosAddress(publicKey: string, prefix: string): string;
-export declare function truncateAddress(str: string, addressType: WalletTypeProp, { prefix }?: {
+export declare function truncateAddress(str: string, addressType: TWalletType, { prefix, targetLength, }?: {
     prefix?: string;
+    targetLength?: number;
 }): string;

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

@@ -6,5 +6,6 @@ export * from './listeners.js';
 export * from './onRamps.js';
 export * from './phone.js';
 export * from './polling.js';
+export * from './types.js';
 export * from './url.js';
 export * from './wallet.js';

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

@@ -1,12 +1,19 @@
-import { Network, OnRampAsset, WalletType } from '@getpara/user-management-client';
+import { Network, OnRampAsset, OnRampProvider, OnRampPurchaseType, TWalletType } from '@getpara/user-management-client';
 import { OnRampAssetInfoRow, OnRampAssetInfo } from '../types/index.js';
 export declare function toAssetInfoArray(data: OnRampAssetInfo): OnRampAssetInfoRow[];
-export declare function getOnRampNetworks(data: OnRampAssetInfo, { walletType, allowed }?: {
-    walletType?: WalletType;
+export declare function getOnRampNetworks(data: OnRampAssetInfo, { walletType, allowed, assets, providers, action, }?: {
+    walletType?: TWalletType;
     allowed?: Network[];
+    assets?: OnRampAsset[];
+    providers?: OnRampProvider[];
+    action?: OnRampPurchaseType;
 }): Network[];
-export declare function getOnRampAssets(data: OnRampAssetInfo, { walletType, network, allowed, }?: {
-    walletType?: WalletType;
+export declare function getOnRampAssets(data: OnRampAssetInfo, { walletType, network, allowed, providers, action, }?: {
+    walletType?: TWalletType;
     network?: Network;
     allowed?: OnRampAsset[];
+    providers?: OnRampProvider[];
+    action?: OnRampPurchaseType;
 }): OnRampAsset[];
+export declare const NETWORK_PREFIXES: Partial<Record<Network, string>>;
+export declare function getNetworkPrefix(network: Network): string | undefined;

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

@@ -1,7 +1,11 @@
-export declare function formatPhoneNumber(phone: string | undefined, countryCode?: string | undefined, opts?: {
+export declare function formatPhoneNumber(phone: string, countryCode?: string | undefined, opts?: {
     forDisplay: undefined | false;
 }): `+${number}` | null;
-export declare function formatPhoneNumber(phone: string | undefined, countryCode: string | undefined, opts: {
+export declare function formatPhoneNumber(phone: string, countryCode: string | undefined, opts: {
     forDisplay: true;
 }): string | null;
 export declare function displayPhoneNumber(phone: string, countryCode?: string): string;
+export declare function splitPhoneNumber(phone: `+${number}`): {
+    phone: string;
+    countryCode: string;
+};

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

@@ -0,0 +1,2 @@
+import { ServerAuthState } from '@getpara/user-management-client';
+export declare function isServerAuthState(obj: ServerAuthState | Record<string, never>): obj is ServerAuthState;

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

@@ -1,4 +1,4 @@
-import { Environment } from '../types/index.js';
+import { Ctx, Environment } from '../types/index.js';
 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;
@@ -13,3 +13,4 @@ export declare function constructUrl({ base, path, params, }: {
     path: string;
     params?: Record<string, string | undefined | null>;
 }): string;
+export declare function shortenUrl(ctx: Ctx, url: string): Promise<string>;

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

@@ -1,11 +1,13 @@
-import { SupportedWalletTypes, TPregenIdentifierType, WalletEntity, WalletScheme, WalletType } from '@getpara/user-management-client';
-import { Wallet, WalletTypeProp } from '../types/index.js';
-export declare const WalletSchemeTypeMap: Record<WalletScheme, Partial<Record<WalletType, true>>>;
+import { CurrentWalletIds, SupportedWalletTypes, TPregenIdentifierType, WalletEntity, TWalletScheme, TWalletType } from '@getpara/user-management-client';
+import { Wallet } from '../types/index.js';
+export declare const WalletSchemeTypeMap: Record<TWalletScheme, Partial<Record<TWalletType, true>>>;
 export declare function isPregenIdentifierMatch(a: string | null | undefined, b: string | null | undefined, type: TPregenIdentifierType): boolean;
-export declare function isWalletSupported(types: WalletType[], wallet: Omit<Wallet, 'signer'>): boolean;
-export declare function getSchemes(types: WalletTypeProp[] | SupportedWalletTypes): WalletScheme[];
-export declare function getWalletTypes(schemes: WalletScheme[]): WalletType[];
-export declare function getEquivalentTypes(types: WalletTypeProp[] | WalletTypeProp): WalletType[];
+export declare function isWalletSupported(types: TWalletType[], wallet: Omit<Wallet, 'signer'>): boolean;
+export declare function getSchemes(types: TWalletType[] | SupportedWalletTypes): TWalletScheme[];
+export declare function getWalletTypes(schemes: TWalletScheme[]): TWalletType[];
+export declare function getEquivalentTypes(types: TWalletType[] | TWalletType): TWalletType[];
 export declare function entityToWallet(w: WalletEntity): Omit<Wallet, 'signer'>;
 export declare function migrateWallet(obj: Record<string, unknown>): Wallet;
 export declare function supportedWalletTypesEq(a: SupportedWalletTypes, b: SupportedWalletTypes): boolean;
+export declare function mergeCurrentWalletIds(original: CurrentWalletIds, additional: CurrentWalletIds): CurrentWalletIds;
+export declare function newUuid(): string;

package/package.json

@@ -1,38 +1,21 @@
 {
   "name": "@getpara/core-sdk",
-  "version": "2.0.0-dev.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,
+  "version": "2.0.0-dev.2",
   "dependencies": {
-    "@celo/utils": "^8.0.0",
+    "@celo/utils": "^8.0.2",
     "@cosmjs/encoding": "^0.32.4",
-    "@getpara/user-management-client": "2.0.0-dev.0",
+    "@ethereumjs/util": "^9.1.0",
+    "@getpara/user-management-client": "2.0.0-dev.2",
     "@noble/hashes": "^1.5.0",
     "base64url": "^3.0.1",
-    "ethereumjs-util": "7.1.5",
-    "libphonenumber-js": "1.11.2",
+    "libphonenumber-js": "^1.11.7",
     "node-forge": "^1.3.1",
-    "qs": "^6.12.0"
-  },
-  "scripts": {
-    "build": "rm -rf dist && node ./scripts/build.mjs && yarn build:types && yarn post-build",
-    "old-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"
+    "uuid": "^11.1.0"
   },
   "devDependencies": {
-    "typescript": "5.1.6"
+    "@faker-js/faker": "^9.5.1",
+    "typescript": "^5.8.3"
   },
-  "files": [
-    "dist",
-    "package.json"
-  ],
   "exports": {
     ".": {
       "types": "./dist/types/index.d.ts",
@@ -40,5 +23,23 @@
       "require": "./dist/cjs/index.js"
     }
   },
-  "gitHead": "f94ef031ef0e1894f5f0800e55f6ca2904641780"
+  "files": [
+    "dist",
+    "package.json"
+  ],
+  "gitHead": "77d818539daa181c839a40f0ad5362af4058844e",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "scripts": {
+    "build": "rm -rf dist && node ./scripts/build.mjs && yarn build:types",
+    "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",
+    "old-build": "yarn build:cjs && yarn build:esm && yarn build:types; yarn post-build",
+    "post-build": "./scripts/set-version.sh",
+    "test": "vitest run --coverage"
+  },
+  "sideEffects": false,
+  "types": "dist/types/index.d.ts",
+  "typings": "dist/types/index.d.ts"
 }