createSolanaSiwxSigner()

createSolanaSiwxSigner(target, options?): (message) => Promise<string>

Creates a SIWX signer for Solana wallets: a function that signs a message with the wallet and returns the ed25519 signature as a base58 string. Pass it as signer to useSiwx().signIn from @tuwaio/siwx-react.

Works with Wallet Standard wallets, @solana/kit message signers, legacy adapters and useWallet() of @solana/wallet-adapter; see SolanaSiwxSignerTarget for how the signing method is chosen. The wallet signs the UTF-8 bytes of the message or its version 1 off-chain message (which hardware wallets can show and sign), as options.messageFormat decides (SolanaSiwxMessageFormat); servers verify both. An @solana/kit signer always signs the UTF-8 bytes, unless messageFormat is 'offchainMessage'.

Parameters

target

SolanaSiwxSignerTarget

The Wallet Standard wallet and account, an @solana/kit message signer or a legacy adapter.

options?

SolanaSiwxSignerOptions = {}

messageFormat: 'auto' (default), 'message' or 'offchainMessage'.

Returns

An async signer. Calling it opens the wallet signature prompt; it rejects with an Error whose message starts with [SIWX-SOLANA] Signing failed: (original error in cause) when the target has no signing capability, the wallet rejects, cannot sign version 1 off-chain messages or signs a different off-chain message, or no signature is returned for the account address.

(message) => Promise<string>

Example


const signer = createSolanaSiwxSigner({ wallet, account });
const signature = await signer(message);