Add reference chain usage for EIP-1271 signers

Author: ScreamingHawk

packages/account/src/account.ts

@@ -517,14 +517,15 @@ export class Account {
     return this.tracker.saveWitnesses({ wallet: this.address, digest, chainId, signatures })
   }
 
-  async publishWitness(): Promise<void> {
+  async publishWitness(chainId: ethers.BigNumberish = 0, referenceChainId?: ethers.BigNumberish): Promise<void> {
     const digest = ethers.id(`This is a Sequence account woo! ${Date.now()}`)
     // Apply ERC-6492 to undeployed children
-    const signature = await this.signDigest(digest, 0, false, 'ignore', {cantValidateBehavior: "eip6492"})
+    const signature = await this.signDigest(digest, 0, false, 'ignore', {referenceChainId, cantValidateBehavior: "eip6492"})
     const decoded = this.coders.signature.decode(signature)
-    const recovered = await this.coders.signature.recover(decoded, { digest, chainId: 0, address: this.address })
+    const recovered = await this.coders.signature.recover(decoded, { digest, chainId, address: this.address })
     const signatures = this.coders.signature.signaturesOf(recovered.config)
-    return this.tracker.saveWitnesses({ wallet: this.address, digest, chainId: 0, signatures })
+    const signaturesWithReferenceChainId = signatures.map(s => ({...s, referenceChainId}))
+    return this.tracker.saveWitnesses({ wallet: this.address, digest, chainId, signatures: signaturesWithReferenceChainId })
   }
 
   async signDigest(

packages/auth/src/services.ts

@@ -1,5 +1,5 @@
 import { Account } from '@0xsequence/account'
-import { SequenceAPIClient } from '@0xsequence/api'
+import { GetAuthToken2Return, GetAuthTokenReturn, SequenceAPIClient } from '@0xsequence/api'
 import { ETHAuth, Proof } from '@0xsequence/ethauth'
 import { Indexer, SequenceIndexer } from '@0xsequence/indexer'
 import { SequenceMetadata } from '@0xsequence/metadata'
@@ -99,7 +99,7 @@ export class Services {
     }
   }
 
-  auth(maxTries: number = 5): Promise<SequenceAPIClient> {
+  auth(maxTries: number = 5, referenceChainId?: ChainIdLike): Promise<SequenceAPIClient> {
     if (this._initialAuthRequest) return this._initialAuthRequest
 
     this._initialAuthRequest = (async () => {
@@ -109,7 +109,7 @@ export class Services {
       let jwtAuth: string | undefined
       for (let i = 1; ; i++) {
         try {
-          jwtAuth = (await this.getJWT(true)).token
+          jwtAuth = (await this.getJWT(true, referenceChainId)).token
           break
         } catch (error) {
           if (i === maxTries) {
@@ -125,7 +125,7 @@ export class Services {
     return this._initialAuthRequest
   }
 
-  private async getJWT(tryAuth: boolean): Promise<SessionJWT> {
+  private async getJWT(tryAuth: boolean, referenceChainId?: ChainIdLike): Promise<SessionJWT> {
     const url = this.settings.sequenceApiUrl
     if (!url) throw Error('No sequence api url')
 
@@ -154,7 +154,12 @@ export class Services {
         .then(async proofString => {
           const api = new SequenceAPIClient(url)
 
-          const authResp = await api.getAuthToken({ ewtString: proofString })
+          let authResp: GetAuthToken2Return | GetAuthTokenReturn
+          if (referenceChainId) {
+            authResp = await api.getAuthToken2({ ewtString: proofString, chainID: referenceChainId?.toString() })
+          } else {
+            authResp = await api.getAuthToken({ ewtString: proofString })
+          }
 
           if (authResp?.status === true && authResp.jwtToken.length !== 0) {
             return authResp.jwtToken

packages/auth/src/session.ts

@@ -289,7 +289,7 @@ export class Session {
 
       // sign a digest and send it to the tracker
       // otherwise the tracker will not know about this account
-      await account.publishWitness()
+      await account.publishWitness(undefined, referenceChainId)
 
       // safety check, the remove tracker should be able to find
       // this account for the reference signer
@@ -303,7 +303,7 @@ export class Session {
 
     if (services) {
       servicesObj = new Services(account, services)
-      servicesObj.auth() // fire and forget
+      servicesObj.auth(1, referenceChainId) // fire and forget
 
       servicesObj.onAuth(result => {
         if (result.status === 'fulfilled') {

packages/core/src/commons/signature.ts

@@ -54,7 +54,7 @@ export interface SignatureCoder<
 
   hashSetImageHash: (imageHash: string) => string
 
-  signaturesOf: (config: Y) => { address: string; signature: string }[]
+  signaturesOf: (config: Y, referenceChainId?: ethers.BigNumberish) => { address: string; signature: string }[]
 
   signaturesOfDecoded: (decoded: Z) => string[]
 }

packages/core/src/v1/signature.ts

@@ -248,7 +248,7 @@ export const SignatureCoder: base.SignatureCoder<WalletConfig, Signature, Unreco
     throw new Error('Image hash not supported on v1')
   },
 
-  signaturesOf(config: WalletConfig): { address: string; signature: string }[] {
+  signaturesOf(config: WalletConfig, referenceChainId?: ethers.BigNumberish): { address: string; signature: string }[] {
     return config.signers.filter(s => s.signature !== undefined).map(s => ({ address: s.address, signature: s.signature! }))
   },
 

packages/passkeys/src/index.ts

@@ -38,7 +38,8 @@ export type PasskeySignerContext = {
 }
 
 export type PasskeySignMetadata = {
-  cantValidateBehavior: 'ignore' | 'eip6492' | 'throw'
+  referenceChainId?: ethers.BigNumberish
+  cantValidateBehavior?: 'ignore' | 'eip6492' | 'throw'
 }
 
 function bytesToBase64URL(bytes: Uint8Array): string {
@@ -180,7 +181,8 @@ export class SequencePasskeySigner implements signers.SapientSigner {
   }
 
   async sign(digest: ethers.BytesLike, metadata: PasskeySignMetadata): Promise<ethers.BytesLike> {
-    const subdigest = subDigestOf(await this.getAddress(), this.chainId, digest)
+    const referenceChainId = metadata?.referenceChainId ?? this.chainId
+    const subdigest = subDigestOf(await this.getAddress(), referenceChainId, ethers.hexlify(digest))
 
     const signature = await this.doSign(digest, subdigest)
 
@@ -208,7 +210,7 @@ export class SequencePasskeySigner implements signers.SapientSigner {
     // Pack the flags as hex string for encoding
     const flags = `0x${(
       (this.requireUserValidation ? 0x40 : 0) |
-      (BigInt(this.chainId) === 0n ? 0x20 : 0) |
+      (BigInt(referenceChainId) === 0n ? 0x20 : 0) |
       (this.requireBackupSanityCheck ? 0x10 : 0)
     ).toString(16)}`
 

packages/sessions/src/tracker.ts

@@ -22,6 +22,7 @@ export type ConfigDataDump = {
 export type SignerSignature = {
   address: string
   signature: string
+  referenceChainId?: ethers.BigNumberish
 }
 
 export interface ConfigTracker {

packages/sessions/src/trackers/remote/index.ts

@@ -83,7 +83,7 @@ export class RemoteConfigTracker implements ConfigTracker, migrator.PresignedMig
         digest: args.digest,
         chainID: numberString(args.chainId),
         // Rename "address" to "signer"
-        signatures: (filteredSignatures as SignerSignature[]).map(({ address, signature }) => ({ signer: address, signature }))
+        signatures: (filteredSignatures as SignerSignature[]).map(({ address, signature, referenceChainId }) => ({ signer: address, signature, referenceChainId: referenceChainId?.toString() }))
       })
     }
   }

packages/sessions/src/trackers/remote/sessions.gen.ts

@@ -1,18 +1,70 @@
 /* eslint-disable */
-// sessions v0.0.1 67f782e8acfe452f905078a7423ed5d27c6639a8
+// sessions v0.0.1 48681273e3b0249c5feb593b9af1b59dc6a14869
 // --
-// Code generated by webrpc-gen@v0.20.3 with typescript generator. DO NOT EDIT.
+// Code generated by webrpc-gen@v0.21.3 with typescript generator. DO NOT EDIT.
 //
 // webrpc-gen -schema=sessions.ridl -target=typescript -client -out=./clients/sessions.gen.ts
 
+export const WebrpcHeader = "Webrpc"
+
+export const WebrpcHeaderValue = "[email protected];[email protected];[email protected]"
+
 // WebRPC description and code-gen version
 export const WebRPCVersion = "v1"
 
 // Schema version of your RIDL schema
 export const WebRPCSchemaVersion = "v0.0.1"
 
 // Schema hash generated from your RIDL schema
-export const WebRPCSchemaHash = "67f782e8acfe452f905078a7423ed5d27c6639a8"
+export const WebRPCSchemaHash = "48681273e3b0249c5feb593b9af1b59dc6a14869"
+
+type WebrpcGenVersions = {
+  webrpcGenVersion: string;
+  codeGenName: string;
+  codeGenVersion: string;
+  schemaName: string;
+  schemaVersion: string;
+};
+
+export function VersionFromHeader(headers: Headers): WebrpcGenVersions {
+  const headerValue = headers.get(WebrpcHeader);
+  if (!headerValue) {
+    return {
+      webrpcGenVersion: "",
+      codeGenName: "",
+      codeGenVersion: "",
+      schemaName: "",
+      schemaVersion: "",
+    };
+  }
+
+  return parseWebrpcGenVersions(headerValue);
+}
+
+function parseWebrpcGenVersions(header: string): WebrpcGenVersions {
+  const versions = header.split(";");
+  if (versions.length < 3) {
+    return {
+      webrpcGenVersion: "",
+      codeGenName: "",
+      codeGenVersion: "",
+      schemaName: "",
+      schemaVersion: "",
+    };
+  }
+
+  const [_, webrpcGenVersion] = versions[0].split("@");
+  const [codeGenName, codeGenVersion] = versions[1].split("@");
+  const [schemaName, schemaVersion] = versions[2].split("@");
+
+  return {
+    webrpcGenVersion,
+    codeGenName,
+    codeGenVersion,
+    schemaName,
+    schemaVersion,
+  };
+}
 
 //
 // Types
@@ -128,9 +180,9 @@ export interface Signature {
 }
 
 export interface SignerSignature {
-  referenceChainID?: string
   signer?: string
   signature: string
+  referenceChainID?: string
 }
 
 export interface ConfigUpdate {
@@ -459,9 +511,12 @@ export class Sessions implements Sessions {
 }
 
   const createHTTPRequest = (body: object = {}, headers: object = {}, signal: AbortSignal | null = null): object => {
+  const reqHeaders: {[key: string]: string} = { ...headers, 'Content-Type': 'application/json' }
+  reqHeaders[WebrpcHeader] = WebrpcHeaderValue
+
   return {
     method: 'POST',
-    headers: { ...headers, 'Content-Type': 'application/json' },
+    headers: reqHeaders,
     body: JSON.stringify(body || {}),
     signal
   }