Splitter

The GraphQL queries that can be performed on the Splitter ADO.

Response Interface

export interface SplitterResponse<T> {
  splitter: T;
}

queryConfig

Queries a splitter contract for its config.

Contract query can be found here.

export async function queryConfig(
  contractAddress: string
): Promise<SplitterConfig> {
  const resp = await query<QuerySplitterConfig, QuerySplitterConfigResponse>(
    QUERY_SPLITTER_CONFIG,
    { contractAddress }
  );

  return resp.splitter.config;
}

Name	Type	Description
contractAddress	string	The contract address of the splitter we want to query the config for.

QuerySplitterConfig

export interface QuerySplitterConfig extends ContractAddressQuery {}

QuerySplitterConfigResponse

export type QuerySplitterConfigResponse = SplitterResponse<{
  config: SplitterConfig;
}>;

Name	Type	Description
config	SplitterConfig	The config of the splitter we queried.

SplitterConfig

export interface SplitterConfig {
  locked: boolean;
  recipients: RecipientPercentage[];
}

Name	Type	Description
locked	boolean	Whether the splitter is locked or not.
recipients	RecipientPercentage	The recipients of the funds sent to the splitter.

RecipientPercentage

export interface RecipientPercentage {
  percent: string;
  recipient: Recipient;
}

Name	Type	Description
percent	string	The percent for the recipient.
recipient	Recipient	The recipient of the above percentage.