@obolnetwork/obol-sdk 2.11.4 → 2.11.5-rc.1

package/src/schema.ts

@@ -1,376 +0,0 @@
-import { ZeroAddress } from 'ethers';
-import {
-  DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT,
-  DEFAULT_RETROACTIVE_FUNDING_TOTAL_SPLIT,
-  PRINCIPAL_THRESHOLD,
-} from './constants';
-import { VALID_DEPOSIT_AMOUNTS, VALID_NON_COMPOUNDING_AMOUNTS } from './ajv';
-
-export const operatorPayloadSchema = {
-  type: 'object',
-  properties: {
-    version: { type: 'string' },
-    enr: { type: 'string' },
-  },
-  required: ['version', 'enr'],
-};
-
-export const definitionSchema = {
-  type: 'object',
-  properties: {
-    name: { type: 'string' },
-    operators: {
-      type: 'array',
-      minItems: 4,
-      items: {
-        type: 'object',
-        properties: {
-          address: {
-            type: 'string',
-          },
-        },
-        required: ['address'],
-      },
-      validateUniqueAddresses: true,
-    },
-    validators: {
-      type: 'array',
-      minItems: 1,
-      items: {
-        type: 'object',
-        properties: {
-          fee_recipient_address: {
-            type: 'string',
-            pattern: '^0x[a-fA-F0-9]{40}$',
-          },
-          withdrawal_address: {
-            type: 'string',
-            pattern: '^0x[a-fA-F0-9]{40}$',
-          },
-        },
-        required: ['fee_recipient_address', 'withdrawal_address'],
-      },
-    },
-    deposit_amounts: {
-      type: ['array', 'null'],
-      items: {
-        type: 'string',
-        pattern: '^[0-9]+$',
-      },
-      if: {
-        $data: '1/compounding',
-      },
-      then: {
-        items: {
-          enum: VALID_DEPOSIT_AMOUNTS,
-        },
-      },
-      else: {
-        items: {
-          enum: VALID_NON_COMPOUNDING_AMOUNTS,
-        },
-      },
-      default: null,
-    },
-    compounding: {
-      type: 'boolean',
-      default: false,
-    },
-    target_gas_limit: {
-      type: 'number',
-      minimum: 1,
-      default: 36000000,
-    },
-    consensus_protocol: {
-      type: 'string',
-      enum: ['qbft', ''],
-      default: '',
-    },
-  },
-  required: ['name', 'operators', 'validators'],
-};
-
-export const totalSplitterPayloadSchema = {
-  type: 'object',
-  properties: {
-    splitRecipients: {
-      type: 'array',
-      items: {
-        type: 'object',
-        properties: {
-          account: {
-            type: 'string',
-            pattern: '^0x[a-fA-F0-9]{40}$',
-          },
-          percentAllocation: { type: 'number' },
-        },
-        required: ['account', 'percentAllocation'],
-      },
-    },
-    ObolRAFSplit: {
-      type: 'number',
-      minimum: DEFAULT_RETROACTIVE_FUNDING_TOTAL_SPLIT,
-      default: DEFAULT_RETROACTIVE_FUNDING_TOTAL_SPLIT,
-    },
-    distributorFee: {
-      type: 'number',
-      maximum: 10,
-      multipleOf: 0.01,
-      default: 0,
-    },
-    controllerAddress: {
-      type: 'string',
-      pattern: '^0x[a-fA-F0-9]{40}$',
-      default: ZeroAddress,
-    },
-  },
-  validateTotalSplitRecipients: true,
-  required: ['splitRecipients'],
-};
-
-export const rewardsSplitterPayloadSchema = {
-  type: 'object',
-  properties: {
-    ...totalSplitterPayloadSchema.properties,
-    ObolRAFSplit: {
-      type: 'number',
-      minimum: DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT,
-      default: DEFAULT_RETROACTIVE_FUNDING_REWARDS_ONLY_SPLIT,
-    },
-    recoveryAddress: {
-      type: 'string',
-      pattern: '^0x[a-fA-F0-9]{40}$',
-      default: ZeroAddress,
-    },
-    etherAmount: { type: 'number' },
-    principalRecipient: {
-      type: 'string',
-      pattern: '^0x[a-fA-F0-9]{40}$',
-    },
-  },
-  validateRewardsSplitRecipients: true,
-  required: ['splitRecipients', 'principalRecipient', 'etherAmount'],
-};
-
-export const ovmBaseSplitPayload = {
-  rewardSplitRecipients: {
-    type: 'array',
-    items: {
-      type: 'object',
-      properties: {
-        address: {
-          type: 'string',
-          pattern: '^0x[a-fA-F0-9]{40}$',
-        },
-        percentAllocation: { type: 'number' },
-      },
-      required: ['address', 'percentAllocation'],
-    },
-  },
-  OVMOwnerAddress: {
-    type: 'string',
-    pattern: '^0x[a-fA-F0-9]{40}$',
-  },
-  splitOwnerAddress: {
-    type: 'string',
-    pattern: '^0x[a-fA-F0-9]{40}$',
-    default: ZeroAddress,
-  },
-  principalThreshold: {
-    type: 'number',
-    minimum: 16,
-    default: PRINCIPAL_THRESHOLD,
-  },
-  distributorFeePercent: {
-    type: 'number',
-    minimum: 0,
-    maximum: 10,
-    default: 0,
-  },
-};
-
-export const ovmRewardsSplitPayloadSchema = {
-  type: 'object',
-  properties: {
-    ...ovmBaseSplitPayload,
-    principalRecipient: {
-      type: 'string',
-      pattern: '^0x[a-fA-F0-9]{40}$',
-    },
-  },
-  validateOVMRewardsSplitRecipients: true,
-  required: ['rewardSplitRecipients', 'OVMOwnerAddress', 'principalRecipient'],
-};
-
-export const ovmTotalSplitPayloadSchema = {
-  type: 'object',
-  properties: {
-    ...ovmBaseSplitPayload,
-    principalSplitRecipients: {
-      type: 'array',
-      items: {
-        type: 'object',
-        properties: {
-          address: {
-            type: 'string',
-            pattern: '^0x[a-fA-F0-9]{40}$',
-          },
-          percentAllocation: { type: 'number' },
-        },
-        required: ['address', 'percentAllocation'],
-      },
-    },
-  },
-  validateOVMRewardsSplitRecipients: true,
-  validateOVMTotalSplitRecipients: true,
-  required: [
-    'rewardSplitRecipients',
-    'principalSplitRecipients',
-    'OVMOwnerAddress',
-  ],
-};
-
-export const ovmRequestWithdrawalPayloadSchema = {
-  type: 'object',
-  properties: {
-    withdrawalFees: {
-      type: 'string',
-      pattern: '^[0-9]+$',
-    },
-    ovmAddress: {
-      type: 'string',
-      pattern: '^0x[a-fA-F0-9]{40}$',
-    },
-    pubKeys: {
-      type: 'array',
-      minItems: 1,
-      items: {
-        type: 'string',
-        pattern: '^0x[a-fA-F0-9]{96}$', // 48 bytes = 96 hex chars + 0x prefix
-      },
-    },
-    amounts: {
-      type: 'array',
-      minItems: 1,
-      items: {
-        type: 'string',
-        pattern: '^[0-9]+$',
-      },
-    },
-  },
-  validateOVMRequestWithdrawalPayload: true,
-  required: ['ovmAddress', 'pubKeys', 'amounts', 'withdrawalFees'],
-};
-
-export const eoaWithdrawalPayloadSchema = {
-  type: 'object',
-  properties: {
-    pubkey: {
-      type: 'string',
-      pattern: '^0x[a-fA-F0-9]{96}$', // 48 bytes = 96 hex chars + 0x prefix
-    },
-    allocation: {
-      type: 'number',
-      minimum: 0,
-    },
-    requiredFee: {
-      type: 'string',
-      pattern: '^[0-9]+$',
-    },
-  },
-  required: ['pubkey', 'allocation', 'requiredFee'],
-};
-
-export const ovmDepositPayloadSchema = {
-  type: 'object',
-  properties: {
-    ovmAddress: {
-      type: 'string',
-      pattern: '^0x[a-fA-F0-9]{40}$',
-    },
-    deposits: {
-      type: 'array',
-      minItems: 1,
-      items: {
-        type: 'object',
-        properties: {
-          pubkey: {
-            type: 'string',
-            pattern: '^0x[a-fA-F0-9]{96}$',
-          },
-          withdrawal_credentials: {
-            type: 'string',
-            pattern: '^0x[a-fA-F0-9]{64}$',
-            description: '32 bytes withdrawal credentials',
-          },
-          signature: {
-            type: 'string',
-            pattern: '^0x[a-fA-F0-9]{192}$',
-            description: '96 bytes signature (190 hex chars + 0x prefix)',
-          },
-          deposit_data_root: {
-            type: 'string',
-            pattern: '^0x[a-fA-F0-9]{64}$', // 32 bytes = 64 hex chars + 0x prefix
-          },
-          amount: {
-            type: 'string',
-            pattern: '^[0-9]+$',
-          },
-        },
-        required: [
-          'pubkey',
-          'withdrawal_credentials',
-          'signature',
-          'deposit_data_root',
-          'amount',
-        ],
-      },
-    },
-  },
-  required: ['ovmAddress', 'deposits'],
-};
-
-export const eoaDepositPayloadSchema = {
-  type: 'object',
-  properties: {
-    deposits: {
-      type: 'array',
-      minItems: 1,
-      items: {
-        type: 'object',
-        properties: {
-          pubkey: {
-            type: 'string',
-            pattern: '^0x[a-fA-F0-9]{96}$',
-          },
-          withdrawal_credentials: {
-            type: 'string',
-            pattern: '^0x[a-fA-F0-9]{64}$',
-            description: '32 bytes withdrawal credentials',
-          },
-          signature: {
-            type: 'string',
-            pattern: '^0x[a-fA-F0-9]{192}$',
-            description: '96 bytes signature (190 hex chars + 0x prefix)',
-          },
-          deposit_data_root: {
-            type: 'string',
-            pattern: '^0x[a-fA-F0-9]{64}$', // 32 bytes = 64 hex chars + 0x prefix
-          },
-          amount: {
-            type: 'string',
-            pattern: '^[0-9]+$',
-          },
-        },
-        required: [
-          'pubkey',
-          'withdrawal_credentials',
-          'signature',
-          'deposit_data_root',
-          'amount',
-        ],
-      },
-    },
-  },
-  required: ['deposits'],
-};

package/src/services.ts

@@ -1,24 +0,0 @@
-import { type SafeRpcUrl, type ClusterLock } from './types.js';
-import { isValidClusterLock } from './verification/common.js';
-
-/**
- * Verifies Cluster Lock's validity.
- * @param lock - cluster lock
- * @param safeRpcUrl - optional safeRpcUrl for safe wallet verification
- * @returns {Promise<{ result: boolean }> } boolean result to indicate if lock is valid
- * @throws on missing keys or values.
- *
- * An example of how to use validateClusterLock:
- * [validateClusterLock](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts#L127)
- */
-export const validateClusterLock = async (
-  lock: ClusterLock,
-  safeRpcUrl?: SafeRpcUrl,
-): Promise<boolean> => {
-  try {
-    const isLockValid = await isValidClusterLock(lock, safeRpcUrl);
-    return isLockValid;
-  } catch (err: any) {
-    throw err;
-  }
-};