Stream Schema

Stream processes are defined as in the following schema.

Schema

Stream Process

• id: unique stream identifier
• name: descriptive stream name
• version: string that describes current version of stream
• input_streams: list of input stream ids
• output_streams: list of output stream ids
• container_id: identitifier for stream process
• build: string location for build files

interface EventStreamProcess {
  id: string;
  name: string;
  owner: string;
  version: string;
  input_streams: Array<EventStreamProcess>;
  output_streams: Array<EventStreamProcess>;
  container_id: string; 
  build: string;
}

Event Stream

• id: unique stream identifier
• process_id: unique identifier for process that creates the stream
• name: descriptive stream name
• version: string that describes current version of stream
• serdes: serialization of the current stream
• type: represents an enum for StreamType [SOURCE, STATELESS, STATEFUL, QUERY]

interface EventStream {
  id: string;
  process_id: string;
  name: string;
  type: StreamType;
  schema_uri: string;
}

Schema URI

interface SchemaMeta {
  type: string;
  name: string;
  uri: string;
  version: string;
}

Event Stream Schema

• name: descriptive stream name
• version: string that describes current version of schema
• serdes: serialization of the current stream

interface Schema<T> {
  name: string;
  version: string;
  serdes: Serdes<T>;
}

Example

export type FungibleTokenDiscoveryStreamEvent =
  | events.NewToken & {
  ref?: BlockchainReference
};

export const fungibleTokenDiscovery: EventStreamSchema<FungibleTokenDiscoveryStreamEvent> = {
  name: "fungible-token-discovery.streams.proxima.one",
  serdes: serializers.json<FungibleTokenDiscoveryStreamEvent>(),
  version: "0.1.0",
}