Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@aptos-labs/siwa

aptos-labs3.4k0.3.0TypeScript support: included

Library of utilities for Sign in with Aptos

aptos, apt, siwa, web3, blockchain, dapps, wallet

readme

@aptos-labs/siwa

A comprehensive library of utilities for implementing Sign in with Aptos (SIWA) authentication in your applications.

Overview

Sign in with Aptos (SIWA) provides a secure and user-friendly way for users to authenticate to off-chain resources by proving ownership of their Aptos account. This library simplifies the implementation of SIWA in both frontend and backend applications.

Installation

pnpm add @aptos-labs/siwa

Documentation

For more detailed documentation, examples, and API reference, please visit the official documentation.

changelog

@aptos-labs/siwa

0.3.0

Minor Changes

  • cf1ffa3: Separated out signature verification with input validation
  • da9fc9d: Bump @aptos-labs/wallet-standard to 0.5.0

Patch Changes

  • cf1ffa3: Add verification step to compare the PublicKey's derived address to the message address

0.2.5

Patch Changes

  • 64510d4: Update getSignInPublicKeyScheme to support object instances
  • 64510d4: Renamed verifyLegacySignIn's output.fullMessage to output.message

0.2.4

Patch Changes

  • 33448ab: Export types from @aptos-labs/wallet-standard

0.2.3

Patch Changes

  • 2d19b1a: Export wallet-standard types from @aptos-labs/siwa

0.2.2

Patch Changes

  • 093f05c: Add utilities for legacy message handling

0.2.1

Patch Changes

  • 41274e1: Fix export formats

0.2.0

Minor Changes

  • 0cf9c69: Bump minor release