This repository has been archived by the owner on Aug 16, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
react-components: Migrate 'useContractSchemaRpc' from contractupdate …
…sample (#46) The sample `contractupdate` had some nice utilities for resolving the on-chain schema of a smart contract. It handles the greasy details of what wasm sections to check (in which order) for the different module versions. This is error prone and not something a dApp developer would want to mess with themselves. This PR moves moves these utils into a hook `useModuleSchemaRpc` as part of `react-components`. As we don't use `Result` in that package, the functions have been rewritten to use exceptions instead.
- Loading branch information
Showing
7 changed files
with
166 additions
and
102 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| import { Buffer } from 'buffer/'; | ||
| import { useEffect, useState } from 'react'; | ||
| import { Schema, moduleSchema } from '@concordium/wallet-connectors'; | ||
| import { ConcordiumGRPCClient, ModuleReference, SchemaVersion } from '@concordium/web-sdk'; | ||
|
|
||
| /** | ||
| * The result of extracting a smart contract {@link Schema} from a WebAssembly module. | ||
| */ | ||
| export interface SchemaResult { | ||
| /** | ||
| * The name of the custom section in which the schema was found. | ||
| */ | ||
| sectionName: string; | ||
| /** | ||
| * The resolved schema. | ||
| */ | ||
| schema: Schema; | ||
| } | ||
|
|
||
| function findCustomSections(m: WebAssembly.Module, moduleVersion: number) { | ||
| function getCustomSections(sectionName: string, schemaVersion: SchemaVersion | undefined) { | ||
| const s = WebAssembly.Module.customSections(m, sectionName); | ||
| return s.length === 0 ? undefined : { sectionName, schemaVersion, contents: s }; | ||
| } | ||
|
|
||
| // First look for section containing schema with embedded version, then "-v1" or "-v2" depending on the module version. | ||
| // See also comment in 'useModuleSchemaRpc'. | ||
| switch (moduleVersion) { | ||
| case 0: | ||
| return ( | ||
| getCustomSections('concordium-schema', undefined) || // always v0 | ||
| getCustomSections('concordium-schema-v1', SchemaVersion.V0) // v0 (not a typo) | ||
| ); | ||
| case 1: | ||
| return ( | ||
| getCustomSections('concordium-schema', undefined) || // v1, v2, or v3 | ||
| getCustomSections('concordium-schema-v2', SchemaVersion.V1) // v1 (not a typo) | ||
| ); | ||
| } | ||
| return getCustomSections('concordium-schema', undefined); // expecting to find this section in future module versions | ||
| } | ||
|
|
||
| function findSchema(m: WebAssembly.Module, moduleVersion: number): SchemaResult | undefined { | ||
| const sections = findCustomSections(m, moduleVersion); | ||
| if (!sections) { | ||
| return undefined; | ||
| } | ||
| const { sectionName, schemaVersion, contents } = sections; | ||
| if (contents.length !== 1) { | ||
| throw new Error(`unexpected size of custom section "${sectionName}"`); | ||
| } | ||
| return { sectionName, schema: moduleSchema(Buffer.from(contents[0]), schemaVersion) }; | ||
| } | ||
|
|
||
| async function fetchSchema(rpc: ConcordiumGRPCClient, moduleRef: string) { | ||
| const { version, source } = await rpc.getModuleSource(ModuleReference.fromHexString(moduleRef)); | ||
| if (source.length === 0) { | ||
| throw new Error('module source is empty'); | ||
| } | ||
| // The module can contain a schema in one of two different custom sections. | ||
| // The supported sections depend on the module version. | ||
| // The schema version can be either defined by the section name or embedded into the actual schema: | ||
| // - Both v0 and v1 modules support the section 'concordium-schema' where the schema includes the version. | ||
| // - For v0 modules this is always a v0 schema. | ||
| // - For v1 modules this can be a v1, v2, or v3 schema. | ||
| // - V0 modules additionally support section 'concordium-schema-v1' which always contain a v0 schema (not a typo). | ||
| // - V1 modules additionally support section 'concordium-schema-v2' which always contain a v1 schema (not a typo). | ||
| // The section 'concordium-schema' is the most common and is what the current tooling produces. | ||
| const module = await WebAssembly.compile(source); | ||
| return findSchema(module, version); | ||
| } | ||
|
|
||
| /** | ||
| * Hook for resolving the {@link Schema} of a smart contract module from the chain. | ||
| * The schema may be used to construct the payload of invocations of smart contracts that are instances of this module. | ||
| * @param rpc gRPC client through which to perform the lookup. | ||
| * @param moduleRef The reference of the module for which to lookup. | ||
| * @param setError Function that is invoked with any error that occurred while resolving the schema (e.g. module was not found or it was malformed). | ||
| * @return The schema wrapped into a {@link SchemaResult} or undefined if no schema was found. | ||
| */ | ||
| export function useModuleSchemaRpc( | ||
| rpc: ConcordiumGRPCClient, | ||
| moduleRef: string, | ||
| setError: (err: string) => void | ||
| ): SchemaResult | undefined { | ||
| const [result, setResult] = useState<SchemaResult | undefined>(); | ||
| useEffect(() => { | ||
| fetchSchema(rpc, moduleRef) | ||
| .then((r) => { | ||
| setResult(r); | ||
| setError(''); | ||
| }) | ||
| .catch((err) => { | ||
| setError(err); | ||
| }); | ||
| }, [rpc, moduleRef]); | ||
| return result; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.