@capxul/sdk 0.1.0-alpha.9 → 0.2.0-alpha.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +108 -0
- package/README.md +45 -0
- package/dist/{client-DG6ODWu6.d.cts → client-B_Z3ThFO.d.cts} +49 -51
- package/dist/{client-ChZrdf3R.d.ts → client-pMBRFcsz.d.ts} +49 -51
- package/dist/client.cjs +1283 -419
- package/dist/client.d.cts +4 -4
- package/dist/client.d.ts +4 -4
- package/dist/client.js +1283 -419
- package/dist/{errors-QHD5Tlok.d.ts → errors-CwhCWGxm.d.ts} +1 -1
- package/dist/{errors-GgKrSUKp.d.cts → errors-rqxuUhQP.d.cts} +1 -1
- package/dist/errors.d.cts +2 -2
- package/dist/errors.d.ts +2 -2
- package/dist/index.cjs +1342 -410
- package/dist/index.d.cts +80 -9
- package/dist/index.d.ts +80 -9
- package/dist/index.js +1341 -412
- package/dist/{next-action-DkrwXYay.d.cts → next-action-CTGl8wpy.d.cts} +2 -2
- package/dist/{next-action-DkrwXYay.d.ts → next-action-CTGl8wpy.d.ts} +2 -2
- package/dist/{types-hfcOE7Oi.d.cts → types-Brucpq0Z.d.cts} +63 -8
- package/dist/{types-PM4AQRLP.d.ts → types-V_D7qjxY.d.ts} +63 -8
- package/dist/webhooks.cjs +1 -1
- package/dist/webhooks.d.cts +2 -2
- package/dist/webhooks.d.ts +2 -2
- package/dist/webhooks.js +1 -1
- package/package.json +7 -5
package/dist/index.d.cts
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
import { S as Session, C as CapxulError$1, a as CapxulClient, A as AccountProvisionPersonalInput } from './client-
|
|
2
|
-
export {
|
|
1
|
+
import { S as Session, C as CapxulError$1, a as CapxulClient, A as AccountProvisionPersonalInput, b as CapxulConfig, V as VerifyOtpResult, c as CompleteBootstrapInput, d as CompleteBootstrapResult } from './client-B_Z3ThFO.cjs';
|
|
2
|
+
export { e as AccountsClient, f as ApiKeyCreateResult, g as ApiKeysClient, h as AuthBootstrapFlowContext, i as AuthBootstrapFlowError, j as AuthBootstrapFlowEvent, k as AuthBootstrapReason, l as AuthBootstrapToken, m as AuthClient, n as AuthSessionStore, B as BrowserCapxulConfig, o as CapxulAuthConfig, p as CapxulDataClient, q as CapxulFlowFactories, r as CapxulSigningConfig, D as DocumentsClient, E as ExternalAccountsClient, H as HttpTransport, L as LocalPrivateKeySignerProvider, M as MeClient, O as OperationsClient, s as OrgDocumentsClient, t as OrgMembersClient, u as OrgPaymentsClient, v as OrgSafesClient, w as OrgTransfersClient, x as OrgTreasuryClient, y as OrgWithdrawalsClient, z as OrganizationsClient, P as PaymentsClient, F as SubAccountsClient, T as TokenTransfer, G as TokenTransferId, I as TokenTransfersClient, J as TokenTransfersListInput, K as TokenTransfersListPage, N as TokenTransfersRetrieveInput, Q as TransfersClient, R as TransportRuntime, U as TransportState, W as VirtualAccountsClient, X as VirtualCardsClient, Y as WebhookEndpointCreateResult, Z as WebhookEndpointsClient, _ as WebhookEventsClient, $ as WithdrawalsClient, a0 as createAuthBootstrapFlowMachine, a1 as createCapxulClient, a2 as makeHttpTransport, a3 as toTokenTransferId } from './client-B_Z3ThFO.cjs';
|
|
3
3
|
import * as xstate from 'xstate';
|
|
4
|
-
import { E as Email, U as Username, O as OperationId, N as NextAction } from './next-action-
|
|
5
|
-
export { A as AccountId, a as ApiKeyId, B as BalanceLedgerEntryId, C as CorrelationId, D as DocumentId, b as ExternalAccountId, K as KybProfileId, c as KycProfileId, M as MemberId, d as OrganizationId, P as PaymentId, e as PhoneNumber, S as SafeId, f as SubAccountId, T as TransactionIntentId, g as TransferId, h as TreasuryId, V as VirtualAccountId, i as VirtualCardId, W as WebhookEndpointId, j as WebhookEventId, k as WithdrawalId, t as toAccountId, l as toApiKeyId, m as toBalanceLedgerEntryId, n as toDocumentId, o as toEmail, p as toExternalAccountId, q as toKybProfileId, r as toKycProfileId, s as toMemberId, u as toOperationId, v as toOrganizationId, w as toPaymentId, x as toPhoneNumber, y as toSafeId, z as toSubAccountId, F as toTransferId, G as toTreasuryId, H as toUsername, I as toVirtualAccountId, J as toVirtualCardId, L as toWebhookEndpointId, Q as toWebhookEventId, R as toWithdrawalId } from './next-action-
|
|
6
|
-
import { C as CapxulError, a as CapxulErrorCode } from './errors-
|
|
7
|
-
export { b as CapxulErrorDetails, c as CapxulErrorEnvelope, d as CapxulResult } from './errors-
|
|
8
|
-
import { A as Account } from './types-
|
|
9
|
-
export { a as AccountLookupResult, b as ApiKey, c as ApiKeyEnvironment, d as ApiKeyType, B as BalanceLedgerEntry, e as BankStatementDocument, C as CreatePaymentResult, f as CreateTransferResult, g as CreateWithdrawalResult, D as Document, E as ExternalAccount, h as ExternalAccountKind, I as InvoiceDocument, K as KybProfile,
|
|
4
|
+
import { E as Email, U as Username, O as OperationId, N as NextAction } from './next-action-CTGl8wpy.cjs';
|
|
5
|
+
export { A as AccountId, a as ApiKeyId, B as BalanceLedgerEntryId, C as CorrelationId, D as DocumentId, b as ExternalAccountId, K as KybProfileId, c as KycProfileId, M as MemberId, d as OrganizationId, P as PaymentId, e as PhoneNumber, S as SafeId, f as SubAccountId, T as TransactionIntentId, g as TransferId, h as TreasuryId, V as VirtualAccountId, i as VirtualCardId, W as WebhookEndpointId, j as WebhookEventId, k as WithdrawalId, t as toAccountId, l as toApiKeyId, m as toBalanceLedgerEntryId, n as toDocumentId, o as toEmail, p as toExternalAccountId, q as toKybProfileId, r as toKycProfileId, s as toMemberId, u as toOperationId, v as toOrganizationId, w as toPaymentId, x as toPhoneNumber, y as toSafeId, z as toSubAccountId, F as toTransferId, G as toTreasuryId, H as toUsername, I as toVirtualAccountId, J as toVirtualCardId, L as toWebhookEndpointId, Q as toWebhookEventId, R as toWithdrawalId } from './next-action-CTGl8wpy.cjs';
|
|
6
|
+
import { C as CapxulError, a as CapxulErrorCode } from './errors-rqxuUhQP.cjs';
|
|
7
|
+
export { b as CapxulErrorDetails, c as CapxulErrorEnvelope, d as CapxulResult } from './errors-rqxuUhQP.cjs';
|
|
8
|
+
import { A as Account } from './types-Brucpq0Z.cjs';
|
|
9
|
+
export { a as AccountLookupResult, b as ApiKey, c as ApiKeyEnvironment, d as ApiKeyType, B as BalanceLedgerEntry, e as BankStatementDocument, C as CreatePaymentResult, f as CreateTransferResult, g as CreateWithdrawalResult, D as Document, E as ExternalAccount, h as ExternalAccountKind, I as IdentityProfileBase, i as InvoiceDocument, K as KybProfile, j as KybStatus, k as KycProfile, l as KycStatus, m as KycUploadDocument, L as List, M as Member, n as MemberInviteResponse, o as MembershipStatus, p as Money, O as Operation, q as OperationStatus, r as OperationSummary, s as Organization, P as PageInfo, t as Payment, u as PaymentParty, v as PaymentStatus, w as PayrollRunDocument, x as PayrollScheduleDocument, R as ReceiptDocument, S as Safe, y as Scope, z as Settlement, F as SubAccount, G as SubAccountOwnerKind, T as TaxFormDocument, H as TimestampIso, J as Transfer, N as TransferCustody, Q as TransferEndpoint, U as TransferFx, V as TransferStatus, W as Treasury, X as UserIdentifier, Y as VirtualAccount, Z as VirtualAccountOwnerKind, _ as VirtualCard, $ as VirtualCardLimits, a0 as VirtualCardOwnerKind, a1 as WebhookEndpoint, a2 as WebhookEvent, a3 as Withdrawal, a4 as WithdrawalStatus } from './types-Brucpq0Z.cjs';
|
|
10
10
|
import { Account as Account$1 } from 'viem';
|
|
11
11
|
export { WebhookVerificationOptions, WebhookVerificationResult, verifyWebhook } from './webhooks.cjs';
|
|
12
12
|
|
|
@@ -497,4 +497,75 @@ declare function tryCatch<T>(promise: Promise<T>): Promise<[Error, null] | [null
|
|
|
497
497
|
*/
|
|
498
498
|
declare function createLocalSigner(privateKey: `0x${string}`): Account$1;
|
|
499
499
|
|
|
500
|
-
|
|
500
|
+
/**
|
|
501
|
+
* AuthService — unified promise-based auth surface.
|
|
502
|
+
*
|
|
503
|
+
* Wraps the imperative `AuthClient` tuple API with a class-based,
|
|
504
|
+
* promise-based interface. `signOut` preserves the data-client
|
|
505
|
+
* reference so provider-owned singletons survive sign-in/sign-out
|
|
506
|
+
* cycles.
|
|
507
|
+
*/
|
|
508
|
+
|
|
509
|
+
declare class AuthService {
|
|
510
|
+
private authClient;
|
|
511
|
+
private sessionStore;
|
|
512
|
+
private config;
|
|
513
|
+
constructor(config?: CapxulConfig);
|
|
514
|
+
sendOtp(email: string): Promise<void>;
|
|
515
|
+
verifyOtp(email: string, otp: string): Promise<VerifyOtpResult>;
|
|
516
|
+
completeBootstrap(params: CompleteBootstrapInput, signer?: Account$1): Promise<CompleteBootstrapResult>;
|
|
517
|
+
/**
|
|
518
|
+
* Clears the persisted session and, when a transport was pre-injected,
|
|
519
|
+
* drops the cached auth header.
|
|
520
|
+
*
|
|
521
|
+
* **Transport safety note:** `clearAuth()` is only invoked when
|
|
522
|
+
* `config._transport` was supplied at construction (e.g. by the React
|
|
523
|
+
* provider). If `AuthService` is instantiated directly in a Node/CLI
|
|
524
|
+
* context without an injected transport, the transport-side auth cache
|
|
525
|
+
* is the caller's responsibility.
|
|
526
|
+
*/
|
|
527
|
+
signOut(): Promise<void>;
|
|
528
|
+
getSession(): Promise<Session | null>;
|
|
529
|
+
}
|
|
530
|
+
|
|
531
|
+
type SignerProvisionResult = {
|
|
532
|
+
readonly signer: Account$1;
|
|
533
|
+
readonly safeAddress: `0x${string}`;
|
|
534
|
+
};
|
|
535
|
+
/**
|
|
536
|
+
* Headless signer auto-provisioner.
|
|
537
|
+
*
|
|
538
|
+
* Generates a fresh viem private-key account and deterministically derives
|
|
539
|
+
* the corresponding Safe v1.4.1 address.
|
|
540
|
+
*
|
|
541
|
+
* No consumer computes `safeAddress` — it is derived internally and
|
|
542
|
+
* returned alongside the signer so `AuthService.completeBootstrap`
|
|
543
|
+
* can supply it to the backend.
|
|
544
|
+
*
|
|
545
|
+
* **Key persistence note:** Every call to `provision()` mints a fresh
|
|
546
|
+
* private key. The caller MUST persist the returned `signer` (or its
|
|
547
|
+
* private key) if the derived `safeAddress` must be recoverable in
|
|
548
|
+
* future sessions. The bootstrap flow persists the signer via the
|
|
549
|
+
* backend (`signerProvider` row), but direct API consumers are
|
|
550
|
+
* responsible for their own key storage.
|
|
551
|
+
*/
|
|
552
|
+
declare class SignerProvisioner {
|
|
553
|
+
provision(): SignerProvisionResult;
|
|
554
|
+
}
|
|
555
|
+
|
|
556
|
+
type PaymentToken = {
|
|
557
|
+
readonly address: `0x${string}`;
|
|
558
|
+
readonly decimals: number;
|
|
559
|
+
readonly symbol: string;
|
|
560
|
+
};
|
|
561
|
+
/**
|
|
562
|
+
* Resolve a currency code to its on-chain payment token metadata.
|
|
563
|
+
*
|
|
564
|
+
* Currently supports USDC only (USD and USDC codes map to the same
|
|
565
|
+
* token). Non-USDC codes return a `NOT_IMPLEMENTED` stub so callers
|
|
566
|
+
* can scaffold multi-currency flows before the registry is fully
|
|
567
|
+
* populated.
|
|
568
|
+
*/
|
|
569
|
+
declare function resolvePaymentToken(currency: string): PaymentToken;
|
|
570
|
+
|
|
571
|
+
export { Account, AccountProvisionPersonalInput, type AuthFlowContext, type AuthFlowError, type AuthFlowEvent, AuthService, CapxulClient, CapxulConfig, CapxulError, CapxulErrorCode, CompleteBootstrapInput, CompleteBootstrapResult, Email, NextAction, type OnboardingFlowContext, type OnboardingFlowError, type OnboardingFlowEvent, type OnboardingProfileInput, type OnboardingSubjectKind, OperationId, type PaymentToken, type ProvisioningFlowContext, type ProvisioningFlowError, type ProvisioningFlowEvent, type ProvisioningFlowInput, type ProvisioningFlowOutput, Session, type SignerProvisionResult, SignerProvisioner, Username, VerifyOtpResult, createAuthFlowMachine, createLocalSigner, createOnboardingFlowMachine, createProvisioningMachine as createProvisioningFlowMachine, matchAction, matchError, matchStatus, resolvePaymentToken, tryCatch };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
import { S as Session, C as CapxulError$1, a as CapxulClient, A as AccountProvisionPersonalInput } from './client-
|
|
2
|
-
export {
|
|
1
|
+
import { S as Session, C as CapxulError$1, a as CapxulClient, A as AccountProvisionPersonalInput, b as CapxulConfig, V as VerifyOtpResult, c as CompleteBootstrapInput, d as CompleteBootstrapResult } from './client-pMBRFcsz.js';
|
|
2
|
+
export { e as AccountsClient, f as ApiKeyCreateResult, g as ApiKeysClient, h as AuthBootstrapFlowContext, i as AuthBootstrapFlowError, j as AuthBootstrapFlowEvent, k as AuthBootstrapReason, l as AuthBootstrapToken, m as AuthClient, n as AuthSessionStore, B as BrowserCapxulConfig, o as CapxulAuthConfig, p as CapxulDataClient, q as CapxulFlowFactories, r as CapxulSigningConfig, D as DocumentsClient, E as ExternalAccountsClient, H as HttpTransport, L as LocalPrivateKeySignerProvider, M as MeClient, O as OperationsClient, s as OrgDocumentsClient, t as OrgMembersClient, u as OrgPaymentsClient, v as OrgSafesClient, w as OrgTransfersClient, x as OrgTreasuryClient, y as OrgWithdrawalsClient, z as OrganizationsClient, P as PaymentsClient, F as SubAccountsClient, T as TokenTransfer, G as TokenTransferId, I as TokenTransfersClient, J as TokenTransfersListInput, K as TokenTransfersListPage, N as TokenTransfersRetrieveInput, Q as TransfersClient, R as TransportRuntime, U as TransportState, W as VirtualAccountsClient, X as VirtualCardsClient, Y as WebhookEndpointCreateResult, Z as WebhookEndpointsClient, _ as WebhookEventsClient, $ as WithdrawalsClient, a0 as createAuthBootstrapFlowMachine, a1 as createCapxulClient, a2 as makeHttpTransport, a3 as toTokenTransferId } from './client-pMBRFcsz.js';
|
|
3
3
|
import * as xstate from 'xstate';
|
|
4
|
-
import { E as Email, U as Username, O as OperationId, N as NextAction } from './next-action-
|
|
5
|
-
export { A as AccountId, a as ApiKeyId, B as BalanceLedgerEntryId, C as CorrelationId, D as DocumentId, b as ExternalAccountId, K as KybProfileId, c as KycProfileId, M as MemberId, d as OrganizationId, P as PaymentId, e as PhoneNumber, S as SafeId, f as SubAccountId, T as TransactionIntentId, g as TransferId, h as TreasuryId, V as VirtualAccountId, i as VirtualCardId, W as WebhookEndpointId, j as WebhookEventId, k as WithdrawalId, t as toAccountId, l as toApiKeyId, m as toBalanceLedgerEntryId, n as toDocumentId, o as toEmail, p as toExternalAccountId, q as toKybProfileId, r as toKycProfileId, s as toMemberId, u as toOperationId, v as toOrganizationId, w as toPaymentId, x as toPhoneNumber, y as toSafeId, z as toSubAccountId, F as toTransferId, G as toTreasuryId, H as toUsername, I as toVirtualAccountId, J as toVirtualCardId, L as toWebhookEndpointId, Q as toWebhookEventId, R as toWithdrawalId } from './next-action-
|
|
6
|
-
import { C as CapxulError, a as CapxulErrorCode } from './errors-
|
|
7
|
-
export { b as CapxulErrorDetails, c as CapxulErrorEnvelope, d as CapxulResult } from './errors-
|
|
8
|
-
import { A as Account } from './types-
|
|
9
|
-
export { a as AccountLookupResult, b as ApiKey, c as ApiKeyEnvironment, d as ApiKeyType, B as BalanceLedgerEntry, e as BankStatementDocument, C as CreatePaymentResult, f as CreateTransferResult, g as CreateWithdrawalResult, D as Document, E as ExternalAccount, h as ExternalAccountKind, I as InvoiceDocument, K as KybProfile,
|
|
4
|
+
import { E as Email, U as Username, O as OperationId, N as NextAction } from './next-action-CTGl8wpy.js';
|
|
5
|
+
export { A as AccountId, a as ApiKeyId, B as BalanceLedgerEntryId, C as CorrelationId, D as DocumentId, b as ExternalAccountId, K as KybProfileId, c as KycProfileId, M as MemberId, d as OrganizationId, P as PaymentId, e as PhoneNumber, S as SafeId, f as SubAccountId, T as TransactionIntentId, g as TransferId, h as TreasuryId, V as VirtualAccountId, i as VirtualCardId, W as WebhookEndpointId, j as WebhookEventId, k as WithdrawalId, t as toAccountId, l as toApiKeyId, m as toBalanceLedgerEntryId, n as toDocumentId, o as toEmail, p as toExternalAccountId, q as toKybProfileId, r as toKycProfileId, s as toMemberId, u as toOperationId, v as toOrganizationId, w as toPaymentId, x as toPhoneNumber, y as toSafeId, z as toSubAccountId, F as toTransferId, G as toTreasuryId, H as toUsername, I as toVirtualAccountId, J as toVirtualCardId, L as toWebhookEndpointId, Q as toWebhookEventId, R as toWithdrawalId } from './next-action-CTGl8wpy.js';
|
|
6
|
+
import { C as CapxulError, a as CapxulErrorCode } from './errors-CwhCWGxm.js';
|
|
7
|
+
export { b as CapxulErrorDetails, c as CapxulErrorEnvelope, d as CapxulResult } from './errors-CwhCWGxm.js';
|
|
8
|
+
import { A as Account } from './types-V_D7qjxY.js';
|
|
9
|
+
export { a as AccountLookupResult, b as ApiKey, c as ApiKeyEnvironment, d as ApiKeyType, B as BalanceLedgerEntry, e as BankStatementDocument, C as CreatePaymentResult, f as CreateTransferResult, g as CreateWithdrawalResult, D as Document, E as ExternalAccount, h as ExternalAccountKind, I as IdentityProfileBase, i as InvoiceDocument, K as KybProfile, j as KybStatus, k as KycProfile, l as KycStatus, m as KycUploadDocument, L as List, M as Member, n as MemberInviteResponse, o as MembershipStatus, p as Money, O as Operation, q as OperationStatus, r as OperationSummary, s as Organization, P as PageInfo, t as Payment, u as PaymentParty, v as PaymentStatus, w as PayrollRunDocument, x as PayrollScheduleDocument, R as ReceiptDocument, S as Safe, y as Scope, z as Settlement, F as SubAccount, G as SubAccountOwnerKind, T as TaxFormDocument, H as TimestampIso, J as Transfer, N as TransferCustody, Q as TransferEndpoint, U as TransferFx, V as TransferStatus, W as Treasury, X as UserIdentifier, Y as VirtualAccount, Z as VirtualAccountOwnerKind, _ as VirtualCard, $ as VirtualCardLimits, a0 as VirtualCardOwnerKind, a1 as WebhookEndpoint, a2 as WebhookEvent, a3 as Withdrawal, a4 as WithdrawalStatus } from './types-V_D7qjxY.js';
|
|
10
10
|
import { Account as Account$1 } from 'viem';
|
|
11
11
|
export { WebhookVerificationOptions, WebhookVerificationResult, verifyWebhook } from './webhooks.js';
|
|
12
12
|
|
|
@@ -497,4 +497,75 @@ declare function tryCatch<T>(promise: Promise<T>): Promise<[Error, null] | [null
|
|
|
497
497
|
*/
|
|
498
498
|
declare function createLocalSigner(privateKey: `0x${string}`): Account$1;
|
|
499
499
|
|
|
500
|
-
|
|
500
|
+
/**
|
|
501
|
+
* AuthService — unified promise-based auth surface.
|
|
502
|
+
*
|
|
503
|
+
* Wraps the imperative `AuthClient` tuple API with a class-based,
|
|
504
|
+
* promise-based interface. `signOut` preserves the data-client
|
|
505
|
+
* reference so provider-owned singletons survive sign-in/sign-out
|
|
506
|
+
* cycles.
|
|
507
|
+
*/
|
|
508
|
+
|
|
509
|
+
declare class AuthService {
|
|
510
|
+
private authClient;
|
|
511
|
+
private sessionStore;
|
|
512
|
+
private config;
|
|
513
|
+
constructor(config?: CapxulConfig);
|
|
514
|
+
sendOtp(email: string): Promise<void>;
|
|
515
|
+
verifyOtp(email: string, otp: string): Promise<VerifyOtpResult>;
|
|
516
|
+
completeBootstrap(params: CompleteBootstrapInput, signer?: Account$1): Promise<CompleteBootstrapResult>;
|
|
517
|
+
/**
|
|
518
|
+
* Clears the persisted session and, when a transport was pre-injected,
|
|
519
|
+
* drops the cached auth header.
|
|
520
|
+
*
|
|
521
|
+
* **Transport safety note:** `clearAuth()` is only invoked when
|
|
522
|
+
* `config._transport` was supplied at construction (e.g. by the React
|
|
523
|
+
* provider). If `AuthService` is instantiated directly in a Node/CLI
|
|
524
|
+
* context without an injected transport, the transport-side auth cache
|
|
525
|
+
* is the caller's responsibility.
|
|
526
|
+
*/
|
|
527
|
+
signOut(): Promise<void>;
|
|
528
|
+
getSession(): Promise<Session | null>;
|
|
529
|
+
}
|
|
530
|
+
|
|
531
|
+
type SignerProvisionResult = {
|
|
532
|
+
readonly signer: Account$1;
|
|
533
|
+
readonly safeAddress: `0x${string}`;
|
|
534
|
+
};
|
|
535
|
+
/**
|
|
536
|
+
* Headless signer auto-provisioner.
|
|
537
|
+
*
|
|
538
|
+
* Generates a fresh viem private-key account and deterministically derives
|
|
539
|
+
* the corresponding Safe v1.4.1 address.
|
|
540
|
+
*
|
|
541
|
+
* No consumer computes `safeAddress` — it is derived internally and
|
|
542
|
+
* returned alongside the signer so `AuthService.completeBootstrap`
|
|
543
|
+
* can supply it to the backend.
|
|
544
|
+
*
|
|
545
|
+
* **Key persistence note:** Every call to `provision()` mints a fresh
|
|
546
|
+
* private key. The caller MUST persist the returned `signer` (or its
|
|
547
|
+
* private key) if the derived `safeAddress` must be recoverable in
|
|
548
|
+
* future sessions. The bootstrap flow persists the signer via the
|
|
549
|
+
* backend (`signerProvider` row), but direct API consumers are
|
|
550
|
+
* responsible for their own key storage.
|
|
551
|
+
*/
|
|
552
|
+
declare class SignerProvisioner {
|
|
553
|
+
provision(): SignerProvisionResult;
|
|
554
|
+
}
|
|
555
|
+
|
|
556
|
+
type PaymentToken = {
|
|
557
|
+
readonly address: `0x${string}`;
|
|
558
|
+
readonly decimals: number;
|
|
559
|
+
readonly symbol: string;
|
|
560
|
+
};
|
|
561
|
+
/**
|
|
562
|
+
* Resolve a currency code to its on-chain payment token metadata.
|
|
563
|
+
*
|
|
564
|
+
* Currently supports USDC only (USD and USDC codes map to the same
|
|
565
|
+
* token). Non-USDC codes return a `NOT_IMPLEMENTED` stub so callers
|
|
566
|
+
* can scaffold multi-currency flows before the registry is fully
|
|
567
|
+
* populated.
|
|
568
|
+
*/
|
|
569
|
+
declare function resolvePaymentToken(currency: string): PaymentToken;
|
|
570
|
+
|
|
571
|
+
export { Account, AccountProvisionPersonalInput, type AuthFlowContext, type AuthFlowError, type AuthFlowEvent, AuthService, CapxulClient, CapxulConfig, CapxulError, CapxulErrorCode, CompleteBootstrapInput, CompleteBootstrapResult, Email, NextAction, type OnboardingFlowContext, type OnboardingFlowError, type OnboardingFlowEvent, type OnboardingProfileInput, type OnboardingSubjectKind, OperationId, type PaymentToken, type ProvisioningFlowContext, type ProvisioningFlowError, type ProvisioningFlowEvent, type ProvisioningFlowInput, type ProvisioningFlowOutput, Session, type SignerProvisionResult, SignerProvisioner, Username, VerifyOtpResult, createAuthFlowMachine, createLocalSigner, createOnboardingFlowMachine, createProvisioningMachine as createProvisioningFlowMachine, matchAction, matchError, matchStatus, resolvePaymentToken, tryCatch };
|