New post. Doc update. Swift 6

Author: craigwrong

.github/workflows/publish.yml

@@ -33,7 +33,7 @@ jobs:
       - name: Install Swift
         uses: sersoft-gmbh/swifty-linux-action@v3
         with:
-          release-version: 5.9
+          release-version: 6.0
       - name: Build with SwiftySites
         run: swift run -c release generate --clean
       - name: Upload artifact

.swiftpm/configuration/Package.resolved

@@ -0,0 +1,79 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1540"
+   version = "1.7">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES"
+      buildArchitectures = "Automatic">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "generate"
+               BuildableName = "generate"
+               BlueprintName = "generate"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      shouldAutocreateTestPlan = "YES">
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "YES"
+      customWorkingDirectory = "/Users/d/Developer/CraigWrong/swift-bitcoin.github.io"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "generate"
+            BuildableName = "generate"
+            BlueprintName = "generate"
+            ReferencedContainer = "container:">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "generate"
+            BuildableName = "generate"
+            BlueprintName = "generate"
+            ReferencedContainer = "container:">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

.swiftpm/xcode/xcshareddata/xcschemes/SwiftBitcoin.xcscheme

@@ -1,11 +1,11 @@
-// swift-tools-version:5.9
+// swift-tools-version:6.0
 import PackageDescription
 
 let package = Package(
     name: "SwiftBitcoin",
     platforms: [.macOS(.v14)],
     dependencies: [
-        .package(url: "https://github.com/swiftysites/swiftysites", branch: "release")],
+        .package(url: "https://github.com/swiftysites/swiftysites", from: "2.0.0")],
     targets: [
         .executableTarget(
             name: "generate",

Package.resolved

@@ -0,0 +1,132 @@
+let post04 = Post("/post/2024-10-06-update", "October Update", "2024-10-06T12:00:00Z", .announcements) { """
+
+So far this year the focus has shifted a bit from getting the client fluent in the peer-to-peer language protocol to making important refinements to many of the public APIs offered by the package.
+
+# New package organization
+
+Swift Bitcoin is now organized in several discreet modules:
+
+- _Crypto_ – Contains all the elliptic curve cryptography needed as well as indispensable hash functions and encodings.
+- _Base_ – Focuses on transaction building and verifying, including a full SCRIPT interpreter.
+- _Wallet_ – Adds a layer which includes addresses, key derivation, mnemonics and signing. 
+- _Blockchain_ – Exposes services for blocks, mempool and chain state management, complete with a basic mining algorithm.
+- _Transport_ – Introduces the notion of network peers and how they communicate using the P2P protocol. 
+- _RPC_ – Provides codecs for important remote node commands.
+
+In additions to these libraries, the package delivers two command-line tools:
+
+- _Node_ – Launches an instance of a full node which listens to RPC commands and can speak the wire protocol. 
+- _Utility_ – Can be used to control running service instances as well as perform a series of offline operations.
+
+# Improved API examples
+
+As an example of the simplicity of the new APIs here's some code snippets taken from the revamped [documentation](https://swift-bitcoin.github.io/docc/documentation/bitcoin/):
+
+## Running a simple script
+
+Here's how to add two numbers:
+
+```swift
+let stack = try BitcoinScript([.constant(1), .constant(1), .add]).run()
+#expect(stack.count == 1)
+let number = try ScriptNumber(stack[0])
+#expect(number.value == 2)
+```
+
+## Spending a transaction
+
+This is how Bob would send satoshis to Alice:
+
+```swift
+// Bob gets paid.
+let bobsSecretKey = SecretKey()
+let bobsAddress = BitcoinAddress(bobsSecretKey)
+
+// The funding transaction, sending money to Bob.
+let fundingTransaction = BitcoinTransaction(inputs: [.init(outpoint: .coinbase)], outputs: [
+    bobsAddress.output(100) // 100 satoshis
+])
+
+// Alice generates an address to give Bob.
+
+let alicesSecretKey = SecretKey()
+let alicesAddress = BitcoinAddress(alicesSecretKey)
+
+// Bob constructs, sings and broadcasts a transaction which pays Alice at her address.
+
+// The spending transaction by which Bob sends money to Alice
+let spendingTransaction = BitcoinTransaction(inputs: [
+    .init(outpoint: fundingTransaction.outpoint(0)),
+], outputs: [
+    alicesAddress.output(50) // 50 satoshis
+])
+
+// Sign the spending transaction.
+let prevouts = [fundingTransaction.outputs[0]]
+let signer = TransactionSigner(
+    transaction: spendingTransaction, prevouts: prevouts, sighashType: .all
+)
+let signedTransaction = signer.sign(input: 0, with: bobsSecretKey)
+
+// Verify transaction signatures.
+let result = signedTransaction.verifyScript(prevouts: prevouts)
+#expect(result)
+```
+
+## Connecting two nodes
+
+Here's how Hal would connect to Satoshi:
+
+```swift
+let satoshiChain = BitcoinService()
+let publicKey = try #require(PublicKey(compressed: [0x03, …]))
+await satoshiChain.generateTo(publicKey)
+
+let satoshi = NodeService(bitcoinService: satoshiChain, feeFilterRate: 2)
+let halPeer = await satoshi.addPeer()
+var satoshiOut = await satoshi.getChannel(for: halPeer).makeAsyncIterator()
+
+let halChain = BitcoinService()
+let hal = NodeService(bitcoinService: halChain, feeFilterRate: 3)
+let satoshiPeer = await hal.addPeer(incoming: false)
+var halOut = await hal.getChannel(for: satoshiPeer).makeAsyncIterator()
+
+// Perform the wire protocol handshake (simplified)
+
+await hal.connect(satoshiPeer)
+
+// `messageHS0` means "0th Message from Hal to Satoshi".
+
+// Hal --(version)->> …
+let messageHS0_version = try #require(await hal.popMessage(satoshiPeer))
+
+// … --(version)->> Satoshi
+try await satoshi.processMessage(messageHS0_version, from: halPeer)
+
+// Satoshi --(version)->> …
+let messageSH0_version = try #require(await satoshi.popMessage(halPeer))
+
+// Satoshi --(verack)->> …
+let messageSH3_verack = try #require(await satoshi.popMessage(halPeer))
+
+// … --(version)->> Hal
+try await hal.processMessage(messageSH0_version, from: satoshiPeer)
+
+// … --(verack)->> Hal
+try await hal.processMessage(messageSH3_verack, from: satoshiPeer)
+
+// Hal --(verack)->> …
+let messageHS3_verack = try #require(await hal.popMessage(satoshiPeer))
+
+// … --(verack)->> Satoshi
+try await satoshi.processMessage(messageHS3_verack, from: halPeer)
+```
+
+# Next steps
+
+Going forward the priority should be to get the transport layer to perform an initial block download against a running Core regtest instance.
+
+The blockchain component needs to be developed further including all block related BIPs.
+
+Finally even more tests need to be migrated over to increase the reliability of the implementation.
+""" }

Package.swift

@@ -1,7 +1,7 @@
 import SwiftySites
 
 let posts = [
-    post01, post02, post03
+    post01, post02, post03, post04
 ]
 
 let site = Site(

src/content/post/posts2024.swift

@@ -1,6 +1,6 @@
 import SwiftySites
 
-let footerPartial = { (page: Page?) -> String in """
+func footerPartial(_ page: Page?) -> String { """
 <footer>
     <a href="https://github.com/swift-bitcoin/swift-bitcoin">Cypherpunks write code 👾</a>
 </footer>

src/main.swift

@@ -1,6 +1,6 @@
 import SwiftySites
 
-let navigationPartial = { (page: Page?) -> String in """
+func navigationPartial(_ page: Page?) -> String { """
 <nav>
     <ul>
         \([pageHome, pageInfo].reduce("") {

src/partials/footerPartial.swift

@@ -1,6 +1,6 @@
 import SwiftySites
 
-let summaryPartial = { (post: Post) -> String in """
+func summaryPartial(_ post: Post) -> String { """
 <article class="summary">
     <header>
         <p class="date"><a href="\(post.path)">\(post.dateFormatted)</a> • <a href="/category/\(post.category)">\(post.category.name)</a></p>