@0xshield3/privy

@0xshield3/privy

@0xshield3/privy is a configuration package for the Privy @privy-io/react-auth library that enables Shield3 RPC integration. It simplifies the setup process for connecting to the Shield3 API by providing a convenient configuration function.

Installation

To install @0xshield3/privy, use your preferred package manager:

npm install @0xshield3/privy
yarn add @0xshield3/privy
pnpm add @0xshield3/privy

Usage

To use @0xshield3/privy, you need to import and call the initShield3PrivyConfig function with your Shield3 API key and optional Privy configuration.

import initShield3PrivyConfig from '@0xshield3/privy';

const privyProviderConfig = {
    // Your Privy configuration options (optional)
};

const shield3PrivyConfig = initShield3PrivyConfig(<YOUR_SHIELD3_API_KEY>, privyProviderConfig);

return (
    <PrivyProvider config={shield3PrivyConfig}>
        <Component {...pageProps} />
    </PrivyProvider>
    );

Parameters

• SHIELD3_API_KEY (string): Your Shield3 API key, which is required for authentication.

• privyClientConfig (PrivyClientConfig type): An optional configuration object for Privy. This object allows you to customize the behavior of the Privy client. Refer to the Privy documentation for available configuration options.

License

This package is licensed under the MIT License. See the LICENSE file for details.