This is the documentation for the Concordium Javascript SDK. Here we cover the JS wrappers for interacting with the Concordium nodes.

Most functionality is provideded by the GRPC-Client however there exists additional helper functions, for example to help with creating transactions, or creating identity proof statements, or general utility functions.

A good way to get started is to check out the runnable examples.

To create a GRPC-Client for use with nodeJS:

    import { ConcordiumGRPCNodeClient, credentials } from '@concordium/web-sdk/nodejs';
    ...
    return new ConcordiumGRPCNodeClient(
        address,
        port,
        credentials.createSsl(),
        { timeout: 15000 }
    );

To create a GRPC-Client for use in a browser (requires GRPC-web enabled on the node):

    import { ConcordiumGRPCWebClient } from '@concordium/web-sdk';
    ...
    return new ConcordiumGRPCWebClient(
        address,
        port,
        { timeout: 15000 }
    );

Compatibility

As of version 7, the SDK's are compatible only with environments respecting the exports field of a modules package.json, i.e. taking this into account when resolving modules. This means

• NodeJS versions 16 and later.
• Bundlers resolving modules by package.json exports.

Typescript

Typescript has support for resolving modules through exports of package.json from versions

• NodeJS -> Typescript version 4.7 and later with compilerOptions.moduleResolution: "node16" // Or "nodenext".
• Bundlers -> Typescript version 5.0 and later with compilerOptions.moduleResolution: "bundler".

NodeJS

The web-sdk is published as an ES module, and as such packages using it must also be ES modules.

The easiest way to run your node application as an ES module, is by setting the type field of package.json to be set to "module":

{
    ...
    "type": "module",
    ...
}

Alternatively, files names with the extension mjs (or mts for TypeScript) are always handled as ES modules.