@fivenorth/loop-sdk 0.9.0 → 0.11.0

package/README.md

@@ -142,6 +142,7 @@ try {
     const result = await provider.submitTransaction(damlCommand, {
         // Optional: show a custom message in the wallet prompt
         message: 'Transfer 10 CC to RetailStore',
+        estimateTraffic: true, // optional: return estimated traffic in submission response
     });
     console.log('Transaction successful:', result);
 } catch (error) {
@@ -186,19 +187,19 @@ try {
 ```javascript
 await loop.wallet.transfer(
   'receiver::fingerprint',
-  '5', // amount (string or number)
+  '5', 
   {
-    // Optional overrides. Defaults to Amulet/DSO if omitted.
-    instrument_admin: 'issuer::fingerprint', // optional
-    instrument_id: 'Amulet',                 // optional
+    instrument_admin: 'issuer::fingerprint', // optional: DSO (default)
+    instrument_id: 'Amulet',                 // optional: Amulet (default)
   },
   {
-    // Optional: show a custom message in the wallet prompt
-    message: 'Send 5 CC to Alice',
+    message: 'Send 5 CC to Alice', // optional: show a custom message in the wallet prompt
+    memo: 'optional memo for the transfer',   // optional: stored as transfer metadata
     executionMode: 'wait',                   // optional: 'async' (default) or 'wait'
     requestedAt: new Date().toISOString(),   // optional
     executeBefore: new Date(Date.now() + 24*60*60*1000).toISOString(), // optional
     requestTimeout: 5 * 60 * 1000,           // optional (ms), defaults to 5 minutes
+    estimateTraffic: true,                   // optional: return estimated traffic in submission response
   },
 );
 ```
@@ -206,7 +207,6 @@ await loop.wallet.transfer(
 Notes:
 - You must have spendable holdings for the specified instrument (admin + id). If left blank, the SDK defaults to the native token.
 - The helper handles fetching holdings, building the transfer factory payload, and submitting via Wallet Connect.
-- Requests time out after 5 minutes by default; override with `requestTimeout` in milliseconds.
 
 Common instrument overrides (pass into the `instrument` argument above):
 
@@ -237,6 +237,15 @@ Notes:
 
 Coming soon
 
+## Loop Server Signing API
+
+Loop SDK also supports a server-side signing flow. Instead of a wallet popup, your backend signs and submits transactions directly using the user's private key.
+
+Example ideas:
+- List pending transfers
+- Accept a pending transfer
+
+
 # Development Guide
 
 This section is only if you want to actively develop the SDK itself. To use the SDK, follow the `#Usage Guide` section

package/dist/connection.d.ts

@@ -0,0 +1,40 @@
+import type { Network, Account, Holding, TransferRequest, PreparedTransferPayload, ExchangeApiKeyResponse, TransactionPayload, PreparedSubmissionResponse, ExecuteSubmissionResquest } from './types';
+import { SessionInfo } from './session';
+export declare class Connection {
+    walletUrl: string;
+    apiUrl: string;
+    ws: WebSocket | null;
+    private network;
+    private ticketId;
+    private onMessageHandler;
+    private reconnectPromise;
+    private status;
+    constructor({ network, walletUrl, apiUrl }: {
+        network?: Network;
+        walletUrl?: string;
+        apiUrl?: string;
+    });
+    connectInProgress(): boolean;
+    getTicket(appName: string, sessionId: string, version: string): Promise<{
+        ticket_id: string;
+    }>;
+    getHolding(authToken: string): Promise<Holding[]>;
+    getActiveContracts(authToken: string, params?: {
+        templateId?: string;
+        interfaceId?: string;
+    }): Promise<any[]>;
+    prepareTransfer(authToken: string, params: TransferRequest): Promise<PreparedTransferPayload>;
+    verifySession(authToken: string): Promise<Account>;
+    connectWebSocket(ticketId: string, onMessage: (event: MessageEvent) => void): void;
+    reconnect(): Promise<void>;
+    exchangeApiKey({ publicKey, signature, epoch }: {
+        publicKey: string;
+        signature: string;
+        epoch: number;
+    }): Promise<ExchangeApiKeyResponse>;
+    prepareTransaction(session: SessionInfo, params: TransactionPayload): Promise<PreparedSubmissionResponse>;
+    executeTransaction(session: SessionInfo, params: ExecuteSubmissionResquest): Promise<PreparedSubmissionResponse>;
+    private websocketUrl;
+    private attachWebSocket;
+}
+//# sourceMappingURL=connection.d.ts.map

package/dist/connection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connection.d.ts","sourceRoot":"","sources":["../src/connection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,OAAO,EACP,OAAO,EACP,OAAO,EACP,eAAe,EACf,uBAAuB,EAEvB,sBAAsB,EACtB,kBAAkB,EAClB,0BAA0B,EAC1B,yBAAyB,EAC5B,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAGxC,qBAAa,UAAU;IACZ,SAAS,EAAE,MAAM,CAA4B;IAC7C,MAAM,EAAE,MAAM,CAA4B;IAC1C,EAAE,EAAE,SAAS,GAAG,IAAI,CAAQ;IACnC,OAAO,CAAC,OAAO,CAAmB;IAClC,OAAO,CAAC,QAAQ,CAAuB;IACvC,OAAO,CAAC,gBAAgB,CAAgD;IACxE,OAAO,CAAC,gBAAgB,CAA8B;IACtD,OAAO,CAAC,MAAM,CAA+D;gBAEjE,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;IAmCtG,iBAAiB,IAAI,OAAO;IAItB,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAoB9F,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAgBjD,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAwB7G,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,uBAAuB,CAAC;IA4C7F,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAmCxD,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI;IAwB3E,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IA+BpB,cAAc,CAAC,EAAC,SAAS,EAAE,SAAS,EAAE,KAAK,EAAC,EAAE;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAC,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAqB3I,kBAAkB,CAAC,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAenG,kBAAkB,CAAC,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAwBtH,OAAO,CAAC,YAAY;IAKpB,OAAO,CAAC,eAAe;CAqC1B"}

package/dist/errors.d.ts

@@ -0,0 +1,13 @@
+export declare class RequestTimeoutError extends Error {
+    constructor(timeout: number);
+}
+export declare class RejectRequestError extends Error {
+    constructor();
+}
+export declare class UnauthorizedError extends Error {
+    code?: string;
+    constructor(code?: string);
+}
+export declare function extractErrorCode(message: any): string | null;
+export declare function isUnauthCode(code: string | null | undefined): code is string;
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,qBAAa,mBAAoB,SAAQ,KAAK;gBAC9B,OAAO,EAAE,MAAM;CAG9B;AAED,qBAAa,kBAAmB,SAAQ,KAAK;;CAI5C;AAED,qBAAa,iBAAkB,SAAQ,KAAK;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;gBACT,IAAI,CAAC,EAAE,MAAM;CAI5B;AAID,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,GAAG,GAAG,MAAM,GAAG,IAAI,CAQ5D;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,IAAI,IAAI,MAAM,CAK5E"}

package/dist/extensions/usdc/index.d.ts

@@ -0,0 +1,11 @@
+import type { WithdrawOptions, UsdcBridgeExtension, WithdrawUsdcRequest, PreparedWithdrawPayload } from './types';
+import type { Provider } from '../../provider';
+import type { Connection } from '../../connection';
+export declare class UsdcBridge implements UsdcBridgeExtension {
+    private getProvider;
+    constructor(getProvider: () => Provider | null);
+    private requireProvider;
+    withdrawalUSDCxToEthereum(recipient: string, amount: string | number, options?: WithdrawOptions): Promise<any>;
+}
+export declare function prepareUsdcWithdraw(connection: Connection, authToken: string, params: WithdrawUsdcRequest): Promise<PreparedWithdrawPayload>;
+//# sourceMappingURL=index.d.ts.map

package/dist/extensions/usdc/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/extensions/usdc/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,uBAAuB,EAA2B,MAAM,SAAS,CAAC;AAC3I,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,qBAAa,UAAW,YAAW,mBAAmB;IACpD,OAAO,CAAC,WAAW,CAAwB;gBAE/B,WAAW,EAAE,MAAM,QAAQ,GAAG,IAAI;IAI9C,OAAO,CAAC,eAAe;IAQvB,yBAAyB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC;CAwB/G;AAED,wBAAsB,mBAAmB,CAAC,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAyBlJ"}

package/dist/extensions/usdc/types.d.ts

@@ -0,0 +1,25 @@
+export type WithdrawUsdcRequest = {
+    recipient: string;
+    amount: string;
+    reference?: string;
+};
+export type PreparedWithdrawPayload = {
+    actAs: string[];
+    readAs: string[];
+    synchronizerId: string;
+    commands: any[];
+    disclosedContracts: any[];
+    packageIdSelectionPreference: string[];
+};
+export type ConnectWithdrawResponse = {
+    payload: PreparedWithdrawPayload;
+};
+export type WithdrawOptions = {
+    reference?: string;
+    requestTimeout?: number;
+    message?: string;
+};
+export interface UsdcBridgeExtension {
+    withdrawalUSDCxToEthereum(recipient: string, amount: string | number, options?: WithdrawOptions): Promise<any>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/extensions/usdc/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/extensions/usdc/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,GAAG,EAAE,CAAC;IAChB,kBAAkB,EAAE,GAAG,EAAE,CAAC;IAC1B,4BAA4B,EAAE,MAAM,EAAE,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,uBAAuB,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,WAAW,mBAAmB;IAClC,yBAAyB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CAChH"}

package/dist/index.d.ts

@@ -0,0 +1,53 @@
+import { Provider } from "./provider";
+import type { Network, Wallet, RunTransactionResponse } from "./types";
+declare class LoopSDK {
+    private version;
+    private appName;
+    private connection;
+    private session;
+    private provider;
+    private openMode;
+    private requestSigningMode;
+    private popupWindow;
+    private redirectUrl?;
+    private onAccept;
+    private onReject;
+    private onTransactionUpdate;
+    private overlay;
+    wallet: Wallet;
+    constructor();
+    init({ appName, network, walletUrl, apiUrl, onAccept, onReject, onTransactionUpdate, options, }: {
+        appName: string;
+        network?: Network;
+        walletUrl?: string;
+        apiUrl?: string;
+        onAccept?: (provider: Provider) => void;
+        onReject?: () => void;
+        onTransactionUpdate?: (payload: RunTransactionResponse, message: any) => void;
+        options?: {
+            openMode?: "popup" | "tab";
+            requestSigningMode?: "popup" | "tab";
+            redirectUrl?: string;
+        };
+    }): void;
+    private loadSessionInfo;
+    autoConnect(): Promise<void>;
+    connect(): Promise<void>;
+    private handleWebSocketMessage;
+    getConnectUrl(): string;
+    private buildConnectUrl;
+    private buildDashboardUrl;
+    private openRequestUi;
+    private closePopupIfExists;
+    private openWallet;
+    private injectModalStyles;
+    private showQrCode;
+    private hideQrCode;
+    logout(): void;
+    private requireProvider;
+    private createProviderHooks;
+}
+export declare const loop: LoopSDK;
+export * from "./extensions/usdc/types";
+export * from "./types";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAqB,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEzD,OAAO,KAAK,EAGX,OAAO,EAEP,MAAM,EACN,sBAAsB,EACtB,MAAM,SAAS,CAAC;AAIjB,cAAM,OAAO;IACZ,OAAO,CAAC,OAAO,CAAmB;IAElC,OAAO,CAAC,OAAO,CAAqB;IACpC,OAAO,CAAC,UAAU,CAA2B;IAC7C,OAAO,CAAC,OAAO,CAA4B;IAC3C,OAAO,CAAC,QAAQ,CAAyB;IACzC,OAAO,CAAC,QAAQ,CAA4B;IAC5C,OAAO,CAAC,kBAAkB,CAA4B;IACtD,OAAO,CAAC,WAAW,CAAuB;IAC1C,OAAO,CAAC,WAAW,CAAC,CAAS;IAE7B,OAAO,CAAC,QAAQ,CAA+C;IAC/D,OAAO,CAAC,QAAQ,CAA6B;IAC3C,OAAO,CAAC,mBAAmB,CAA0E;IACvG,OAAO,CAAC,OAAO,CAA+B;IACvC,MAAM,EAAE,MAAM,CAAC;;IAMtB,IAAI,CAAC,EACJ,OAAO,EACP,OAAO,EACP,SAAS,EACT,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,mBAAmB,EACnB,OAAO,GACP,EAAE;QACF,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;QACxC,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;QACtB,mBAAmB,CAAC,EAAE,CAAC,OAAO,EAAE,sBAAsB,EAAE,OAAO,EAAE,GAAG,KAAK,IAAI,CAAC;QAC9E,OAAO,CAAC,EAAE;YACT,QAAQ,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;YAC3B,kBAAkB,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;YACrC,WAAW,CAAC,EAAE,MAAM,CAAC;SACrB,CAAC;KACF;YAiCa,eAAe;IA6CvB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IA8B5B,OAAO;IA2Cb,OAAO,CAAC,sBAAsB;IA8DvB,aAAa,IAAI,MAAM;IAO9B,OAAO,CAAC,eAAe;IASvB,OAAO,CAAC,iBAAiB;IAOzB,OAAO,CAAC,aAAa;IAqBrB,OAAO,CAAC,kBAAkB;IAW1B,OAAO,CAAC,UAAU;IAuClB,OAAO,CAAC,iBAAiB;IAyIzB,OAAO,CAAC,UAAU;IAoFlB,OAAO,CAAC,UAAU;IAOlB,MAAM;IAQN,OAAO,CAAC,eAAe;IASvB,OAAO,CAAC,mBAAmB;CAe3B;AAED,eAAO,MAAM,IAAI,SAAgB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,SAAS,CAAC"}