@openzeppelin/ui-builder-adapter-stellar 0.13.0 → 0.15.0

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { WalletConnectionStatus, ContractAdapter, StellarNetworkConfig, UiKitConfiguration, FormFieldType, ContractSchema, FieldType, FunctionParameter, ExecutionConfig, TxStatus, TransactionStatusUpdate, ContractFunction, Connector, ExecutionMethodDetail, AvailableUiKit, NativeConfigLoader, EcosystemWalletComponents, EcosystemReactUiProviderProps, EcosystemSpecificReactHooks, RelayerDetails, RelayerDetailsRich, UserRpcProviderConfig, AdapterConfig } from '@openzeppelin/ui-builder-types';
+import { WalletConnectionStatus, ContractAdapter, StellarNetworkConfig, UiKitConfiguration, NetworkServiceForm, FormFieldType, ContractSchema, FieldType, FunctionParameter, ExecutionConfig, TxStatus, TransactionStatusUpdate, ContractFunction, Connector, ExecutionMethodDetail, AvailableUiKit, NativeConfigLoader, EcosystemWalletComponents, EcosystemReactUiProviderProps, EcosystemSpecificReactHooks, RelayerDetails, RelayerDetailsRich, UserRpcProviderConfig, AdapterConfig } from '@openzeppelin/ui-builder-types';
 
 /**
  * Stellar-specific wallet connection status extending the base interface.
@@ -13,13 +13,27 @@ interface StellarWalletConnectionStatus extends WalletConnectionStatus {
 
 /**
  * Stellar-specific adapter implementation using explicit method delegation.
- *
- * NOTE: Contains placeholder implementations for most functionalities.
  */
 declare class StellarAdapter implements ContractAdapter {
     readonly networkConfig: StellarNetworkConfig;
     readonly initialAppServiceKitName: UiKitConfiguration['kitName'];
     constructor(networkConfig: StellarNetworkConfig);
+    /**
+     * @inheritdoc
+     */
+    getNetworkServiceForms(): NetworkServiceForm[];
+    /**
+     * @inheritdoc
+     */
+    validateNetworkServiceConfig(serviceId: string, values: Record<string, unknown>): Promise<boolean>;
+    /**
+     * @inheritdoc
+     */
+    testNetworkServiceConnection(serviceId: string, values: Record<string, unknown>): Promise<{
+        success: boolean;
+        latency?: number;
+        error?: string;
+    }>;
     /**
      * NOTE about artifact inputs (single input with auto-detection):
      *
@@ -44,6 +58,9 @@ declare class StellarAdapter implements ContractAdapter {
      *   manual contract definition exactly like the EVM/Midnight flows.
      * - Provide clear UI hints about supported formats (JSON spec or Wasm binary).
      */
+    /**
+     * @inheritdoc
+     */
     getContractDefinitionInputs(): FormFieldType[];
     /**
      * @inheritdoc
@@ -63,38 +80,89 @@ declare class StellarAdapter implements ContractAdapter {
             definitionHash?: string;
         };
     }>;
+    /**
+     * @inheritdoc
+     */
     getWritableFunctions(contractSchema: ContractSchema): ContractSchema['functions'];
+    /**
+     * @inheritdoc
+     */
     mapParameterTypeToFieldType(parameterType: string): FieldType;
     getCompatibleFieldTypes(parameterType: string): FieldType[];
     generateDefaultField<T extends FieldType = FieldType>(parameter: FunctionParameter, contractSchema?: ContractSchema): FormFieldType<T>;
+    /**
+     * @inheritdoc
+     */
     formatTransactionData(contractSchema: ContractSchema, functionId: string, submittedInputs: Record<string, unknown>, fields: FormFieldType[]): unknown;
     signAndBroadcast(transactionData: unknown, executionConfig: ExecutionConfig, onStatusChange: (status: TxStatus, details: TransactionStatusUpdate) => void, runtimeApiKey?: string): Promise<{
         txHash: string;
     }>;
+    /**
+     * @inheritdoc
+     */
     isViewFunction(functionDetails: ContractFunction): boolean;
+    /**
+     * @inheritdoc
+     */
     queryViewFunction(contractAddress: string, functionId: string, params?: unknown[], contractSchema?: ContractSchema): Promise<unknown>;
+    /**
+     * @inheritdoc
+     */
     formatFunctionResult(decodedValue: unknown, functionDetails: ContractFunction): string;
+    /**
+     * @inheritdoc
+     */
     supportsWalletConnection(): boolean;
+    /**
+     * @inheritdoc
+     */
     getAvailableConnectors(): Promise<Connector[]>;
+    /**
+     * @inheritdoc
+     */
     connectWallet(connectorId: string): Promise<{
         connected: boolean;
         address?: string;
         error?: string;
     }>;
+    /**
+     * @inheritdoc
+     */
     disconnectWallet(): Promise<{
         disconnected: boolean;
         error?: string;
     }>;
+    /**
+     * @inheritdoc
+     */
     getWalletConnectionStatus(): StellarWalletConnectionStatus;
     /**
      * @inheritdoc
      */
     onWalletConnectionChange(callback: (currentStatus: WalletConnectionStatus, previousStatus: WalletConnectionStatus) => void): () => void;
+    /**
+     * @inheritdoc
+     */
     getSupportedExecutionMethods(): Promise<ExecutionMethodDetail[]>;
+    /**
+     * @inheritdoc
+     */
     validateExecutionConfig(config: ExecutionConfig): Promise<true | string>;
+    /**
+     * @inheritdoc
+     */
     getExplorerUrl(address: string): string | null;
+    /**
+     * @inheritdoc
+     */
     getExplorerTxUrl?(txHash: string): string | null;
+    /**
+     * @inheritdoc
+     */
     isValidAddress(address: string, addressType?: string): boolean;
+    /**
+     * @inheritdoc
+     */
     getAvailableUiKits(): Promise<AvailableUiKit[]>;
     /**
      * @inheritdoc
@@ -118,11 +186,16 @@ declare class StellarAdapter implements ContractAdapter {
      * @inheritdoc
      */
     getEcosystemReactHooks(): EcosystemSpecificReactHooks | undefined;
+    /**
+     * @inheritdoc
+     */
     getRelayers(serviceUrl: string, accessToken: string): Promise<RelayerDetails[]>;
+    /**
+     * @inheritdoc
+     */
     getRelayer(serviceUrl: string, accessToken: string, relayerId: string): Promise<RelayerDetailsRich>;
     /**
-     * Returns a React component for configuring Stellar-specific relayer transaction options.
-     * @returns The Stellar relayer options component
+     * @inheritdoc
      */
     getRelayerOptionsComponent(): React.ComponentType<{
         options: Record<string, unknown>;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { WalletConnectionStatus, ContractAdapter, StellarNetworkConfig, UiKitConfiguration, FormFieldType, ContractSchema, FieldType, FunctionParameter, ExecutionConfig, TxStatus, TransactionStatusUpdate, ContractFunction, Connector, ExecutionMethodDetail, AvailableUiKit, NativeConfigLoader, EcosystemWalletComponents, EcosystemReactUiProviderProps, EcosystemSpecificReactHooks, RelayerDetails, RelayerDetailsRich, UserRpcProviderConfig, AdapterConfig } from '@openzeppelin/ui-builder-types';
+import { WalletConnectionStatus, ContractAdapter, StellarNetworkConfig, UiKitConfiguration, NetworkServiceForm, FormFieldType, ContractSchema, FieldType, FunctionParameter, ExecutionConfig, TxStatus, TransactionStatusUpdate, ContractFunction, Connector, ExecutionMethodDetail, AvailableUiKit, NativeConfigLoader, EcosystemWalletComponents, EcosystemReactUiProviderProps, EcosystemSpecificReactHooks, RelayerDetails, RelayerDetailsRich, UserRpcProviderConfig, AdapterConfig } from '@openzeppelin/ui-builder-types';
 
 /**
  * Stellar-specific wallet connection status extending the base interface.
@@ -13,13 +13,27 @@ interface StellarWalletConnectionStatus extends WalletConnectionStatus {
 
 /**
  * Stellar-specific adapter implementation using explicit method delegation.
- *
- * NOTE: Contains placeholder implementations for most functionalities.
  */
 declare class StellarAdapter implements ContractAdapter {
     readonly networkConfig: StellarNetworkConfig;
     readonly initialAppServiceKitName: UiKitConfiguration['kitName'];
     constructor(networkConfig: StellarNetworkConfig);
+    /**
+     * @inheritdoc
+     */
+    getNetworkServiceForms(): NetworkServiceForm[];
+    /**
+     * @inheritdoc
+     */
+    validateNetworkServiceConfig(serviceId: string, values: Record<string, unknown>): Promise<boolean>;
+    /**
+     * @inheritdoc
+     */
+    testNetworkServiceConnection(serviceId: string, values: Record<string, unknown>): Promise<{
+        success: boolean;
+        latency?: number;
+        error?: string;
+    }>;
     /**
      * NOTE about artifact inputs (single input with auto-detection):
      *
@@ -44,6 +58,9 @@ declare class StellarAdapter implements ContractAdapter {
      *   manual contract definition exactly like the EVM/Midnight flows.
      * - Provide clear UI hints about supported formats (JSON spec or Wasm binary).
      */
+    /**
+     * @inheritdoc
+     */
     getContractDefinitionInputs(): FormFieldType[];
     /**
      * @inheritdoc
@@ -63,38 +80,89 @@ declare class StellarAdapter implements ContractAdapter {
             definitionHash?: string;
         };
     }>;
+    /**
+     * @inheritdoc
+     */
     getWritableFunctions(contractSchema: ContractSchema): ContractSchema['functions'];
+    /**
+     * @inheritdoc
+     */
     mapParameterTypeToFieldType(parameterType: string): FieldType;
     getCompatibleFieldTypes(parameterType: string): FieldType[];
     generateDefaultField<T extends FieldType = FieldType>(parameter: FunctionParameter, contractSchema?: ContractSchema): FormFieldType<T>;
+    /**
+     * @inheritdoc
+     */
     formatTransactionData(contractSchema: ContractSchema, functionId: string, submittedInputs: Record<string, unknown>, fields: FormFieldType[]): unknown;
     signAndBroadcast(transactionData: unknown, executionConfig: ExecutionConfig, onStatusChange: (status: TxStatus, details: TransactionStatusUpdate) => void, runtimeApiKey?: string): Promise<{
         txHash: string;
     }>;
+    /**
+     * @inheritdoc
+     */
     isViewFunction(functionDetails: ContractFunction): boolean;
+    /**
+     * @inheritdoc
+     */
     queryViewFunction(contractAddress: string, functionId: string, params?: unknown[], contractSchema?: ContractSchema): Promise<unknown>;
+    /**
+     * @inheritdoc
+     */
     formatFunctionResult(decodedValue: unknown, functionDetails: ContractFunction): string;
+    /**
+     * @inheritdoc
+     */
     supportsWalletConnection(): boolean;
+    /**
+     * @inheritdoc
+     */
     getAvailableConnectors(): Promise<Connector[]>;
+    /**
+     * @inheritdoc
+     */
     connectWallet(connectorId: string): Promise<{
         connected: boolean;
         address?: string;
         error?: string;
     }>;
+    /**
+     * @inheritdoc
+     */
     disconnectWallet(): Promise<{
         disconnected: boolean;
         error?: string;
     }>;
+    /**
+     * @inheritdoc
+     */
     getWalletConnectionStatus(): StellarWalletConnectionStatus;
     /**
      * @inheritdoc
      */
     onWalletConnectionChange(callback: (currentStatus: WalletConnectionStatus, previousStatus: WalletConnectionStatus) => void): () => void;
+    /**
+     * @inheritdoc
+     */
     getSupportedExecutionMethods(): Promise<ExecutionMethodDetail[]>;
+    /**
+     * @inheritdoc
+     */
     validateExecutionConfig(config: ExecutionConfig): Promise<true | string>;
+    /**
+     * @inheritdoc
+     */
     getExplorerUrl(address: string): string | null;
+    /**
+     * @inheritdoc
+     */
     getExplorerTxUrl?(txHash: string): string | null;
+    /**
+     * @inheritdoc
+     */
     isValidAddress(address: string, addressType?: string): boolean;
+    /**
+     * @inheritdoc
+     */
     getAvailableUiKits(): Promise<AvailableUiKit[]>;
     /**
      * @inheritdoc
@@ -118,11 +186,16 @@ declare class StellarAdapter implements ContractAdapter {
      * @inheritdoc
      */
     getEcosystemReactHooks(): EcosystemSpecificReactHooks | undefined;
+    /**
+     * @inheritdoc
+     */
     getRelayers(serviceUrl: string, accessToken: string): Promise<RelayerDetails[]>;
+    /**
+     * @inheritdoc
+     */
     getRelayer(serviceUrl: string, accessToken: string, relayerId: string): Promise<RelayerDetailsRich>;
     /**
-     * Returns a React component for configuring Stellar-specific relayer transaction options.
-     * @returns The Stellar relayer options component
+     * @inheritdoc
      */
     getRelayerOptionsComponent(): React.ComponentType<{
         options: Record<string, unknown>;