Skip to content

Commit

Permalink
fix: update sso sdk docs (#259)
Browse files Browse the repository at this point in the history
  • Loading branch information
JackHamer09 authored Nov 19, 2024
1 parent 18340f1 commit 24d41cf
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
6 changes: 4 additions & 2 deletions content/00.build/30.zksync-sso/25.interfaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ This provides some technical information on how these components can be used.

### Auth Server

The entrypoint to the SDK is via the ``zksyncAccountConnector`` to connect to the *Auth Server*.
The entrypoint to the SDK is via the ``zksyncSsoConnector`` to connect to the *Auth Server*.
This takes the auth domain, session, and basic app information (name, icon). The fully expanded type looks like:

<!-- // cspell: disable -->
```ts
type ZKsyncAccountConnectorOptions = {
type ZksyncSsoConnectorOptions = {
metadata?: {
name: string,
icon?: string,
Expand All @@ -26,6 +27,7 @@ type ZKsyncAccountConnectorOptions = {
authServerUrl?: string;
};
```
<!-- // cspell: enable -->

This returns a [WAGMI connector](https://wagmi.sh/core/api/connectors) that can be used to perform wallet-like
actions with the available account.
Expand Down
8 changes: 4 additions & 4 deletions content/00.build/30.zksync-sso/5.getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ Just 2 steps:
```ts [wagmi]
import { zksyncSepoliaTestnet } from "viem/chains";
import { createConfig, connect } from "@wagmi/core";
import { zksyncAccountConnector } from "zksync-sso/connector";
import { zksyncSsoConnector } from "zksync-sso/connector";
const ssoConnector = zksyncAccountConnector({
const ssoConnector = zksyncSsoConnector({
// Optional session configuration, if omitted user will have to sign every transaction via Auth Server
session: {
feeLimit: parseEther("0.1"),
Expand Down Expand Up @@ -96,9 +96,9 @@ Just 2 steps:
```ts [web3modal]
import { zksyncSepoliaTestnet } from "viem/chains";
import { defaultWagmiConfig } from "@web3modal/wagmi";
import { zksyncAccountConnector } from "zksync-sso/connector";
import { zksyncSsoConnector } from "zksync-sso/connector";
const ssoConnector = zksyncAccountConnector({
const ssoConnector = zksyncSsoConnector({
// Optional session configuration, if omitted user will have to sign every transaction via Auth Server
session: {
feeLimit: parseEther("0.1"),
Expand Down

0 comments on commit 24d41cf

Please sign in to comment.