@stellar/typescript-wallet-sdk 1.7.0 → 1.8.0-beta.1731096658096

package/CHANGELOG.MD

@@ -1,3 +1,11 @@
+# Release notes - Typescript Wallet SDK - 1.8.0
+
+### Added
+* Upgrades `@stellar/stellar-sdk` to `13.0.0-beta.1` which supports the `Protocol 22` XDR (#172)
+* Add `transaction_id` field to SEP-12 requests (#165)
+* Make `withdraw_anchor_account` field optional (#164)
+* Deprecate `getServicesInfo()` in favor of `Sep24.info()` (#166)
+
 # Release notes - Typescript Wallet SDK - 1.7.0
 
 ### Fixed

package/examples/helpers/ask-question.ts

@@ -0,0 +1,15 @@
+import readline from "readline";
+
+export const askQuestion = (query) => {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+
+  return new Promise<string>((resolve) =>
+    rl.question(query, (ans) => {
+      rl.close();
+      resolve(ans);
+    }),
+  );
+};

package/examples/sep10/.env.example

@@ -0,0 +1,2 @@
+ANCHOR_DOMAIN=testanchor.stellar.org
+RUN_MAINNET=false

package/examples/sep10/README.md

@@ -0,0 +1,34 @@
+# Sep-10 examples for stellar typescript-wallet-sdk
+
+## Example code
+
+To view how the wallet-sdk can be used to create a sep-10 auth token for a
+wallet to send to an anchor, look at `sep10Wallet.ts`.
+
+To view how to setup an authentication server for the anchor, look at
+`sep10Server.ts`.
+
+## Running deposit and withdrawals
+
+To see them in action you can run below from the project root:
+
+```
+$ yarn example:sep10
+```
+
+This will run an example SEP-10 server which can use to sign authentication
+requests and to serve a SEP-1 stellar.toml
+
+## Changing environment variables
+
+If you'd like to use different environment variable values than the default
+ones, you can add a `.env` file. See `.env.example` as an example.
+
+The environment variables you can set are:
+
+| Variable Name   | Description                                                                                                                    | Default Value          |
+| --------------- | ------------------------------------------------------------------------------------------------------------------------------ | ---------------------- |
+| ANCHOR_DOMAIN   | The anchor domain for your application.                                                                                        | testanchor.stellar.org |
+| AUTH_KEY_SECRET | The secret key for the account authenticating                                                                                  | none                   |
+| RUN_MAINNET     | Set to `true` to run the application on Mainnet.                                                                               | false                  |
+| CLIENT_DOMAIN   | [SEP-10](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md) client domain used for authentication. | none                   |

package/examples/sep10/sep10Server.ts

@@ -0,0 +1,53 @@
+import path from "path";
+import express from "express";
+import { Transaction, Keypair } from "@stellar/stellar-sdk";
+import * as dotenv from "dotenv";
+import bodyParser from "body-parser";
+
+dotenv.config({ path: path.resolve(__dirname, ".env") });
+
+const PORT = process.env.SERVER_PORT ?? 7000;
+const SERVER_SIGNING_KEY = String(process.env.SERVER_SIGNING_KEY);
+const app = express();
+
+app.use(bodyParser.json());
+app.use(bodyParser.urlencoded({ extended: true }));
+
+// Serve the sep-1 stellar.toml file
+app.use(
+  "/.well-known",
+  express.static(path.join(__dirname, "well_known"), {
+    setHeaders: function (res) {
+      res.set("Access-Control-Allow-Headers", "Content-Type,X-Requested-With");
+      res.type("application/json");
+      console.log("request to /.well-known");
+    },
+  }),
+);
+
+// Sign requests from the wallet for sep-10 client attribution
+app.post("/sign", (req, res) => {
+  console.log("request to /sign");
+  const envelope_xdr = req.body.transaction;
+  const network_passphrase = req.body.network_passphrase;
+  const transaction = new Transaction(envelope_xdr, network_passphrase);
+
+  if (Number.parseInt(transaction.sequence, 10) !== 0) {
+    res.status(400);
+    res.send("transaction sequence value must be '0'");
+    return;
+  }
+
+  transaction.sign(Keypair.fromSecret(SERVER_SIGNING_KEY));
+
+  res.set("Access-Control-Allow-Origin", "*");
+  res.status(200);
+  res.send({
+    transaction: transaction.toEnvelope().toXDR("base64"),
+    network_passphrase: network_passphrase,
+  });
+});
+
+app.listen(PORT, () => {
+  console.log(`Listening on port ${PORT}`);
+});

package/examples/sep10/sep10Wallet.ts

@@ -0,0 +1,45 @@
+import path from "path";
+
+import { walletSdk, SigningKeypair, DefaultSigner, Wallet } from "../../src";
+
+import * as dotenv from "dotenv";
+dotenv.config({ path: path.resolve(__dirname, ".env") });
+
+// Grabbing environment variables
+
+const anchorDomain = process.env.ANCHOR_DOMAIN || "testanchor.stellar.org";
+const runMainnet = process.env.RUN_MAINNET || false;
+const authKeySecret = process.env.AUTH_KEY_SECRET;
+const clientDomain = process.env.CLIENT_DOMAIN;
+
+let wallet: Wallet;
+if (runMainnet === "true") {
+  console.log("Warning: you are running this script on the public network.");
+  wallet = walletSdk.Wallet.MainNet();
+} else {
+  wallet = walletSdk.Wallet.TestNet();
+}
+const anchor = wallet.anchor({
+  homeDomain: anchorDomain,
+});
+
+const getSep10AuthToken = async () => {
+  const authKey = SigningKeypair.fromSecret(authKeySecret);
+  const sep10 = await anchor.sep10();
+  const signer = DefaultSigner;
+
+  const getAuthToken = async () => {
+    return sep10.authenticate({
+      accountKp: authKey,
+      walletSigner: signer,
+      clientDomain,
+    });
+  };
+
+  const authToken = await getAuthToken();
+
+  return authToken;
+};
+
+const authToken = getSep10AuthToken();
+console.log(`Auth Token: ${authToken}`);

package/examples/sep10/well_known/stellar.toml

@@ -0,0 +1,18 @@
+ACCOUNTS = [ "GBM53YM5CUICEOTGY3N2UJLLZ4QXNCAANINBNLHSNTEULBQ3HENOUU2J" ]
+VERSION = "0.1.0"
+SIGNING_KEY = "GBM53YM5CUICEOTGY3N2UJLLZ4QXNCAANINBNLHSNTEULBQ3HENOUU2J"
+NETWORK_PASSPHRASE = "Test SDF Network ; September 2015"
+
+[[PRINCIPALS]]
+name = "user"
+email = "user@stellar.org"
+keybase = "user"
+github = "https://www.github.com/user"
+
+[DOCUMENTATION]
+ORG_NAME = "Stellar Development Foundation"
+ORG_URL = "https://stellar.org"
+ORG_DESCRIPTION = "TS example backend server."
+ORG_KEYBASE = "stellar.public"
+ORG_TWITTER = "StellarOrg"
+ORG_GITHUB = "stellar"

package/examples/sep12/.env.example

@@ -0,0 +1,2 @@
+SECRET_KEY="S..."
+ANCHOR_DOMAIN=testanchor.stellar.org

package/examples/sep12/README.md

@@ -0,0 +1,25 @@
+# Sep-12 examples for stellar typescript-wallet-sdk
+
+## Example code
+
+To view how the wallet-sdk can be used to add sep12 KYC details, look at
+`./sep12.ts`.
+
+To run the script and interactively collect KYC details, configure the
+appropriate environment variables and run -
+
+```
+$ yarn example:sep12
+```
+
+## Changing environment variables
+
+If you'd like to use different environment variable values than the default
+ones, you can add a `.env` file. See `.env.example` as an example.
+
+The environment variables you can set are:
+
+| Variable Name | Description                                    | Default Value          |
+| ------------- | ---------------------------------------------- | ---------------------- |
+| ANCHOR_DOMAIN | The anchor domain for your application.        | testanchor.stellar.org |
+| SECRET_KEY    | The secret key to use for sep10 authentication |                        |

package/examples/sep12/sep12.ts

@@ -0,0 +1,38 @@
+import path from "path";
+
+import * as dotenv from "dotenv";
+import { SigningKeypair, walletSdk } from "../../src";
+import { askQuestion } from "helpers/ask-question";
+
+dotenv.config({ path: path.resolve(__dirname, ".env") });
+
+const main = async () => {
+  const homeDomain = process.env.ANCHOR_DOMAIN || "testanchor.stellar.org";
+  const secretKey = process.env.SECRET_KEY;
+  if (!secretKey) {
+    throw new Error("No secret key provided");
+  }
+
+  const wallet = walletSdk.Wallet.TestNet();
+  const anchor = wallet.anchor({ homeDomain });
+
+  const authKey = SigningKeypair.fromSecret(secretKey);
+  const sep10 = await anchor.sep10();
+  const authToken = await sep10.authenticate({ accountKp: authKey });
+  const sep12 = await anchor.sep12(authToken);
+
+  const firstName = await askQuestion("What is your first name?");
+  const lastName = await askQuestion("What is your last name?");
+
+  const response = await sep12.add({
+    sep9Info: {
+      first_name: firstName,
+      last_name: lastName,
+      // ...
+    },
+  });
+
+  console.log(response.id);
+};
+
+main();

package/examples/sep24/sep24.ts

@@ -1,5 +1,4 @@
 import axios from "axios";
-import readline from "readline";
 import path from "path";
 
 import {
@@ -19,6 +18,7 @@ import {
 } from "@stellar/stellar-sdk";
 
 import * as dotenv from "dotenv";
+import { askQuestion } from "helpers/ask-question";
 dotenv.config({ path: path.resolve(__dirname, ".env") });
 
 // Grabbing environment variables
@@ -237,18 +237,4 @@ walletSigner.signWithDomainAccount = async ({
   return Promise.resolve(transaction);
 };
 
-export const askQuestion = (query) => {
-  const rl = readline.createInterface({
-    input: process.stdin,
-    output: process.stdout,
-  });
-
-  return new Promise((resolve) =>
-    rl.question(query, (ans) => {
-      rl.close();
-      resolve(ans);
-    }),
-  );
-};
-
 runSep24();