Fix wrong ABNF Message construction (#2337)

* fix: wrong ABNF Message construction * added: changeset * Update .changeset/clever-shoes-hope.md * chore: snaps --------- Co-authored-by: awkweb <tom@meagher.co>
wevm · Jun 4, 2024 · 8984eee · 8984eee
1 parent e754534
commit 8984eee
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git a/.changeset/clever-shoes-hope.md b/.changeset/clever-shoes-hope.md
@@ -0,0 +1,5 @@
+---
+"viem": patch
+---
+
+Updated `createSiweMessage` `statement` construction to match ABNF Message Format.
diff --git a/src/utils/siwe/createSiweMessage.test.ts b/src/utils/siwe/createSiweMessage.test.ts
@@ -21,6 +21,7 @@ test('default', () => {
     "example.com wants you to sign in with your Ethereum account:
     0xA0Cf798816D4b9b9866b5330EEa46a18382f251e
 
+
     URI: https://example.com/path
     Version: 1
     Chain ID: 1
@@ -44,6 +45,7 @@ test('parameters: scheme', () => {
     "https://example.com wants you to sign in with your Ethereum account:
     0xA0Cf798816D4b9b9866b5330EEa46a18382f251e
 
+
     URI: https://example.com/path
     Version: 1
     Chain ID: 1
@@ -86,6 +88,7 @@ test('parameters: issuedAt', () => {
     "example.com wants you to sign in with your Ethereum account:
     0xA0Cf798816D4b9b9866b5330EEa46a18382f251e
 
+
     URI: https://example.com/path
     Version: 1
     Chain ID: 1
@@ -107,6 +110,7 @@ test('parameters: expirationTime', () => {
     "example.com wants you to sign in with your Ethereum account:
     0xA0Cf798816D4b9b9866b5330EEa46a18382f251e
 
+
     URI: https://example.com/path
     Version: 1
     Chain ID: 1
@@ -131,6 +135,7 @@ test('parameters: notBefore', () => {
     "example.com wants you to sign in with your Ethereum account:
     0xA0Cf798816D4b9b9866b5330EEa46a18382f251e
 
+
     URI: https://example.com/path
     Version: 1
     Chain ID: 1
@@ -155,6 +160,7 @@ test('parameters: requestId', () => {
     "example.com wants you to sign in with your Ethereum account:
     0xA0Cf798816D4b9b9866b5330EEa46a18382f251e
 
+
     URI: https://example.com/path
     Version: 1
     Chain ID: 1
@@ -183,6 +189,7 @@ test('parameters: resources', () => {
     "example.com wants you to sign in with your Ethereum account:
     0xA0Cf798816D4b9b9866b5330EEa46a18382f251e
 
+
     URI: https://example.com/path
     Version: 1
     Chain ID: 1

diff --git a/src/utils/siwe/createSiweMessage.ts b/src/utils/siwe/createSiweMessage.ts
@@ -138,9 +138,9 @@ export function createSiweMessage(
   })()
   const statement = (() => {
     if (!parameters.statement) return ''
-    return `\n${parameters.statement}\n`
+    return `${parameters.statement}\n`
   })()
-  const prefix = `${origin} wants you to sign in with your Ethereum account:\n${address}\n${statement}`
+  const prefix = `${origin} wants you to sign in with your Ethereum account:\n${address}\n\n${statement}`
 
   let suffix = `URI: ${uri}\nVersion: ${version}\nChain ID: ${chainId}\nNonce: ${nonce}\nIssued At: ${issuedAt.toISOString()}`