Fix examples

docs/pages/misc-pages/upgrade-guide.md

@@ -16,6 +16,20 @@ converting the type:
   - To refer to `CredentialRegistrationId` as a type use `CredentialRegistrationId.Type`.
   - Constructing `new CredentialRegistrationId("<hex-string>")` is now `CredentialRegistrationId.fromHexString("<hex-string>")`.
 
+The API now uses dedicated types instead of language primitives:
+- Use `AccountAddress` instead of a string with base58 encoding. Use `AccountAddress.fromBase58('<base58>')` to construct it.
+- Use `BlockHash` instead of a string with hex encoding. Use `BlockHash.fromHexString('<hex>')` to construct it.
+- Use `TranactionHash` instead of a string with hex encoding. Use `TransactionHash.fromHexString('<hex>')` to construct it.
+- Use `Energy` instead of a bigint. Use `Energy.create(<integer>)` to construct it.
+- Use `ReceiveName` instead of a string. Use `ReceiveName.fromString('<contract>.<function>')` to construct it.
+- Use `InitName` instead of a string. Use `Init.fromString('init_<contract>')` to construct it.
+- Use `ContractName` instead of a string. Use `ContractName.fromString('<contract>')` to construct it.
+- Use `EntrypointName` instead of a string. Use `EntrypointName.fromString('<function>')` to construct it.
+- Use `Parameter` instead of a string with hex encoding. Use `Parameter.fromHexString('<hex>')`.
+- Use `SequenceNumber` (formerly called nonce) instead of a bigint. Use `SequenceNumber.create(<integer>)` to construct it.
+- Use `Timestamp` instead of a bigint. Can be constructed using `Timestamp.fromMillis(<integer>)`.
+- Use `Duration` instead of a bigint. Can be constructed using `Duration.fromMillis(<integer>)`.
+
 ### Web
 
 The `@concordium/web-sdk` now requires bundlers to respect `exports` field of

examples/client/invokeContract.ts

@@ -8,6 +8,8 @@ import {
     ContractTraceEvent,
     Energy,
     Parameter,
+    ReceiveName,
+    ReturnValue,
     createConcordiumClient,
 } from '@concordium/node-sdk';
 import { credentials } from '@grpc/grpc-js';
@@ -110,7 +112,7 @@ const client = createConcordiumClient(
     const contract = ContractAddress.create(cli.flags.contract);
     const context: ContractContext = {
         // Required
-        method: cli.flags.receive,
+        method: ReceiveName.fromString(cli.flags.receive),
         contract,
         // Optional
         invoker,
@@ -132,9 +134,12 @@ const client = createConcordiumClient(
     } else if (result.tag === 'success') {
         console.log('Invoke was succesful');
 
-        const returnValue: string | undefined = result.returnValue; // If the invoked method has return value
+        const returnValue = result.returnValue; // If the invoked method has return value
         if (returnValue) {
-            console.log('The return value of the invoked method:', returnValue);
+            console.log(
+                'The return value of the invoked method:',
+                ReturnValue.toHexString(returnValue)
+            );
         }
 
         const events: ContractTraceEvent[] = result.events;

examples/composed-examples/findAccountCreationBlock.ts

@@ -84,7 +84,7 @@ const client = createConcordiumClient(
     for await (const summary of summaries) {
         if (
             summary.type === 'accountCreation' &&
-            summary.address === account.address
+            AccountAddress.equals(summary.address, account)
         ) {
             console.log(
                 'Hash of transaction that created the account:',

examples/composed-examples/initAndUpdateContract.ts

@@ -18,6 +18,11 @@ import {
     parseWallet,
     buildAccountSigner,
     affectedContracts,
+    ContractName,
+    ReceiveName,
+    Energy,
+    EntrypointName,
+    ReturnValue,
 } from '@concordium/node-sdk';
 import { credentials } from '@grpc/grpc-js';
 import { readFileSync } from 'node:fs';
@@ -78,9 +83,9 @@ const client = createConcordiumClient(
     const moduleRef = new ModuleReference(
         '44434352ddba724930d6b1b09cd58bd1fba6ad9714cf519566d5fe72d80da0d1'
     );
-    const maxCost = 30000n;
-    const contractName = 'weather';
-    const receiveName = 'weather.set';
+    const maxCost = Energy.create(30000);
+    const contractName = ContractName.fromStringUnchecked('weather');
+    const receiveName = ReceiveName.fromStringUnchecked('weather.set');
     const schema = await client.getEmbeddedSchema(moduleRef);
 
     // --- Initialize Contract --- //
@@ -148,7 +153,7 @@ const client = createConcordiumClient(
 
     const updateParams = serializeUpdateContractParameters(
         contractName,
-        'set',
+        EntrypointName.fromString('set'),
         rainyWeather,
         schema
     );
@@ -191,21 +196,18 @@ const client = createConcordiumClient(
         const contextPostInit: ContractContext = {
             contract: unwrap(contractAddress),
             invoker: sender,
-            method: 'weather.get',
+            method: ReceiveName.fromString('weather.get'),
         };
 
         const invokedPostInit = await client.invokeContract(contextPostInit);
 
         if (invokedPostInit.tag === 'success') {
-            const rawReturnValue = Buffer.from(
-                unwrap(invokedPostInit.returnValue),
-                'hex'
-            );
+            const rawReturnValue = unwrap(invokedPostInit.returnValue);
             const returnValue = deserializeReceiveReturnValue(
-                rawReturnValue,
+                ReturnValue.toBuffer(rawReturnValue),
                 schema,
-                'weather',
-                'get'
+                contractName,
+                EntrypointName.fromString('get')
             );
             console.log('\nThe weather is now:');
             console.dir(returnValue, { depth: null, colors: true });

examples/composed-examples/listNumberAccountTransactions.ts

@@ -89,7 +89,7 @@ const client = createConcordiumClient(
         // For each transaction in the block:
         trxLoop: for await (const trx of trxStream) {
             if (isTransferLikeSummary(trx)) {
-                const trxAcc = AccountAddress.fromBase58(trx.sender);
+                const trxAcc = trx.sender;
 
                 // Loop over account dictionary entries to check if account
                 // is already in dictionary:
@@ -102,7 +102,7 @@ const client = createConcordiumClient(
                 }
 
                 // If account is not in dictionary, then add it:
-                dict[trx.sender] = 1;
+                dict[AccountAddress.toBase58(trx.sender)] = 1;
             }
         }
     }

packages/common/src/schema.ts

@@ -1,6 +1,9 @@
 import * as wasm from '@concordium/rust-bindings';
 import { Buffer } from 'buffer/index.js';
 import JSONbig from 'json-bigint';
+import * as ContractName from './types/ContractName.js';
+import * as EntrypointName from './types/EntrypointName.js';
+import * as Parameter from './types/Parameter.js';
 import { SchemaVersion, SmartContractTypeValues } from './types.js';
 
 /**
@@ -11,12 +14,12 @@ import { SchemaVersion, SmartContractTypeValues } from './types.js';
  */
 export function getInitContractParameterSchema(
     moduleSchema: ArrayBuffer,
-    contractName: string,
+    contractName: ContractName.Type,
     schemaVersion?: SchemaVersion
-): Buffer {
+): Uint8Array {
     const parameterSchema = wasm.getInitContractParameterSchema(
         Buffer.from(moduleSchema).toString('hex'),
-        contractName,
+        ContractName.toString(contractName),
         schemaVersion
     );
     return Buffer.from(parameterSchema, 'hex');
@@ -31,14 +34,14 @@ export function getInitContractParameterSchema(
  */
 export function getUpdateContractParameterSchema(
     moduleSchema: ArrayBuffer,
-    contractName: string,
-    receiveFunctionName: string,
+    contractName: ContractName.Type,
+    receiveFunctionName: EntrypointName.Type,
     schemaVersion?: SchemaVersion
-): Buffer {
+): Uint8Array {
     const parameterSchema = wasm.getReceiveContractParameterSchema(
         Buffer.from(moduleSchema).toString('hex'),
-        contractName,
-        receiveFunctionName,
+        ContractName.toString(contractName),
+        EntrypointName.toString(receiveFunctionName),
         schemaVersion
     );
     return Buffer.from(parameterSchema, 'hex');
@@ -63,21 +66,21 @@ export function displayTypeSchemaTemplate(rawSchema: ArrayBuffer): string {
  * @returns serialized buffer of init contract parameters
  */
 export function serializeInitContractParameters(
-    contractName: string,
+    contractName: ContractName.Type,
     // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
     parameters: any,
     rawSchema: ArrayBuffer,
     schemaVersion?: SchemaVersion,
     verboseErrorMessage = false
-): Buffer {
+): Parameter.Type {
     const serializedParameters = wasm.serializeInitContractParameters(
         JSONbig.stringify(parameters),
         Buffer.from(rawSchema).toString('hex'),
-        contractName,
+        ContractName.toString(contractName),
         schemaVersion,
         verboseErrorMessage
     );
-    return Buffer.from(serializedParameters, 'hex');
+    return Parameter.fromBuffer(Buffer.from(serializedParameters, 'hex'));
 }
 
 /**
@@ -90,23 +93,23 @@ export function serializeInitContractParameters(
  * @returns serialized buffer of update contract parameters
  */
 export function serializeUpdateContractParameters(
-    contractName: string,
-    receiveFunctionName: string,
+    contractName: ContractName.Type,
+    receiveFunctionName: EntrypointName.Type,
     // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
     parameters: any,
     rawSchema: ArrayBuffer,
     schemaVersion?: SchemaVersion,
     verboseErrorMessage = false
-): Buffer {
+): Parameter.Type {
     const serializedParameters = wasm.serializeReceiveContractParameters(
         JSONbig.stringify(parameters),
         Buffer.from(rawSchema).toString('hex'),
-        contractName,
-        receiveFunctionName,
+        ContractName.toString(contractName),
+        EntrypointName.toString(receiveFunctionName),
         schemaVersion,
         verboseErrorMessage
     );
-    return Buffer.from(serializedParameters, 'hex');
+    return Parameter.fromBuffer(Buffer.from(serializedParameters, 'hex'));
 }
 
 /**
@@ -121,28 +124,28 @@ export function serializeTypeValue(
     value: any,
     rawSchema: ArrayBuffer,
     verboseErrorMessage = false
-): Buffer {
+): Parameter.Type {
     const serializedValue = wasm.serializeTypeValue(
         JSONbig.stringify(value),
         Buffer.from(rawSchema).toString('hex'),
         verboseErrorMessage
     );
-    return Buffer.from(serializedValue, 'hex');
+    return Parameter.fromBuffer(Buffer.from(serializedValue, 'hex'));
 }
 
 /**
  * Given a contract's raw state, its name and its schema, return the state as a JSON object.
  * The return type is any, and the actual type should be determined by using the schema.
  */
 export function deserializeContractState(
-    contractName: string,
+    contractName: ContractName.Type,
     schema: ArrayBuffer,
     state: ArrayBuffer,
     verboseErrorMessage = false
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
 ): any {
     const serializedState = wasm.deserializeState(
-        contractName,
+        ContractName.toString(contractName),
         Buffer.from(state).toString('hex'),
         Buffer.from(schema).toString('hex'),
         verboseErrorMessage
@@ -171,17 +174,17 @@ export function deserializeContractState(
 export function deserializeReceiveReturnValue(
     returnValueBytes: ArrayBuffer,
     moduleSchema: ArrayBuffer,
-    contractName: string,
-    functionName: string,
+    contractName: ContractName.Type,
+    functionName: EntrypointName.Type,
     schemaVersion?: number,
     verboseErrorMessage = false
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
 ): any {
     const deserializedReturnValue = wasm.deserializeReceiveReturnValue(
         Buffer.from(returnValueBytes).toString('hex'),
         Buffer.from(moduleSchema).toString('hex'),
-        contractName,
-        functionName,
+        ContractName.toString(contractName),
+        EntrypointName.toString(functionName),
         schemaVersion,
         verboseErrorMessage
     );
@@ -209,16 +212,16 @@ export function deserializeReceiveReturnValue(
 export function deserializeReceiveError(
     errorBytes: ArrayBuffer,
     moduleSchema: ArrayBuffer,
-    contractName: string,
-    functionName: string,
+    contractName: ContractName.Type,
+    functionName: EntrypointName.Type,
     verboseErrorMessage = false
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
 ): any {
     const deserializedError = wasm.deserializeReceiveError(
         Buffer.from(errorBytes).toString('hex'),
         Buffer.from(moduleSchema).toString('hex'),
-        contractName,
-        functionName,
+        ContractName.toString(contractName),
+        EntrypointName.toString(functionName),
         verboseErrorMessage
     );
     try {
@@ -244,14 +247,14 @@ export function deserializeReceiveError(
 export function deserializeInitError(
     errorBytes: ArrayBuffer,
     moduleSchema: ArrayBuffer,
-    contractName: string,
+    contractName: ContractName.Type,
     verboseErrorMessage = false
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
 ): any {
     const deserializedError = wasm.deserializeInitError(
         Buffer.from(errorBytes).toString('hex'),
         Buffer.from(moduleSchema).toString('hex'),
-        contractName,
+        ContractName.toString(contractName),
         verboseErrorMessage
     );
     try {

packages/common/src/types/Parameter.ts

@@ -87,7 +87,7 @@ export function fromSchemaType(
     value: unknown
 ): Parameter {
     const schemaBytes = serializeSchemaType(schemaType);
-    return fromBuffer(serializeTypeValue(value, schemaBytes));
+    return serializeTypeValue(value, schemaBytes);
 }
 
 /**
@@ -101,7 +101,7 @@ export function fromBase64SchemaType(
     value: unknown
 ): Parameter {
     const schemaBytes = Buffer.from(schemaBase64, 'base64');
-    return fromBuffer(serializeTypeValue(value, schemaBytes));
+    return serializeTypeValue(value, schemaBytes);
 }
 
 /**