0g-orbit 0.1.0 → 0.2.0

package/src/orbit.ts

@@ -3,6 +3,7 @@ import type { NetworkName, NetworkConfig } from './networks.js'
 import { getNetwork, NETWORKS } from './networks.js'
 import { StorageClient } from './storage.js'
 import { InferenceClient } from './inference.js'
+import { FineTuningClient } from './fine-tuning.js'
 import type {
     OrbitConfig,
     StoreResult,
@@ -12,6 +13,11 @@ import type {
     InferOptions,
     ServiceInfo,
     AccountStatus,
+    DatasetUploadResult,
+    CreateTaskOptions,
+    FineTuneTask,
+    FineTuneModel,
+    FineTuneProvider,
 } from './types.js'
 import { ConnectionError } from './errors.js'
 
@@ -19,6 +25,7 @@ export class Orbit {
     readonly network: NetworkConfig
     readonly storage: StorageClient
     readonly inference: InferenceClient
+    private _fineTuning: FineTuningClient | null = null
     private wallet: Wallet
     private provider: JsonRpcProvider
 
@@ -34,6 +41,14 @@ export class Orbit {
         this.inference = new InferenceClient(network, wallet)
     }
 
+    /** Lazy-initialized fine-tuning client */
+    get fineTuning(): FineTuningClient {
+        if (!this._fineTuning) {
+            this._fineTuning = new FineTuningClient(this.network, this.wallet, this.storage)
+        }
+        return this._fineTuning
+    }
+
     /**
      * Connect to the 0G network. This is the primary entry point.
      *
@@ -140,6 +155,36 @@ export class Orbit {
         return this.inference.listServices()
     }
 
+    // --- Fine-Tuning shortcuts ---
+
+    async uploadDataset(filePath: string): Promise<DatasetUploadResult> {
+        return this.fineTuning.uploadDataset(filePath)
+    }
+
+    async createFineTuneTask(options: CreateTaskOptions): Promise<FineTuneTask> {
+        return this.fineTuning.createTask(options)
+    }
+
+    async getFineTuneTask(providerAddress: string, taskId: string): Promise<FineTuneTask> {
+        return this.fineTuning.getTask(providerAddress, taskId)
+    }
+
+    async downloadModel(
+        providerAddress: string,
+        taskId: string,
+        outputPath: string
+    ): Promise<void> {
+        return this.fineTuning.downloadModel(providerAddress, taskId, outputPath)
+    }
+
+    async listModels(): Promise<FineTuneModel[]> {
+        return this.fineTuning.listModels()
+    }
+
+    async listProviders(): Promise<FineTuneProvider[]> {
+        return this.fineTuning.listProviders()
+    }
+
     // --- Account ---
 
     async status(): Promise<AccountStatus> {

package/src/storage.ts

@@ -95,12 +95,12 @@ export class StorageClient {
             if (uploadErr) {
                 const msg = uploadErr.message
                 let suggestion = 'Check your OG balance and try again.'
-                if (msg.includes('gas') || msg.includes('underpriced')) {
+                if (msg.includes('insufficient funds') || msg.includes('INSUFFICIENT_FUNDS')) {
+                    suggestion = 'Your wallet needs more OG for gas. Get testnet OG from: https://faucet.0g.ai'
+                } else if (msg.includes('underpriced') || msg.includes('gas required exceeds')) {
                     suggestion = `Gas auto-escalation hit the ceiling (${maxGas} wei). Try a higher maxGasPrice, e.g. { maxGasPrice: ${maxGas * 2}n }`
                 } else if (msg.includes('timeout') || msg.includes('ETIMEDOUT')) {
                     suggestion = 'The RPC endpoint timed out. Try a different RPC URL with the rpcUrl option.'
-                } else if (msg.includes('insufficient funds')) {
-                    suggestion = 'Your wallet needs more OG for gas. Get testnet OG from: https://faucet.0g.ai'
                 }
                 throw new StorageError(`Upload failed: ${msg}`, suggestion)
             }

package/src/types.ts

@@ -83,3 +83,75 @@ export interface AccountStatus {
     /** Wallet address */
     address: string
 }
+
+// --- Fine-Tuning ---
+
+export interface DatasetUploadResult {
+    /** Merkle root hash of the uploaded dataset in 0G Storage */
+    root: string
+    /** On-chain transaction hash */
+    txHash: string
+}
+
+export interface CreateTaskOptions {
+    /** Name of the base model to fine-tune (e.g. 'Qwen2.5-0.5B-Instruct') */
+    model: string
+    /** Root hash of the dataset in 0G Storage (from uploadDataset) */
+    dataset: string
+    /** Provider wallet address */
+    providerAddress: string
+    /** Training hyperparameters (JSON object or file path) */
+    trainingParams?: {
+        nEpochs?: number
+        batchSize?: number
+        learningRate?: number
+        loraRank?: number
+        loraAlpha?: number
+        [key: string]: unknown
+    }
+}
+
+export type FineTuneStatus =
+    | 'init'
+    | 'setting-up'
+    | 'set-up'
+    | 'training'
+    | 'trained'
+    | 'delivering'
+    | 'delivered'
+    | 'acknowledged'
+    | 'finished'
+    | 'failed'
+
+export interface FineTuneTask {
+    /** Task ID */
+    id: string
+    /** Base model name or hash */
+    model: string
+    /** Dataset root hash */
+    dataset: string
+    /** Provider address */
+    provider: string
+    /** Current task status */
+    status: FineTuneStatus
+    /** Task creation time */
+    createdAt?: string
+    /** Last update time */
+    updatedAt?: string
+}
+
+export interface FineTuneModel {
+    /** Model name */
+    name: string
+    /** Model configuration (hash, description, etc.) */
+    config: Record<string, string>
+}
+
+export interface FineTuneProvider {
+    /** Provider wallet address */
+    address: string
+    /** Provider endpoint URL */
+    url: string
+    /** Customized models offered by this provider */
+    models: string[]
+}