0xcert Docs

# Update asset imprint

When issued assets data that was generates through certification changes the data on blockchain needs to change as well. This is where updating asset imprint comes into play. In this guide we will update an existing assets imprint.

# Prerequisites

In this guide, we will assume you have gone through the Asset ledger deployment guide and have deployed an asset ledger and that you have gone trough Issue asset guide and created asset. You will also need a MetaMask account with some credits.

WARNING

Asset ledger must have UPDATE_ASSET capability.

# Usage overview

We begin by importing the client modules.

import { ActionUpdateAssetImprint, ActionKind, Client, Priority } from "@0xcert/client";

Before we can start transferring assets we must initialize our client first.

const client = new Client({
  provider,
  apiUrl: 'https://api-rinkeby.0xcert.org',
});
await client.init();

WARNING

For successful client initialization you need connected 0xcert framework provider instance. See Providers chapter for detailed instructions. Your provider must be connected to Rinkeby Ethereum test network.

Once client is initialized, we define our update asset imprint action.

const actionUpdateAssetImprint: ActionUpdateAssetImprint = {
  kind: ActionKind.UPDATE_ASSET_IMPRINT,
  assetLedgerId: ledger.id,
  senderId: provider.accountId,
  imprint: 'd747e6ffd1aa3f83efef2931e3cc22c653ea97a32c1ee7289e4966b6964ecdfb',
  id: asset.id,
};

To update asset's imprint we need to generate new asset's imprint. You can learn more about generating imprints in the Certification guide. As assetLedgerId we must provide the ID of our newly deployed asset ledger from guide Asset ledger deployment or any other deployed ledger. We specify which issued asset we want to update by setting id to the ID of the asset. We can use asset we created in guide Issue asset or any other created asset that we own.

WARNING

Asset with the provided ID must exists on the provided asset ledger.

As senderId we set provider.accountId, which means that we will be signing update asset imprint creation order.

TIP

Account address specified as senderId can only update asset imprint if they are either the asset's owner or if they have been authorized by the asset's owner and have the ability to operate with it on their behalf.

After we defined our update asset imprint action, it's time to define our order which will perform the defined action.

const order = {
  signersIds: [
    provider.accountId
  ],
  actions: [
    actionUpdateAssetImprint,
  ],
  wildcardSigner: false,
  automatedPerform: true,
  payerId: provider.accountId,
};

Order must be signed by all of the accounts specified in signersIds array. In our case, we are updating our asset, so we are the only signer of the order. We add our defined update asset imprint action in actions array. There can be multiple different actions present in one order and they will be atomically performed. If wildcardSigner is set to true order can be signed by any account. In our case we need only our signature for the order to be successfully performed, so we set wildcardSigner to false. We want our order to be performed as soon as it can be, so we enable automated performance of the order by setting automatedPerform to true. Order will be automatically performed after all of the requirements of the order are fulfilled. If automatedPerform was set to false we would need to call performOrder(orderRef) function after the order creation. As payerId we set provider.accountId, so we will be paying for the execution of the order. To learn more about different scenarios check out the Additional scenarios section.

WARNING

If payer is not specified wildcardSigner field must be set to true and order's payer will be set automatically. If payer is specified it must be listed as order signer in signersIds array.

After our actions order is defined we can finally create it.

const actionsOrder = await client.createOrder(order, Priority.HIGH).then((data) => data.data);

WARNING

Make sure you have enough credits to perform this action.

Since actions order performance might take some time, we can check the order's status by requesting its data.

const status = await client.getOrder(actionsOrder.ref).then((data) => data.data.status);

If the status of the action order equals to 7, we know that our order was performed successfully and our asset was updated. Now we can request our newly updated asset.

const asset = await client.getLedgerAsset(ledger.ref, asset.id).then((data) => data.data);

TIP

You can also set up and receive webhooks. In this scenario you will receive webhooks when our order changes (updated or successful) or if it fails. You can learn more about webhooks in chapter Webhooks.

← Destroy asset →