XRPLF · mDuo13 · Sep 23, 2023 · Jun 20, 2023 · Jul 1, 2023 · Jul 1, 2023
diff --git a/content/_code-samples/build-a-wallet/desktop-js/.gitignore b/content/_code-samples/build-a-wallet/desktop-js/.gitignore
@@ -0,0 +1,132 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+Wallet/
diff --git a/content/_code-samples/build-a-wallet/desktop-js/0-hello/index.js b/content/_code-samples/build-a-wallet/desktop-js/0-hello/index.js
@@ -0,0 +1,27 @@
+const { app, BrowserWindow } = require('electron')
+
+const path = require('path')
+
+/**
+ * This is our main function, it creates our application window, preloads the code we will need to communicate
+ * between the renderer Process and the main Process, loads a layout and performs the main logic
+ */
+const createWindow = () => {
+
+    // Creates the application window
+    const appWindow = new BrowserWindow({
+        width: 1024,
+        height: 768
+    })
+
+    // Loads a layout
+    appWindow.loadFile(path.join(__dirname, 'view', 'template.html'))
+
+    return appWindow
+}
+
+// Here we have to wait for the application to signal that it is ready
+// to execute our code. In this case we just create a main window.
+app.whenReady().then(() => {
+    createWindow()
+})
diff --git a/content/_code-samples/build-a-wallet/desktop-js/0-hello/view/template.html b/content/_code-samples/build-a-wallet/desktop-js/0-hello/view/template.html
@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+  <meta charset="UTF-8" />
+  <meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self'" />
+  <meta http-equiv="X-Content-Security-Policy" content="default-src 'self'; script-src 'self'" />
+  <title>XRPL Wallet Tutorial (JavaScript / Electron)</title>
+</head>
+
+<body>
+
+  <h3>Build a XRPL Wallet - Part 0/8</h3>
+  <span>Hello world!</span>
+
+</body>
+
+</html>
diff --git a/content/_code-samples/build-a-wallet/desktop-js/1-ledger-index/index.js b/content/_code-samples/build-a-wallet/desktop-js/1-ledger-index/index.js
@@ -0,0 +1,63 @@
+const { app, BrowserWindow } = require('electron')
+
+const path = require('path')
+const xrpl = require("xrpl")
+
+const TESTNET_URL = "wss://s.altnet.rippletest.net:51233"
+
+/**
+ * This function creates a WebService client, which connects to the XRPL and fetches the latest ledger index.
+ *
+ * @returns {Promise<number>}
+ */
+const getValidatedLedgerIndex = async () => {
+    const client = new xrpl.Client(TESTNET_URL)
+
+    await client.connect()
+
+    // Reference: https://xrpl.org/ledger.html#ledger
+    const ledgerRequest = {
+        "command": "ledger",
+        "ledger_index": "validated"
+    }
+
+    const ledgerResponse = await client.request(ledgerRequest)
+
+    await client.disconnect()
+
+    return ledgerResponse.result.ledger_index
+}
+
+/**
+ * This is our main function, it creates our application window, preloads the code we will need to communicate
+ * between the renderer Process and the main Process, loads a layout and performs the main logic
+ */
+const createWindow = () => {
+
+    // Creates the application window
+    const appWindow = new BrowserWindow({
+        width: 1024,
+        height: 768,
+        webPreferences: {
+            preload: path.join(__dirname, 'view', 'preload.js'),
+        },
+    })
+
+    // Loads a layout
+    appWindow.loadFile(path.join(__dirname, 'view', 'template.html'))
+
+    return appWindow
+}
+
+// Here we have to wait for the application to signal that it is ready
+// to execute our code. In this case we create a main window, query
+// the ledger for its latest index and submit the result to the main
+// window where it will be displayed
+app.whenReady().then(() => {
+
+    const appWindow = createWindow()
+
+    getValidatedLedgerIndex().then((value) => {
+        appWindow.webContents.send('update-ledger-index', value)
+    })
+})
diff --git a/content/_code-samples/build-a-wallet/desktop-js/1-ledger-index/view/preload.js b/content/_code-samples/build-a-wallet/desktop-js/1-ledger-index/view/preload.js
@@ -0,0 +1,11 @@
+const { contextBridge, ipcRenderer } = require('electron');
+
+// Expose functionality from main process (aka. "backend") to be used by the renderer process(aka. "backend")
+contextBridge.exposeInMainWorld('electronAPI', {
+    // By calling "onUpdateLedgerIndex" in the frontend process we can now attach a callback function to
+    // by making onUpdateLedgerIndex available at the window level.
+    // The subscribed function gets triggered whenever the backend process triggers the event 'update-ledger-index'
+    onUpdateLedgerIndex: (callback) => {
+        ipcRenderer.on('update-ledger-index', callback)
+    }
+})
diff --git a/content/_code-samples/build-a-wallet/desktop-js/1-ledger-index/view/renderer.js b/content/_code-samples/build-a-wallet/desktop-js/1-ledger-index/view/renderer.js
@@ -0,0 +1,7 @@
+const ledgerIndexEl = document.getElementById('ledger-index')
+
+// Here we define the callback function that performs the content update
+// whenever 'update-ledger-index' is called by the main process
+window.electronAPI.onUpdateLedgerIndex((_event, value) => {
+    ledgerIndexEl.innerText = value
+})
diff --git a/content/_code-samples/build-a-wallet/desktop-js/1-ledger-index/view/template.html b/content/_code-samples/build-a-wallet/desktop-js/1-ledger-index/view/template.html
@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+  <meta charset="UTF-8" />
+  <meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self'" />
+  <meta http-equiv="X-Content-Security-Policy" content="default-src 'self'; script-src 'self'" />
+  <title>XRPL Wallet Tutorial (JavaScript / Electron)</title>
+</head>
+
+<body>
+
+  <h3>Build a XRPL Wallet - Part 1/8</h3>
+  Latest validated ledger index: <strong id="ledger-index"></strong>
+
+</body>
+
+<script src="renderer.js"></script>
+
+</html>
diff --git a/content/_code-samples/build-a-wallet/desktop-js/2-async/index.js b/content/_code-samples/build-a-wallet/desktop-js/2-async/index.js
@@ -0,0 +1,53 @@
+const { app, BrowserWindow } = require('electron')
+const path = require('path')
+const xrpl = require("xrpl")
+
+const TESTNET_URL = "wss://s.altnet.rippletest.net:51233"
+
+/**
+ * This function creates our application window
+ *
+ * @returns {Electron.CrossProcessExports.BrowserWindow}
+ */
+const createWindow = () => {
+
+    const appWindow = new BrowserWindow({
+        width: 1024,
+        height: 768,
+        webPreferences: {
+            preload: path.join(__dirname, 'view', 'preload.js'),
+        },
+    })
+
+    appWindow.loadFile(path.join(__dirname, 'view', 'template.html'))
+
+    return appWindow
+}
+
+/**
+ * This function creates a XRPL client, subscribes to 'ledger' events from the XRPL and broadcasts those by
+ * dispatching the 'update-ledger-data' event which will be picked up by the frontend
+ *
+ * @returns {Promise<void>}
+ */
+const main = async () => {
+    const appWindow = createWindow()
+
+    const client = new xrpl.Client(TESTNET_URL)
+
+    await client.connect()
+
+    // Subscribe client to 'ledger' events
+    // Reference: https://xrpl.org/subscribe.html
+    await client.request({
+        "command": "subscribe",
+        "streams": ["ledger"]
+    })
+
+    // Dispatch 'update-ledger-data' event
+    client.on("ledgerClosed", async (ledger) => {
+        appWindow.webContents.send('update-ledger-data', ledger)
+    })
+}
+
+app.whenReady().then(main)
diff --git a/content/_code-samples/build-a-wallet/desktop-js/2-async/view/preload.js b/content/_code-samples/build-a-wallet/desktop-js/2-async/view/preload.js
@@ -0,0 +1,7 @@
+const { contextBridge, ipcRenderer } = require('electron');
+
+contextBridge.exposeInMainWorld('electronAPI', {
+    onUpdateLedgerData: (callback) => {
+        ipcRenderer.on('update-ledger-data', callback)
+    }
+})
diff --git a/content/_code-samples/build-a-wallet/desktop-js/2-async/view/renderer.js b/content/_code-samples/build-a-wallet/desktop-js/2-async/view/renderer.js
@@ -0,0 +1,15 @@
+const ledgerIndexEl = document.getElementById('ledger-index')
+
+// Step 2 code additions - start
+const ledgerHashEl = document.getElementById('ledger-hash')
+const ledgerCloseTimeEl = document.getElementById('ledger-close-time')
+// Step 2 code additions - end
+
+window.electronAPI.onUpdateLedgerData((_event, value) => {
+    ledgerIndexEl.innerText = value.ledger_index
+
+    // Step 2 code additions - start
+    ledgerHashEl.innerText = value.ledger_hash
+    ledgerCloseTimeEl.innerText = value.ledger_time
+    // Step 2 code additions - end
+})
diff --git a/content/_code-samples/build-a-wallet/desktop-js/2-async/view/template.html b/content/_code-samples/build-a-wallet/desktop-js/2-async/view/template.html
@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+  <meta charset="UTF-8" />
+  <meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self'" />
+  <meta http-equiv="X-Content-Security-Policy" content="default-src 'self'; script-src 'self'" />
+  <title>XRPL Wallet Tutorial (JavaScript / Electron)</title>
+</head>
+
+<body>
+  <h3>Build a XRPL Wallet - Part 2/8</h3>
+  <b>Latest validated ledger stats</b><br />
+  Ledger Index: <strong id="ledger-index"></strong><br />
+  Ledger Hash: <strong id="ledger-hash"></strong><br />
+  Close Time: <strong id="ledger-close-time"></strong><br />
+</body>
+
+<script src="renderer.js"></script>
+
+</html>