Quickstart

Follow these steps to set up Zky Toolkit and start using it in your project.

1. Obtain Your API Key

To use Zky Toolkit, you’ll need an API key. Head over to the Zky Wallet Dashboard to sign up or log in, and create a new project to get your API key.

Once you’re logged in:

1. Go to the Dashboard.

2. Select Create New Project.

3. Copy your API key from the project details.

2. Install Zky Toolkit

In your project directory, install Zky Toolkit from npm:

npm install @kondor-finance/zky-toolkit

3. Set Up Tailwind CSS

If you haven’t already, install Tailwind CSS by following the official Tailwind CSS installation guide. Once installed, configure Tailwind to include Zky Toolkit components by adding the following to your tailwind.config.js file:

import type { Config } from "tailwindcss";

const config: Config = {
  content: ['./node_modules/@kondor-finance/zky-toolkit/**/*.{html,js,ts,tsx,jsx}'],
};

export default config;

This configuration ensures that Tailwind processes the styles from Zky Toolkit components correctly.

4. Set Up Zky Toolkit as a Provider

Import Zky Toolkit into your application and wrap your root component with the ZkyProvider component. Pass your API key as a prop:

import { ZkyToolkitProvider, ConnectButton } from "@kondor-finance/zky-toolkit";

const apiKey = "YOUR_API_KEY_HERE";

export default function Home() {
  return (
    <ZkyToolkitProvider apiKey={apiKey}>
      <YourApp>
        <ConnectButton />
      </YourApp>
    </ZkyToolkitProvider>
  );
}

Now, with Zky Toolkit set up as a provider, you can start utilizing wallet functionalities within your app.

To use your Bitcoin Testnet account, go to your Xverse wallet > Settings > Network > Testnet