@ocap/types 1.28.8 → 1.29.0

package/index.d.ts

@@ -1,3 +1,4 @@
+// Protobuf generated types
 export * from './lib/enum_pb';
 export * from './lib/rpc_pb';
 export * from './lib/service_pb';
@@ -5,4 +6,25 @@ export * from './lib/state_pb';
 export * from './lib/trace-type_pb';
 export * from './lib/tx_pb';
 export * from './lib/type_pb';
-export * from './lib/vendor_pb';
+
+// vendor_pb types - explicit exports to avoid conflicts with type_pb
+// (TConsensusParams, TValidator, TEvidence are defined in both files)
+export type {
+  TKVPair,
+  TBlockParams,
+  TEvidenceParams,
+  TValidatorParams,
+  TLastCommitInfo,
+  TVersion,
+  TBlockID,
+  TPartSetHeader,
+  TValidatorUpdate,
+  TVoteInfo,
+  TPubKey,
+  THeader,
+  TRequestBeginBlock,
+  TRequestEndBlock,
+} from './lib/vendor_pb';
+
+// Interface types (I* that extend proto types)
+export * from './interfaces';

package/interfaces/base.ts

@@ -0,0 +1,38 @@
+// core/types/interfaces/base.ts
+
+import type BaseBN from 'bn.js';
+
+// BN type definition - implementation is in @ocap/util
+export interface BN extends BaseBN {}
+
+export type { BaseBN };
+
+export type Promisable<T> = T | Promise<T>;
+export type BytesType = string | Buffer | Uint8Array;
+export type Timestamp = string | number | Date;
+export type Address = string;
+export type Hash = string;
+
+export interface IAny {
+  typeUrl: string;
+  value: Uint8Array;
+}
+
+export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+export type RequiredBy<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
+export type DeepPartial<T> = {
+  [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+
+/**
+ * Make specific keys required (keeps all other fields, makes K required and non-nullable)
+ * Useful for pipeline context types where certain fields become guaranteed after specific phases
+ */
+export type RequiredFields<T, K extends keyof T> = T & Required<Pick<T, K>>;
+
+/**
+ * Make all properties in T non-nullable (remove undefined from each property)
+ */
+export type NonNullableFields<T> = {
+  [P in keyof T]: NonNullable<T[P]>;
+};

package/interfaces/config.ts

@@ -0,0 +1,166 @@
+// core/types/interfaces/config.ts
+// Chain configuration types, aligned with Proto types from type_pb.d.ts
+
+import type {
+  TAccountConfig,
+  TCurveConfig,
+  TDelegateConfig,
+  TForeignToken,
+  TForgeToken,
+  TTransactionConfig,
+  TTxFeeConfig,
+  TTxGasConfig,
+  TTxStakeConfig,
+  TVaultConfig,
+} from '../lib/type_pb';
+import type { DeepPartial } from './base';
+
+// ============ Direct Re-exports (Proto compatible) ============
+
+export type { TDelegateConfig, TForeignToken, TTxFeeConfig, TCurveConfig };
+
+// ============ Config-specific Types ============
+
+/** Transaction type URL pattern like 'fg:t:transfer' */
+export type TxTypeUrl = `fg:t:${string}`;
+
+/** Map of transaction type URL to number value (size, fee, etc.) */
+export type TxTypeMap = { default: number } & Partial<Record<TxTypeUrl, number>>;
+
+// ============ Extended Types (with differences noted) ============
+
+/**
+ * Account configuration
+ * Diff from TAccountConfig: pk is string (not Uint8Array), added moniker
+ */
+export interface IAccountConfig extends Omit<TAccountConfig, 'pk' | 'balance'> {
+  pk: string;
+  balance?: number;
+  moniker?: string;
+}
+
+/**
+ * Transaction gas configuration
+ * Diff from TTxGasConfig: minStake/maxStake are number (Proto uses string)
+ */
+export interface ITxGasConfig extends Omit<TTxGasConfig, 'minStake' | 'maxStake'> {
+  minStake: number;
+  maxStake: number;
+}
+
+/**
+ * Transaction stake configuration
+ * Diff from TTxStakeConfig: added createCreditToken field
+ */
+export interface ITxStakeConfig extends TTxStakeConfig {
+  createCreditToken: number;
+}
+
+/**
+ * Transaction configuration
+ * Diff from TTransactionConfig:
+ * - txFee: TxTypeMap (Proto uses TTxFeeConfig[])
+ * - txGas: ITxGasConfig (Proto uses TTxGasConfig)
+ * - txStake: ITxStakeConfig (Proto uses TTxStakeConfig)
+ * - added: maxTxSize, supportedTxs, multiSignV2Txs
+ */
+export interface ITransactionConfig extends Omit<TTransactionConfig, 'txFee' | 'txGas' | 'txStake' | 'delegate'> {
+  maxTxSize: TxTypeMap;
+  txFee: TxTypeMap;
+  txGas: ITxGasConfig;
+  txStake: ITxStakeConfig;
+  delegate: TDelegateConfig;
+  supportedTxs: string[];
+  multiSignV2Txs: string[];
+}
+
+/**
+ * Token configuration
+ * Diff from TForgeToken:
+ * - icon: string (Proto uses Uint8Array | string)
+ * - initialSupply/totalSupply: number (Proto uses string)
+ * - added: website, metadata, foreignToken
+ */
+export interface ITokenConfig extends Omit<TForgeToken, 'icon' | 'initialSupply' | 'totalSupply'> {
+  icon: string;
+  initialSupply: number;
+  totalSupply: number;
+  website?: string | null;
+  /** Token metadata - format varies by token type (JSON structure kept flexible) */
+  metadata?: unknown;
+  foreignToken?: TForeignToken | null;
+}
+
+/**
+ * Vault addresses configuration
+ * Diff from TVaultConfig: all fields optional, added txFees array
+ */
+export interface IVaultsConfig extends Partial<TVaultConfig> {
+  txFees?: string[];
+}
+
+/**
+ * Consensus configuration (no Proto equivalent)
+ * Index signature allows for chain-specific extensions
+ */
+export interface IConsensusConfig {
+  maxValidators?: number;
+  minValidatorStake?: string;
+  blockTime?: number;
+  maxBlockSize?: number;
+  /** Extension point for chain-specific consensus config */
+  [key: string]: unknown;
+}
+
+// ============ Composite Config Types ============
+
+/** Default configuration (without required fields like address) */
+export interface IDefaultConfig {
+  transaction: ITransactionConfig;
+  vaults: IVaultsConfig;
+  accounts: IAccountConfig[];
+  reservedSymbols: string[];
+  token: Omit<ITokenConfig, 'description' | 'address'> & { description?: string; address?: string };
+}
+
+/** Full chain configuration */
+export interface IChainConfig {
+  chainId: string;
+  chainName?: string;
+  version: string;
+  transaction: ITransactionConfig;
+  moderator: IAccountConfig;
+  accounts: IAccountConfig[];
+  vaults: IVaultsConfig;
+  token: ITokenConfig;
+  consensus?: IConsensusConfig;
+  reservedSymbols?: string[];
+}
+
+/** Partial chain configuration for create() input - uses DeepPartial since create() merges with defaults */
+export type IChainConfigInput = DeepPartial<IChainConfig> & {
+  chainId: string;
+  version: string;
+  moderator: IAccountConfig;
+};
+
+/**
+ * Token ITX (inner transaction) for token creation
+ * Similar to TTokenInfo but with string amounts
+ */
+export interface ITokenItx {
+  name: string;
+  description: string;
+  symbol: string;
+  unit: string;
+  decimal: number;
+  totalSupply: string;
+  initialSupply: string;
+  issuer: string;
+  address: string;
+  foreignToken?: TForeignToken | null;
+  /** Token metadata - format varies by token type (JSON structure kept flexible) */
+  metadata?: unknown;
+  website?: string | null;
+  icon: string;
+}

package/interfaces/index.ts

@@ -0,0 +1,254 @@
+// core/types/interfaces/index.ts
+//
+// NOTE: Proto types (T*) are exported directly from core/types/index.d.ts via lib/*_pb.d.ts
+// This file only exports interface types (I*) that extend or complement proto types
+// DO NOT re-export proto types here to avoid "already exported" errors
+
+// Base types
+export type {
+  BN,
+  BaseBN,
+  Promisable,
+  BytesType,
+  Timestamp,
+  Address,
+  Hash,
+  IAny,
+  PartialBy,
+  RequiredBy,
+  DeepPartial,
+  RequiredFields,
+  NonNullableFields,
+} from './base';
+
+// State types (extended Proto T*State interfaces)
+export type {
+  IStateContext,
+  IStateContextInput,
+  IState,
+  IStateWithOwner,
+  StateChangeType,
+  StateKind,
+  IStateChangeEvent,
+  TokenBalanceMap,
+  // Account and Asset
+  IAccountState,
+  IAssetState,
+  IForeignToken,
+  ITokenMetadata,
+  ITokenState,
+  // Factory types
+  IFactoryHook,
+  IFactoryInput,
+  IAssetFactoryState,
+  IStakeState,
+  // Delegation types
+  IDelegationTokenLimit,
+  IDelegationAssetLimit,
+  IDelegationOpLimit,
+  IDelegationOps,
+  IDelegateState,
+  // Rollup types
+  IRollupValidator,
+  IRollupState,
+  IBlockSignature,
+  IRollupBlock,
+  IEvidenceState,
+  ITokenFactoryCurve,
+  ITokenFactoryState,
+} from './state';
+
+// Config types (interface types only - proto types exported from lib/*_pb.d.ts)
+export type {
+  // Config-specific types
+  TxTypeUrl,
+  TxTypeMap,
+  // Extended types
+  IAccountConfig,
+  ITxGasConfig,
+  ITxStakeConfig,
+  ITransactionConfig,
+  ITokenConfig,
+  IVaultsConfig,
+  IConsensusConfig,
+  // Composite types
+  IDefaultConfig,
+  IChainConfig,
+  IChainConfigInput,
+  ITokenItx,
+} from './config';
+
+// StateDB
+export type {
+  HookFunction,
+  StateEventHandler,
+  IOperationContext,
+  IChainTokenInfo,
+  IChainState,
+  ITxData,
+  ITxState,
+  IBalanceState,
+  IStateTable,
+  IBalanceTable,
+  ITokenTable,
+  IRollupTable,
+  IReady,
+  IStateDB,
+  StateDBTableName,
+} from './statedb';
+
+// IndexDB (interface types only - proto types T* exported from lib/*_pb.d.ts)
+export type {
+  // Token format conversion types
+  TokenConversionInput,
+  // Unified indexed state type (local union type)
+  TIndexedState,
+  // IndexDB type mappings
+  IndexTableTypeMap,
+  IndexTableType,
+  IndexedTypeFor,
+  // State to indexed type mappings
+  StateToIndexedMap,
+  StateTypeOf,
+  IndexedTypeOf,
+  // IIndexTable interface
+  IndexTableHookFn,
+  IIndexTable,
+  // List result types
+  IListTransactionsResult,
+  IListAssetsResult,
+  IListAccountsResult,
+  IListTokensResult,
+  IListFactoriesResult,
+  IListStakesResult,
+  IListDelegationsResult,
+  IListRollupsResult,
+  IListRollupBlocksResult,
+  IListRollupValidatorsResult,
+  IListTokenFactoriesResult,
+  ListResultTypeMap,
+  ListResultFor,
+  // IIndexDB interface
+  IIndexDB,
+} from './indexdb';
+
+// Pipeline context types
+export type {
+  // Common interfaces
+  IPipelineLogger,
+  IDecodedTransaction,
+  IMultiSigData,
+  IAccountUpdate,
+  ILockedState,
+  IInputChange,
+  IValidatedItx,
+  IGasStake,
+  ITokenCondition,
+  IOutput,
+  IInput,
+  // Phase context types (new 5-phase hierarchy)
+  IBaseContext,
+  ITxOnlyContext,
+  IDecodedContext,
+  IGasContext,
+  IReadyContext,
+  IExecutedContext,
+  // Mixin interfaces: Account states
+  IWithSender,
+  IWithReceiver,
+  IWithDelegator,
+  IWithDelegators,
+  IWithOwner,
+  IWithIssuer,
+  IWithIssuers,
+  IWithLocker,
+  IWithSigners,
+  IWithReceivers,
+  IWithSenders,
+  // Mixin interfaces: Protocol states
+  IWithAsset,
+  IWithAssets,
+  IWithToken,
+  IWithTokens,
+  IWithFactory,
+  IWithTokenFactory,
+  IWithStake,
+  IWithStakes,
+  IWithDelegation,
+  IWithRollup,
+  IWithRollupBlock,
+  IWithEvidence,
+  IWithLocked,
+  FinalizedContext,
+} from './pipeline';
+
+// Testing utility types
+export type {
+  // Error types
+  ITestError,
+  PipeNextFn,
+  // Context types
+  PartialTransactionContext,
+  MockStateDB,
+  MockChainConfig,
+  // State types
+  MockAccountState,
+  MockAssetState,
+  MockTokenState,
+  MockStakeState,
+  MockDelegateState,
+  MockTxState,
+  // Full context
+  TestContext,
+  // Pipe function types
+  MockPipeFunction,
+  MockErrorPipeFunction,
+  // Result types
+  IExecuteResult,
+  IPipeTestResult,
+} from './testing';
+
+// Resolver types (shared between @ocap/gql and @ocap/resolver)
+export type {
+  // Context and args
+  IResolverContext,
+  IGetAccountStateArgs,
+  IGetAccountTokensArgs,
+  IAddressArgs,
+  // Token and state types
+  ITokenInfo,
+  IResolverAccountState,
+  IResolverStakeState,
+  IResolverRollupState,
+  IResolverFactoryState,
+  // Paging
+  IResolverPaging,
+  // Transaction types
+  IResolverTxItxJson,
+  IResolverTransaction,
+  // List result types
+  IResolverListTransactionsResult,
+  IResolverListAssetsResult,
+  IResolverListAccountsResult,
+  IResolverListTokensResult,
+  IResolverListFactoriesResult,
+  IResolverListStakesResult,
+  IResolverListDelegationsResult,
+  IResolverListRollupsResult,
+  IResolverListRollupBlocksResult,
+  IResolverListRollupValidatorsResult,
+  IResolverListTokenFactoriesResult,
+  // Info types
+  IResolverChainInfo,
+  IResolverNodeInfo,
+  IResolverNetInfo,
+  IResolverValidatorsInfo,
+  IResolverForgeStats,
+  // Response wrappers
+  ITokenFlowsResult,
+  ISearchResult,
+  IEstimateGasResult,
+  IBlocksResult,
+  // Main interface
+  IResolver,
+} from './resolver';