Merge pull request #5 from NillionNetwork/feat/credit_system_integration

feat: added credit system integration

Author: jcabrero

README.md

@@ -21,7 +21,7 @@ import "dotenv/config";
 
 // Initialize client with API key from environment variables
 const client = new NilaiOpenAIClient({
-  baseURL: "https://nilai-a779.nillion.network/v1/",
+  baseURL: "https://api.nilai.nillion.network/nuc/v1/",
   apiKey: process.env.NILLION_API_KEY,
 });
 
@@ -46,7 +46,7 @@ import "dotenv/config";
 
 // Set up your API key in a .env file or environment variable
 const client = new NilaiOpenAIClient({
-  baseURL: "https://nilai-a779.nillion.network/v1/",  
+  baseURL: "https://api.nilai.nillion.network/nuc/v1/",  
   apiKey: process.env.NILLION_API_KEY, // Your private key
 });
 
@@ -77,20 +77,18 @@ import {
   NilaiOpenAIClient,
   DelegationTokenServer,
   AuthType,
-  NilAuthInstance,
 } from "@nillion/nilai-ts";
 import "dotenv/config";
 
 // Server-side: Create a delegation token server
 const server = new DelegationTokenServer(process.env.NILLION_API_KEY, {
-  nilauthInstance: NilAuthInstance.SANDBOX,
   expirationTime: 3600, // 1 hour validity
   tokenMaxUses: 10, // Allow 10 uses
 });
 
 // Client-side: Initialize client for delegation token mode
 const client = new NilaiOpenAIClient({
-  baseURL: "https://nilai-a779.nillion.network/v1/",
+  baseURL: "https://api.nilai.nillion.network/nuc/v1/",
   authType: AuthType.DELEGATION_TOKEN,
 });
 
@@ -137,7 +135,7 @@ import "dotenv/config";
 import { NilaiOpenAIClient } from "@nillion/nilai-ts";
 
 const client = new NilaiOpenAIClient({
-  baseURL: "https://nilai-a779.nillion.network/v1/",
+  baseURL: "https://api.nilai.nillion.network/nuc/v1/",
   apiKey: process.env.NILLION_API_KEY,
 });
 ```
@@ -148,7 +146,7 @@ const client = new NilaiOpenAIClient({
 - **🤖 OpenAI Compatibility**: Drop-in replacement for the OpenAI client.
 - **⚡ Automatic Token Management**: Handles root token caching and expiration automatically.
 - **🛡️ Secure Delegation**: Server-side token management with configurable expiration and usage limits.
-- **🌐 Network Flexibility**: Support for sandbox and production `nilauth` environments.
+- **🌐 Self-Signed NUCs**: Uses self-signed NUC tokens without requiring a remote nilauth service.
 - **🔒 Type Safety**: Strongly typed with Zod schema validation for robust development.
 - **🔧 Universal Compatibility**: Built-in polyfills for Node.js environments ensure seamless operation across different platforms without manual configuration.
 

examples/0-api-key.ts

@@ -1,5 +1,5 @@
 import "dotenv/config";
-import { NilAuthInstance, NilaiOpenAIClient } from "@nillion/nilai-ts";
+import { NilaiOpenAIClient } from "@nillion/nilai-ts";
 
 // To obtain an API key, navigate to https://nilpay.vercel.app/
 // and create a new subscription.
@@ -10,18 +10,14 @@ const API_KEY = process.env.NILLION_API_KEY;
 
 async function main() {
   // Initialize the client in API key mode
-  // For sandbox, use the following:
   const client = new NilaiOpenAIClient({
-    baseURL: "https://nilai-a779.nillion.network/v1/",
+    baseURL: "https://api.nilai.nillion.network/nuc/v1/",
     apiKey: API_KEY,
-    nilauthInstance: NilAuthInstance.SANDBOX,
-    // For production, use the following:
-    // nilauthInstance: NilAuthInstance.PRODUCTION,
   });
 
   // Make a request to the Nilai API
   const response = await client.chat.completions.create({
-    model: "google/gemma-3-27b-it",
+    model: "openai/gpt-oss-20b",
     messages: [
       { role: "user", content: "Hello! Can you help me with something?" },
     ],

examples/1-delegation-token.ts

@@ -4,7 +4,6 @@ import {
   type DelegationTokenRequest,
   type DelegationTokenResponse,
   DelegationTokenServer,
-  NilAuthInstance,
   NilaiOpenAIClient,
 } from "@nillion/nilai-ts";
 
@@ -23,7 +22,6 @@ async function main() {
   // The server is responsible for creating delegation tokens
   // and managing their expiration and usage.
   const server = new DelegationTokenServer(API_KEY, {
-    nilauthInstance: NilAuthInstance.SANDBOX,
     expirationTime: 10, // 10 seconds validity of delegation tokens
     tokenMaxUses: 1, // 1 use of a delegation token
   });
@@ -32,10 +30,8 @@ async function main() {
   // The client is responsible for making requests to the Nilai API.
   // We do not provide an API key but we set the auth type to DELEGATION_TOKEN
   const client = new NilaiOpenAIClient({
-    baseURL: "https://nilai-a779.nillion.network/v1/",
+    baseURL: "https://api.nilai.nillion.network/nuc/v1/",
     authType: AuthType.DELEGATION_TOKEN,
-    // For production instances, use the following:
-    //nilauthInstance: NilAuthInstance.PRODUCTION,
   });
 
   // >>> Client produces a delegation request
@@ -51,7 +47,7 @@ async function main() {
 
   // >>> Client uses the delegation token to make a request
   const response = await client.chat.completions.create({
-    model: "google/gemma-3-27b-it",
+    model: "openai/gpt-oss-20b",
     messages: [
       { role: "user", content: "Hello! Can you help me with something?" },
     ],

examples/2-nildb-prompt-store-retrieve.ts

@@ -4,7 +4,6 @@ import {
   type DelegationTokenRequest,
   type DelegationTokenResponse,
   DelegationTokenServer,
-  NilAuthInstance,
   NilaiOpenAIClient,
 } from "@nillion/nilai-ts";
 import { Did as DidClass } from "@nillion/nuc";
@@ -17,11 +16,9 @@ const API_KEY = process.env.NILLION_API_KEY;
 
 async function store_to_nildb(prompt: string): Promise<[string, string]> {
   // Initialize the client in API key mode
-  // For sandbox, use the following:
   const client = new NilaiOpenAIClient({
-    baseURL: "https://nilai-f910.nillion.network/nuc/v1/",
+    baseURL: "https://api.nilai.nillion.network/nuc/v1/",
     apiKey: API_KEY,
-    nilauthInstance: NilAuthInstance.PRODUCTION,
   });
 
   const createdIds: string[] = await client.createPrompt(prompt);
@@ -46,7 +43,6 @@ async function main() {
   // The server is responsible for creating delegation tokens
   // and managing their expiration and usage.
   const server = new DelegationTokenServer(API_KEY, {
-    nilauthInstance: NilAuthInstance.PRODUCTION,
     expirationTime: 60 * 60, // 3600 seconds = 1 hour validity of delegation tokens
     tokenMaxUses: 10, // 10 uses of a delegation token
     prompt_document: {
@@ -59,10 +55,8 @@ async function main() {
   // The client is responsible for making requests to the Nilai API.
   // We do not provide an API key but we set the auth type to DELEGATION_TOKEN
   const client = new NilaiOpenAIClient({
-    baseURL: "https://nilai-f910.nillion.network/nuc/v1/",
+    baseURL: "https://api.nilai.nillion.network/nuc/v1/",
     authType: AuthType.DELEGATION_TOKEN,
-    // For production instances, use the following:
-    nilauthInstance: NilAuthInstance.PRODUCTION,
   });
   console.log("Requesting delegation token from NilAI Server");
 

examples/3-web-search.ts

@@ -1,5 +1,5 @@
 import "dotenv/config";
-import { NilAuthInstance, NilaiOpenAIClient } from "@nillion/nilai-ts";
+import { NilaiOpenAIClient } from "@nillion/nilai-ts";
 
 // To obtain an API key, navigate to https://nilpay.vercel.app/
 // and create a new subscription.
@@ -10,19 +10,15 @@ const API_KEY = process.env.NILLION_API_KEY;
 
 async function main() {
   // Initialize the client in API key mode
-  // For sandbox, use the following:
   const client = new NilaiOpenAIClient({
-    baseURL: "https://nilai-a779.nillion.network/v1/",
+    baseURL: "https://api.nilai.nillion.network/nuc/v1/",
     apiKey: API_KEY,
-    nilauthInstance: NilAuthInstance.SANDBOX,
-    // For production, use the following:
-    // nilauthInstance: NilAuthInstance.PRODUCTION,
   });
 
   // Make a request to the Nilai API
   const response = await client.chat.completions.create(
     {
-      model: "google/gemma-3-27b-it",
+      model: "openai/gpt-oss-20b",
       messages: [
         {
           role: "user",

src/client.ts

@@ -1,13 +1,12 @@
 import { randomUUID } from "node:crypto";
 import {
+  Command,
   Did as DidClass,
   InvocationBody,
   Keypair,
-  NilauthClient,
   NucTokenBuilder,
   type NucTokenEnvelope,
   NucTokenEnvelopeSchema,
-  PayerBuilder,
 } from "@nillion/nuc";
 import {
   type AclDto,
@@ -22,7 +21,6 @@ import {
   DefaultNilDBConfig,
   type DelegationTokenRequest,
   type DelegationTokenResponse,
-  NilAuthInstance,
   type NilAuthPublicKey,
   type NilaiClientOptions,
   type NilDBDelegation,
@@ -34,11 +32,9 @@ export interface NilaiOpenAIClientOptions
   extends NilaiClientOptions,
     ClientOptions {
   authType?: AuthType;
-  nilauthInstance?: NilAuthInstance;
 }
 export class NilaiOpenAIClient extends OpenAI {
   private authType: AuthType = AuthType.API_KEY;
-  private nilAuthInstance: NilAuthInstance = NilAuthInstance.SANDBOX;
   private nilAuthPrivateKey: Keypair | null = null;
   private _rootTokenEnvelope: NucTokenEnvelope | null = null;
   private delegationToken: NucTokenEnvelope | null = null;
@@ -47,17 +43,11 @@ export class NilaiOpenAIClient extends OpenAI {
   constructor(
     options: NilaiOpenAIClientOptions = {
       authType: AuthType.API_KEY,
-      nilauthInstance: NilAuthInstance.SANDBOX,
       apiKey: "",
       baseURL: "",
     },
   ) {
-    const {
-      authType = AuthType.API_KEY,
-      nilauthInstance = NilAuthInstance.SANDBOX,
-      apiKey,
-      ...openAIOptions
-    } = options;
+    const { authType = AuthType.API_KEY, apiKey, ...openAIOptions } = options;
 
     // Set up authentication
     const processedOptions = { apiKey: apiKey, ...openAIOptions };
@@ -80,7 +70,6 @@ export class NilaiOpenAIClient extends OpenAI {
     super(processedOptions);
 
     this.authType = authType;
-    this.nilAuthInstance = nilauthInstance;
 
     this._initializeAuth(apiKey);
   }
@@ -138,18 +127,16 @@ export class NilaiOpenAIClient extends OpenAI {
     }
 
     if (!this._rootTokenEnvelope || isExpired(this._rootTokenEnvelope)) {
-      const nilauthClient = await NilauthClient.from(
-        this.nilAuthInstance,
-        await new PayerBuilder()
-          .chainUrl("https://rpc.testnet.nilchain-rpc-proxy.nilogy.xyz")
-          .keypair(this.nilAuthPrivateKey)
-          .build(),
-      );
-      const rootTokenResponse = await nilauthClient.requestToken(
-        this.nilAuthPrivateKey,
-        "nilai",
-      );
-      this._rootTokenEnvelope = rootTokenResponse.token;
+      const expirationTime = Math.floor(Date.now() / 1000) + 3600; // 1 hour
+      const selfDid = new DidClass(this.nilAuthPrivateKey.publicKey());
+      const rootTokenString = NucTokenBuilder.delegation([])
+        .command(new Command(["nil", "ai", "generate"]))
+        .audience(selfDid)
+        .subject(selfDid)
+        .expiresAt(expirationTime)
+        .build(this.nilAuthPrivateKey.privateKey());
+      this._rootTokenEnvelope =
+        NucTokenEnvelopeSchema.parse(rootTokenString);
     }
 
     return this._rootTokenEnvelope;

src/index.ts

@@ -10,7 +10,6 @@ export {
   type DelegationTokenRequest,
   type DelegationTokenResponse,
   type InvocationArgs,
-  NilAuthInstance,
   type NilaiClientOptions,
   RequestType,
 } from "./types";

src/server.ts

@@ -3,10 +3,9 @@ import {
   DelegationBody,
   Did as DidClass,
   Keypair,
-  NilauthClient,
   NucTokenBuilder,
   type NucTokenEnvelope,
-  PayerBuilder,
+  NucTokenEnvelopeSchema,
 } from "@nillion/nuc";
 
 import {
@@ -42,18 +41,16 @@ export class DelegationTokenServer {
     }
 
     if (!this._rootTokenEnvelope || isExpired(this._rootTokenEnvelope)) {
-      const nilauthClient = await NilauthClient.from(
-        this.config.nilauthInstance,
-        await new PayerBuilder()
-          .chainUrl("https://rpc.testnet.nilchain-rpc-proxy.nilogy.xyz")
-          .keypair(this.nilAuthPrivateKey)
-          .build(),
-      );
-      const rootTokenResponse = await nilauthClient.requestToken(
-        this.nilAuthPrivateKey,
-        "nilai",
-      );
-      this._rootTokenEnvelope = rootTokenResponse.token;
+      const expirationTime = Math.floor(Date.now() / 1000) + 3600; // 1 hour
+      const selfDid = new DidClass(this.nilAuthPrivateKey.publicKey());
+      const rootTokenString = NucTokenBuilder.delegation([])
+        .command(new Command(["nil", "ai", "generate"]))
+        .audience(selfDid)
+        .subject(selfDid)
+        .expiresAt(expirationTime)
+        .build(this.nilAuthPrivateKey.privateKey());
+      this._rootTokenEnvelope =
+        NucTokenEnvelopeSchema.parse(rootTokenString);
     }
 
     return this._rootTokenEnvelope;

src/types.ts

@@ -34,7 +34,6 @@ export const PromptDocumentInfoSchema = z.object({
 });
 
 export const DelegationServerConfigSchema = z.object({
-  nilauthInstance: NilAuthInstanceSchema.default(NilAuthInstance.SANDBOX),
   expirationTime: z.number().positive().default(60),
   tokenMaxUses: z.number().positive().default(1),
   prompt_document: PromptDocumentInfoSchema.optional(),
@@ -62,9 +61,6 @@ export type DelegationTokenResponse = z.infer<
 
 export const NilaiClientOptionsSchema = z.object({
   authType: AuthTypeSchema.default(AuthType.DELEGATION_TOKEN).optional(),
-  nilauthInstance: NilAuthInstanceSchema.default(
-    NilAuthInstance.SANDBOX,
-  ).optional(),
 });
 export type NilaiClientOptions = z.infer<typeof NilaiClientOptionsSchema>;
 
@@ -74,7 +70,6 @@ export type InvocationArgs = z.infer<typeof InvocationArgsSchema>;
 // Constants with validation
 export const DefaultDelegationTokenServerConfig: DelegationServerConfig =
   DelegationServerConfigSchema.parse({
-    nilauthInstance: NilAuthInstance.SANDBOX,
     expirationTime: 60,
     tokenMaxUses: 1,
   });