CLI Tool to Mint Assets
Create a custom CLI Tool, using Deno and Fetch to connect to anvil API, taking few configurable parameters, it is possible to mint a collection using a binary with a custom implementation.
This a a very specific example, the goal is to show how flexible and versatile the Anvil API is.
This example will be entirely done into one file named index.ts
Objectives
Build a simple CLI tool to mint assets
Create a Policy (an NFT Collection)
Create a custom function to customize the asset metadata
Create 2 wallets, one for the policy and one to act as the customer
Submit transaction to the network
This is only an example showing the anvil api versatility
The example is built on Cardano Preprod
Dependencies
import { Buffer } from "node:buffer";
import {
Credential,
type Ed25519KeyHash,
FixedTransaction,
NativeScript,
NativeScripts,
PrivateKey,
ScriptAll,
ScriptPubkey,
TimelockExpiry,
} from "npm:@emurgo/[email protected]";
import { parseArgs } from "jsr:@std/cli/parse-args";
Cardano Wallets
We have this utility to generate wallets: https://github.com/Cardano-Forge/cardano-wallet-cli/releases
~/Downloads/cardano-wallet-macos-latest --name policy --mnemonic
~/Downloads/cardano-wallet-macos-latest --name customer --mnemonic
You'll need to add some tADA to both wallets—100 should be more than enough.
Import Helper Functions
To reduce the amount of content in this guide, you only have to import all functions defined here:
https://github.com/Cardano-Forge/anvil-api/blob/main/docs/guides/utilities-functions/README.mdCLI
const args: {
_: [];
expireDate: string;
customerWalletPath: string;
policyWalletPath: string;
metadataTemplatePath: string;
counter: number;
submit: boolean;
} = parseArgs(Deno.args);
Parse and prepare the policy and wallets:
// NOTE: Be sure to send ADA in this address, it will be used to pay the tx fee.
const customerWallet = JSON.parse(
Deno.readTextFileSync(args.customerWalletPath)
);
// Wallet to create the policy with, no ADA is required for this one.
const policyWallet = JSON.parse(Deno.readTextFileSync(args.policyWalletPath));
// Expiration date, you can interact with the policy until this DateTime is reached.
// After that the policy is locked.
const slot = timeToSlot(new Date(args.expireDate));
const keyhash = get_keyhash(policyWallet.skey);
if (!keyhash) {
throw new Error("Unable to get key hash for policy, missing or invalid skey");
}
const policyAnvilApi = create_policy_script(keyhash, slot);
Collection configurations
This example requires 2 rules.
const policyAnvilApiScript = {
type: "all",
scripts: [
{
type: "sig",
keyHash: keyhash.to_hex(),
},
{
type: "before",
slot: slot,
},
],
};
Meaning that the policy has to be signed by the wallet defined in the policy wallet path parameter AND all mutations must be done before the DateTime defined.
Create Metadata
This function is where you have to define your own data and configuration per asset.
CIP-25 enforces few fields as mandatory see here: https://cips.cardano.org/cip/CIP-25
You can also use our powerful metadata validator: https://metadraft.io
For example
const assets: {
version: string;
assetName: string;
metadata: {
name: string;
image: string | string[];
mediaType: string;
description: string;
epoch: number;
};
policyId: string;
quantity: 1;
}[] = [];
const assetMetadataTemplate = JSON.parse(
Deno.readTextFileSync(args.metadataTemplatePath)
);
const counter = args.counter;
// Simulate use case
assets.push({
version: "cip25",
assetName: `anvilapicip25_${counter}`,
metadata: {
...assetMetadataTemplate,
// Adding custom data just to test the flow
name: `anvil-api-${counter}`,
epoch: new Date().getTime(), // dummy data
},
policyId: get_policy_id(policyAnvilApi.mint_script),
quantity: 1,
});
The counter is used to be sure that the assetName
remains unique.
TBD: Show an example output (screenshot or link to preprod url or all of them)
The transaction
const data = {
changeAddress: customerWallet.enterprise_address_preprod,
mint: assets,
preloadedScripts: [
{
type: "simple",
script: policyAnvilApiScript,
hash: get_policy_id(policyAnvilApi.mint_script),
},
],
};
const urlTX =
"https://preprod.api.ada-anvil.app/v2/services/transactions/build";
const transactionToSignWithPolicyKey = await fetch(urlTX, {
method: "POST",
body: JSON.stringify(data),
headers: {
"Content-Type": "application/json",
"X-Api-Key": "testnet_EyrkvCWDZqjkfLSe1pxaF0hXxUcByHEhHuXIBjt9",
},
}).then((res) => res.json());
Sign with the policy wallet
// Sign transaction with policy key
const transactionToSignWithCustomerKey = FixedTransaction.from_bytes(
Buffer.from(transactionToSignWithPolicyKey.complete, "hex")
);
transactionToSignWithCustomerKey.sign_and_add_vkey_signature(
PrivateKey.from_bech32(policyWallet.skey)
);
Sign with the customer wallet
usually done using the browser extension
const txToSubmitOnChain = FixedTransaction.from_bytes(
Buffer.from(transactionToSignWithCustomerKey.to_hex(), "hex")
);
// This sign the tx and add vkeys to the txToSubmitOnChain, so in submit we don't need to provide signautres
txToSubmitOnChain.sign_and_add_vkey_signature(
PrivateKey.from_bech32(customerWallet.skey)
);
Submit Transaction
if (args.submit) {
const urlSubmit =
"https://preprod.api.ada-anvil.app/v2/services/transactions/submit";
const submitted = await fetch(urlSubmit, {
method: "POST",
body: JSON.stringify({
signatures: [], // This empty because the txToSubmitOnChain has the vkeys
transaction: txToSubmitOnChain.to_hex(),
}),
headers: {
"Content-Type": "application/json",
"X-Api-Key": "testnet_EyrkvCWDZqjkfLSe1pxaF0hXxUcByHEhHuXIBjt9",
},
}).then((res) => res.json());
console.debug(submitted);
} else {
console.log(txToSubmitOnChain.to_hex());
}
Using the CLI
deno compile --allow-read --allow-write --allow-net index.ts
Dont forget to increase the counter, otherwise you will double mint.
./index --expireDate=2025-01-01 \
--customerWalletPath=customer.json \
--policyWalletPath=policy.json \
--metadataTemplatePath=metatemplate.json \
--counter=2 \
--submit
Explorer
The Whole File (Deno Version)
Last updated
Was this helpful?