Wallet

generateSiweMessage({wallet: {chainId: string, address: string}, from: {domain: string, uri: string}}) => Promise<string>

import {useLoginWithSiwe} from '@privy-io/expo';

export function LoginScreen() {
const [address, setAddress] = useState('');
const [message, setMessage] = useState('');
const {generateSiweMessage} = useLoginWithSiwe();

const handleGenerate = async () => {
    const message = await generateSiweMessage({
    from: {
        domain: 'my-domain.com', // domain must be allowlisted in the Privy dashboard.
        uri: 'https://my-domain.com',
    },
    wallet: {
        // sepolia chainId with CAIP-2 prefix
        chainId: `eip155:11155111`,
        address,
    },
    });

    setMessage(message);
};

return (
    <View>
    <TextInput
        value={address}
        onChangeText={setAddress}
        placeholder="0x..."
        inputMode="ascii-capable"
    />

    <Button onPress={handleGenerate}>Generate Message</Button>

    {Boolean(message) && <Text>{message}</Text>}
    </View>
);
}

loginWithSiwe({signature: string, messageOverride?: string, disableSignup?: boolean}) => Promise<Result<PrivyUser>>

import {useLoginWithSiwe, usePrivy} from '@privy-io/expo';

export function LoginScreen() {
const [signature, setSignature] = useState('');

const {user} = usePrivy();
const {loginWithSiwe} = useLoginWithSiwe();

if (user) {
    return (
    <>
        <Text>Logged In</Text>
        <Text>{JSON.stringify(user, null, 2)}</Text>
    </>
    );
}

return (
    <View>
    <TextInput
        value={signature}
        onChangeText={setSignature}
        placeholder="0x..."
        inputMode="ascii-capable"
    />

    <Button onPress={() => loginWithSiwe({signature})}>Login</Button>
    </View>
);
}

onGenerateMessage?: ((message: string) => void) | undefined

onSuccess?: ((user: PrivyUser, isNewUser: boolean) => void) | undefined

onError?: (error: Error) => void

import {useLoginWithSiwe} from '@privy-io/expo';

export function LoginScreen() {
  const {generateSiweMessage, loginWithSiwe} = useLoginWithSiwe({
    onGenerateMessage(message) {
      // show a toast, send analytics event, etc...
    },
    onSuccess(user, isNewUser) {
      // show a toast, send analytics event, etc...
    },
    onError(error) {
      // show a toast, update form errors, etc...
    },
  });

  // ...
}

type SiweFlowState =
  | { status: "initial" }
  | { status: "error"; error: Error | null }
  | { status: "generating-message" }
  | { status: "awaiting-signature" }
  | { status: "submitting-signature" }
  | { status: "done" };

func generateMessage(params: SiweMessageParams) async throws -> String

do {
    let params = SiweMessageParams(
        appDomain: "my-domain.com",
        appUri: "https://my-domain.com",
        chainId: "1",
        walletAddress: "0x12345..."
    )

    let siweMessage = try await privy.siwe.generateMessage(params: params)
} catch {
    // An error can be thrown if the network call to generate the message fails,
    // or if invalid metadata was passed in.
}

func login(
    message: String,
    signature: String,
    params: SiweMessageParams,
    metadata: WalletLoginMetadata?
) async throws -> PrivyUser

do {
    let params = SiweMessageParams(
        appDomain: "my-domain.com",
        appUri: "https://my-domain.com",
        chainId: "1",
        walletAddress: "0x12345..."
    )

    // Generate SIWE message
    let siweMessage = try await privy.siwe.generateMessage(params: siweParams)

    // Optional metadata
    let metadata = WalletLoginMetadata(
        walletClientType: WalletClientType.metamask,
        connectorType: "wallet_connect"
    )

    // Login
    try await privy.siwe.login(
      message: siweMessage,
      // the signature generated by the user's wallet
      signature: signature,
      params: siweParams,
      metadata: metadata
    )
} catch {
    // error logging user in
}

public suspend fun generateMessage(params: SiweMessageParams): Result<String>

val params = SiweMessageParams(
    appDomain = domain,
    appUri = uri,
    chainId = chainId,
    walletAddress = walletAddress
)

privy.siwe.generateMessage(params = params).fold(
    onSuccess = { message ->
        // request an EIP-191 `personal_sign` signature on the message
    },
    onFailure = { e ->
        // An error can be thrown if the network call to generate the message fails,
        // or if invalid metadata was passed in.
    }
)

public suspend fun login(
    message: String,
    signature: String,
    params: SiweMessageParams,
    metadata: WalletLoginMetadata?,
): Result<PrivyUser>

val params = SiweMessageParams(
    appDomain = domain,
    appUri = uri,
    chainId = chainId,
    walletAddress = walletAddress
)

// optional metadata
val metadata = WalletLoginMetadata(walletClientType = walletClient, connectorType = connectorType)

privy.siwe.login(message, signature, params, metadata).fold(
    onSuccess = { privyUser ->
        // Login success
    },
    onFailure = { e ->
        // Login failure, either due to invalid signature or network error
    }
)

Future<Result<String>> generateMessage(SiweMessageParams params)

final params = SiweMessageParams(
  appDomain: domain,
  appUri: uri,
  chainId: chainId,
  walletAddress: walletAddress,
);

final result = await privy.siwe.generateMessage(params);

result.fold(
  onSuccess: (message) {
    // request an EIP-191 `personal_sign` signature on the message
  },
  onFailure: (error) {
    // An error can be thrown if the network call to generate the message fails,
    // or if invalid metadata was passed in.
  },
);

Future<Result<PrivyUser>> login({
  required String message,
  required String signature,
  required SiweMessageParams params,
  WalletLoginMetadata? metadata,
})

final params = SiweMessageParams(
  appDomain: domain,
  appUri: uri,
  chainId: chainId,
  walletAddress: walletAddress,
);

// optional metadata
final metadata = WalletLoginMetadata(
  walletClientType: walletClient,
  connectorType: connectorType,
);

final result = await privy.siwe.login(
  message: message,
  signature: signature,
  params: params,
  metadata: metadata,
);

result.fold(
  onSuccess: (privyUser) {
    // Login success
  },
  onFailure: (error) {
    // Login failure, either due to invalid signature or network error
  },
);