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.

Sign up for GitHub

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

chore: fix contract type #59

Merged
merged 1 commit into from
Feb 7, 2024
Merged

chore: fix contract type #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 2 additions & 5 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import Eth from '@metamask/ethjs';
import type { DeployedRegistryContract } from '@metamask/ethjs-types';
import registryMap from './registry-map.json';
import abi from './abi.json';

Expand All @@ -12,10 +13,6 @@ interface MethodRegistryArgs {
provider: HttpProvider;
}

interface DeployedRegistryContract {
entries (bytes: string): string[];
}

export class MethodRegistry {
private registry: DeployedRegistryContract;

Expand All @@ -38,7 +35,7 @@ export class MethodRegistry {
* @param bytes - The `0x`-prefixed hexadecimal string representing the four-byte signature of the contract method to lookup.
*/
async lookup(bytes: string) {
const result: string[] | undefined = await this.registry.entries(bytes);
const result = await this.registry.entries(bytes);
if (result) {
return result[0];
}
Expand Down
16 changes: 10 additions & 6 deletions types/ethjs/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
declare module '@metamask/ethjs-types' {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that usually type augmentations aren't a good idea because they will only be present locally and will not be included in the type declaration files, so they could cause type errors in another project that uses this package. This seems to be okay for right now because registry is private, so DeployedRegistryContract gets erased from the built type declaration files, but something to keep in mind in case this does cause problems later.

Copy link
Contributor Author

@legobeat legobeat Feb 6, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see how it would cause type-errors? But in any case yes, this "synthetic module" is for internal use only. If reuse elsewhere becomes relevant I guess it also becomes relevant to consider exposing these (for example generated from jsdoc comments) from ethjs-contract and ethjs-query packages themselves.

export interface RegistryContract {
at (address: string): DeployedRegistryContract;
}
export interface DeployedRegistryContract {
entries (bytes: string): Promise<string[]>;
}
}
declare module '@metamask/ethjs' {
import type { RegistryContract } from '@metamask/ethjs-types';

class Eth {
constructor(provider: any);

contract(abi: Record<string, unknown>): RegistryContract;
}
interface RegistryContract {
at (address: string): DeployedRegistryContract;
}
interface DeployedRegistryContract {
entries (bytes: string): string[];
}
export=Eth;
}
Loading