Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added missing types description #11197

Merged
merged 1 commit into from
Jan 10, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions packages/apps-config/src/endpoints/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,35 @@ import type { Option } from '../settings/types.js';

interface BaseOption {
dnslink?: string;
/**
* Genesis hash for chain
*/
genesisHash?: HexString;
/**
* Homepage Url
*/
homepage?: string;
/**
* Parachain Id of chain
*/
paraId?: number;
/**
* Summary about chain
*/
summary?: string;
teleport?: number[];
ui: {
/**
* Color for chain
*/
color?: string;
/**
* Identicon type i.e. polkadot, beachball, ethereum etc
*/
identityIcon?: IconTheme;
/**
* Logo component for chain
*/
logo?: string;
}
}
Expand All @@ -28,10 +49,22 @@ export interface EndpointOption extends BaseOption {
* Declares whether the given endpoint is the People chain used to store identity information.
*/
isPeople?: boolean;
/**
* Checks whether one of the given provider is reachable or not. If set to true, it hides the chain from explorer.
*/
isUnreachable?: boolean;
/**
* Declares list of all linked chains. However, It is applicable for relay chains only.
*/
linked?: EndpointOption[];
info?: string;
/**
* Declares the list of all RPC providers
*/
providers: Record<string, `${'wss://' | 'light://substrate-connect/'}${string}`>;
/**
* Declares chain name
*/
text: string;
/**
* Declares whether or not the endpoint is a relay chain.
Expand Down
Loading