mint
Mint a token for a specified reference material on a contract of your choice. You need to have been given minting permission.
The reference material is typically uploaded to IPFS or Arweave and can be easily done through our
uploadReference method found in the storage module. Follow this guide to learn how to handle permanent uploads!Royalties can be configured to provide a customized flow of funds as explained below.
It is possible to configure the amount of copies you want to mint through the
amount field, but currently they will all share the same reference material.The nftContactId can be supplied as an argument or through the
TOKEN_CONTRACT environment variable.mint takes a single argument of type MintArgsexport type MintArgs = {
//the contractId from which you want to mint
//can be specified through CONTRACT_ADDRESS configuration / environment variables
contractAddress?: string;
//the intended owner of the token being minted
ownerId: string;
// metadata including title, description and reference materials
metadata: TokenMetadata;
options?: MintOptions;
noMedia?: boolean; // explicit opt-in to NFT without media, breaks wallets
noReference?: boolean; // explicit opt-in to NFT without reference
};
export type MintArgs = {
//the contractId from which you want to mint, this can be statically defined via the mbjs config file
contractAddress?: string;
//the intended owner of the token being minted
ownerId: string;
//on chain metadata, currently reference and media must be provided unless clearly opted out using the noMedia or noReference args
//the storage module returns the media hash to be provided to the media key in the metadata object when uploading as well as the referenceId which should be supplied to the reference key.
metadata: TokenMetadata;
//permanent royalties to be paid on every token sale provided in a Record of keys (accountIds) and values (amount)
//the royalty total is capped at 0.5 eg: {"test1.near" : 0.2, "test2.near": 0.3}
royalties?: Splits;
//amount of tokens with the same metadata you would like to mint
amount?: number;
// explicit opt-in to NFT without media, breaks wallets
noMedia?: boolean;
// explicit opt-in to NFT without reference
noReference?: boolean;
tokenIdsToMint?: number[];
};
export type TokenMetadata = {
title?: string;
description?: string;
media?: string;
media_hash?: string;
copies?: number;
issued_at?: string; // Stringified unix timestamp, according to
expires_at?: string; // standards this is milliseconds since epoch, but
starts_at?: string; // since `env::block_timestamp` is in nanoseconds
updated_at?: string; // most timestamps in the ecosystem are nanoseconds
extra?: string;
reference?: string;
reference_hash?: string;
}
Example usage of mint method in a hypothetical React component:
MintComponent.ts
1
import { useState } from 'react';
2
import { useWallet } from '@mintbase-js/react';
3
import { execute, mint, MintArgs } from '@mintbase-js/sdk';
4
5
6
export const MintComponent = ({ media, reference, contractAddress, owner }: MintArgs): JSX.Element => {
7
8
const { selector } = useWallet();
9
10
const handleMint = async (): Promise<void> => {
11
12
const wallet = await selector.wallet();
13
14
await execute(
15
mint({ contractAddress: contractAddress, metadata: { media, reference }, ownerId: owner })
16
);
17
18
}
19
20
return (
21
<div>
22
<button onClick={handleMint}>
23
Mint
24
</button>
25
</div>
26
);
27
};
Last modified 18d ago