Torii Pontos finais

Torii é o HTTP, SSE, e WebSocket porta de entrada Iroha 3. Serve tanto para o livro-razão APIs e pontos finais do operador.

As regras do protocolo em vigor são as seguintes:

• O formato binário canônico é Norito
• Muitos endpoints também suportam JSON quando você envia Accept: application/json
• As métricas são expostas no formato Prometheus

Para detalhes de formato, negociação de conteúdo, bandeiras de layout, hashes de esquema e Norito RPC orientação, ver o Norito Referência.

Pontos finais comuns

Ponto final .	Formatar	Propósito .
POST /transaction	Norito	Submeter uma transacção assinada
POST /query	Norito	Enviar uma consulta assinada
GET /events	WebSocket	Subscreva os fluxos de eventos
GET /block/stream	WebSocket	Fluxo de blocos comprometidos
GET /peers	JSON	Lista de pares expostas por Torii
GET /health	JSON	Endpoint de vida leve
GET /api_version	JSON	A versão padrão API
GET /status	JSON	Resumo de status de alto nível para os operadores
GET /metrics	Prometheus	Prometheus raspe endpoint
GET /schema	JSON	Impressão do esquema de modelo de dados servido pelo nó
GET /openapi ou GET /openapi.json	JSON	Documento OpenAPI para as rotas ativas Torii HTTP
GET /v1/parameters	JSON	Impressão de parâmetro do nó
GET /v1/node/capabilities	JSON	Capacidade do nodo e metadados do modelo de dados
GET /v1/api/versions	JSON	As versões Torii API suportadas
GET /v1/events/sse	SSE	Fluxo de eventos para clientes de longa duração
GET /v1/time/now	JSON	Snapshot do nó de relógio de parede
GET /v1/time/status	JSON	Situação de sincronização do tempo

/openapi é a lista de endpoint autorizada para um nó em execução. A superfície exata depende da criar recursos e configuração de tempo de execução, por isso os clientes gerados devem preferir o OpenAPI O documento sobre uma lista de rotas copiada à mão Torii API consola para carregar o documento ao vivo, teste JSON rotas, cópia curl solicitações, e gerar código do cliente a partir do esquema atual.

Experimente as rotas ao vivo Taira

A rede de teste pública Taira expõe a mesma superfície Torii JSON que os clientes de aplicações usam para exploração somente leitura. Estes comandos não exigem chaves:

TAIRA_ROOT=https://taira.sora.org

curl -fsS "$TAIRA_ROOT/status" \
  | jq '{blocks, txs_approved, txs_rejected, queue_size, peers}'

curl -fsS "$TAIRA_ROOT/openapi.json" \
  | jq -r '.paths | keys[]' \
  | grep '^/v1/' \
  | head -n 20

curl -fsS "$TAIRA_ROOT/v1/node/capabilities" \
  | jq '{abi_version, data_model_version, query: .query.aggregate.supported_resources}'

Experimente o recurso diz contra a atual situação mundial:

curl -fsS "$TAIRA_ROOT/v1/domains?limit=5" \
  | jq -r '.items[].id'

curl -fsS "$TAIRA_ROOT/v1/assets/definitions?limit=5" \
  | jq -r '.items[] | [.id, .name, .total_quantity] | @tsv'

Se uma rota de testnet pública retornar 502, temporizar ou relatar uma fila saturada, trate-a como um problema de disponibilidade do endpoint e tente novamente mais tarde antes de depurar o código do cliente.

Consenso e pontos finais do tempo de execução

Ponto final .	Formatar	Propósito .
GET /v1/sumeragi/commit-certificates	JSON	Resumos recentes dos certificados de compromisso
GET /v1/sumeragi/validator-sets	JSON	Histórico de configuração do validador
GET /v1/sumeragi/validator-sets/{height}	JSON	Validador definido a uma altura de bloco
GET /v1/sumeragi/status	Norito ou JSON	Imagem detalhada do estado de consenso
GET /v1/sumeragi/status/sse	SSE	Fluxo contínuo de status de consenso
GET /v1/sumeragi/leader	JSON	Informações atuais sobre os líderes
GET /v1/sumeragi/qc	Norito ou JSON	Último resumo do certificado de quórum
GET /v1/sumeragi/checkpoints	JSON	Resumo de pontos de controlo de consenso
GET /v1/sumeragi/consensus-keys	JSON	Chaves de consenso ativas
GET /v1/sumeragi/bls_keys	JSON	Técnicas de consenso activas BLS
GET /v1/sumeragi/phases	JSON	Última amostra de latência por fase
GET /v1/sumeragi/rbc	JSON	RBC métricas de sessão e de tráfego
GET /v1/sumeragi/rbc/sessions	JSON	Impressão de sessão ativa RBC
GET /v1/sumeragi/pacemaker	JSON	Estatuto do pacemaker
GET /v1/sumeragi/params	JSON	Parâmetros de corrente em cadeia Sumeragi
GET /v1/sumeragi/collectors	JSON	Impressão do plano de colecionador determinista
GET /v1/sumeragi/key-lifecycle	JSON	Status do ciclo de vida da chave de consenso
GET /v1/sumeragi/telemetry	JSON	Imagem de telemetria de consenso
GET /v1/sumeragi/evidence	JSON	Registros de provas, opcionalmente filtrados por cadeia de consulta
GET /v1/sumeragi/evidence/count	JSON	Contagem dos registos de evidências .
POST /v1/sumeragi/evidence/submit	JSON	Submeter provas de consenso
GET /v1/sumeragi/commit_qc/{hash}	Norito ou JSON	Cometer QC registro para um hash de bloco
GET /v1/runtime/abi/active	JSON	Descrição do tempo de execução ativo ABI
GET /v1/runtime/abi/hash	JSON	Atividade de execução ABI hash
GET /v1/runtime/metrics	JSON	Impressão de métricas de tempo de execução
GET /v1/runtime/upgrades	JSON	Lista de atualização do tempo de execução
POST /v1/runtime/upgrades/propose	JSON	Proponha uma atualização do tempo de execução .
POST /v1/runtime/upgrades/activate/{id}	JSON	Ativar uma proposta de atualização do tempo de execução
POST /v1/runtime/upgrades/cancel/{id}	JSON	Cancelar uma atualização de tempo de execução proposta

Aplicativo e SORA Famílias de rota

Quando Torii é construído com o conjunto de recursos voltados para aplicativos, ele expõe famílias adicionais JSON para exploradores, serviços SORA, fluxos de pontes, provas e armazenamento.

Família da rota	Propósito
/v1/accounts/*, /v1/domains/*, /v1/assets/*	JSON leituras, auxiliares de consulta, auxiliares para embarque e visualizações do portfólio ou dos titulares
/v1/nfts/*, /v1/rwas/*, /v1/confidential/*	NFT, ativos do mundo real e visões confidenciais de activos
/v1/aliases/*, /v1/assets/aliases/*, /v1/sns/*, /v1/identifiers/*	Nome, alias e resolução do identificador
/v1/explorer/*	Contas, ativos, blocos, transações, instruções, métricas e visualizações de fluxo orientadas para exploradores
/v1/transactions/*, /v1/pipeline/*, /v1/iso20022/*	Histórico de transacções, recuperação ou estado do gasoduto e ISO 20022 auxiliares
/v1/contracts/*	Código de contrato, implantação, pacote, chamada, visualização, evento, atividade, roll-up e rotas de estado
/v1/multisig/*, /v1/controls/*	Propostas, aprovações e auxiliares de controlo das transferências multisig
/v1/bridge/*, /v1/ledger/*, /v1/proofs/*	Finalidade, prova de estado, prova de bloco, retenção de provas e rotas de consulta de provas
/v1/da/*	Avaliabilidade de dados ingestão, manifestos, políticas de prova, compromissos e intenções pin
/v1/zk/*	ZK raízes, verificação de provas, comprovação de IVM, contagem de votos, chaves de verificação, registos de provas e anexos
/v1/gov/*, /v1/ministry/*	Propostas de governança, folhetos de votação, estado do conselho, espaços de nome protegidos, propostas de ordem do dia, promulgação e finalização.
/v1/nexus/*, /v1/sccp/*	Nexus faixa, espaço de dados, e auxiliares de prova cruzada.
/v1/musubi/*	Musubi leituras do registo de pacotes e construção de instruções
/v1/subscriptions/*	Planejamento de assinatura, ciclo de vida da assinatura, utilização e cobrança de assistentes
/v1/sorafs/*, /sorafs/*, /.well-known/sorafs/*	SoraFS descoberta do fornecedor, comprovação de capacidade, fixação, recolha de armazenamento e serviço público de conteúdo
/v1/soracloud/*, /v1/soradns/*, /soradns/*, /api/*	SoraCloud ciclo de vida do serviço, fluxos de computação privada/modelo, descoberta pública e roteamento de aplicativos hospedados
/v1/connect/*, /v1/vpn/*	Iroha Conectar sessões, WebSocket Transportes, VPN sessões, perfis e recibos
/v1/app-api/*, /v1/api/*, /v1/content/*	Aplicações API ligações e pacotes / roteamento de conteúdo apoiado em CID
/v1/operator/*, /v1/mcp	A autenticação do operador e a ponte nativa MCP JSON-RPC
/v1/offline/*, /v1/repo/*, /v1/space-directory/*, /v1/ram-lfe/*	Preparação offline, acordos de repositório, manifestos do espaço de dados e assistentes RAM-LFE
/v1/kaigi/*, /v1/webhooks/*, /v1/notify/*, /v1/telemetry/*	Colaboração, webhook, notificação push e integrações de telemetria ao vivo

Ponte ISO 20022

Torii expõe a ponte ISO 20022 sob /v1/iso20022/* quando estiver ativada a aplicação voltada para API e o tempo de execução da ponte. A ponte tem um alcance intencional: Não é um gateway de compensação ISO 20022 de finalidade geral, mas um subconjunto suportado para a transformação de mensagens de pagamento selecionadas em transferências assinadas Iroha e para o acompanhamento do seu status no livro-razão.

Torii ISO 20022 Pontos finais

Método e ponto final	Propósito
POST /v1/iso20022/pacs008	Submeter uma transferência de crédito do cliente FI para FI e construir a transferência de activos correspondente Iroha
POST /v1/iso20022/pacs009	Submeter uma transferência de crédito FI para FI utilizada para PvP ou financiamento em dinheiro relacionado a títulos
POST /v1/iso20022/pacs002	Enviar um relatório sobre o estado dos pagamentos
POST /v1/iso20022/pacs004	Enviar uma declaração de pagamento
POST /v1/iso20022/camt056	Enviar um pedido de cancelamento do pagamento
POST /v1/iso20022/sese023	Enviar uma instrução de liquidação de valores mobiliários
POST /v1/iso20022/sese024	Enviar uma mensagem sobre o status da liquidação de títulos
POST /v1/iso20022/sese025	Submeter uma confirmação de liquidação de títulos
POST /v1/iso20022/colr012	Enviar uma mensagem de substituição da garantia
GET /v1/iso20022/messages/{msg_id}	Leia o registro canônico da ponte para uma mensagem .
GET /v1/iso20022/audit/messages	Leia o manifesto de auditoria das mensagens .
GET /v1/iso20022/messages/{msg_id}/pacs002	Render o estado de pagamento em curso como pacs.002 XML
GET /v1/iso20022/messages/{msg_id}/pacs004	Retribuir a declaração de pagamento corrente como pacs.004 XML
GET /v1/iso20022/messages/{msg_id}/camt029	A resolução de cancelamento atual deve ser apresentada em camt.029 XML
GET /v1/iso20022/messages/{msg_id}/sese024	Render o estado atual da liquidação como sese.024 XML
GET /v1/iso20022/messages/{msg_id}/sese025	A confirmação da liquidação atual deve ser apresentada como sese.025 XML

pacs.008 As submissões devem fornecer a mensagem ID, montante da liquidação interbancária, moeda, data de liquidação, devedor e credor IBANs, e o devedor e credor BICs. Quando os dados de referência são configurados, a ponte verifica também o BIC, IBAN, e ISO 4217 travessas de moeda antes da transacção gerada entrar no gasoduto.

As declarações pacs.009 devem incluir a mensagem de negócios ID, a definição da mensagem ID, o tempo de criação, o montante do liquidação interbancária, a moeda, a data de liquidação. Agente de instrução e agente de instrução BICs, e devedor e credor IBANs. Se a mensagem incluir Purp, a ponte aceita atualmente apenas financiamento destinado a valores mobiliários: Purp=SECU.

Os pontos finais de apresentação pacs.008 e pacs.009 aceitam os envelopes XML ISO ou o formato de campo plano utilizado nos testes de ponte. Os campos opcionais SplmtryData podem inserir o livro-razão Iroha, Conta de origem e meta IDs ou endereços, e definição de ativo ID. A resposta é 202 Accepted com message_id, transaction_hash, status, pacs002_code, e o contexto do livro/conto/ativo resolvido.

Suporte adicional de parceria e mapeamento

A Comissão IVM ISO A assistente também valida e materializa as seguintes famílias de mensagens para envelope a validação, o mapeamento de liquidações ou a reconciliação para baixo. Torii rotas.

Família de mensagens	Apoio atual
head.001	Validação do cabeçalho da aplicação de negócios para os envelopes ISO, incluindo os campos BizMsgIdr, MsgDefIdr, tempo de criação e remetente/receptor opcionais BIC
pacs.007, pacs.028, pacs.029	Reversão do pagamento, pedido de status e resolução/análise do estado da investigação
pain.001, pain.002	Iniciação de pagamento do cliente e validação do relatório de estado de pagamento
camt.052, camt.053, camt.054	Relatório da conta, declaração e validação de notificações

Sessões Kaigi

Kaigi fornece salas de áudio / vídeo em tempo real pagas no SORA Nexus. Use-o quando um aplicativo precisa da criação de sessões apoiadas por contabilidade, mudanças de listagem, manifestos de relevo, sinalização criptografada e medição de uso em vez de manter todo o estado de conferência off-chain.

O ciclo de vida orientado para a contabilidade é:

• CreateKaigi: criar uma chamada sob um domínio e armazenar a sua política, cronograma, metadados e manifesto opcional de relay.
• JoinKaigi e LeaveKaigi: atualizar a lista de chamadas. No modo privado, os participantes utilizam compromissos, anuladores e provas da lista em vez de exporem diretamente a conta do participante IDs.
• RecordKaigiUsage: adicionar a duração medida e os totais dos gases.
• EndKaigi: fechar a sessão e registar o tempo final.

Torii expõe a telemetria de relevo no /v1/kaigi/relays, /v1/kaigi/relays/{relay_id}, /v1/kaigi/relays/health, e /v1/kaigi/relays/events quando o aplicativo API O estado da sessão é reflectido através do Kaigi eventos de domínio tais como KaigiRosterSummary, KaigiRelayManifestUpdated, KaigiRelayHealthUpdated, e KaigiUsageSummary.

Teste de fumo CLI

Em primeiro lugar, o iroha kaigi CLI deve ser utilizado para verificar se um ponto final Torii aceita transações Kaigi antes de ligar um UI. O comando quickstart cria uma sala temporária contra o endpoint ativo Torii e imprime um resumo com o identificador de chamada, o comando juntar-se e a sugestão do spool SoraNet:

iroha kaigi quickstart --auto-join-host --summary-out kaigi-summary.json

Para fluxos scripted, gerenciar o ciclo de vida da sala explicitamente:

iroha kaigi create \
  --domain streaming \
  --call-name daily \
  --host <i105-account-id> \
  --privacy-mode transparent \
  --room-policy authenticated

iroha kaigi join --domain streaming --call-name daily --participant <i105-account-id>
iroha kaigi leave --domain streaming --call-name daily --participant <i105-account-id>

iroha kaigi record-usage \
  --domain streaming \
  --call-name daily \
  --duration-ms 120000 \
  --billed-gas 1500

iroha kaigi end --domain streaming --call-name daily

Utilização --room-policy public para salas que os relés possam expor sem ingressos de espectador, ou --room-policy authenticated Quando as saídas devem exigir a autenticação do espectador. --privacy-mode zk-roster-v1 Só depois que a rede tiver Kaigi Chaves de verificação da lista e do uso configuradas; juntas, folhas, e os registos privados de utilização falham durante a verificação determinista.

Testes com a demonstração JavaScript

Use a demonstração de desktop soramitsu/iroha-demo-javascript para um teste de carteira de ponta a ponta. A demonstração é uma aplicação Electron e Vue que conversa diretamente com Torii através da ligação local @iroha/iroha-js e inclui uma rota /kaigi para mídia nativa do navegador de um a um .

Use a demonstração com @iroha/iroha-js do repositório de origem Iroha. Os pinos da demonstração são SDK até file:../iroha/javascript/iroha_js, então mantenha ambos os cheques neste layout:

mkdir iroha-wallet-workspace
cd iroha-wallet-workspace
git clone https://github.com/hyperledger-iroha/iroha.git
git clone https://github.com/soramitsu/iroha-demo-javascript.git

cd iroha/javascript/iroha_js
npm install
npm run build:native
npm run build:dist

cd ../../../iroha-demo-javascript
npm install
npm run dev

Use Node.js 20 ou mais recente e uma cadeia de ferramentas Rust para que o módulo nativo iroha_js_host possa ser construído. Reconstruir a SDK na caixa irmã Iroha após mudar sua fonte; o layout do pacote limpo não contém o espaço de trabalho Cargo necessário por npm run build:native.

Para um ensaio controlado, aponte a demonstração para um ponto final Kaigi capaz de Torii:

1. Inicie um nó Iroha com o aplicativo SORA/Kaigi voltado para APIs habilitado, ou use um ponto final público que expõe as superfícies Kaigi de que precisa.

2. Verifique a acessibilidade básica com /health, em seguida, verifique a superfície da rota ao vivo com /openapi ou /openapi.json. Algumas implementações também expõem /v1/health, mas /health é o controle de vida portátil. .

3. Para TAIRA, verifique as rotas de telemetria do relevo antes de tentar uma reunião ao vivo:

   TAIRA=https://taira.sora.org
   curl -fsS "$TAIRA/health"
   curl -fsS "$TAIRA/v1/kaigi/relays"
   curl -fsS "$TAIRA/v1/kaigi/relays/health"

Estas verificações comprovam que a telemetria de relevo Torii e Kaigi são acessíveis. Não criam uma reunião; CreateKaigi e JoinKaigi ainda precisam de carteiras financiadas e apresentação assinada de transacções. 4. Abra a demonstração, vá para Configurações, configure o Torii URL e deixe que o aplicativo carregue a cadeia ID e prefixo de rede do ponto final. 5. Criar ou restaurar duas carteiras locais na demonstração. Use janelas de aplicativos separadas, perfis ou máquinas para que o anfitrião e o convidado tenham estado de carteira separado.

Para testar o Kaigi UI:

1. Na janela de hospedagem, abra Kaigi, escolha Iniciar reunião, defina um título e selecione Convite Privado ou Convite Transparente.
2. Selecione Ligue a câmera e o microfone para que WebRTC tenha mídia local.
3. Selecione Criar um link de reunião. Uma carteira ao vivo envia CreateKaigi; o aplicativo mostra então um convite iroha://kaigi/join?call=...&secret=... e uma rota de retorno #/kaigi?....
4. Mantenha a janela do anfitrião aberta e compartilhe o convite com o convidado.
5. Na janela de convidados, abra o convite ou coje-o na reunião Join, ative a mídia local e selecione Join meeting. Uma carteira ao vivo retira a oferta criptografada do host da Torii e envia a JoinKaigi com metadados criptografados da resposta.
6. O anfitrião deve aplicar automaticamente a primeira resposta através da transmissão ou pesquisa de sinais de chamada Kaigi. Ambas as janelas devem mostrar mídia conectada e detalhes de conexão atualizados.
7. Terminar a sessão do anfitrião, ou usar o comando CLI iroha kaigi end para a mesma ligação ID.

As necessidades privadas Kaigi protegidas XOR para pagar a taxa do ponto de entrada privado. Se a demonstração relatar que as necessidades privativas Kaigi protegidas XOR, use o prompt auto-proteção no aplicativo e tente novamente a ação criar ou participar. Se a geração de provas, financiamento privado ou sinalização ao vivo não estiver disponível, a demonstração pode voltar para um fluxo transparente / manual. Nesse caso, abra a sinalização avançada, copie a oferta crua ou o pacote de resposta e colete-o na outra janela.

Para verificações automatizadas no repo de demonstração, executar:

npm test -- tests/kaigiView.spec.ts tests/preloadKaigiBridge.spec.ts
npm run e2e:ui
npm run verify

As suítes Vitest focadas cobrem a criação de links de reunião Kaigi, carregamento compacto de convites, chamadas privadas de ponte de criação / junção / final, pedidos de auto-escudo, fallbacks manuais e pesquisas de resposta. O teste de fumaça UI inclui a rota /kaigi em portos de vista de desktop e móveis. Os meios de comunicação ao vivo entre duas carteiras ainda precisam de um teste manual de duas janelas porque as permissões da câmera/microfone do navegador e os fluxos de mídia peer são específicos para o ambiente.

Para o código de integração da amostra, veja Embed Kaigi em um aplicativo JavaScript .

Estatuto e métricas

Os endpoints de status e métricas são as primeiras coisas a ser incorporadas em painéis de controlo:

• /status expõe campos de peer, bloco, fila e consenso de nível superior
• /metrics expõe contadores Prometheus, medidores e histogramas.

Em nós habilitados para Nexus, a saída de status também inclui seções conscientes da faixa e do espaço de dados. Quando nexus.enabled = false, essas secções são omitidas.

JSON versus Norito

Vários endpoints do operador retornam Norito por padrão. Quando o endpoint suporta JSON, envie:

Accept: application/json

Isto é especialmente útil para:

• /v1/sumeragi/status
• /v1/sumeragi/qc
• /v1/sumeragi/commit_qc/{hash}

Quando um ponto final aceita ou retorna digitado Norito diretamente, utilização application/x-norito como o tipo de conteúdo ou preferido Accept valor. Veja Norito para os pormenores de transporte.

Perfis de telemetria

A visibilidade dos endpoints depende da configuração telemetry.profile do nó. A configuração atual expõe cinco níveis de perfil:

Perfil .	/status	/metrics	Rutas de desenvolvimento
disabled	não	não	não
operator	sim	não	não
extended	sim	sim	não
developer	sim	não	sim
full	sim	sim	sim

CLI Curta-metragens

O iroha CLI já envolve muitos destes pontos finais:

iroha --config ./localnet/client.toml --output-format text ops sumeragi status
iroha --config ./localnet/client.toml --output-format text ops sumeragi phases
iroha --config ./localnet/client.toml ops sumeragi params
iroha --config ./localnet/client.toml --output-format text ops sumeragi telemetry

Referências a montante

• README API e visão geral da observabilidade
• ISO Implementação da ponte de 20022
• Desempenho e métricas