Skip to main content

Client Configuration

The ECloud SDK client is the main entry point for interacting with EigenCompute. It provides access to all SDK modules and handles authentication and network configuration.

Creating a client​

Basic usage​

import { createECloudClient } from '@layr-labs/ecloud-sdk';

const client = createECloudClient({
  privateKey: process.env.PRIVATE_KEY as `0x${string}`,
  environment: 'sepolia',
});

With custom RPC​

const client = createECloudClient({
  privateKey: '0x...',
  environment: 'mainnet-alpha',
  rpcUrl: 'https://rpc.example.com',
  verbose: true,
});

Multiple RPC endpoints (fallback)​

const client = createECloudClient({
  privateKey: '0x...',
  environment: 'sepolia',
  rpcUrl: [
    'https://rpc1.example.com',
    'https://rpc2.example.com',
    'https://rpc3.example.com',
  ],
});

Configuration options​

ClientConfig​

interface ClientConfig {
  /**
   * Private key for signing transactions
   * Must be a hex string starting with '0x'
   */
  privateKey: `0x${string}`;
  
  /**
   * Deployment environment
   * - 'sepolia': Sepolia testnet
   * - 'mainnet-alpha': Ethereum mainnet
   */
  environment: 'sepolia' | 'mainnet-alpha';
  
  /**
   * Custom RPC URL(s) for Ethereum node connection
   * Can be a single URL or array of URLs for fallback
   * @default Uses environment's default RPC
   */
  rpcUrl?: string | string[];
  
  /**
   * Enable verbose logging
   * @default false
   */
  verbose?: boolean;
}

Authentication​

The SDK requires a private key to sign transactions. Provide it using one of these methods:

1. Environment variable​

Set the PRIVATE_KEY environment variable:

export PRIVATE_KEY=0x...
const client = createECloudClient({
  privateKey: process.env.PRIVATE_KEY as `0x${string}`,
  environment: 'sepolia',
});

2. OS keychain (using ecloud CLI)​

Store your key securely using the ecloud CLI:

ecloud auth create

Retrieve it programmatically:

import { requirePrivateKey } from '@layr-labs/ecloud-sdk';

const privateKey = await requirePrivateKey({
  environment: 'sepolia',
  // Will prompt or retrieve from keychain
});

const client = createECloudClient({
  privateKey,
  environment: 'sepolia',
});

3. Direct parameter​

Pass the private key directly (not recommended for production):

const client = createECloudClient({
  privateKey: '0x...',
  environment: 'sepolia',
});
Security

Never commit private keys to source control. Use environment variables or secure key management systems in production.

Client properties​

Once created, the client exposes the following modules:

const client = createECloudClient({ ... });

// Access modules
client.compute    // Compute module (app deployment & management)
client.billing    // Billing module (subscriptions & credits)

// Billing address
client.billing.address  // Ethereum address derived from private key

Environments​

See Billing for subscription setup and Prerequisites for client creation.

Sepolia (testnet)​

Development and testing environment on Sepolia testnet.

const client = createECloudClient({
  privateKey: process.env.PRIVATE_KEY as `0x${string}`,
  environment: 'sepolia',
});

Mainnet Alpha​

Ethereum mainnet environment (currently in Alpha phase).

const client = createECloudClient({
  privateKey: process.env.PRIVATE_KEY as `0x${string}`,
  environment: 'mainnet-alpha',
});

Verbose logging​

Enable detailed logging for debugging:

const client = createECloudClient({
  privateKey: '0x...',
  environment: 'sepolia',
  verbose: true,  // Enable verbose output
});

When enabled, the SDK logs:

  • Transaction submissions
  • API requests
  • Deployment progress
  • Error details

Error handling​

try {
  const client = createECloudClient({
    privateKey: process.env.PRIVATE_KEY as `0x${string}`,
    environment: 'sepolia',
  });
  
  // Method calls may throw
  await client.compute.app.deploy({ ... });
} catch (error) {
  if (error.message.includes('insufficient funds')) {
    console.error('Not enough ETH for gas');
  } else {
    console.error('Error:', error.message);
  }
}

Best practices​

1. Use environment variables​

const client = createECloudClient({
  privateKey: process.env.PRIVATE_KEY as `0x${string}`,
  environment: (process.env.ECLOUD_ENV || 'sepolia') as 'sepolia' | 'mainnet-alpha',
  rpcUrl: process.env.RPC_URL,
});

2. Enable verbose logging during development​

const client = createECloudClient({
  privateKey: process.env.PRIVATE_KEY as `0x${string}`,
  environment: 'sepolia',
  verbose: process.env.NODE_ENV === 'development',
});

Private key utilities​

Generate a new private key​

import { generateNewPrivateKey } from '@layr-labs/ecloud-sdk';

const { privateKey, address } = generateNewPrivateKey();
console.log('Private Key:', privateKey);
console.log('Address:', address);

Validate private key format​

import { validatePrivateKeyFormat } from '@layr-labs/ecloud-sdk';

const isValid = validatePrivateKeyFormat('0x...');
if (!isValid) {
  throw new Error('Invalid private key format');
}

Next steps​