Este é o SDK oficial para interagir com a API do Gateway da PaymeChain a partir de qualquer ambiente JavaScript (Node.js, navegadores, etc.).

O SDK é construído para ser leve e agnóstico de framework, fornecendo uma maneira simples de consumir todos os endpoints RESTful expostos pelo DE.Payme.Gateway.Api.

Funcionalidades

• Leve e Agnóstico: Sem dependências de Node.js ou de frameworks de frontend. Funciona em qualquer lugar.
• API Completa: Fornece acesso a todos os endpoints do Gateway, organizados por serviço.
• Fácil de Usar: Uma interface simples e intuitiva para interagir com a blockchain através do Gateway.
• Baseado em Promises: Todas as chamadas de API retornam Promises, facilitando o uso com async/await.

Instalação

npm install @paymechain/sdk

Como Usar

1. Importar e Configurar

Primeiro, importe o PaymeClient e crie uma instância, fornecendo a URL base do seu DE.Payme.Gateway.Api.

import { PaymeClient } from '@paymechain/sdk'; // ou o caminho local, ex: './src'

// A única configuração necessária é a URL do seu Gateway
const config = {
  gatewayUrl: 'https://localhost:44397', // Altere para a URL do seu ambiente
};

// Crie uma instância do cliente
const paymeClient = new PaymeClient(config);

// O cliente está pronto para ser usado!

2. Usando os Serviços

Após a instanciação, todos os serviços estão disponíveis como propriedades do paymeClient.

Exemplo: Buscar informações de uma conta

async function getAccountInfo(address: string) {
  try {
    const account = await paymeClient.account.getAccountInfo(address);
    console.log("Endereço:", account.Address);
    console.log("Sequência:", account.Sequence);
  } catch (error) {
    console.error(`Erro ao buscar conta ${address}:`, error.message);
  }
}

Exemplo: Criar uma nova carteira

async function createNewWallet() {
  try {
    const newWallet = await paymeClient.wallet.createWallet();
    console.log("Carteira Criada!");
    console.log("Mnemonic:", newWallet.Mnemonic);
    console.log("Endereço:", newWallet.Address);
  } catch (error) {
    console.error("Erro ao criar carteira:", error.message);
  }
}

// Exemplo de chamada
createNewWallet();

Serviços Disponíveis

O paymeClient oferece acesso aos seguintes serviços, que correspondem diretamente aos controllers da API do Gateway:

• paymeClient.account
• paymeClient.block
• paymeClient.explorer
• paymeClient.lightClient
• paymeClient.staking
• paymeClient.statistics
• paymeClient.token
• paymeClient.transaction
• paymeClient.validator
• paymeClient.wallet