Add EdgeCurrencyWallet.signBytes

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 
+- added: `EdgeCurrencyWallet.signBytes` to sign raw bytes with a private key.
 - changed: Randomize data-sync start times.
 
 ## 2.9.2 (2024-07-25)

src/core/currency/wallet/currency-wallet-api.ts

@@ -1,5 +1,6 @@
 import { div, eq, mul } from 'biggystring'
 import { Disklet } from 'disklet'
+import { base64 } from 'rfc4648'
 import { bridgifyObject, onMethod, watchMethod } from 'yaob'
 
 import {
@@ -532,6 +533,31 @@ export function makeCurrencyWalletApi(
       )
     },
 
+    async signBytes(
+      bytes: Uint8Array,
+      opts: EdgeSignMessageOptions = {}
+    ): Promise<string> {
+      const privateKeys = walletInfo.keys
+
+      if (engine.signBytes != null) {
+        return await engine.signBytes(bytes, privateKeys, opts)
+      }
+
+      // Various plugins expect specific encodings for signing messages
+      // (base16, base64, etc).
+      // Do the conversion here temporarily if `signMessage` is implemented
+      // while we migrate to `signBytes`.
+      else if (pluginId === 'bitcoin' && engine.signMessage != null) {
+        return await engine.signMessage(
+          base64.stringify(bytes),
+          privateKeys,
+          opts
+        )
+      }
+
+      throw new Error(`${pluginId} doesn't support signBytes`)
+    },
+
     async signMessage(
       message: string,
       opts: EdgeSignMessageOptions = {}

src/types/types.ts

@@ -972,8 +972,8 @@ export interface EdgeCurrencyEngine {
   ) => Promise<EdgePaymentProtocolInfo>
 
   // Signing:
-  readonly signMessage?: (
-    message: string,
+  readonly signBytes?: (
+    bytes: Uint8Array,
     privateKeys: JsonObject,
     opts: EdgeSignMessageOptions
   ) => Promise<string>
@@ -1001,6 +1001,16 @@ export interface EdgeCurrencyEngine {
 
   /** @deprecated Provide EdgeCurrencyTools.getDisplayPublicKey: */
   readonly getDisplayPublicSeed?: () => string | null
+
+  /**
+   * @deprecated Replaced by `signBytes`.
+   * Various plugins implement this function with inconsistent encodings.
+   */
+  readonly signMessage?: (
+    message: string,
+    privateKeys: JsonObject,
+    opts: EdgeSignMessageOptions
+  ) => Promise<string>
 }
 
 // currency plugin -----------------------------------------------------
@@ -1216,8 +1226,8 @@ export interface EdgeCurrencyWallet {
   ) => Promise<EdgeTransaction>
 
   // Signing:
-  readonly signMessage: (
-    message: string,
+  readonly signBytes: (
+    buf: Uint8Array,
     opts?: EdgeSignMessageOptions
   ) => Promise<string>
 
@@ -1240,6 +1250,12 @@ export interface EdgeCurrencyWallet {
 
   // Generic:
   readonly otherMethods: EdgeOtherMethods
+
+  /** @deprecated Use `signBytes` instead. */
+  readonly signMessage: (
+    message: string,
+    opts?: EdgeSignMessageOptions
+  ) => Promise<string>
 }
 
 export interface EdgeMemoryWallet {