verifySignInMessage

Verifies an AptosSignInInput against another AptosSignInInput. Typically, this is to compare the AptosSignInInput acquired from the wallet and the AptosSignInInput stored in the backend at the beginning of a Sign in with Aptos flow.


import { verifySignInMessage, deserializeSignInOutput, type AptosSignInInput, type SerializedAptosSignInOutput } from "@aptos-labs/siwa";
 
const expectedInput: AptosSignInInput = {
  domain: "example.com",
  nonce: "abc123def456",
  statement: "Sign in to Example.com to access your account"
};
 
const serializedOutput: SerializedAptosSignInOutput = // ... response from the `serializeSignInOutput` function
 
const output = await deserializeSignInOutput(serializedOutput);
 
const result = await verifySignInMessage({
  expected: expectedInput,
  input: output.input,
  publicKey: output.publicKey
});
 
if (!result.valid) {
  // Message verification failed: result.errors
}

Specifications

Parameters:

Name	Type	Default
`params`	`{ publicKey: PublicKey; expected: AptosSignInInput & { domain: string; }; input: AptosSignInInput & AptosSignInBoundFields; }`
`options`	`{ aptos?: Aptos; excludedResources?: string[]; }`

Returns:

Promise<VerificationResult>

The verification result.