@0xobelisk/client 0.4.7 → 1.2.0-pre.100

package/src/sui/index.ts

@@ -0,0 +1,30 @@
+/**
+ * @0xobelisk/client/sui - Unified Dubhe Client for Sui Blockchain
+ *
+ * 🚀 Simple, powerful client creation aligned with @0xobelisk/react
+ *
+ * Features:
+ * - ⚡ Unified configuration interface
+ * - 🔧 Factory pattern for easy instantiation
+ * - 🛡️ Complete type safety with strict TypeScript
+ * - 📦 All-in-one bundle with contract, GraphQL, gRPC, and ECS clients
+ * - 🎯 Intuitive API design
+ * - 🌐 Platform-agnostic (Browser, Node.js, COCOS)
+ */
+
+// ============ Type Exports ============
+export type { NetworkType, ClientConfig, DubheConfig, DubheClientBundle } from './types';
+
+// ============ Client Factory Functions ============
+export {
+  createClient,
+  createClientWithValidation,
+  validateClientConfig,
+  isNetworkType
+} from './client';
+
+// ============ Re-export Core Types for Convenience ============
+export type { Dubhe } from '@0xobelisk/sui-client';
+export type { DubheGraphqlClient } from '@0xobelisk/graphql-client';
+export type { DubheECSWorld } from '@0xobelisk/ecs';
+export type { DubheGrpcClient } from '@0xobelisk/grpc-client';

package/src/sui/types.ts

@@ -0,0 +1,94 @@
+import type { SuiMoveNormalizedModules, Dubhe } from '@0xobelisk/sui-client';
+import type { DubheGraphqlClient } from '@0xobelisk/graphql-client';
+import type { DubheECSWorld } from '@0xobelisk/ecs';
+import type { DubheGrpcClient } from '@0xobelisk/grpc-client';
+
+/**
+ * Network type for Sui blockchain
+ */
+export type NetworkType = 'mainnet' | 'testnet' | 'devnet' | 'localnet';
+
+/**
+ * Client configuration interface
+ * Aligned with @0xobelisk/react configuration for consistency
+ */
+export interface ClientConfig {
+  /** Network type */
+  network: NetworkType;
+  /** Contract package ID */
+  packageId: string;
+  /** Contract metadata (required for contract instantiation) */
+  metadata: any;
+  /** Dubhe Schema ID (optional, for enhanced features) */
+  dubheSchemaId?: string;
+  /** Dubhe metadata (enables GraphQL/ECS features) */
+  dubheMetadata?: any;
+  /** Authentication credentials */
+  credentials?: {
+    /** Private key (base64 or hex string) */
+    secretKey?: string;
+    /** Mnemonic phrase (12 or 24 words) */
+    mnemonics?: string;
+  };
+  /** Service endpoints configuration */
+  endpoints?: {
+    /** Full node RPC URLs (can provide multiple for redundancy) */
+    fullnodeUrls?: string[];
+    /** GraphQL endpoint URL */
+    graphql?: string;
+    /** WebSocket endpoint URL for subscriptions */
+    websocket?: string;
+    /** gRPC endpoint URL */
+    grpc?: string;
+    /** Dubhe Channel API URL */
+    channelUrl?: string;
+  };
+  /** Performance and behavior options */
+  options?: {
+    /** Enable batch query optimization */
+    enableBatchOptimization?: boolean;
+    /** Default cache timeout (milliseconds) */
+    cacheTimeout?: number;
+    /** Request debounce delay (milliseconds) */
+    debounceMs?: number;
+    /** Auto-reconnect on WebSocket errors */
+    reconnectOnError?: boolean;
+  };
+}
+
+/**
+ * Type alias for consistency with @0xobelisk/react package
+ */
+export type DubheConfig = ClientConfig;
+
+/**
+ * Client bundle returned by createClient
+ * Contains all initialized client instances
+ */
+export interface DubheClientBundle {
+  /** Dubhe contract instance - core client for contract interactions */
+  contract: Dubhe;
+  /** GraphQL client for querying indexed data */
+  graphqlClient: DubheGraphqlClient;
+  /** gRPC client for high-performance queries */
+  grpcClient: DubheGrpcClient;
+  /** ECS World instance for entity-component-system queries */
+  ecsWorld: DubheECSWorld;
+  /** Contract metadata */
+  metadata: SuiMoveNormalizedModules;
+  /** Network type */
+  network: NetworkType;
+  /** Package ID */
+  packageId: string;
+  /** Dubhe Schema ID (if provided) */
+  dubheSchemaId?: string;
+  /** User address */
+  address: string;
+  /** Configuration options used */
+  options?: {
+    enableBatchOptimization?: boolean;
+    cacheTimeout?: number;
+    debounceMs?: number;
+    reconnectOnError?: boolean;
+  };
+}

package/LICENSE

@@ -1,92 +0,0 @@
-Business Source License 1.1
-
-License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
-"Business Source License" is a trademark of MariaDB Corporation Ab.
-
------------------------------------------------------------------------------
-
-Parameters
-
-Licensor:             Obelisk Labs
-
-Licensed Work:        Obelisk Engine
-                      The Licensed Work is (c) 2023 Obelisk Labs
-
------------------------------------------------------------------------------
-
-Terms
-
-The Licensor hereby grants you the right to copy, modify, create derivative
-works, redistribute, and make non-production use of the Licensed Work. The
-Licensor may make an Additional Use Grant, above, permitting limited
-production use.
-
-Effective on the Change Date, or the fourth anniversary of the first publicly
-available distribution of a specific version of the Licensed Work under this
-License, whichever comes first, the Licensor hereby grants you rights under
-the terms of the Change License, and the rights granted in the paragraph
-above terminate.
-
-If your use of the Licensed Work does not comply with the requirements
-currently in effect as described in this License, you must purchase a
-commercial license from the Licensor, its affiliated entities, or authorized
-resellers, or you must refrain from using the Licensed Work.
-
-All copies of the original and modified Licensed Work, and derivative works
-of the Licensed Work, are subject to this License. This License applies
-separately for each version of the Licensed Work and the Change Date may vary
-for each version of the Licensed Work released by Licensor.
-
-You must conspicuously display this License on each original or modified copy
-of the Licensed Work. If you receive the Licensed Work in original or
-modified form from a third party, the terms and conditions set forth in this
-License apply to your use of that work.
-
-Any use of the Licensed Work in violation of this License will automatically
-terminate your rights under this License for the current and all other
-versions of the Licensed Work.
-
-This License does not grant you any right in any trademark or logo of
-Licensor or its affiliates (provided that you may use a trademark or logo of
-Licensor as expressly required by this License).
-
-TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
-AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
-EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
-TITLE.
-
-MariaDB hereby grants you permission to use this License’s text to license
-your works, and to refer to it using the trademark "Business Source License",
-as long as you comply with the Covenants of Licensor below.
-
------------------------------------------------------------------------------
-
-Covenants of Licensor
-
-In consideration of the right to use this License’s text and the "Business
-Source License" name and trademark, Licensor covenants to MariaDB, and to all
-other recipients of the licensed work to be provided by Licensor:
-
-1. To specify as the Change License the GPL Version 2.0 or any later version,
-   or a license that is compatible with GPL Version 2.0 or a later version,
-   where "compatible" means that software provided under the Change License can
-   be included in a program with software provided under GPL Version 2.0 or a
-   later version. Licensor may specify additional Change Licenses without
-   limitation.
-
-2. To either: (a) specify an additional grant of rights to use that does not
-   impose any additional restriction on the right granted in this License, as
-   the Additional Use Grant; or (b) insert the text "None".
-
-3. To specify a Change Date.
-
-4. Not to modify this License in any other way.
-
------------------------------------------------------------------------------
-
-Notice
-
-The Business Source License (this document, or the "License") is not an Open
-Source license. However, the Licensed Work will eventually be made available
-under an Open Source License, as stated in this License.