update readme and other nits #81
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -111,6 +111,18 @@ function toNumber(value, fallback = 0) { | |
| return Number.isFinite(normalized) ? normalized : fallback; | ||
| } | ||
|
|
||
| function normalizeTimestamp(value, fallback = null) { | ||
| if (value == null || value === '') return fallback; | ||
|
|
||
| const numeric = Number(value); | ||
| if (Number.isFinite(numeric)) { | ||
| return numeric < 1e12 ? numeric * 1000 : numeric; | ||
| } | ||
|
|
||
| const parsed = new Date(value).getTime(); | ||
| return Number.isFinite(parsed) ? parsed : fallback; | ||
| } | ||
|
|
||
| function getOfferbookSnapshot() { | ||
| const offerbookPath = path.join(api1State.DATA_DIR, 'offerbook.json'); | ||
| const snapshot = { | ||
|
|
@@ -249,6 +261,7 @@ function inferTaprootFromReport(rawReport = {}) { | |
| } | ||
|
|
||
| function buildSwapReportRecord(filePath, rawReport) { | ||
| const fileStats = fs.statSync(filePath); | ||
| const fileName = path.basename(filePath, '.json'); | ||
| const nativeSwapId = | ||
| rawReport.nativeSwapId || | ||
|
|
@@ -293,10 +306,16 @@ function buildSwapReportRecord(filePath, rawReport) { | |
| rawReport.report?.endTimestamp || | ||
| rawReport.report?.end_timestamp || | ||
| null; | ||
| const completedAt = normalizeTimestamp(rawCompletedAt, fileStats.mtimeMs); | ||
| const startedAt = normalizeTimestamp( | ||
| rawReport.startedAt || | ||
| rawReport.started_at || | ||
| rawReport.report?.startedAt || | ||
| rawReport.report?.started_at || | ||
| rawReport.report?.startTimestamp || | ||
| rawReport.report?.start_timestamp, | ||
| null | ||
| ); | ||
| const isTaproot = inferTaprootFromReport(rawReport); | ||
| const protocol = normalizeSwapProtocol( | ||
| rawReport.protocol || nestedReport.protocol, | ||
|
|
@@ -316,7 +335,9 @@ function buildSwapReportRecord(filePath, rawReport) { | |
| nativeSwapId, | ||
| appSwapId, | ||
| status: normalizedStatus, | ||
| startedAt, | ||
| completedAt, | ||
| fileModifiedAt: fileStats.mtimeMs, | ||
| filePath, | ||
| fileName, | ||
| isCoreReport, | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,14 +16,14 @@ This guide covers all features and functionality of the Coinswap Taker App. | |
|
|
||
| ## Setup and Connection | ||
|
|
||
| On launch, the app walks through setup and connection configuration: | ||
|
|
||
| 1. **Bitcoin Core Connection** - Configure RPC credentials and port | ||
| 2. **Tor Configuration** - Set control and SOCKS ports (defaults: 9051, 9050) | ||
| 3. **Wallet Loading** - Opens your existing encrypted wallet, prompts creation, or allows restoration from backup JSON | ||
| 4. **ZMQ Setup** - Configure real-time block and transaction notifications as part of the Bitcoin endpoint setup | ||
|
|
||
| The setup page allows you to review and update your configuration. | ||
|
|
||
| ## Wallet Page | ||
|
|
||
|
|
@@ -102,7 +102,7 @@ Configure app and Bitcoin Core connection: | |
| - **Wallet Backup** - Create encrypted wallet backups | ||
| - **Connection Testing** - Verify Bitcoin Core and Tor connectivity | ||
|
|
||
| Settings can be reviewed and updated from the app, though the current development build may require re-running setup on launch. | ||
|
|
||
| ## Log Page | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -36,6 +36,22 @@ export function Market(container) { | |
| } | ||
| } | ||
|
|
||
| function formatTorEndpoint(address, start = 14, end = 16) { | ||
| if (!address || typeof address !== 'string') return 'unknown'; | ||
|
|
||
| const separatorIndex = address.lastIndexOf(':'); | ||
| if (separatorIndex === -1) return address; | ||
|
|
||
| const host = address.slice(0, separatorIndex); | ||
| const port = address.slice(separatorIndex + 1); | ||
|
|
||
| if (host.length <= start + end + 3) { | ||
| return `${host}:${port}`; | ||
| } | ||
|
|
||
| return `${host.slice(0, start)}...${host.slice(-end)}:${port}`; | ||
| } | ||
|
Comment on lines
+39
to
+53
There was a problem hiding this comment. 🧹 Nitpick | 🔵 Trivial Extract This helper is now identical to the one in 🤖 Prompt for AI Agents |
||
|
|
||
| // Check sync state every second | ||
| function startSyncStateMonitor() { | ||
| if (syncCheckInterval) return; | ||
|
|
@@ -754,7 +770,7 @@ export function Market(container) { | |
| ${protocolBadge.icon} ${protocolBadge.label} | ||
| </span> | ||
| </div> | ||
| <div class="text-gray-300 font-mono text-sm truncate" title="${maker.address}">${formatTorEndpoint(maker.address)}</div> | ||
| <div class="text-green-400">${maker.baseFee}</div> | ||
| <div class="text-blue-400">${maker.volumeFee}%</div> | ||
| <div class="text-cyan-400">${maker.timeFee}%</div> | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,9 +17,9 @@ export function ReceiveComponent(container) { | |
| <!-- QR Code --> | ||
| <div class="bg-white p-4 rounded-lg mb-6 flex items-center justify-center"> | ||
| <div id="qr-container" class="flex items-center justify-center" style="min-height: 256px; min-width: 256px;"> | ||
| <div id="qr-loading" class="text-center text-gray-500"> | ||
| <p class="text-sm">No address loaded</p> | ||
| <p class="text-xs mt-2">Click the button below to generate a receive address.</p> | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
@@ -28,7 +28,7 @@ export function ReceiveComponent(container) { | |
| <div class="mb-6"> | ||
| <div class="bg-[#0f1419] border border-gray-700 rounded-lg p-4 flex items-center justify-between"> | ||
| <span id="current-address" class="font-mono text-sm text-white break-all flex-1 mr-4"> | ||
| No address loaded | ||
| </span> | ||
| <button id="copy-address" disabled class="bg-[#FF6B35] hover:bg-[#ff7d4d] disabled:bg-gray-600 disabled:cursor-not-allowed text-white px-4 py-2 rounded text-sm font-semibold text-lg transition-colors whitespace-nowrap"> | ||
| Copy | ||
|
|
@@ -40,8 +40,8 @@ export function ReceiveComponent(container) { | |
| </div> | ||
|
|
||
| <!-- Generate New Address Button --> | ||
| <button id="generate-new" class="w-full bg-[#242d3d] hover:bg-[#2d3748] disabled:bg-gray-700 disabled:cursor-not-allowed text-white font-semibold text-lg py-3 rounded-lg transition-colors border border-gray-700"> | ||
| <span class="generate-text">Generate Address</span> | ||
| <span class="generate-loading hidden"> | ||
|
Comment on lines
+43
to
45
There was a problem hiding this comment. Don't leak fresh receive addresses to a third-party QR service. Manual generation is now the primary receive path, and this flow still hands the new address to Also applies to: 402-405, 419-424 🤖 Prompt for AI Agents |
||
| <span class="inline-block animate-spin mr-2">⟳</span> | ||
| Generating... | ||
|
|
@@ -399,9 +399,9 @@ export function ReceiveComponent(container) { | |
|
|
||
| // Show loading in QR container | ||
| qrContainer.innerHTML = ` | ||
| <div class="text-center"> | ||
| <div class="animate-spin rounded-full h-8 w-8 border-b-2 border-gray-400 mx-auto mb-2"></div> | ||
| <p class="text-sm text-gray-500">Generating address...</p> | ||
| </div> | ||
| `; | ||
|
|
||
|
|
@@ -457,17 +457,10 @@ export function ReceiveComponent(container) { | |
| } | ||
| } | ||
|
|
||
| async function initialize() { | ||
| try { | ||
| await updateRecentAddresses(); | ||
| updateAddressStatus(null); | ||
| } catch (error) { | ||
| console.error('❌ Initialization failed:', error); | ||
| currentAddressEl.textContent = 'Failed to initialize'; | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -50,6 +50,22 @@ function saveSwapDataToCache(utxos, makers, balance) { | |||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||
| function formatTorEndpoint(address, start = 14, end = 16) { | ||||||||||||||||||||||||||||||||||||||||
| if (!address || typeof address !== 'string') return 'unknown'; | ||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||
| const separatorIndex = address.lastIndexOf(':'); | ||||||||||||||||||||||||||||||||||||||||
| if (separatorIndex === -1) return address; | ||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||
| const host = address.slice(0, separatorIndex); | ||||||||||||||||||||||||||||||||||||||||
| const port = address.slice(separatorIndex + 1); | ||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||
| if (host.length <= start + end + 3) { | ||||||||||||||||||||||||||||||||||||||||
| return `${host}:${port}`; | ||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||
| return `${host.slice(0, start)}...${host.slice(-end)}:${port}`; | ||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||
| export async function SwapComponent(container) { | ||||||||||||||||||||||||||||||||||||||||
| const existingContent = container.querySelector('#swap-content'); | ||||||||||||||||||||||||||||||||||||||||
| if (existingContent) { | ||||||||||||||||||||||||||||||||||||||||
|
|
@@ -662,10 +678,13 @@ export async function SwapComponent(container) { | |||||||||||||||||||||||||||||||||||||||
| details.hops + ' hop' + (details.hops !== 1 ? 's' : ''); | ||||||||||||||||||||||||||||||||||||||||
| content.querySelector('#estimated-time').textContent = | ||||||||||||||||||||||||||||||||||||||||
| formatEstimatedTime(details.timeSeconds); | ||||||||||||||||||||||||||||||||||||||||
| const selectedMakersText = | ||||||||||||||||||||||||||||||||||||||||
| getTopCandidateMakers() | ||||||||||||||||||||||||||||||||||||||||
| .map((maker) => formatTorEndpoint(maker.address)) | ||||||||||||||||||||||||||||||||||||||||
| .join(', ') || 'None selected'; | ||||||||||||||||||||||||||||||||||||||||
| const selectedMakersEl = content.querySelector('#selected-makers-display'); | ||||||||||||||||||||||||||||||||||||||||
| selectedMakersEl.textContent = selectedMakersText; | ||||||||||||||||||||||||||||||||||||||||
| selectedMakersEl.title = selectedMakersText; | ||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+681
to
+687
There was a problem hiding this comment. Tooltip shows abbreviated value instead of full addresses. Setting 🔧 Proposed fix to show full addresses in tooltip const selectedMakersText =
getTopCandidateMakers()
.map((maker) => formatTorEndpoint(maker.address))
.join(', ') || 'None selected';
+ const fullAddressesText =
+ getTopCandidateMakers()
+ .map((maker) => maker.address)
+ .join(', ') || 'None selected';
const selectedMakersEl = content.querySelector('#selected-makers-display');
selectedMakersEl.textContent = selectedMakersText;
- selectedMakersEl.title = selectedMakersText;
+ selectedMakersEl.title = fullAddressesText;📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||||||||||||||||||||||||||||
| content.querySelector('#maker-fee-percent').textContent = | ||||||||||||||||||||||||||||||||||||||||
| details.makerFeePercent + '%'; | ||||||||||||||||||||||||||||||||||||||||
| content.querySelector('#maker-fee-sats').textContent = | ||||||||||||||||||||||||||||||||||||||||
|
|
@@ -1104,7 +1123,7 @@ export async function SwapComponent(container) { | |||||||||||||||||||||||||||||||||||||||
| </div> | ||||||||||||||||||||||||||||||||||||||||
| <div class="flex justify-between mb-2 gap-3"> | ||||||||||||||||||||||||||||||||||||||||
| <span class="text-sm text-gray-400">Top Maker Candidates</span> | ||||||||||||||||||||||||||||||||||||||||
| <span id="selected-makers-display" class="text-sm text-cyan-400 text-right whitespace-nowrap overflow-hidden text-ellipsis block max-w-[220px] md:max-w-[280px] lg:max-w-[340px]" title="None selected">None selected</span> | ||||||||||||||||||||||||||||||||||||||||
| </div> | ||||||||||||||||||||||||||||||||||||||||
| <div class="flex justify-between mb-2"> | ||||||||||||||||||||||||||||||||||||||||
| <span class="text-sm text-gray-400">Hops</span> | ||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add blank lines around this heading and the fenced blocks.
markdownlint is still flagging MD022/MD031 in this section, so the README will keep warning until the heading and each code fence are separated by blank lines.
Also applies to: 133-143
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 123-123: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 124-124: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
🤖 Prompt for AI Agents