n8n-nodes-token-creator
v0.1.6
Published
n8n community node to interact with Finchain Token Creator using the official SDK
Maintainers
Readme
n8n-nodes-token-creator
Community node para integrar o Finchain Token Creator com o n8n, usando o SDK oficial finchain-token-creator.
Com este node você pode:
- Criar (deploy) novos tokens (ERC20 / ERC721) em diferentes redes
- Listar tokens da sua conta Finchain Token Creator
- Fazer mint de tokens (fungíveis e NFTs)
- Transferir e queimar tokens
- Consultar status de transações e histórico de ações de um token
Criado por Evens Taian.
Requisitos
- n8n 1.x ou superior
- Conta no Finchain Token Creator
- Credenciais de API válidas (
apiKeyeapiSecret)
Instalação
Na pasta de instalação do n8n (ou Docker volume com os nodes personalizados):
npm install n8n-nodes-token-creatorDepois reinicie o n8n para que o novo node seja carregado.
Configuração das credenciais
Este pacote adiciona o tipo de credencial:
- Finchain Token Creator API (
finchainTokenCreatorApi)
Campos:
- API Key – sua API Key obtida no painel do Finchain Token Creator
- API Secret – seu API Secret correspondente
Como configurar:
- No n8n, acesse Settings → API Credentials.
- Clique em New e selecione Finchain Token Creator API.
- Informe
API KeyeAPI Secret. - Salve e use esta credencial nas instâncias do node Finchain Token Creator.
O node chama internamente:
await FTC.config({
apiKey: 'YOUR_API_KEY',
apiSecret: 'YOUR_API_SECRET',
});antes de executar qualquer operação.
Visão geral do node
Nome do node: Finchain Token Creator
Credencial: Finchain Token Creator API
Resources
- Token
- Action
Cada resource possui um conjunto de operações mapeadas diretamente para o SDK oficial.
Resource: Token
Operation: Deploy
Cria e faz o deploy de um novo token.
Internamente chama:
FTC.tokens.deploy(
FTC.types.STANDARD[standard],
FTC.types.NETWORK[network],
FTC.types.CLASS_IDENTIFIER[classIdentifier],
payload,
);Parâmetros:
- Standard (
standard)ERC20ERC721
- Network (
network)XRPL_TESTNETBSC_TESTNETAMOY_TESTNETBSCETHEREUMPOLYGON
- Class Identifier (
classIdentifier)UTILITY_TOKENREWARDS_TOKENPAYMENT_TOKENFAN_SPORT_TOKENRWA_TOKENREFI_TOKENDEFI_TOKEN
- Name (
name) – nome do token (obrigatório) - Symbol (
symbol) – ticker/símbolo do token (obrigatório) - Description (
description) – descrição do token - Quantity (
quantity) – supply total (obrigatório paraERC20, string) - Company Name (
companyName) – nome da empresa/projeto (obrigatório) - Icon Binary Property (
iconBinaryProperty) – nome da propriedade binária que contém o ícone (opcional)
Sobre o ícone:
- Se você fornecer
iconBinaryProperty, o node:- Lê o binário do item de entrada
- Converte para
Buffer - Define
payload.icon = buffer
- Isso é compatível com o uso descrito no README do SDK (ícone como
Buffer/stream).
Operation: List
Lista tokens da sua conta Finchain Token Creator.
Internamente chama:
FTC.tokens.list(page, limit);Parâmetros:
- Page (
page) – página (padrão:1) - Limit (
limit) – quantidade por página (padrão:1000)
Retorno:
O node retorna o JSON exatamente como recebido do SDK (incluindo campos como hashId, address, imgUrl, name, ticker, supply, network, type, scanUrl, created_at, status, actions, etc.).
Operation: Mint
Faz mint de tokens fungíveis (ERC20) ou itens NFT (ERC721).
Internamente chama:
FTC.tokens.mint(
tokenAddress,
amount,
to,
tokenItemName?, // opcional
file?, // opcional
);Parâmetros:
- Token Address (
tokenAddress) – endereço do token - Amount (
amount) – quantidade para mint - To Address (
to) – endereço de destino - Token Item Name (
tokenItemName, opcional)- Necessário quando você envia arquivo para NFT
- Binary Property (NFT File) (
nftBinaryProperty, opcional)- Nome da propriedade binária que contem o arquivo a ser associado (NFT)
Comportamento:
- Se
nftBinaryPropertyfor informado:- O node lê o binário e converte em
Buffer - Chama
FTC.tokens.mint(tokenAddress, amount, to, tokenItemName, fileBuffer)
- O node lê o binário e converte em
- Se não houver arquivo:
- Chama
FTC.tokens.mint(tokenAddress, amount, to)para fungíveis.
- Chama
Operation: Transfer
Transfere tokens para outro endereço.
Internamente chama:
FTC.tokens.transfer(tokenAddress, amount, to);Parâmetros:
- Token Address (
tokenAddress) - Amount (
amount) - To Address (
to)
Operation: Burn
Queima (burn) tokens.
Internamente chama:
FTC.tokens.burn(tokenAddress, amount);Parâmetros:
- Token Address (
tokenAddress) - Amount (
amount)
Resource: Action
Operation: Get Status
Consulta o status de uma ação/transação pelo hashId.
Internamente chama:
FTC.actions.status(hashId);Parâmetros:
- Hash ID (
hashId)
Operation: Get Transactions
Lista as transações de um determinado token.
Internamente chama:
FTC.actions.transactions(tokenAddress, type?, page?, limit?);Parâmetros:
- Token Address (
actionTokenAddress) – endereço do token - Type (
actionType)""(Any)MINTTRANSFERBURN
- Page (
actionPage) – página (padrão:1) - Limit (
actionLimit) – limite (padrão:1000)
Exemplos de uso no n8n
1. Deploy de um novo token ERC20
- Crie um workflow.
- Adicione o node Finchain Token Creator.
- Configure:
- Credentials: sua
Finchain Token Creator API. - Resource:
Token - Operation:
Deploy - Standard:
ERC20 - Network: por exemplo
BSC_TESTNET - Class Identifier:
UTILITY_TOKEN - Name:
MyToken - Symbol:
MTK - Description:
My utility token - Quantity:
1000000 - Company Name:
My Company - (Opcional) Icon Binary Property se quiser enviar ícone.
- Credentials: sua
- Execute o node; a resposta incluirá os detalhes do token criado.
2. Mint de tokens ERC20
- Use o mesmo workflow ou outro.
- Adicione Finchain Token Creator:
- Resource:
Token - Operation:
Mint - Token Address: endereço do token ERC20
- Amount:
1000 - To Address: endereço de destinatário
- Resource:
- Execute o node.
3. Mint de NFT (ERC721) com arquivo
- Adicione um node que carregue um arquivo (por ex. HTTP Request → Binary, ou Read Binary File).
- No node Finchain Token Creator:
- Resource:
Token - Operation:
Mint - Token Address: endereço do contrato ERC721
- Amount:
1 - To Address: endereço do destinatário
- Token Item Name:
My NFT Item - Binary Property (NFT File): nome da propriedade binária (ex.:
data)
- Resource:
- Execute; o node enviará o
Bufferdo arquivo para o SDK.
4. Consultar status de uma ação
- Adicione Finchain Token Creator:
- Resource:
Action - Operation:
Get Status - Hash ID:
HASH_IDretornado em alguma ação anterior.
- Resource:
- Execute para obter o status atualizado.
Tratamento de erros
- Se houver falha em qualquer chamada ao SDK (ex.: credenciais inválidas, parâmetros faltando, erro de rede):
- Com Continue On Fail ativado no node:
- O item retorna um JSON com
{"error": "<mensagem de erro>"}.
- O item retorna um JSON com
- Com Continue On Fail desativado:
- O workflow interrompe e mostra o erro no painel de execução.
- Com Continue On Fail ativado no node:
Desenvolvimento local
Se quiser ajustar o node localmente:
# Na pasta do projeto
npm install
npm run buildOs arquivos compilados serão gerados em dist/, de acordo com a configuração do tsconfig.json.
Licença
- Este pacote é disponibilizado sob a licença MIT.
- O SDK oficial
finchain-token-creatortambém é licenciado sob MIT.
Autor
- Evens Taian
- NPM:
evenstaian - Projeto Finchain Token Creator: tokencreator.finchain.com.br
