feat: Generate TS from XDR

soroban-spec/src/gen/ts/boilerplate.rs

@@ -1,7 +1,7 @@
 #![allow(non_snake_case)]
+use heck::ToLowerCamelCase;
 use heck::ToShoutySnakeCase;
 use include_dir::{include_dir, Dir};
-use serde::Serialize;
 use std::{
     fs,
     io::Write,
@@ -37,86 +37,66 @@ impl Project {
         contract_id: &str,
         spec: &[ScSpecEntry],
     ) -> std::io::Result<()> {
-        self.add_contract_id(contract_name, contract_id)?;
-        self.add_interface(contract_name)?;
-        self.update_package_json(contract_name)?;
+        self.replace_placeholder_patterns(contract_name, contract_id)?;
         self.append_index_ts(spec)
     }
 
-    fn append_index_ts(&self, spec: &[ScSpecEntry]) -> std::io::Result<()> {
-        fs::OpenOptions::new()
-            .append(true)
-            .open(self.0.join("src/index.ts"))?
-            .write_all(generate(spec).as_bytes())
-    }
-
-    fn add_contract_id(&self, contract_name: &str, contract_id: &str) -> std::io::Result<()> {
+    fn replace_placeholder_patterns(
+        &self,
+        contract_name: &str,
+        contract_id: &str,
+    ) -> std::io::Result<()> {
+        let replacement_strings = &[
+            ("INSERT_CONTRACT_NAME_HERE", contract_name.to_string()),
+            (
+                "INSERT_SCREAMING_SNAKE_CASE_CONTRACT_NAME_HERE",
+                contract_name.to_shouty_snake_case(),
+            ),
+            (
+                "INSERT_CAMEL_CASE_CONTRACT_NAME_HERE",
+                contract_name.to_lower_camel_case(),
+            ),
+            ("INSERT_CONTRACT_ID_HERE", contract_id.to_string()),
+            ("INSERT_NETWORK_NAME_HERE", "FUTURENET".to_string()),
+            (
+                "INSERT_NETWORK_PASSPHRASE_HERE",
+                "Test SDF Future Network ; October 2022".to_string(),
+            ),
+            (
+                "INSERT_RPC_URL_HERE",
+                "https://rpc-futurenet.stellar.org:443/soroban/rpc".to_string(),
+            ),
+        ];
         let root: &Path = self.as_ref();
-        let CONTRACT_NAME = contract_name.to_shouty_snake_case();
-        fs::OpenOptions::new()
-            .append(true)
-            .open(root.join("src/constants.ts"))?
-            .write_all(
-                format!(
-                    r#"
-/**
- * The Soroban contract ID for the `{contract_name}` contract.
- * 
- * You can override this by setting a `SOROBAN_{CONTRACT_NAME}_CONTRACT_ID` or
- * `PUBLIC_SOROBAN_{CONTRACT_NAME}_CONTRACT_ID` environment variable.
- */
-export const CONTRACT_ID = import.meta.env.PUBLIC_SOROBAN_{CONTRACT_NAME}_CONTRACT_ID
-    ?? import.meta.env.SOROBAN_{CONTRACT_NAME}_CONTRACT_ID
-    ?? '{contract_id}'
-"#
-                )
-                .as_bytes(),
-            )
+        [
+            "package.json",
+            "README.md",
+            "src/constants.ts",
+            "src/convert.ts",
+            "src/env.d.ts",
+            "src/index.ts",
+            "src/invoke.ts",
+            "src/server.ts",
+        ]
+        .into_iter()
+        .map(|file_name| {
+            let file = &root.join(file_name);
+            let mut contents = fs::read_to_string(file).unwrap();
+            replacement_strings
+                .iter()
+                .for_each(|(pattern, replacement)| {
+                    contents = contents.replace(pattern, replacement);
+                });
+            fs::write(file, contents)
+        })
+        .collect::<std::io::Result<()>>()
     }
 
-    fn add_interface(&self, contract_name: &str) -> std::io::Result<()> {
-        let CONTRACT_NAME = contract_name.to_shouty_snake_case();
-        let root: &Path = self.as_ref();
-
+    fn append_index_ts(&self, spec: &[ScSpecEntry]) -> std::io::Result<()> {
         fs::OpenOptions::new()
             .append(true)
-            .open(root.join("src/env.d.ts"))?
-            .write_all(
-                format!(
-                    r#"
-interface ImportMetaEnv {{
-    readonly PUBLIC_SOROBAN_{CONTRACT_NAME}_CONTRACT_ID: string;
-    readonly SOROBAN_{CONTRACT_NAME}_CONTRACT_ID: string;
-
-    readonly PUBLIC_SOROBAN_NETWORK_NAME: string;
-    readonly SOROBAN_NETWORK_NAME: string;
-
-    readonly PUBLIC_SOROBAN_NETWORK_PASSPHRASE: string;
-    readonly SOROBAN_NETWORK_PASSPHRASE: string;
-
-    readonly PUBLIC_SOROBAN_RPC_URL: string;
-    readonly SOROBAN_RPC_URL: string;
-}}
-"#
-                )
-                .as_bytes(),
-            )
-    }
-
-    fn update_package_json(&self, contract_name: &str) -> std::io::Result<()> {
-        let p = self.0.join("package.json");
-        let mut value: serde_json::Value = fs::read_to_string(&p)?.parse()?;
-        let obj = value.as_object_mut().unwrap();
-        obj.insert(
-            "name".to_owned(),
-            serde_json::Value::String(contract_name.to_owned()),
-        );
-        let mut buf = Vec::new();
-        let formatter = serde_json::ser::PrettyFormatter::with_indent(b"    ");
-        let mut ser = serde_json::Serializer::with_formatter(&mut buf, formatter);
-        obj.serialize(&mut ser).unwrap();
-        fs::write(&p, &buf)?;
-        Ok(())
+            .open(self.0.join("src/index.ts"))?
+            .write_all(generate(spec).as_bytes())
     }
 }
 

soroban-spec/src/gen/ts/project_template/README.md

@@ -1,32 +1,32 @@
-# abundance-token JS
+# INSERT_CONTRACT_NAME_HERE JS
 
-JS library for interacting with [Soroban](https://soroban.stellar.org/) smart contract `abundance-token` via Soroban RPC.
+JS library for interacting with [Soroban](https://soroban.stellar.org/) smart contract `INSERT_CONTRACT_NAME_HERE` via Soroban RPC.
 
 This library was automatically generated by Soroban CLI using a command similar to:
 
 ```bash
 soroban contract bindings ts \
-  --rpc-url https://rpc-futurenet.stellar.org:443/soroban/rpc \
-  --network-passphrase "Test SDF Future Network ; October 2022" \
-  --id 2c6c3b8ba9923d029d8ef7eb80080384b1da32bcf0698290119fdfbf3f2a01de \
-  --name abundance-token
+  --rpc-url INSERT_RPC_URL_HERE \
+  --network-passphrase "INSERT_NETWORK_PASSPHRASE_HERE" \
+  --id INSERT_CONTRACT_ID_HERE \
+  --name INSERT_CONTRACT_NAME_HERE
 ```
 
 It uses these settings by default, but you can override them with environment variables if you need to:
 
-- **Contract ID**: `2c6c3b8ba9923d029d8ef7eb80080384b1da32bcf0698290119fdfbf3f2a01de`
+- **Contract ID**: `INSERT_CONTRACT_ID_HERE`
 
-  Override with environment variable `SOROBAN_ABUNDANCE_TOKEN_CONTRACT_ID` or `PUBLIC_SOROBAN_ABUNDANCE_TOKEN_CONTRACT_ID`
+  Override with environment variable `SOROBAN_INSERT_SCREAMING_SNAKE_CASE_CONTRACT_NAME_HERE_CONTRACT_ID` or `PUBLIC_SOROBAN_INSERT_SCREAMING_SNAKE_CASE_CONTRACT_NAME_HERE_CONTRACT_ID`
 
-- **RPC endpoint**: `https://rpc-futurenet.stellar.org:443/soroban/rpc`
+- **RPC endpoint**: `INSERT_RPC_URL_HERE`
 
   Override with environment variable `SOROBAN_RPC_URL` or `PUBLIC_SOROBAN_RPC_URL`
 
-- **Network Passphrase**: `Test SDF Future Network ; October 2022`
+- **Network Passphrase**: `INSERT_NETWORK_PASSPHRASE_HERE`
 
   Override with environment variable `SOROBAN_NETWORK_PASSPHRASE` or `PUBLIC_SOROBAN_NETWORK_PASSPHRASE`
 
-- **Freighter Network Name**: `FUTURENET`
+- **Freighter Network Name**: `INSERT_NETWORK_NAME_HERE`
 
   What's this? [Freighter](https://www.freighter.app/) is the only signer/wallet supported for now. The [`signTransaction` method](https://docs.freighter.app/docs/guide/usingfreighternode/#signtransaction) requires a [specific naming convention](https://github.com/stellar/freighter/blob/7158e5f3b0bcb6b8d9086312955d1ce94352410e/%40shared/constants/stellar.ts#L12) for different networks.
 
@@ -39,17 +39,17 @@ You don't need to publish this library to NPM to use it. You can add it to your
 ```json
 {
   "dependencies": {
-    "abundance-token": "./path/to/this/folder"
+    "INSERT_CONTRACT_NAME_HERE": "./path/to/this/folder"
   }
 }
 ```
 
 Then you can import it into your editor and see inline documentation for all of its exports:
 
 ```js
-import * as abundanceToken from "abundance-token"
+import * as INSERT_CAMEL_CASE_CONTRACT_NAME_HERE from "INSERT_CONTRACT_NAME_HERE"
 
-abundanceToken.|
+INSERT_CAMEL_CASE_CONTRACT_NAME_HERE.|
 ```
 
 As long as your editor is configured to show JavaScript/TypeScript documentation, you can pause your typing at that `|` to get a list of all exports and inline-documentation for each. It exports a separate [async](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function) function for each method in the smart contract, with documentation for each generated from the comments the contract's author included in the original source code.

soroban-spec/src/gen/ts/project_template/package.json

@@ -1,6 +1,6 @@
 {
     "version": "0.0.0",
-    "name": "abundance-token",
+    "name": "INSERT_CONTRACT_NAME_HERE",
     "dependencies": {
         "@stellar/freighter-api": "1.4.0",
         "buffer": "6.0.3",

soroban-spec/src/gen/ts/project_template/src/constants.ts

@@ -1,3 +1,13 @@
+/**
+ * The Soroban contract ID for the `INSERT_CONTRACT_NAME_HERE` contract.
+ *
+ * You can override this by setting a `SOROBAN_INSERT_SCREAMING_SNAKE_CASE_CONTRACT_NAME_HERE_CONTRACT_ID` or
+ * `PUBLIC_SOROBAN_INSERT_SCREAMING_SNAKE_CASE_CONTRACT_NAME_HERE_CONTRACT_ID` environment variable.
+ */
+export const CONTRACT_ID = import.meta.env.PUBLIC_SOROBAN_INSERT_SCREAMING_SNAKE_CASE_CONTRACT_NAME_HERE_CONTRACT_ID
+    ?? import.meta.env.SOROBAN_INSERT_SCREAMING_SNAKE_CASE_CONTRACT_NAME_HERE_CONTRACT_ID
+    ?? 'INSERT_CONTRACT_ID_HERE'
+
 /**
  * Matches the name given by Freighter's `getNetworkDetails().network` for the network used to initialize this library.
  *
@@ -6,7 +16,7 @@
  */
 export const NETWORK_NAME = import.meta.env.PUBLIC_SOROBAN_NETWORK_NAME
   ?? import.meta.env.SOROBAN_NETWORK_NAME
-  ?? 'FUTURENET'
+  ?? 'INSERT_NETWORK_NAME_HERE'
 
 /**
  * The Soroban network passphrase used to initialize this library.
@@ -16,7 +26,7 @@ export const NETWORK_NAME = import.meta.env.PUBLIC_SOROBAN_NETWORK_NAME
  */
 export const NETWORK_PASSPHRASE = import.meta.env.PUBLIC_SOROBAN_NETWORK_PASSPHRASE
   ?? import.meta.env.SOROBAN_NETWORK_PASSPHRASE
-  ?? 'Test SDF Future Network ; October 2022'
+  ?? 'INSERT_NETWORK_PASSPHRASE_HERE'
 
 /**
  * The Soroban RPC endpoint used to initialize this library.
@@ -26,5 +36,5 @@ export const NETWORK_PASSPHRASE = import.meta.env.PUBLIC_SOROBAN_NETWORK_PASSPHR
  */
 export const RPC_URL = import.meta.env.PUBLIC_SOROBAN_RPC_URL
   ?? import.meta.env.SOROBAN_RPC_URL
-  ?? 'https://rpc-futurenet.stellar.org:443/soroban/rpc'
+  ?? 'INSERT_RPC_URL_HERE'
 

soroban-spec/src/gen/ts/project_template/src/env.d.ts

@@ -1,4 +1,16 @@
+interface ImportMetaEnv {
+  readonly PUBLIC_SOROBAN_INSERT_SCREAMING_SNAKE_CASE_CONTRACT_NAME_HERE_CONTRACT_ID: string;
+  readonly SOROBAN_INSERT_SCREAMING_SNAKE_CASE_CONTRACT_NAME_HERE_CONTRACT_ID: string;
 
+  readonly PUBLIC_SOROBAN_NETWORK_NAME: string;
+  readonly SOROBAN_NETWORK_NAME: string;
+
+  readonly PUBLIC_SOROBAN_NETWORK_PASSPHRASE: string;
+  readonly SOROBAN_NETWORK_PASSPHRASE: string;
+
+  readonly PUBLIC_SOROBAN_RPC_URL: string;
+  readonly SOROBAN_RPC_URL: string;
+}
 
 interface ImportMeta {
   readonly env: ImportMetaEnv;

soroban-spec/src/gen/ts/project_template/src/invoke.ts

@@ -41,7 +41,9 @@ export async function getAccount(): Promise<Account> {
 }
 
 /**
- * Invoke a method on the Abundance token contract.
+ * Invoke a method on the INSERT_CONTRACT_NAME_HERE contract.
+ *
+ * Uses Freighter to determine the current user and sign the transaction.
  *
  * @param {string} obj.method - The method to invoke.
  * @param {any[]} obj.args - The arguments to pass to the method.
@@ -121,4 +123,4 @@ async function invokeRpc(tx: Tx): Promise<TxResponse> {
   }
 
   return getTransactionResponse
-}
+}