Xitadel SDK

This SDK provides a TypeScript interface for interacting with the Xitadel program on Solana.

Current Status

The SDK is currently set up for local development with the Anchor workspace. To use it:

1. First, build the Anchor program to generate types:

anchor build

2. Link the SDK locally:

cd sdk
npm link

3. In your project:

npm link @xitadel/sdk

Development Setup

1. The SDK uses path aliases to import Anchor-generated types:

import type { Xitadel } from "@program/xitadel";

2. TypeScript is configured to resolve these imports in tsconfig.json:

{
  "paths": {
    "@program/*": ["../target/types/*"]
  }
}

3. Make sure to build the Anchor program before working on the SDK:

anchor build

Known Issues

1. The current setup has some type issues with the Anchor workspace that need to be resolved. We're tracking these issues and will update the SDK once they're fixed.

2. For now, you can use the SDK by importing the workspace directly in your tests:

import { Program } from "@coral-xyz/anchor";
import { Xitadel } from "../target/types/xitadel";

const program = anchor.workspace.Xitadel as Program<Xitadel>;

Next Steps

1. Resolve type issues with Anchor workspace integration
2. Add proper error handling and type definitions
3. Add more instruction handlers
4. Add comprehensive tests
5. Publish to npm

Contributing

1. Build the program:

anchor build

2. Install dependencies:

npm install

3. Build the SDK:

npm run build

4. Run tests:

npm test

License

ISC