GetCreateTokenInstructionsArgs

type GetCreateTokenInstructionsArgs = TokenInstructionBase<KeyPairSigner> & {
  decimals?: bigint | number;
  freezeAuthority?: Address | TransactionSigner;
  metadata: {
     isMutable: boolean;
     name: string;
     symbol: string;
     uri: string;
  };
  metadataAddress: Address;
  mintAuthority?: TransactionSigner;
  updateAuthority?: TransactionSigner;
};

Type declaration

Name	Type	Description
`decimals?`	`bigint` \| `number`	The number of decimal places this token should have Default `9` - the most commonly used decimals value
`freezeAuthority?`	`Address` \| `TransactionSigner`	Authority address that is able to freeze (and thaw) user owned token accounts. When a user's token account is frozen, they will not be able to transfer their tokens. When not provided, defaults to: `null`
`metadata`	{ `isMutable`: `boolean`; `name`: `string`; `symbol`: `string`; `uri`: `string`; }	Optional (but highly recommended) metadata to attach to this token
`metadata.isMutable`	`boolean`	Whether or not the onchain metadata will be editable after minting
`metadata.name`	`string`	Name of this token
`metadata.symbol`	`string`	Symbol for this token
`metadata.uri`	`string`	URI pointing to additional metadata for this token. Typically an offchain json file.
`metadataAddress`	`Address`	Metadata address for this token Examples For `TOKEN_PROGRAM_ADDRESS` use the getTokenMetadataAddress function: `metadataAddress: await getTokenMetadataAddress(mint.address);` For `TOKEN_2022_PROGRAM_ADDRESS` use the mint's address: `metadataAddress: mint.address;`
`mintAuthority?`	`TransactionSigner`	Authority address that is allowed to mint new tokens When not provided, defaults to: `feePayer`
`updateAuthority?`	`TransactionSigner`	Authority address that is allowed to update the metadata When not provided, defaults to: `feePayer`

GetCreateTokenInstructionsArgs

Type declaration

On this page