@stellar/typescript-wallet-sdk 1.4.0 → 1.5.0

package/src/walletSdk/Types/index.ts

@@ -1,6 +1,6 @@
 import { RawAxiosRequestHeaders } from "axios";
 import { Networks } from "@stellar/stellar-sdk";
-import { ApplicationConfiguration, StellarConfiguration } from "walletSdk";
+import { ApplicationConfiguration, StellarConfiguration } from "../";
 import { RecoveryServerMap } from "./recovery";
 
 // Export types from root walletSdk/index.ts

package/src/walletSdk/Types/recovery.ts

@@ -1,7 +1,7 @@
 import { Transaction } from "@stellar/stellar-sdk";
 
-import { WalletSigner } from "walletSdk/Auth";
-import { AccountKeypair, PublicKeypair } from "walletSdk/Horizon";
+import { WalletSigner } from "../Auth";
+import { AccountKeypair, PublicKeypair } from "../Horizon";
 import { AuthToken } from "./auth";
 import { CommonBuilder } from "./horizon";
 

package/test/e2e/README.md

@@ -0,0 +1,11 @@
+# How it works
+
+## browser.test.ts
+
+This test uses playwright to load the browser bundle file into a browser
+environment and run its code. If there is a bug in how its built,
+window.WalletSDK will be undefined.
+
+### To run
+
+$ yarn build $ yarn test browser.test.ts

package/test/e2e/browser.test.ts

@@ -0,0 +1,52 @@
+import { chromium, webkit } from "playwright";
+
+describe("Test browser build", () => {
+  const browsers = [
+    { name: "Chrome", instance: chromium },
+    { name: "Safari", instance: webkit },
+  ];
+
+  for (const b of browsers) {
+    it(
+      "works on " + b.name,
+      async () => {
+        await (async () => {
+          const browser = await b.instance.launch();
+          const page = await browser.newPage();
+
+          await page.goto("https://stellar.org");
+
+          await page.addScriptTag({
+            path: "./lib/bundle_browser.js",
+          });
+
+          // Use the Stellar SDK in the website's context
+          const result = await page.evaluate(() => {
+            let kp;
+            try {
+              const wal = (window as any).WalletSDK.Wallet.TestNet();
+              const account = wal.stellar().account();
+
+              kp = account.createKeypair();
+            } catch (e) {
+              return { success: false };
+            }
+
+            return {
+              publicKey: kp.publicKey,
+              secretKey: kp.secretKey,
+              success: true,
+            };
+          });
+
+          expect(result.publicKey).toBeTruthy();
+          expect(result.secretKey).toBeTruthy();
+          expect(result.success).toBeTruthy();
+
+          await browser.close();
+        })();
+      },
+      15000,
+    );
+  }
+});

package/test/integration/README.md

@@ -0,0 +1,38 @@
+# Recovery Integration Tests
+
+## How it works
+
+The recovery integration tests run different recovery scenarios against recovery
+signer and webauth servers. 2 recovery signer and 2 webauth servers are started
+in a docker-compose file (see test/docker/docker-compose.yml), to simulate a
+wallet interacting with 2 separate recovery servers.
+
+## To run tests locally:
+
+```
+// start servers using docker
+$ docker-compose -f @stellar/typescript-wallet-sdk/test/docker/docker-compose.yml up
+
+// run tests
+$ yarn test:recovery:ci
+```
+
+# AnchorPlatform Integration Tests
+
+## How it works
+
+This test works similar to the recovery integration tests. It spins up an
+anchorplatform image from the (java anchor sdk
+repo)[https://github.com/stellar/java-stellar-anchor-sdk] and runs tests
+against.
+
+## To run tests locally:
+
+- follow the steps defined in the
+  (.github/workflows/integration.anchorPlatformTest.yml)[https://github.com/stellar/typescript-wallet-sdk/blob/main/.github/workflows/integration.anchorPlatformTest.yml]
+  file locally
+
+1. Clone the java-stellar-anchor-sdk repo locally
+2. Run the docker build command
+3. Run the docker command
+4. Run the anchorPlatform tests from this repo

package/test/integration/anchorplatform.test.ts

@@ -1,5 +1,6 @@
 import { Wallet } from "../../src";
 import { IssuedAssetId } from "../../src/walletSdk/Asset";
+import { DefaultAuthHeaderSigner } from "../../src/walletSdk/Auth/AuthHeaderSigner";
 
 let wallet;
 let stellar;
@@ -23,6 +24,14 @@ describe("Anchor Platform Integration Tests", () => {
     expect(authToken.token).toBeTruthy();
   });
 
+  it("using DefaultAuthHeaderSigner should work", async () => {
+    const auth = await anchor.sep10();
+
+    const authHeaderSigner = new DefaultAuthHeaderSigner();
+    const authToken = await auth.authenticate({ accountKp, authHeaderSigner });
+    expect(authToken.token).toBeTruthy();
+  });
+
   it("SEP-12 KYC and SEP-6 should work", async () => {
     const auth = await anchor.sep10();
     const authToken = await auth.authenticate({ accountKp });

package/test/server.test.ts

@@ -68,4 +68,17 @@ describe("Server helpers", () => {
     parsed = Server.parseAnchorTransaction(withdrawJson);
     expect(parsed.kind).toBe("withdrawal");
   });
+  it("should parse moneygram JSON transactions", () => {
+    const d1 = `{"id":"19489958-c0c4-4090-a272-a51fc851f524","kind":"deposit","status":"incomplete","amount_in":"3.00","amount_in_asset":"USD","amount_out":"3.00","amount_out_asset":"USD","amount_fee":"0.00","amount_fee_asset":"USD","started_at":"2024-03-28T16:20:09Z","stellar_transaction_id":"","refunded":false,"from":"","to":""}`;
+    let parsed = Server.parseAnchorTransaction(d1);
+    expect(parsed.kind).toBe("deposit");
+
+    const w1 = `{"withdraw_anchor_account":"GAYF33NNNMI2Z6VNRFXQ64D4E4SF77PM46NW3ZUZEEU5X7FCHAZCMHKU","withdraw_memo":"639496083328800102","withdraw_memo_type":"id","id":"d64c5d56-de6d-492e-95dd-412fb86c1c14","kind":"withdrawal","status":"pending_user_transfer_start","more_info_url":"https://extstellar.moneygram.com/transaction-status?transaction_id\u003dd64c5d56-de6d-492e-95dd-412fb86c1c14\u0026token\u003deyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJkNjRjNWQ1Ni1kZTZkLTQ5MmUtOTVkZC00MTJmYjg2YzFjMTQiLCJpc3MiOiJtb3JlSW5mb1VybCIsInN1YiI6IkdBWkRVRlIyTDQ3S0hBS1g0V1NVWDNJUFo3NDYyVDVFNzNNQVpIWE9XT0NFQlBBUVlIVDdFNjJGIiwiaWF0IjoxNzExNjQyNzU0LCJleHAiOjE3MTE3MjkxNTQsImNsaWVudF9kb21haW4iOiJhcGktZGV2LnZpYnJhbnRhcHAuY29tIn0.CNjnMzXYA9aSU0ZA9Gd-P5bDWmpnaoAen8SnGz6PlHQ\u0026lang\u003den-US\u0026refNumber\u003d89445520","amount_in":"3.0","amount_in_asset":"USDC","amount_out":"4.02","amount_out_asset":"CAD","amount_fee":"0.0","amount_fee_asset":"USDC","started_at":"2024-03-28T16:18:02Z","stellar_transaction_id":"","external_transaction_id":"89445520","refunded":false,"from":"GAZDUFR2L47KHAKX4WSUX3IPZ7462T5E73MAZHXOWOCEBPAQYHT7E62F","to":"GAYF33NNNMI2Z6VNRFXQ64D4E4SF77PM46NW3ZUZEEU5X7FCHAZCMHKU"}`;
+    parsed = Server.parseAnchorTransaction(w1);
+    expect(parsed.kind).toBe("withdrawal");
+
+    const w2 = `{"id":"d64c5d56-de6d-492e-95dd-412fb86c1c14","kind":"withdrawal","status":"incomplete","amount_in":"0","amount_out":"0","amount_fee":"0","started_at":"2024-03-28T16:18:02Z","stellar_transaction_id":"","refunded":false,"from":"GAZDUFR2L47KHAKX4WSUX3IPZ7462T5E73MAZHXOWOCEBPAQYHT7E62F"}`;
+    parsed = Server.parseAnchorTransaction(w2);
+    expect(parsed.kind).toBe("withdrawal");
+  });
 });

package/test/wallet.test.ts

@@ -20,6 +20,10 @@ import {
   WalletSigner,
   DefaultSigner,
 } from "../src/walletSdk/Auth/WalletSigner";
+import {
+  DefaultAuthHeaderSigner,
+  DomainAuthHeaderSigner,
+} from "../src/walletSdk/Auth/AuthHeaderSigner";
 import { SigningKeypair } from "../src/walletSdk/Horizon/Account";
 import { Sep24 } from "../src/walletSdk/Anchor/Sep24";
 import { DomainSigner } from "../src/walletSdk/Auth/WalletSigner";
@@ -1880,3 +1884,84 @@ describe("Http client", () => {
     expect(resp.data.transaction).toBeTruthy();
   });
 });
+
+describe("AuthHeaderSigner", () => {
+  beforeAll(() => {
+    jest.resetAllMocks();
+  });
+  it("full sep-10 auth using header token should work", async () => {
+    const wallet = Wallet.TestNet();
+    const accountKp = wallet.stellar().account().createKeypair();
+    wallet.stellar().fundTestnetAccount(accountKp.publicKey);
+
+    const anchor = wallet.anchor({ homeDomain: "testanchor.stellar.org" });
+    const auth = await anchor.sep10();
+
+    const authHeaderSigner = new DefaultAuthHeaderSigner();
+    const authToken = await auth.authenticate({
+      accountKp,
+      authHeaderSigner,
+    });
+
+    expect(authToken).toBeTruthy();
+  }, 15000);
+
+  it("should match example implementation generated JWT", async () => {
+    const generatedAuthToken =
+      "eyJhbGciOiJFZERTQSJ9.eyJpYXQiOjE3MTE2NDg0ODYsImV4cCI6MTcxMTY0OTM4NiwiYWNjb3VudCI6IkdDNlVDWFZUQU1ORzVKTE9NWkJTQ05ZWFZTTk5GSEwyM1NKUFlPT0ZKRTJBVllERFMyRkZUNDVDIiwiY2xpZW50X2RvbWFpbiI6ImV4YW1wbGUtd2FsbGV0LnN0ZWxsYXIub3JnIiwid2ViX2F1dGhfZW5kcG9pbnQiOiJodHRwczovL2V4YW1wbGUuY29tL3NlcDEwL2F1dGgifQ.UQt8FpUK-BlnFw35o8Ke4GDOoCrMe9ztEx4_TGQ06XhMgUbn_b7EMPMVLWJ8RRNgSk2dNhyGUgIbhKzKtWtBBw";
+    const issuer = SigningKeypair.fromSecret(
+      "SCYVDFYEHNDNTB2UER2FCYSZAYQFAAZ6BDYXL3BWRQWNL327GZUXY7D7",
+    );
+
+    const claims = {
+      iat: 1711648486,
+      exp: 1711649386,
+      account: "GC6UCXVTAMNG5JLOMZBSCNYXVSNNFHL23SJPYOOFJE2AVYDDS2FFT45C",
+      client_domain: "example-wallet.stellar.org",
+      web_auth_endpoint: "https://example.com/sep10/auth",
+    };
+
+    const signer = new DefaultAuthHeaderSigner();
+    const token = await signer.createToken({
+      claims,
+      clientDomain: "",
+      issuer,
+    });
+
+    expect(token).toBe(generatedAuthToken);
+  });
+
+  it("DefaultAuthHeaderSigner should work", async () => {
+    const accountKp = SigningKeypair.fromSecret(
+      "SAFXVNFRZQAC66RUZ2IJKMSNQCPXTKXVRX356COUKJJKJXBSLRX43DEZ",
+    );
+
+    const signer = new DefaultAuthHeaderSigner();
+    const token = await signer.createToken({
+      claims: {},
+      clientDomain: "test-domain",
+      issuer: accountKp,
+    });
+    expect(token).toBeTruthy();
+  });
+
+  it("DomainAuthHeaderSigner should work", async () => {
+    const accountKp = SigningKeypair.fromSecret(
+      "SAFXVNFRZQAC66RUZ2IJKMSNQCPXTKXVRX356COUKJJKJXBSLRX43DEZ",
+    );
+
+    const signer = new DomainAuthHeaderSigner("some-url.com");
+
+    const data = { account: "dummy-account" };
+
+    jest.spyOn(signer, "signTokenRemote").mockResolvedValue("success-token");
+
+    const token = await signer.createToken({
+      authTokenData: data,
+      clientDomain: "test-domain",
+      issuer: accountKp,
+    });
+
+    expect(token).toBe("success-token");
+  });
+});

package/webpack.config.js

@@ -29,6 +29,7 @@ module.exports = (env = { NODE: false }) => {
             util: require.resolve("util"),
             vm: require.resolve("vm-browserify"),
             "process/browser": require.resolve("process/browser"),
+            buffer: require.resolve("buffer"),
           }
         : {},
     },
@@ -45,6 +46,9 @@ module.exports = (env = { NODE: false }) => {
           new webpack.ProvidePlugin({
             process: "process/browser",
           }),
+          new webpack.ProvidePlugin({
+            Buffer: ["buffer", "Buffer"],
+          }),
         ]
       : [],
   };

package/test/README.md

@@ -1,18 +0,0 @@
-# Recovery Integration Tests
-
-## How it works
-
-The recovery integration tests run different recovery scenarios against recovery
-signer and webauth servers. 2 recovery signer and 2 webauth servers are started
-in a docker-compose file (see test/docker/docker-compose.yml), to simulate a
-wallet interacting with 2 separate recovery servers.
-
-## To run tests locally:
-
-```
-// start servers using docker
-$ docker-compose -f test/docker/docker-compose.yml up
-
-// run tests
-$ yarn test:integration:ci
-```