Skip to content
Merged
Show file tree
Hide file tree
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
70 changes: 70 additions & 0 deletions packages/chains/chain-core/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,25 @@ export type ChainCapabilities = {
getXpub?: boolean;
};

export type SigningComponentKind = 'hash' | 'curve' | 'encoding';

export type SigningComponentDefinition = {
kind: SigningComponentKind;
name: string;
code: number;
};

export type SigningComponentRequirement = {
kind: SigningComponentKind;
name: string;
minFirmware: [number, number, number];
};

export type ChainSigningSuite = {
definitions?: SigningComponentDefinition[];
requirements?: SigningComponentRequirement[];
};

export type GetAddressParams = {
path?: DerivationPath;
accountIndex?: number;
Expand Down Expand Up @@ -127,6 +146,7 @@ export type ChainPlugin<
signer: TSigner,
options?: TOptions,
) => Promise<TAdapter> | TAdapter;
signingSuite?: ChainSigningSuite;
};

export type ChainRegistryResolveOptions = {
Expand Down Expand Up @@ -248,6 +268,56 @@ export function createChainRegistry<TContext = DeviceContext>(
};
}

export {
createSigningComponentRegistry,
SigningComponentConflictError,
type SigningComponentRegistry,
} from './signingComponentRegistry';

// ---------------------------------------------------------------------------
// Firmware version utilities
// ---------------------------------------------------------------------------

export type FirmwareVersionTuple = [number, number, number];

const normalizeFirmwarePart = (value: unknown): number => {
if (typeof value !== 'number' || !Number.isFinite(value)) return 0;
return Math.max(0, Math.trunc(value));
};

export const getFirmwareVersion = (client: unknown): FirmwareVersionTuple => {
const maybeClient = client as {
getFwVersion?: () => {
major?: unknown;
minor?: unknown;
fix?: unknown;
};
};
if (typeof maybeClient?.getFwVersion !== 'function') {
return [0, 0, 0];
}
const fw = maybeClient.getFwVersion();
return [
normalizeFirmwarePart(fw?.major),
normalizeFirmwarePart(fw?.minor),
normalizeFirmwarePart(fw?.fix),
];
};

export const compareFirmwareVersions = (
current: FirmwareVersionTuple,
required: FirmwareVersionTuple,
): number => {
if (current[0] !== required[0]) return current[0] - required[0];
if (current[1] !== required[1]) return current[1] - required[1];
return current[2] - required[2];
};

export const isAtLeastFirmware = (
current: FirmwareVersionTuple,
minimum: FirmwareVersionTuple,
): boolean => compareFirmwareVersions(current, minimum) >= 0;

// ---------------------------------------------------------------------------
// Shared chain utilities
// ---------------------------------------------------------------------------
Expand Down
230 changes: 230 additions & 0 deletions packages/chains/chain-core/src/signingComponentRegistry.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,230 @@
import type { SigningComponentDefinition, SigningComponentKind } from './index';

const SIGNING_COMPONENT_KINDS: SigningComponentKind[] = [
'hash',
'curve',
'encoding',
];

type SigningComponentDefinitionMap = {
[K in SigningComponentKind]: Map<string, number>;
};

type SigningComponentReverseDefinitionMap = {
[K in SigningComponentKind]: Map<number, string>;
};

const createNameMaps = (): SigningComponentDefinitionMap => ({
hash: new Map<string, number>(),
curve: new Map<string, number>(),
encoding: new Map<string, number>(),
});

const createCodeMaps = (): SigningComponentReverseDefinitionMap => ({
hash: new Map<number, string>(),
curve: new Map<number, string>(),
encoding: new Map<number, string>(),
});

const normalizeSigningComponentKind = (kind: unknown): SigningComponentKind => {
if (kind === 'hash' || kind === 'curve' || kind === 'encoding') {
return kind;
}
throw new Error(`Invalid signing component kind: ${String(kind)}`);
};

const normalizeSigningComponentName = (name: unknown): string => {
if (typeof name !== 'string') {
throw new Error(`Invalid signing component name: ${String(name)}`);
}
const normalized = name.trim().toUpperCase();
if (!normalized) {
throw new Error('Signing component name cannot be empty');
}
return normalized;
};

const normalizeSigningComponentCode = (code: unknown): number => {
if (
typeof code !== 'number' ||
!Number.isFinite(code) ||
!Number.isInteger(code) ||
code < 0
) {
throw new Error(`Invalid signing component code: ${String(code)}`);
}
return code;
};

const normalizeDefinition = (definition: SigningComponentDefinition) => {
const kind = normalizeSigningComponentKind(definition.kind);
const name = normalizeSigningComponentName(definition.name);
const code = normalizeSigningComponentCode(definition.code);
return { kind, name, code };
};

const sortDefinitions = (
definitions: SigningComponentDefinition[],
): SigningComponentDefinition[] => {
return [...definitions].sort((a, b) => {
if (a.kind !== b.kind) return a.kind.localeCompare(b.kind);
if (a.name !== b.name) return a.name.localeCompare(b.name);
return a.code - b.code;
});
};

const normalizeDefinitions = (
definitions: SigningComponentDefinition[],
): SigningComponentDefinition[] => {
if (!Array.isArray(definitions)) {
throw new Error('Signing component definitions must be an array');
}
return definitions.map(normalizeDefinition);
};

export class SigningComponentConflictError extends Error {
public readonly kind: SigningComponentKind;
public readonly componentName: string;
public readonly code: number;

constructor(message: string, def: SigningComponentDefinition) {
super(message);
this.name = 'SigningComponentConflictError';
this.kind = def.kind;
this.componentName = def.name;
this.code = def.code;
}
}

export type SigningComponentRegistry = {
register: (definitions: SigningComponentDefinition[]) => void;
preflight: (definitions: SigningComponentDefinition[]) => void;
resolve: (kind: SigningComponentKind, name: string) => number | undefined;
resolveOrThrow: (kind: SigningComponentKind, name: string) => number;
reverseResolve: (
kind: SigningComponentKind,
code: number,
) => string | undefined;
has: (kind: SigningComponentKind, name: string) => boolean;
list: (kind?: SigningComponentKind) => SigningComponentDefinition[];
reset: () => void;
};

export function createSigningComponentRegistry(): SigningComponentRegistry {
const nameToCode = createNameMaps();
const codeToName = createCodeMaps();

const checkConflict = (
stagedNameToCode: SigningComponentDefinitionMap,
stagedCodeToName: SigningComponentReverseDefinitionMap,
def: SigningComponentDefinition,
) => {
const existingCode = stagedNameToCode[def.kind].get(def.name);
if (existingCode !== undefined && existingCode !== def.code) {
throw new SigningComponentConflictError(
`Signing component conflict for ${def.kind}:${def.name}. Existing code=${existingCode}, new code=${def.code}.`,
def,
);
}

const existingName = stagedCodeToName[def.kind].get(def.code);
if (existingName !== undefined && existingName !== def.name) {
throw new SigningComponentConflictError(
`Signing component conflict for ${def.kind} code=${def.code}. Existing name=${existingName}, new name=${def.name}.`,
def,
);
}
};

const preflight = (definitions: SigningComponentDefinition[]) => {
const normalized = normalizeDefinitions(definitions);
const stagedNameToCode = createNameMaps();
const stagedCodeToName = createCodeMaps();

for (const kind of SIGNING_COMPONENT_KINDS) {
nameToCode[kind].forEach((code, name) => {
stagedNameToCode[kind].set(name, code);
});
codeToName[kind].forEach((name, code) => {
stagedCodeToName[kind].set(code, name);
});
}

for (const def of normalized) {
checkConflict(stagedNameToCode, stagedCodeToName, def);
stagedNameToCode[def.kind].set(def.name, def.code);
stagedCodeToName[def.kind].set(def.code, def.name);
}
};

const register = (definitions: SigningComponentDefinition[]) => {
const normalized = normalizeDefinitions(definitions);
preflight(normalized);

for (const def of normalized) {
nameToCode[def.kind].set(def.name, def.code);
codeToName[def.kind].set(def.code, def.name);
}
};

const resolve = (
kind: SigningComponentKind,
name: string,
): number | undefined => {
return nameToCode[kind].get(normalizeSigningComponentName(name));
};

const resolveOrThrow = (kind: SigningComponentKind, name: string): number => {
const code = resolve(kind, name);
if (code === undefined) {
throw new Error(`Signing component not found: ${kind}:${name}`);
}
return code;
};

const reverseResolve = (
kind: SigningComponentKind,
code: number,
): string | undefined => {
return codeToName[kind].get(normalizeSigningComponentCode(code));
};

const has = (kind: SigningComponentKind, name: string): boolean => {
return resolve(kind, name) !== undefined;
};

const list = (kind?: SigningComponentKind): SigningComponentDefinition[] => {
const definitions: SigningComponentDefinition[] = [];
const kinds = kind ? [kind] : SIGNING_COMPONENT_KINDS;

for (const currentKind of kinds) {
nameToCode[currentKind].forEach((code, name) => {
definitions.push({
kind: currentKind,
name,
code,
});
});
}

return sortDefinitions(definitions);
};

const reset = () => {
for (const kind of SIGNING_COMPONENT_KINDS) {
nameToCode[kind].clear();
codeToName[kind].clear();
}
};

return {
register,
preflight,
resolve,
resolveOrThrow,
reverseResolve,
has,
list,
reset,
};
}
Loading
Loading