@fivenorth/loop-sdk 0.5.1 → 0.6.1

package/README.md

@@ -90,6 +90,8 @@ const holdings = await provider.getHolding();
 console.log(holdings);
 ```
 
+Each holding includes its `instrument_id` (with `admin` and `id` fields), which you can use when building transfers for CC, CIP-56 tokens, LOOP, or any custom instrument.
+
 #### Get Active Contracts
 
 You can query for active contracts by `templateId` or `interfaceId`.
@@ -151,6 +153,35 @@ try {
 }
 ```
 
+#### Transfer (built-in helper)
+
+```javascript
+await loop.wallet.transfer(
+  'receiver::fingerprint',
+  '5', // amount (string or number)
+  {
+    // Optional overrides. Defaults to Amulet/DSO if omitted.
+    instrument_admin: 'issuer::fingerprint', // optional
+    instrument_id: 'Amulet',                 // optional
+  },
+  {
+    requestedAt: new Date().toISOString(),   // optional
+    executeBefore: new Date(Date.now() + 24*60*60*1000).toISOString(), // optional
+  },
+);
+```
+
+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.
+
+Common instrument overrides (pass into the `instrument` argument above):
+
+- Canton Coin (CC): `{ instrument_admin: 'cc-issuer::fingerprint', instrument_id: 'CC' }`
+- CIP-56: `{ instrument_admin: 'cip56-issuer::fingerprint', instrument_id: 'CIP-56' }`
+
+Swap in the admin/id for the specific instrument you hold in the Loop wallet.
+
 # API
 
 Coming soon
@@ -179,4 +210,4 @@ Upon doing so you can visit http://localhost:3030/ to see the local demo app, se
 ```
 bun run build
 bun publish
-```
+```

package/dist/index.js

@@ -2153,6 +2153,39 @@ class Connection {
     }
     return response.json();
   }
+  async prepareTransfer(authToken, params) {
+    const payload = {
+      recipient: params.recipient,
+      amount: params.amount
+    };
+    if (params.instrument) {
+      if (params.instrument.instrument_admin) {
+        payload.instrument_admin = params.instrument.instrument_admin;
+      }
+      if (params.instrument.instrument_id) {
+        payload.instrument_id = params.instrument.instrument_id;
+      }
+    }
+    if (params.requested_at) {
+      payload.requested_at = params.requested_at;
+    }
+    if (params.execute_before) {
+      payload.execute_before = params.execute_before;
+    }
+    const response = await fetch(`${this.apiUrl}/api/v1/.connect/pair/transfer`, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bearer ${authToken}`
+      },
+      body: JSON.stringify(payload)
+    });
+    if (!response.ok) {
+      throw new Error("Failed to prepare transfer.");
+    }
+    const data = await response.json();
+    return data.payload;
+  }
   async verifySession(authToken) {
     const response = await fetch(`${this.apiUrl}/api/v1/.connect/pair/account`, {
       method: "GET",
@@ -2235,7 +2268,7 @@ class Provider {
   email;
   auth_token;
   requests = new Map;
-  requestTimeout = 30000;
+  requestTimeout = 300000;
   constructor({ connection, party_id, public_key, auth_token, email, requestTimeout }) {
     if (!connection) {
       throw new Error("Provider requires a connection object.");
@@ -2245,7 +2278,7 @@ class Provider {
     this.public_key = public_key;
     this.email = email;
     this.auth_token = auth_token;
-    this.requestTimeout = requestTimeout || 30000;
+    this.requestTimeout = requestTimeout || 300000;
   }
   handleResponse(message) {
     console.log("Received response:", message);
@@ -2262,6 +2295,42 @@ class Provider {
   async submitTransaction(payload) {
     return this.sendRequest("run_transaction" /* RUN_TRANSACTION */, payload);
   }
+  async transfer(recipient, amount, instrument, options) {
+    const amountStr = typeof amount === "number" ? amount.toString() : amount;
+    const resolveDate = (value, fallbackMs) => {
+      if (value instanceof Date) {
+        return value.toISOString();
+      }
+      if (typeof value === "string" && value.length > 0) {
+        return value;
+      }
+      if (fallbackMs) {
+        return new Date(Date.now() + fallbackMs).toISOString();
+      }
+      return new Date().toISOString();
+    };
+    const requestedAtIso = resolveDate(options?.requestedAt);
+    const executeBeforeIso = resolveDate(options?.executeBefore, 24 * 60 * 60 * 1000);
+    const transferRequest = {
+      recipient,
+      amount: amountStr,
+      instrument: {
+        instrument_admin: instrument?.instrument_admin,
+        instrument_id: instrument?.instrument_id || "Amulet"
+      },
+      requested_at: requestedAtIso,
+      execute_before: executeBeforeIso
+    };
+    const preparedPayload = await this.connection.prepareTransfer(this.auth_token, transferRequest);
+    return this.submitTransaction({
+      commands: preparedPayload.commands,
+      disclosedContracts: preparedPayload.disclosedContracts,
+      packageIdSelectionPreference: preparedPayload.packageIdSelectionPreference,
+      actAs: preparedPayload.actAs,
+      readAs: preparedPayload.readAs,
+      synchronizerId: preparedPayload.synchronizerId
+    });
+  }
   async signMessage(message) {
     return this.sendRequest("sign_raw_message" /* SIGN_RAW_MESSAGE */, message);
   }
@@ -2301,6 +2370,25 @@ class Provider {
   }
 }
 
+// src/wallet.ts
+class LoopWallet {
+  getProvider;
+  constructor(getProvider) {
+    this.getProvider = getProvider;
+  }
+  requireProvider() {
+    const provider = this.getProvider();
+    if (!provider) {
+      throw new Error("SDK not connected. Call connect() and wait for acceptance first.");
+    }
+    return provider;
+  }
+  transfer(recipient, amount, instrument, options) {
+    const provider = this.requireProvider();
+    return provider.transfer(recipient, amount, instrument, options);
+  }
+}
+
 // src/index.ts
 class LoopSDK {
   version = "0.0.1";
@@ -2314,7 +2402,10 @@ class LoopSDK {
   onReject = null;
   overlay = null;
   ticketId = null;
-  constructor() {}
+  wallet;
+  constructor() {
+    this.wallet = new LoopWallet(() => this.provider);
+  }
   init({
     appName,
     network,
@@ -2527,6 +2618,12 @@ class LoopSDK {
       this.overlay = null;
     }
   }
+  requireProvider() {
+    if (!this.provider) {
+      throw new Error("SDK not connected. Call connect() and wait for acceptance first.");
+    }
+    return this.provider;
+  }
 }
 var loop = new LoopSDK;
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fivenorth/loop-sdk",
-  "version": "0.5.1",
+  "version": "0.6.1",
   "author": "hello@fivenorth.io",
   "main": "dist/index.js",
   "module": "dist/index.js",