Package Exports
- candy-machine-assistant
- candy-machine-assistant/lib/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (candy-machine-assistant) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
candy-machine-assistant
An NPM package which provides functions to connect with Solana's NFT mint accounts, generate PDAs, get candy machine state, send transactions, retrieve collection data, get Token MetaData easier by avoiding writing boilerplate code. This streamlines the interactions with a deployed candy machine.
In this extract,
candyMachine has an interface CandyMachineAccount given by
interface CandyMachineAccount {
id: anchor.web3.PublicKey;
program: anchor.Program;
state: CandyMachineState;
}All other type interfaces are instances from @solana/web3.js
The most utilized examples are given below :
getAtaForMint() :
const userTokenAccountAddress = (
await getAtaForMint(
mint.publicKey,
payer)
)[0];
// Generates the Associated Token Account Address given a mint and walletAddress.
getCandyMachineState() :
const cndy = await getCandyMachineState(
anchorWallet: anchor.Wallet,
candyMachineId: anchor.web3.PublicKey,
connection: anchor.web3.Connection,
);
// Returns the state of the candy machine.
sendTransaction() :
await sendTransaction(
connection: Connection,
wallet: any,
instructions: TransactionInstruction[] | Transaction,
signers: Keypair[],
awaitConfirmation = true,
commitment: Commitment = "singleGossip",
includesFeePayer: boolean = false,
block?: BlockhashAndFeeCalculator,
);
// Sends a transaction to the blockchain given a set of parameters, returns void.
getCollectionPDA() :
const [collectionPDA] = await getCollectionPDA(
candyMachineAddress
);
// Returns the Program Derived Address of the collection given a Candy Machine ID.
mintOneToken() :
const mintResult = await mintOneToken(
candyMachine,
walletAddress.publicKey,
beforeTransactions,
afterTransactions,
setupMint ?? setupTxn
);
// Returns a MintResult, given parameters and returns Mint Transaction ID and a Metadata Key.
createAccountsForMint() :
let setupMint = await createAccountsForMint(
candyMachine,
walletAddress.publicKey
);
// Returns the setup state of the account i.e. = {
mint: anchor.web3.Keypair;
userTokenAccount: anchor.web3.PublicKey;
transaction: string;
}
awaitTransactionSignatureConfirmation() :
await awaitTransactionSignatureConfirmation(
setupMint.transaction,
txTimeout,
connection,
true
);
// Takes in a Transaction Signature, a timeout, a connection and queryStatus
// returns the slot, amount of confirmations, errors if any and the confirmation status.
shortenAddress():
const sliced = shortenAddress("35YzKveuqytHjgmgmKgXHi295t7LkDGRCm3xN12tCwRY",4)
// 35Yz...CwRY , i.e. returns a sliced solana wallet addres in the given format
getMetadataPDA();
const metadataPDA = await getMetadataPDA(mint.publicKey);
// Takes in a Public Key mint and returns the Metadata Program Derived Address associated with it
Example project : JokerMania