Documentation on @fireblocks/ncw-js-sdk

Jarl · January 25, 2024, 3:38pm

In the NCW React Demo App the lib @fireblocks/ncw-js-sdk is used. Is there any documentation available for that lib?

mnamakwala · January 25, 2024, 8:50pm

Hi Jarl,
Yes, we do.
Please check out these articles

Jarl · January 25, 2024, 9:40pm

The first is only version information, the second is about the node-js lib. I looked at the code of this last lib, but couldn’t find the functions that would be needed for NCW in the frontend (like e.g. the FireblocksNCW object). Maybe I’m overlooking it, but can’t find it?

mnamakwala · January 25, 2024, 10:01pm

It does please check out this JS file.

github.com

fireblocks/fireblocks-sdk-js/blob/master/src/ncw-sdk.ts

import {
    AssetResponse, Web3PagedResponse, NCW,
} from "./types";

export interface NcwSdk {
    /**
     * Get NCW supported assets
     */
    getSupportedAssets({ pageCursor, pageSize, onlyBaseAssets }: NCW.GetSupportedAssetsPayload): Promise<Web3PagedResponse<NCW.WalletAssetResponse>>;

    /**
     * Create a new NCW wallet
     */
    createWallet(): Promise<{ walletId: string; enabled: boolean; }>;

    /**
     * Get a NCW wallet
     *
     * @param {string} walletId
     */

This file has been truncated. show original

You can also check the open API spec

Jarl · January 25, 2024, 10:54pm

I am still confused. If I interpret correct, the above are for the backend functionality for NCW at Fireblocks (either via SDK or direct via API).

Looking at the ncw-web-demo, I need a class ‘FireblocksNCW’ with the following functions:

FireblocksNCW.initialize(…)
fireblocksNCW.backupKeys(passphrase, passphraseId)
fireblocksNCW.recoverKeys(passphraseResolver)
fireblocksNCW.getKeysStatus()
fireblocksNCW.clearAllStorage()
fireblocksNCW.getKeysStatus()
fireblocksNCW.signTransaction(txId)
fireblocksNCW.stopInProgressSignTransaction()
fireblocksNCW.generateMPCKeys(ALGORITHMS)
fireblocksNCW.stopMpcDeviceSetup()
fireblocksNCW.takeover()
fireblocksNCW.exportFullKeys(chainCode, cloudKeyShares)
fireblocksNCW.deriveAssetKey(extendedPrivateKey, coinType, account, change, index)
fireblocksNCW.dispose()

These are part of (via npmjs) @fireblocks/ncw-js-sdk. There is no source code available for this, and I can also not find documentation, but it is used in the ncw-web-demo, to demonstrate the NCW functionality in the end-user-device

Topic		Replies	Views
Where to can I find the Fireblocks SDK documentation? Developer Discussion	4	419	November 14, 2023
New SDK versions for NCW Announcements	0	374	December 12, 2023
Using Typescript to use Fireblocks SDK Developer Discussion	2	406	November 4, 2023
Source code for NCW Client SDK Developer Discussion help-center	4	229	April 12, 2024
NCW js sdk in expo/RN Developer Discussion	10	486	April 24, 2024

Documentation on @fireblocks/ncw-js-sdk

Related topics