TokenizationApi

All URIs are relative to https://developers.fireblocks.com/reference/

Method	HTTP request	Description
burnCollectionToken	POST /tokenization/collections/{id}/tokens/burn	Burn tokens
createNewCollection	POST /tokenization/collections	Create a new collection
deactivateAndUnlinkAdapters	DELETE /tokenization/multichain/bridge/layerzero	Remove LayerZero adapters
deployAndLinkAdapters	POST /tokenization/multichain/bridge/layerzero	Deploy LayerZero adapters
fetchCollectionTokenDetails	GET /tokenization/collections/{id}/tokens/{tokenId}	Get collection token details
getCollectionById	GET /tokenization/collections/{id}	Get a collection by id
getDeployableAddress	POST /tokenization/multichain/deterministic_address	Get deterministic address for contract deployment
getLayerZeroDvnConfig	GET /tokenization/multichain/bridge/layerzero/config/{adapterTokenLinkId}/dvns	Get LayerZero DVN configuration
getLayerZeroPeers	GET /tokenization/multichain/bridge/layerzero/config/{adapterTokenLinkId}/peers	Get LayerZero peers
getLinkedCollections	GET /tokenization/collections	Get collections
getLinkedToken	GET /tokenization/tokens/{id}	Return a linked token
getLinkedTokens	GET /tokenization/tokens	List all linked tokens
getLinkedTokensCount	GET /tokenization/tokens/count	Get the total count of linked tokens
issueNewToken	POST /tokenization/tokens	Issue a new token
issueTokenMultiChain	POST /tokenization/multichain/tokens	Issue a token on one or more blockchains
link	POST /tokenization/tokens/link	Link a contract
mintCollectionToken	POST /tokenization/collections/{id}/tokens/mint	Mint tokens
reIssueTokenMultiChain	POST /tokenization/multichain/reissue/token/{tokenLinkId}	Reissue a multichain token
removeLayerZeroPeers	DELETE /tokenization/multichain/bridge/layerzero/config/peers	Remove LayerZero peers
setLayerZeroDvnConfig	POST /tokenization/multichain/bridge/layerzero/config/dvns	Set LayerZero DVN configuration
setLayerZeroPeers	POST /tokenization/multichain/bridge/layerzero/config/peers	Set LayerZero peers
unlink	DELETE /tokenization/tokens/{id}	Unlink a token
unlinkCollection	DELETE /tokenization/collections/{id}	Delete a collection link
validateLayerZeroChannelConfig	GET /tokenization/multichain/bridge/layerzero/validate	Validate LayerZero channel configuration

burnCollectionToken

CollectionBurnResponseDto burnCollectionToken(collectionBurnRequestDto, )

Burn tokens in a collection

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiBurnCollectionTokenRequest, CollectionBurnResponseDto } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiBurnCollectionTokenRequest = {
  // CollectionBurnRequestDto
  collectionBurnRequestDto: param_value,
  // string | The collection link id
  id: fbfbfbfb-fbfb-fbfb-fbfb-fbfbfbfbfbfb,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.tokenization.burnCollectionToken(body).then((res: FireblocksResponse<CollectionBurnResponseDto>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
collectionBurnRequestDto	CollectionBurnRequestDto
id	[string]	The collection link id	defaults to undefined
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

CollectionBurnResponseDto

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Tokens burned successfully	-
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createNewCollection

CollectionLinkDto createNewCollection(collectionDeployRequestDto)

Create a new collection and link it as a token.
Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiCreateNewCollectionRequest, CollectionLinkDto } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiCreateNewCollectionRequest = {
  // CollectionDeployRequestDto
  collectionDeployRequestDto: param_value,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.tokenization.createNewCollection(body).then((res: FireblocksResponse<CollectionLinkDto>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
collectionDeployRequestDto	CollectionDeployRequestDto
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

CollectionLinkDto

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Collection was created successfully	-
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deactivateAndUnlinkAdapters

RemoveLayerZeroAdaptersResponse deactivateAndUnlinkAdapters(removeLayerZeroAdaptersRequest)

Remove LayerZero adapters by deactivating and unlinking them. This endpoint revokes roles and deactivates the specified adapter contracts.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiDeactivateAndUnlinkAdaptersRequest, RemoveLayerZeroAdaptersResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiDeactivateAndUnlinkAdaptersRequest = {
  // RemoveLayerZeroAdaptersRequest
  removeLayerZeroAdaptersRequest: param_value,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.tokenization.deactivateAndUnlinkAdapters(body).then((res: FireblocksResponse<RemoveLayerZeroAdaptersResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
removeLayerZeroAdaptersRequest	RemoveLayerZeroAdaptersRequest
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

RemoveLayerZeroAdaptersResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	LayerZero adapters removal process completed	-
400	Bad request, invalid input data or parameters	-
404	Token link not found	-
409	Token link processing error	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deployAndLinkAdapters

DeployLayerZeroAdaptersResponse deployAndLinkAdapters(deployLayerZeroAdaptersRequest)

Deploy LayerZero adapters for multichain token bridging functionality. This endpoint creates adapter contracts that enable cross-chain token transfers.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiDeployAndLinkAdaptersRequest, DeployLayerZeroAdaptersResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiDeployAndLinkAdaptersRequest = {
  // DeployLayerZeroAdaptersRequest
  deployLayerZeroAdaptersRequest: param_value,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.tokenization.deployAndLinkAdapters(body).then((res: FireblocksResponse<DeployLayerZeroAdaptersResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
deployLayerZeroAdaptersRequest	DeployLayerZeroAdaptersRequest
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

DeployLayerZeroAdaptersResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	LayerZero adapters deployed successfully	-
400	Bad request, invalid input data or parameters	-
404	Token link not found	-
409	Token link preparation error	-
422	Token link is not fungible	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetchCollectionTokenDetails

CollectionLinkDto fetchCollectionTokenDetails()

Get collection token details by id

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiFetchCollectionTokenDetailsRequest, CollectionLinkDto } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiFetchCollectionTokenDetailsRequest = {
  // string | The collection link id
  id: fbfbfbfb-fbfb-fbfb-fbfb-fbfbfbfbfbfb,
  // string | The tokenId as it appears on the blockchain
  tokenId: 1,
};

fireblocks.tokenization.fetchCollectionTokenDetails(body).then((res: FireblocksResponse<CollectionLinkDto>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
id	[string]	The collection link id	defaults to undefined
tokenId	[string]	The tokenId as it appears on the blockchain	defaults to undefined

Return type

CollectionLinkDto

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Collection token details were fetched successfully	-
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCollectionById

CollectionLinkDto getCollectionById()

Get a collection by id

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiGetCollectionByIdRequest, CollectionLinkDto } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiGetCollectionByIdRequest = {
  // string | The token link id
  id: fbfbfbfb-fbfb-fbfb-fbfb-fbfbfbfbfbfb,
};

fireblocks.tokenization.getCollectionById(body).then((res: FireblocksResponse<CollectionLinkDto>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
id	[string]	The token link id	defaults to undefined

Return type

CollectionLinkDto

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Collection fetched successfully	-
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDeployableAddress

DeployableAddressResponse getDeployableAddress(getDeployableAddressRequest)

Get a deterministic address for contract deployment. The address is derived from the contract's bytecode and provided salt. This endpoint is used to get the address of a contract that will be deployed in the future.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiGetDeployableAddressRequest, DeployableAddressResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiGetDeployableAddressRequest = {
  // GetDeployableAddressRequest
  getDeployableAddressRequest: param_value,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.tokenization.getDeployableAddress(body).then((res: FireblocksResponse<DeployableAddressResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
getDeployableAddressRequest	GetDeployableAddressRequest
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

DeployableAddressResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Deterministic address for contract deployment	-
400	Invalid parameters or template has no bytecode	-
409	Address is already taken	-
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLayerZeroDvnConfig

GetLayerZeroDvnConfigResponse getLayerZeroDvnConfig()

Retrieve the DVN (Data Verification Network) configuration for a specific adapter. Returns DVN configurations for channels between the source adapter and its peers.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiGetLayerZeroDvnConfigRequest, GetLayerZeroDvnConfigResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiGetLayerZeroDvnConfigRequest = {
  // string | The token link id of the adapter token link
  adapterTokenLinkId: b70701f4-d7b1-4795-a8ee-b09cdb5b850d,
  // string | Optional peer adapter token link ID to filter results (optional)
  peerAdapterTokenLinkId: 6add4f2a-b206-4114-8f94-2882618ffbb4,
};

fireblocks.tokenization.getLayerZeroDvnConfig(body).then((res: FireblocksResponse<GetLayerZeroDvnConfigResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
adapterTokenLinkId	[string]	The token link id of the adapter token link	defaults to undefined
peerAdapterTokenLinkId	[string]	Optional peer adapter token link ID to filter results	(optional) defaults to undefined

Return type

GetLayerZeroDvnConfigResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	LayerZero DVN configuration retrieved successfully	-
400	Bad request, invalid input data or parameters	-
404	Token link not found	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLayerZeroPeers

GetLayerZeroPeersResponse getLayerZeroPeers()

Retrieve the LayerZero peers configured for a specific adapter. Returns information about peer relationships for cross-chain communication.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiGetLayerZeroPeersRequest, GetLayerZeroPeersResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiGetLayerZeroPeersRequest = {
  // string | The token link id of the adapter token link
  adapterTokenLinkId: b70701f4-d7b1-4795-a8ee-b09cdb5b850d,
};

fireblocks.tokenization.getLayerZeroPeers(body).then((res: FireblocksResponse<GetLayerZeroPeersResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
adapterTokenLinkId	[string]	The token link id of the adapter token link	defaults to undefined

Return type

GetLayerZeroPeersResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	LayerZero peers retrieved successfully	-
400	Bad request, invalid input data or parameters	-
404	Token link not found	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLinkedCollections

GetLinkedCollectionsPaginatedResponse getLinkedCollections()

Get collections (paginated).
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiGetLinkedCollectionsRequest, GetLinkedCollectionsPaginatedResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiGetLinkedCollectionsRequest = {
  // string | Page cursor to get the next page, for example - \"MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==\" (optional)
  pageCursor: pageCursor_example,
  // number | Number of items per page (max 100), requesting more then 100 will return 100 items (optional)
  pageSize: 10,
  // any | A comma separated list of statuses to filter. Default is \"COMPLETED\" (optional)
  status: COMPLETED,
};

fireblocks.tokenization.getLinkedCollections(body).then((res: FireblocksResponse<GetLinkedCollectionsPaginatedResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
pageCursor	[string]	Page cursor to get the next page, for example - "MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA=="	(optional) defaults to undefined
pageSize	[number]	Number of items per page (max 100), requesting more then 100 will return 100 items	(optional) defaults to 100
status	any	A comma separated list of statuses to filter. Default is "COMPLETED"	(optional) defaults to undefined

Return type

GetLinkedCollectionsPaginatedResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Collection fetched successfully	-
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLinkedToken

TokenLinkDto getLinkedToken()

Return a linked token, with its status and metadata.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiGetLinkedTokenRequest, TokenLinkDto } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiGetLinkedTokenRequest = {
  // string | The token link id
  id: fbfbfbfb-fbfb-fbfb-fbfb-fbfbfbfbfbfb,
};

fireblocks.tokenization.getLinkedToken(body).then((res: FireblocksResponse<TokenLinkDto>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
id	[string]	The token link id	defaults to undefined

Return type

TokenLinkDto

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Token fetched successfully	-
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLinkedTokens

TokensPaginatedResponse getLinkedTokens()

Return all linked tokens (paginated)

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiGetLinkedTokensRequest, TokensPaginatedResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiGetLinkedTokensRequest = {
  // string | Page cursor to get the next page (optional)
  pageCursor: MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==,
  // number | Number of items per page, requesting more then max will return max items (optional)
  pageSize: 10,
  // any | A comma separated list of statuses to filter. Default is \"COMPLETED\" (optional)
  status: COMPLETED,
};

fireblocks.tokenization.getLinkedTokens(body).then((res: FireblocksResponse<TokensPaginatedResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
pageCursor	[string]	Page cursor to get the next page	(optional) defaults to undefined
pageSize	[number]	Number of items per page, requesting more then max will return max items	(optional) defaults to undefined
status	any	A comma separated list of statuses to filter. Default is "COMPLETED"	(optional) defaults to undefined

Return type

TokensPaginatedResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLinkedTokensCount

LinkedTokensCount getLinkedTokensCount()

Get the total count of linked tokens

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, LinkedTokensCount } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body:any = {};

fireblocks.tokenization.getLinkedTokensCount(body).then((res: FireblocksResponse<LinkedTokensCount>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

LinkedTokensCount

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Count fetched successfully	-
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

issueNewToken

TokenLinkDto issueNewToken(createTokenRequestDto)

Facilitates the creation of a new token, supporting both EVM-based and Stellar/Ripple platforms. For EVM, it deploys the corresponding contract template to the blockchain and links the token to the workspace. For Stellar/Ripple, it links a newly created token directly to the workspace without deploying a contract. Returns the token link with status "PENDING" until the token is deployed or "SUCCESS" if no deployment is needed.
Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiIssueNewTokenRequest, TokenLinkDto } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiIssueNewTokenRequest = {
  // CreateTokenRequestDto
  createTokenRequestDto: param_value,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.tokenization.issueNewToken(body).then((res: FireblocksResponse<TokenLinkDto>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
createTokenRequestDto	CreateTokenRequestDto
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

TokenLinkDto

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Token was created successfully	-
409	Asset already exists	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

issueTokenMultiChain

IssueTokenMultichainResponse issueTokenMultiChain(createMultichainTokenRequest)

Facilitates the creation of a new token on one or more blockchains.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiIssueTokenMultiChainRequest, IssueTokenMultichainResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiIssueTokenMultiChainRequest = {
  // CreateMultichainTokenRequest
  createMultichainTokenRequest: param_value,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.tokenization.issueTokenMultiChain(body).then((res: FireblocksResponse<IssueTokenMultichainResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
createMultichainTokenRequest	CreateMultichainTokenRequest
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

IssueTokenMultichainResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Tokens were created successfully	-
400	Invalid input.	-
409	Address is already taken.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

link

TokenLinkDto link(tokenLinkRequestDto)

Link an a contract

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiLinkRequest, TokenLinkDto } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiLinkRequest = {
  // TokenLinkRequestDto
  tokenLinkRequestDto: param_value,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.tokenization.link(body).then((res: FireblocksResponse<TokenLinkDto>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
tokenLinkRequestDto	TokenLinkRequestDto
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

TokenLinkDto

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Token linked successfully	-
201		-
404	Could not find the underlying contract to link to	-
409	Token link for {refId} already exists	-
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

mintCollectionToken

CollectionMintResponseDto mintCollectionToken(collectionMintRequestDto, )

Mint tokens and upload metadata

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiMintCollectionTokenRequest, CollectionMintResponseDto } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiMintCollectionTokenRequest = {
  // CollectionMintRequestDto
  collectionMintRequestDto: param_value,
  // string | The collection link id
  id: fbfbfbfb-fbfb-fbfb-fbfb-fbfbfbfbfbfb,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.tokenization.mintCollectionToken(body).then((res: FireblocksResponse<CollectionMintResponseDto>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
collectionMintRequestDto	CollectionMintRequestDto
id	[string]	The collection link id	defaults to undefined
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

CollectionMintResponseDto

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Tokens minted successfully	-
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reIssueTokenMultiChain

IssueTokenMultichainResponse reIssueTokenMultiChain(reissueMultichainTokenRequest, )

Reissue a multichain token. This endpoint allows you to reissue a token on one or more blockchains. The token must be initially issued using the issueTokenMultiChain endpoint.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiReIssueTokenMultiChainRequest, IssueTokenMultichainResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiReIssueTokenMultiChainRequest = {
  // ReissueMultichainTokenRequest
  reissueMultichainTokenRequest: param_value,
  // string | The ID of the token link
  tokenLinkId: tokenLinkId_example,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.tokenization.reIssueTokenMultiChain(body).then((res: FireblocksResponse<IssueTokenMultichainResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
reissueMultichainTokenRequest	ReissueMultichainTokenRequest
tokenLinkId	[string]	The ID of the token link	defaults to undefined
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

IssueTokenMultichainResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Successfully reissued multichain token	-
400	Invalid input	-
404	Deployed contract not found	-
409	Address is already taken	-
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

removeLayerZeroPeers

RemoveLayerZeroPeersResponse removeLayerZeroPeers(removeLayerZeroPeersRequest)

Remove LayerZero peers to disconnect adapter contracts. This endpoint removes peer relationships between LayerZero adapters.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiRemoveLayerZeroPeersRequest, RemoveLayerZeroPeersResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiRemoveLayerZeroPeersRequest = {
  // RemoveLayerZeroPeersRequest
  removeLayerZeroPeersRequest: param_value,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.tokenization.removeLayerZeroPeers(body).then((res: FireblocksResponse<RemoveLayerZeroPeersResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
removeLayerZeroPeersRequest	RemoveLayerZeroPeersRequest
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

RemoveLayerZeroPeersResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	LayerZero peers removal process completed	-
400	Bad request, invalid input data or parameters	-
404	Token link not found	-
409	Token link processing error	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

setLayerZeroDvnConfig

SetLayerZeroDvnConfigResponse setLayerZeroDvnConfig(setLayerZeroDvnConfigRequest)

Configure DVN settings for LayerZero adapters. This endpoint sets up the DVN configuration for message verification between source and destination adapters.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiSetLayerZeroDvnConfigRequest, SetLayerZeroDvnConfigResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiSetLayerZeroDvnConfigRequest = {
  // SetLayerZeroDvnConfigRequest
  setLayerZeroDvnConfigRequest: param_value,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.tokenization.setLayerZeroDvnConfig(body).then((res: FireblocksResponse<SetLayerZeroDvnConfigResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
setLayerZeroDvnConfigRequest	SetLayerZeroDvnConfigRequest
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

SetLayerZeroDvnConfigResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	LayerZero DVN configuration set successfully	-
400	Bad request, invalid input data or parameters	-
404	Token link not found	-
409	Token link preparation error	-
422	Bridging protocol blockchain metadata not found	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

setLayerZeroPeers

SetLayerZeroPeersResponse setLayerZeroPeers(setLayerZeroPeersRequest)

Set LayerZero peers to establish connections between adapter contracts. This endpoint creates peer relationships that enable cross-chain communication. It sets the destination adapter as a peer of the source adapter. If bidirectional is true, it also sets the source adapter as a peer of the destination adapter(s).

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiSetLayerZeroPeersRequest, SetLayerZeroPeersResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiSetLayerZeroPeersRequest = {
  // SetLayerZeroPeersRequest
  setLayerZeroPeersRequest: param_value,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.tokenization.setLayerZeroPeers(body).then((res: FireblocksResponse<SetLayerZeroPeersResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
setLayerZeroPeersRequest	SetLayerZeroPeersRequest
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

SetLayerZeroPeersResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	LayerZero peers set successfully	-
400	Bad request, invalid input data or parameters	-
404	Token link not found	-
409	Token link preparation error	-
422	Token link is not fungible	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unlink

unlink()

Unlink a token. The token will be unlinked from the workspace. The token will not be deleted on chain nor the refId, only the link to the workspace will be removed.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiUnlinkRequest } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiUnlinkRequest = {
  // string | The token link id
  id: fbfbfbfb-fbfb-fbfb-fbfb-fbfbfbfbfbfb,
};

fireblocks.tokenization.unlink(body).then((res: FireblocksResponse<any>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
id	[string]	The token link id	defaults to undefined

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Token unlinked successfully	-
204		-
404	Link did not exist	-
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unlinkCollection

unlinkCollection()

Delete a collection link

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiUnlinkCollectionRequest } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiUnlinkCollectionRequest = {
  // string | The token link id
  id: fbfbfbfb-fbfb-fbfb-fbfb-fbfbfbfbfbfb,
};

fireblocks.tokenization.unlinkCollection(body).then((res: FireblocksResponse<any>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
id	[string]	The token link id	defaults to undefined

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Collection unlinked successfully	-
404	Link for collection does not exist	-
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

validateLayerZeroChannelConfig

ValidateLayerZeroChannelResponse validateLayerZeroChannelConfig()

Validate the LayerZero channel configuration between adapters. This endpoint checks if the channel configuration is correct and returns any validation errors.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, TokenizationApiValidateLayerZeroChannelConfigRequest, ValidateLayerZeroChannelResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: TokenizationApiValidateLayerZeroChannelConfigRequest = {
  // string | The token link ID of the adapter
  adapterTokenLinkId: b70701f4-d7b1-4795-a8ee-b09cdb5b850d,
  // string | Peer adapter token link ID to validate against
  peerAdapterTokenLinkId: 6add4f2a-b206-4114-8f94-2882618ffbb4,
};

fireblocks.tokenization.validateLayerZeroChannelConfig(body).then((res: FireblocksResponse<ValidateLayerZeroChannelResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
adapterTokenLinkId	[string]	The token link ID of the adapter	defaults to undefined
peerAdapterTokenLinkId	[string]	Peer adapter token link ID to validate against	defaults to undefined

Return type

ValidateLayerZeroChannelResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	LayerZero channel configuration validation completed	-
400	Bad request, invalid input data or parameters	-
404	Token link not found	-
422	Bridging protocol blockchain metadata not found	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

TokenizationApi.md

Latest commit

History

TokenizationApi.md

File metadata and controls

TokenizationApi

burnCollectionToken

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createNewCollection

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deactivateAndUnlinkAdapters

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deployAndLinkAdapters

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetchCollectionTokenDetails

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getCollectionById

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getDeployableAddress

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getLayerZeroDvnConfig

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getLayerZeroPeers

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getLinkedCollections

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getLinkedToken

Example

Parameters