Merge pull request #185 from Vib-UX/wire_shutdown

bmancini55 · web-flow · commit de8afecbee83 · 2021-08-04T12:11:25.000-04:00
Wire shutdown, closes #179
diff --git a/packages/wire/__tests__/messages/ShutdownChannelMessage.spec.ts b/packages/wire/__tests__/messages/ShutdownChannelMessage.spec.ts
@@ -0,0 +1,35 @@
+import { ChannelId } from "@node-lightning/core";
+import { expect } from "chai";
+import { ShutdownMessage } from "../../lib/messages/ShutdownMessage";
+
+describe("ShutdownChannelMessage", () => {
+    describe(".deserialize", () => {
+        it("should deserialize without error", () => {
+            const input = Buffer.from(
+                "0026"+ // type
+                "0000000000000000000000000000000000000000000000000000000000000000" +    // Channel ID
+                "0015" +  //len
+                "00a41a8527eab06efc0a8df57045d247784a071e23" //p2wpkh 
+                 ,"hex"); // prettier-ignore
+            const result = ShutdownMessage.deserialize(input);
+            expect(result.type).to.equal(38);
+            expect(result.channelId.toString()).to.equal("0000000000000000000000000000000000000000000000000000000000000000"); // prettier-ignore
+            expect(result.scriptPubKey.toString("hex")).to.equal("00a41a8527eab06efc0a8df57045d247784a071e23"); // prettier-ignore
+        });
+    });
+    describe(".serialize", () => {
+        it("should serialize a message", () => {
+            const instance = new ShutdownMessage();
+            instance.channelId = new ChannelId(Buffer.from("0000000000000000000000000000000000000000000000000000000000000000", "hex")); // prettier-ignore
+            instance.scriptPubKey = Buffer.from("00a41a8527eab06efc0a8df57045d247784a071e23", "hex"); // prettier-ignore
+
+            const result = instance.serialize();
+            expect(result.toString("hex")).to.equal(
+                "0026" +
+                    "0000000000000000000000000000000000000000000000000000000000000000" +
+                    "0015" +
+                    "00a41a8527eab06efc0a8df57045d247784a071e23",
+            );
+        });
+    });
+});
diff --git a/packages/wire/lib/MessageFactory.ts b/packages/wire/lib/MessageFactory.ts
@@ -13,6 +13,7 @@ import { QueryChannelRangeMessage } from "./messages/QueryChannelRangeMessage";
 import { QueryShortChannelIdsMessage } from "./messages/QueryShortChannelIdsMessage";
 import { ReplyChannelRangeMessage } from "./messages/ReplyChannelRangeMessage";
 import { ReplyShortChannelIdsEndMessage } from "./messages/ReplyShortChannelIdsEndMessage";
+import { ShutdownMessage } from "./messages/ShutdownMessage";
 import { MessageType } from "./MessageType";
 
 export function deserialize(buffer: Buffer): IWireMessage {
@@ -34,6 +35,8 @@ export function deserialize(buffer: Buffer): IWireMessage {
             return OpenChannelMessage.deserialize(buffer);
         case MessageType.AcceptChannel:
             return AcceptChannelMessage.deserialize(buffer);
+        case MessageType.Shutdown:
+            return ShutdownMessage.deserialize(buffer);
 
         // gossip messages
         case MessageType.NodeAnnouncement:
diff --git a/packages/wire/lib/MessageType.ts b/packages/wire/lib/MessageType.ts
@@ -14,7 +14,7 @@ export enum MessageType {
     FundingCreated = 34,
     FundingSigned = 35,
     FundingLocked = 36,
-    CloseChannel = 38,
+    Shutdown = 38,
     ClosingSigned = 39,
 
     // Commitment (128-255)
diff --git a/packages/wire/lib/messages/ShutdownMessage.ts b/packages/wire/lib/messages/ShutdownMessage.ts
@@ -0,0 +1,66 @@
+import { BufferReader, BufferWriter } from "@node-lightning/bufio";
+import { MessageType } from "../MessageType";
+import { ChannelId } from "@node-lightning/core";
+import { IWireMessage } from "./IWireMessage";
+
+/**
+ * ShutdownMessage represents the `shutdown` message defined in BOLT #2 of the Lightning
+ * Specification. This message can be sent by either node. The scriptPubKey must be a valid P2WPKH,
+ * P2WSH, P2SH-P2WPKH, P2SH-P2WSH, or any valid witness script if option_shutdown_anysegwit is
+ * negotiated and it should be same as `shutdown_scriptpubkey` value if it was sent during
+ * `'open/accept' channel message`. Therefore, if both conditions hold true resulting transaction
+ * will propagate to miners. If shutdown is sent by either node, corresponding node should send
+ * commitment_signed to commit any outstanding changes before replying shutdown. Once shutdown is
+ * sent by both nodes no new HTLCs should be added or accepted by the channel. After successful
+ * handshake of shutdown message, fee negotiation and signature sending can begin with
+ * `closing_signed` message.
+ */
+export class ShutdownMessage implements IWireMessage {
+    public static type = MessageType.Shutdown;
+
+    /**
+     * Deserializes a shutdown message
+     * @param buf
+     */
+    public static deserialize(buf: Buffer): ShutdownMessage {
+        const instance = new ShutdownMessage();
+        const reader = new BufferReader(buf);
+
+        reader.readUInt16BE(); // read type
+        instance.channelId = new ChannelId(reader.readBytes(32));
+        const len = reader.readUInt16BE();
+        instance.scriptPubKey = reader.readBytes(len);
+
+        return instance;
+    }
+
+    /**
+     * The type for message. Shutdown = 38
+     */
+    public readonly type: MessageType = ShutdownMessage.type;
+
+    /**
+     * ChannelId generated from the funding transactions outpoint.
+     */
+    public channelId: ChannelId;
+
+    /**
+     * scriptPubKey is used by the sender to get paid, it must be a valid P2WPKH, P2WSH, P2SH-P2WPKH,
+     *  P2SH-P2WSH, or any valid witness script if option_shutdown_anysegwit is negotiated and it
+     * should be same as `shutdown_scriptpubkey` value if it was sent during `'open/accept' channel
+     * message`.
+     */
+    public scriptPubKey: Buffer;
+
+    /**
+     * Serializes the message into a Buffer
+     */
+    public serialize(): Buffer {
+        const writer = new BufferWriter();
+        writer.writeUInt16BE(this.type);
+        writer.writeBytes(this.channelId.toBuffer());
+        writer.writeUInt16BE(this.scriptPubKey.length);
+        writer.writeBytes(this.scriptPubKey);
+        return writer.toBuffer();
+    }
+}
