DeployedContractsApi

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

Method	HTTP request	Description
addContractABI	POST /tokenization/contracts/abi	Save contract ABI
fetchContractAbi	POST /tokenization/contracts/fetch_abi	Fetch the contract ABI
getDeployedContractByAddress	GET /tokenization/contracts/{assetId}/{contractAddress}	Return deployed contract data
getDeployedContractById	GET /tokenization/contracts/{id}	Return deployed contract data by id
getDeployedContracts	GET /tokenization/contracts	List deployed contracts data

addContractABI

ContractWithAbiDto addContractABI(addAbiRequestDto)

Save contract ABI for the tenant

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, DeployedContractsApiAddContractABIRequest, ContractWithAbiDto } 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: DeployedContractsApiAddContractABIRequest = {
  // AddAbiRequestDto
  addAbiRequestDto: 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.deployedContracts.addContractABI(body).then((res: FireblocksResponse<ContractWithAbiDto>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
addAbiRequestDto	AddAbiRequestDto
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

ContractWithAbiDto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Contract ABI created (or updated) for the tenant	-
409	Contract ABI already exists.	-
0	Error Response	* X-Request-ID -

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

fetchContractAbi

ContractWithAbiDto fetchContractAbi(fetchAbiRequestDto)

Fetch the ABI. If not found fetch the ABI from the block explorer

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, DeployedContractsApiFetchContractAbiRequest, ContractWithAbiDto } 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: DeployedContractsApiFetchContractAbiRequest = {
  // FetchAbiRequestDto
  fetchAbiRequestDto: 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.deployedContracts.fetchContractAbi(body).then((res: FireblocksResponse<ContractWithAbiDto>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
fetchAbiRequestDto	FetchAbiRequestDto
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

ContractWithAbiDto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Contract ABI found.	-
404	Contract ABI not found	-
0	Error Response	* X-Request-ID -

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

getDeployedContractByAddress

DeployedContractResponseDto getDeployedContractByAddress()

Return deployed contract data by blockchain native asset id and contract address

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, DeployedContractsApiGetDeployedContractByAddressRequest, DeployedContractResponseDto } 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: DeployedContractsApiGetDeployedContractByAddressRequest = {
  // string | The contract\'s onchain address
  contractAddress: 0xC2c4e1Db41F0bB97996D0eD0542D2170d146FB66,
  // string
  assetId: assetId_example,
};

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

Parameters

Name	Type	Description	Notes
contractAddress	[string]	The contract's onchain address	defaults to undefined
assetId	[string]		defaults to undefined

Return type

DeployedContractResponseDto

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]

getDeployedContractById

DeployedContractResponseDto getDeployedContractById()

Return deployed contract data by id

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, DeployedContractsApiGetDeployedContractByIdRequest, DeployedContractResponseDto } 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: DeployedContractsApiGetDeployedContractByIdRequest = {
  // string | The deployed contract data identifier
  id: b70701f4-d7b1-4795-a8ee-b09cdb5b850d,
};

fireblocks.deployedContracts.getDeployedContractById(body).then((res: FireblocksResponse<DeployedContractResponseDto>) => {
  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 deployed contract data identifier	defaults to undefined

Return type

DeployedContractResponseDto

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]

getDeployedContracts

DeployedContractsPaginatedResponse getDeployedContracts()

Return a filtered lean representation of the deployed contracts data on all blockchains (paginated)

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, DeployedContractsApiGetDeployedContractsRequest, DeployedContractsPaginatedResponse } 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: DeployedContractsApiGetDeployedContractsRequest = {
  // 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,
  // string | The contract\'s onchain address (optional)
  contractAddress: 0xC2c4e1Db41F0bB97996D0eD0542D2170d146FB66,
  // string (optional)
  baseAssetId: baseAssetId_example,
  // string (optional)
  contractTemplateId: contractTemplateId_example,
};

fireblocks.deployedContracts.getDeployedContracts(body).then((res: FireblocksResponse<DeployedContractsPaginatedResponse>) => {
  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
contractAddress	[string]	The contract's onchain address	(optional) defaults to undefined
baseAssetId	[string]		(optional) defaults to undefined
contractTemplateId	[string]		(optional) defaults to undefined

Return type

DeployedContractsPaginatedResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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

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

Files

DeployedContractsApi.md

Latest commit

History

DeployedContractsApi.md

File metadata and controls

DeployedContractsApi

addContractABI

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetchContractAbi

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getDeployedContractByAddress

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getDeployedContractById

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getDeployedContracts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details