Function assetsAPI

sdk/node/src/api/assets.js:46–143

(client)

 * @module AssetsApi
 */
const assetsAPI = (client) => {
  /**
   * @typedef {Object} createRequest
   *
   * @property {String} [alias]
   * User specified, unique identifier.
   *
   * @property {String[]} rootXpubs
   * The list of keys used to create the issuance program for the asset.
   *
   * @property {Number} quorum
   * The number of keys required to issue units of the asset.
   *
   * @property {Object} [tags]
   * User-specified, arbitrary/unstructured data local to the asset's originating core.
   *
   * @property {Object} [defintion]
   * User-specified, arbitrary/unstructured data visible across blockchain networks.
   */

  /**
   * @typedef {Object} updateTagsRequest
   *
   * @property {String} [id]
   * The asset ID. Either the ID or alias must be specified, but not both.
   *
   * @property {String} [alias]
   * The asset alias. Either the ID or alias must be specified, but not both.
   *
   * @property {Object} [tags]
   * A new set of tags, which will replace the existing tags.
   */

  return {
    /**
     * Create a new asset.
     *
     * @param {module:AssetsApi~createRequest} params - Parameters for asset creation.
     * @param {objectCallback} [callback] - Optional callback. Use instead of Promise return value as desired.
     * @returns {Promise<Asset>} Newly created asset.
     */
    create: (params, cb) => shared.create(client, '/create-asset', params, {cb}),

    /**
     * Create multiple new assets.
     *
     * @param {module:AssetsApi~createRequest[]} params - Parameters for creation of multiple assets.
     * @param {batchCallback} [callback] - Optional callback. Use instead of Promise return value as desired.
     * @returns {Promise<BatchResponse<Asset>>} Newly created assets.
     */
    createBatch: (params, cb) => shared.createBatch(client, '/create-asset', params, {cb}),

    /**
     * Update asset tags.
     *
     * @param {module:AssetsApi~updateTagsRequest} params - Parameters for updating asset tags.
     * @param {objectCallback} [cb] - Optional callback. Use instead of Promise return value as desired.
     * @returns {Promise<Object>} Success message.