web SDK v8

examples/nodejs/client/getEmbeddedSchema.ts

@@ -52,7 +52,9 @@ const client = new ConcordiumGRPCNodeClient(address, Number(port), credentials.c
     const schema = await client.getEmbeddedSchema(moduleRef);
     // #endregion documentation-snippet
 
-    fs.writeFileSync(cli.flags.outPath, schema);
+    if (schema) {
+        fs.writeFileSync(cli.flags.outPath, new Uint8Array(schema.buffer));
+    }
 
     console.log('Wrote schema to file: ', cli.flags.outPath);
 })();

examples/nodejs/composed-examples/getEmbeddedSchemaFromInstance.ts

@@ -59,7 +59,9 @@ const client = new ConcordiumGRPCNodeClient(address, Number(port), credentials.c
     const schema = await client.getEmbeddedSchema(moduleRef);
     // #endregion documentation-snippet
 
-    fs.writeFileSync(cli.flags.outPath, schema);
+    if (schema) {
+        fs.writeFileSync(cli.flags.outPath, new Uint8Array(schema.buffer));
+    }
 
     console.log('Wrote schema to file: ', cli.flags.outPath);
 })();

examples/nodejs/composed-examples/initAndUpdateContract.ts

@@ -94,7 +94,7 @@ const client = new ConcordiumGRPCNodeClient(address, Number(port), credentials.c
         sender,
     };
 
-    const initParams = serializeInitContractParameters(contractName, sunnyWeather, schema);
+    const initParams = serializeInitContractParameters(contractName, sunnyWeather, schema!.buffer);
 
     const initPayload: InitContractPayload = {
         amount: CcdAmount.zero(),
@@ -142,7 +142,7 @@ const client = new ConcordiumGRPCNodeClient(address, Number(port), credentials.c
         contractName,
         EntrypointName.fromString('set'),
         rainyWeather,
-        schema
+        schema!.buffer
     );
 
     const updatePayload: UpdateContractPayload = {
@@ -187,7 +187,7 @@ const client = new ConcordiumGRPCNodeClient(address, Number(port), credentials.c
             const rawReturnValue = unwrap(invokedPostInit.returnValue);
             const returnValue = deserializeReceiveReturnValue(
                 ReturnValue.toBuffer(rawReturnValue),
-                schema,
+                schema!.buffer,
                 contractName,
                 EntrypointName.fromString('get')
             );

packages/ccd-js-gen/src/lib.ts

@@ -178,7 +178,7 @@ async function generateCode(
     }
     notifier.done('Parse smart contract module.');
 
-    const moduleSchema = rawModuleSchema === null ? null : SDK.parseRawModuleSchema(rawModuleSchema);
+    const moduleSchema = rawModuleSchema && SDK.parseRawModuleSchema(rawModuleSchema);
 
     const outputFilePath = path.format({
         dir: outDirPath,

packages/sdk/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 8.0.0
+
+### Breaking changes
+
+- `getEmbeddedModuleSchema` now uses the module version to determine in which custom wasm sections to look for the schema.
+  It also no longer is `async` because there isn't any need for it to be so.
+- `ConcordiumGRPCClient.getEmbeddedSchema` now delegates to `getEmbeddedModuleSchema` instead of `wasmToSchema`
+  (which was removed as it was just a less capable version of `getEmbeddedModuleSchema`).
+  This means that it returns the complete `RawModuleSchema` instead of only the schema bytes.
+  It also means that it returns `null` instead of an error when no embedded schema was found.
+
+
 ## 7.5.1
 
 ### Fixed

packages/sdk/src/GenericContract.ts

@@ -521,10 +521,11 @@ export class Contract<E extends string = string, V extends string = string> exte
         if (!schema) {
             try {
                 const raw = await grpcClient.getEmbeddedSchema(instanceInfo.sourceModule);
-                const encoded = Buffer.from(raw).toString('base64');
-
-                if (encoded) {
-                    mSchema = encoded;
+                if (raw) {
+                    const encoded = Buffer.from(raw.buffer).toString('base64');
+                    if (encoded) {
+                        mSchema = encoded;
+                    }
                 }
             } catch {
                 // Do nothing.

packages/sdk/src/grpc/GRPCClient.ts

@@ -14,6 +14,7 @@ import { calculateEnergyCost } from '../energyCost.js';
 import { HealthClient } from '../grpc-api/v2/concordium/health.client.js';
 import { QueriesClient } from '../grpc-api/v2/concordium/service.client.js';
 import * as v2 from '../grpc-api/v2/concordium/types.js';
+import { RawModuleSchema } from '../schemaTypes.js';
 import { serializeAccountTransactionPayload } from '../serialization.js';
 import * as v1 from '../types.js';
 import { HexString, isRpcError } from '../types.js';
@@ -29,8 +30,9 @@ import * as SequenceNumber from '../types/SequenceNumber.js';
 import * as Timestamp from '../types/Timestamp.js';
 import * as TransactionExpiry from '../types/TransactionExpiry.js';
 import * as TransactionHash from '../types/TransactionHash.js';
+import { getEmbeddedModuleSchema } from '../types/VersionedModuleSource.js';
 import type { BlockItemStatus, BlockItemSummary } from '../types/blockItemSummary.js';
-import { countSignatures, isHex, isValidIp, mapRecord, mapStream, unwrap, wasmToSchema } from '../util.js';
+import { countSignatures, isHex, isValidIp, mapRecord, mapStream, unwrap } from '../util.js';
 import * as translate from './translation.js';
 
 /**
@@ -199,13 +201,16 @@ export class ConcordiumGRPCClient {
      * @param moduleRef the module's reference, represented by the ModuleReference class.
      * @param blockHash optional block hash to get the module embedded schema at, otherwise retrieves from last finalized block
      *
-     * @returns the module schema as a buffer.
-     * @throws An error of type `RpcError` if not found in the block.
-     * @throws If the module or schema cannot be parsed
+     * @returns the module schema as a {@link RawModuleSchema} or `null` if not found in the block.
+     * @throws An error of type `RpcError` if the module was not found in the block.
+     * @throws If the module source cannot be parsed or contains duplicate schema sections.
      */
-    async getEmbeddedSchema(moduleRef: ModuleReference.Type, blockHash?: BlockHash.Type): Promise<Uint8Array> {
-        const versionedSource = await this.getModuleSource(moduleRef, blockHash);
-        return wasmToSchema(versionedSource.source);
+    async getEmbeddedSchema(
+        moduleRef: ModuleReference.Type,
+        blockHash?: BlockHash.Type
+    ): Promise<RawModuleSchema | undefined> {
+        const source = await this.getModuleSource(moduleRef, blockHash);
+        return getEmbeddedModuleSchema(source);
     }
 
     /**

packages/sdk/src/pub/types.ts

@@ -46,7 +46,7 @@ export * from '../signHelpers.js';
 export * from '../versionedTypeHelpers.js';
 export * from '../accountHelpers.js';
 
-export { isHex, streamToList, wasmToSchema, unwrap } from '../util.js';
+export { isHex, streamToList, unwrap } from '../util.js';
 
 export * from '../accountTransactions.js';
 export * from '../energyCost.js';

packages/sdk/src/schemaTypes.ts

@@ -36,7 +36,7 @@ export function toOptionJson<T>(value: T | undefined): OptionJson<T> {
 }
 
 /** Schema version from before the schema bytes contained version information. */
-type UnversionedSchemaVersion = 0 | 1;
+export type UnversionedSchemaVersion = 0 | 1;
 
 /**
  * Represents unparsed bytes for a smart contract module schema.

packages/sdk/src/types/VersionedModuleSource.ts

@@ -3,10 +3,9 @@ import { Buffer } from 'buffer/index.js';
 import * as H from '../contractHelpers.js';
 import { Cursor, deserializeUInt32BE } from '../deserializationHelpers.js';
 import { sha256 } from '../hash.js';
-import { RawModuleSchema } from '../schemaTypes.js';
+import { RawModuleSchema, UnversionedSchemaVersion } from '../schemaTypes.js';
 import { encodeWord32 } from '../serializationHelpers.js';
 import { VersionedModuleSource } from '../types.js';
-import { schemaBytesFromWasmModule } from '../util.js';
 import * as ModuleReference from './ModuleReference.js';
 
 /** Interface of a smart contract containing the name of the contract and every entrypoint. */
@@ -100,22 +99,50 @@ export async function parseModuleInterface(moduleSource: VersionedModuleSource):
  * Extract the embedded smart contract schema bytes. Returns `null` if no schema is embedded.
  * @param {VersionedModuleSource} moduleSource The smart contract module source.
  * @returns {RawModuleSchema | null} The raw module schema if found.
+ * @throws If the module source cannot be parsed or contains duplicate schema sections.
  */
-export async function getEmbeddedModuleSchema(moduleSource: VersionedModuleSource): Promise<RawModuleSchema | null> {
-    const wasmModule = await WebAssembly.compile(moduleSource.source);
-    const versionedSchema = schemaBytesFromWasmModule(wasmModule, 'concordium-schema');
-    if (versionedSchema !== null) {
-        return { type: 'versioned', buffer: versionedSchema };
+export function getEmbeddedModuleSchema({ source, version }: VersionedModuleSource): RawModuleSchema | undefined {
+    const sections = findCustomSections(new WebAssembly.Module(source), version);
+    if (sections === undefined) {
+        return undefined;
+    }
+    const { sectionName, unversionedSchemaVersion, contents } = sections;
+    if (contents.length !== 1) {
+        throw new Error(
+            `invalid module: expected to find at most one custom section named "${sectionName}", but found ${contents.length}`
+        );
+    }
+    const schema = contents[0];
+    if (unversionedSchemaVersion !== undefined) {
+        return {
+            type: 'unversioned',
+            version: unversionedSchemaVersion,
+            buffer: schema,
+        };
     }
-    const unversionedSchemaV0 = schemaBytesFromWasmModule(wasmModule, 'concordium-schema-v1');
-    if (unversionedSchemaV0 !== null) {
-        return { type: 'unversioned', version: 0, buffer: unversionedSchemaV0 };
+    return { type: 'versioned', buffer: schema };
+}
+
+function findCustomSections(m: WebAssembly.Module, moduleVersion: number) {
+    function getCustomSections(sectionName: string, unversionedSchemaVersion: UnversionedSchemaVersion | undefined) {
+        const s = WebAssembly.Module.customSections(m, sectionName);
+        return s.length === 0 ? undefined : { sectionName, unversionedSchemaVersion, contents: s };
     }
-    const unversionedSchemaV1 = schemaBytesFromWasmModule(wasmModule, 'concordium-schema-v2');
-    if (unversionedSchemaV1 !== null) {
-        return { type: 'unversioned', version: 1, buffer: unversionedSchemaV1 };
+
+    // First look for section containing schema with embedded version, then "-v1" or "-v2" depending on the module version.
+    switch (moduleVersion) {
+        case 0:
+            return (
+                getCustomSections('concordium-schema', undefined) || // always v0
+                getCustomSections('concordium-schema-v1', 0) // v0 (not a typo)
+            );
+        case 1:
+            return (
+                getCustomSections('concordium-schema', undefined) || // v1, v2, or v3
+                getCustomSections('concordium-schema-v2', 1) // v1 (not a typo)
+            );
     }
-    return null;
+    return getCustomSections('concordium-schema', undefined); // expecting to find this section in future module versions
 }
 
 /**

packages/sdk/src/util.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
 import { Buffer } from 'buffer/index.js';
 
 import { AccountTransactionSignature, HexString, IpAddressString } from './types.js';
@@ -60,44 +59,6 @@ export function countSignatures(accountSignatures: AccountTransactionSignature):
     return totalSignatureCount;
 }
 
-/**
- * Compiles a wasm module and extracts the smart contract schema.
- *
- * @param wasm the wasm module as a Buffer
- *
- * @throws If WASM module contains no schema
- * @throws If WASM module provided is invalid
- *
- * @returns the smart contract schema as a Buffer
- */
-export function wasmToSchema(wasm: ArrayBuffer): Uint8Array {
-    const wasmModule = new WebAssembly.Module(wasm);
-    const schemaBytes = schemaBytesFromWasmModule(wasmModule, 'concordium-schema');
-    if (schemaBytes === null) {
-        throw Error('WASM-Module contains no schema!');
-    }
-    return new Uint8Array(schemaBytes);
-}
-
-/**
- * Extracts custom-section containing the smart contract schema if present.
- * @param wasmModule the WebAssembly module.
- * @returns the smart contract schema as a Buffer or null if not present.
- */
-export function schemaBytesFromWasmModule(
-    wasmModule: WebAssembly.Module,
-    sectionName: 'concordium-schema' | 'concordium-schema-v1' | 'concordium-schema-v2'
-): ArrayBuffer | null {
-    const sections = WebAssembly.Module.customSections(wasmModule, sectionName);
-    if (sections.length === 1) {
-        return sections[0];
-    } else if (sections.length === 0) {
-        return null;
-    } else {
-        throw Error('Invalid WASM-Module retrieved!');
-    }
-}
-
 /**
  * Convert a Date to seconds since epoch.
  */

packages/sdk/test/ci/module-schema.test.ts

@@ -12,8 +12,8 @@ describe('VersionedModuleSource: getEmbeddedModuleSchema', () => {
             path.join(testFileDir, 'cis2-wccd-embedded-schema-v1-versioned.wasm.v1')
         );
         const moduleSource = versionedModuleSourceFromBuffer(contractModule);
-        const moduleSchema = await getEmbeddedModuleSchema(moduleSource);
-        if (moduleSchema === null) {
+        const moduleSchema = getEmbeddedModuleSchema(moduleSource);
+        if (moduleSchema === undefined) {
             fail('Failed to find module schame');
         }
         expect(moduleSchema.type).toBe('versioned');
@@ -24,8 +24,8 @@ describe('VersionedModuleSource: getEmbeddedModuleSchema', () => {
             path.join(testFileDir, 'cis1-wccd-embedded-schema-v0-versioned.wasm.v0')
         );
         const moduleSource = versionedModuleSourceFromBuffer(contractModule);
-        const moduleSchema = await getEmbeddedModuleSchema(moduleSource);
-        if (moduleSchema === null) {
+        const moduleSchema = getEmbeddedModuleSchema(moduleSource);
+        if (moduleSchema === undefined) {
             fail('Failed to find module schame');
         }
         expect(moduleSchema.type).toBe('versioned');
@@ -39,8 +39,8 @@ describe('VersionedModuleSource: getEmbeddedModuleSchema', () => {
             version: 0,
             source: Buffer.from(unversionedContractModule),
         } as const;
-        const moduleSchema = await getEmbeddedModuleSchema(moduleSource);
-        if (moduleSchema === null) {
+        const moduleSchema = getEmbeddedModuleSchema(moduleSource);
+        if (moduleSchema === undefined) {
             fail('Failed to find module schame');
         }
         expect(moduleSchema.type).toBe('unversioned');
@@ -51,8 +51,8 @@ describe('VersionedModuleSource: getEmbeddedModuleSchema', () => {
             path.join(testFileDir, 'cis2-wccd-embedded-schema-v1-unversioned.wasm.v1')
         );
         const moduleSource = versionedModuleSourceFromBuffer(contractModule);
-        const moduleSchema = await getEmbeddedModuleSchema(moduleSource);
-        if (moduleSchema === null) {
+        const moduleSchema = getEmbeddedModuleSchema(moduleSource);
+        if (moduleSchema === undefined) {
             fail('Failed to find module schame');
         }
         expect(moduleSchema.type).toBe('unversioned');

packages/sdk/test/ci/util.test.ts

@@ -1,6 +1,7 @@
 import { readFileSync } from 'fs';
 
-import { stringToInt, wasmToSchema } from '../../src/util.js';
+import { getEmbeddedModuleSchema } from '../../src/index.js';
+import { stringToInt } from '../../src/util.js';
 
 test('stringToInt transforms chosen field, but not others', () => {
     const keysToTransform = ['a'];
@@ -31,7 +32,10 @@ test('Embedded schema is the same as a seperate schema file', () => {
     const wasmModule = versionedWasmModule.subarray(8);
 
     const seperateSchema = readFileSync('test/ci/resources/icecream-schema.bin');
-    const embeddedSchema = wasmToSchema(wasmModule);
+    const embeddedSchema = getEmbeddedModuleSchema({
+        source: wasmModule,
+        version: 1,
+    });
 
-    expect(new Uint8Array(seperateSchema)).toEqual(embeddedSchema);
+    expect(new Uint8Array(seperateSchema)).toEqual(new Uint8Array(embeddedSchema!.buffer));
 });

packages/sdk/test/client/clientV2.test.ts

@@ -605,7 +605,7 @@ test.each(clients)('getEmbeddedSchema', async (client) => {
         const rawReturnValue = invoked.returnValue;
         const returnValue = v1.deserializeReceiveReturnValue(
             v1.ReturnValue.toBuffer(rawReturnValue),
-            schema,
+            schema!.buffer,
             v1.ContractName.fromStringUnchecked('weather'),
             v1.EntrypointName.fromStringUnchecked('get')
         );