Documentation Index
Fetch the complete documentation index at: https://docs.chipipay.com/llms.txt
Use this file to discover all available pages before exploring further.
Usage
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
encryptKey | string | Yes | User-defined code or password to encrypt the wallet’s private key |
externalUserId | string | Yes | Your application’s unique identifier for the user |
chain | Chain | Yes | Blockchain network. Use Chain.STARKNET |
walletType | string | No | "CHIPI" (default) or "READY". CHIPI supports session keys and passkeys. READY is Argent X compatible. |
classHash | string | No | Custom StarkNet class hash for the wallet contract. Overrides the default for the wallet type. Must be declared on mainnet and implement SNIP-9. See Custom Wallet Types. |
usePasskey | boolean | No | Use WebAuthn passkey for encryption instead of PIN |
Return Value
Returns a Promise that resolves to an object containing:publicKey: The wallet’s StarkNet addressencryptedPrivateKey: The encrypted private key (store securely)walletType: The wallet type that was createdclassHash: The class hash used for deployment
Example Implementation
Wallet creation is free! Gas fees are sponsored by the Chipi paymaster for all wallet types.
Wallet Types
| Type | Account | Session Keys | Passkeys | Use Case |
|---|---|---|---|---|
CHIPI | OpenZeppelin + SNIP-9 | Yes | Yes | Default. Best for most apps. |
READY | Argent X v0.4.0 | No | No | Argent X ecosystem compatibility |
| Custom | Any SNIP-9 account | Depends | Depends | Advanced: bring your own account |
Related Methods
- getWallet - Retrieve existing wallet information
- transfer - Send tokens from the created wallet
- prepareWalletUpgrade - Upgrade wallet to a different type
- Custom Wallet Types Guide - Using custom account implementations
