Skip to content

Commit

Permalink
chore(siwx): add authentication name to SIWX (#228)
Browse files Browse the repository at this point in the history
  • Loading branch information
arein authored Jan 2, 2025
1 parent b035e6a commit 2498fd6
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/appkit/features/siwx/default.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: SIWX
title: Authentication (SIWX)
---

import SiwxIndex from '../../shared/siwx/index.mdx'

<SiwxIndex />
<SiwxIndex />
5 changes: 5 additions & 0 deletions docs/appkit/shared/siwx/index.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
import Button from '../../../components/button/index.js'

## Introduction

The **Sign In With X** feature enables decentralized applications (Dapps) to authenticate users seamlessly across multiple blockchain networks, such as Ethereum, Polygon or Solana. This feature allows developers using our SDK to implement authentication by having users sign a unique string message with their blockchain wallets. The **Sign In With X** feature is designed in accordance with the [CAIP-122](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-122.md) standard, which establishes a chain-agnostic framework for blockchain-based authentication and authorization on off-chain services.

<img src="/assets/siwe-connect.gif" />
<br />

<Button name="Try Demo" url="https://appkit-lab.reown.com/library/siwx-default/" />
<br/>

## Getting Started

**SIWX** works as a plugin system for AppKit and you are going to add the plugin in the AppKit configuration. There are some ways to implement the **SIWX** feature:
Expand Down
2 changes: 1 addition & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ module.exports = {
},
{
type: 'doc',
label: 'SIWX',
label: 'Authentication (SIWX)',
id: 'appkit/features/siwx/default'
},
{ type: 'doc', label: 'Sponsored Transactions', id:'appkit/features/sponsored-transactions'}
Expand Down

0 comments on commit 2498fd6

Please sign in to comment.