serializeSignInOutput

Serializes a AptosSignInOutput to a versioned SerializedAptosSignInOutput. This format is used to transfer the AptosSignInOutput from the backend to the frontend.


import { serializeSignInOutput, type AptosSignInOutput, type AptosSignInInput } from "@aptos-labs/siwa";
 
const output: AptosSignInOutput = // .. response from the `signIn` function
 
const serialized = serializeSignInOutput(output); // { version: "2", type: "ed25519", signature: "0x...", input: {...}, publicKey: "0x..." }

Specifications

Parameters:

Name	Type	Default
`output`	`Pick<AptosSignInOutput, "type" \| "signature" \| "input" \| "account">` The `AptosSignInOutput` to serialize.

Returns:

SerializedAptosSignInOutput

The serialized AptosSignInOutput.