> For the complete documentation index, see [llms.txt](https://docs.decentraland.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.decentraland.org/contributor/contributor-pt/comunicacoes/tipos-de-transporte/websocket.md). # WebSocket O transporte websocket é um dos transportes de mensagens da ilha suportados pelo protocolo de comms do Decentraland. Os clientes devem usá-lo quando receberem uma connection string apropriada do realm de seu [Archipelago](https://github.com/decentraland/docs/tree/main/contributor/archipelago/README.md) service, ou se estiver indicado como um transporte fixo. No contexto do transporte websocket, uma ilha é chamada de *sala*. Ambos os nomes indicam a mesma coisa: um grupo de jogadores próximos que trocam atualizações e chat. As connection strings começam com o `ws-room:` prefixo, seguido por uma `wss://` URI para a sala específica. Elas se parecem com isto: ``` ws-room:wss://comms.example.com/rooms/ ``` Na ausência de um protocolo explícito para a URI websocket, `wss://` é assumido. ### Conectando O transporte usa o protocolo websocket regular sobre HTTPS. Os clientes podem abrir uma conexão usando qualquer implementação padrão à sua disposição. ### Pacotes Websocket Todas as mensagens do transporte websocket são serializadas usando a [`WsPacket`](https://github.com/decentraland/protocol/blob/c48ea0aa00d8173084571552463a6a05a7f49636/proto/decentraland/kernel/comms/rfc5/ws_comms.proto#L78) estrutura. Elas implementam um conjunto de mensagens de conectividade e autenticação em nível de protocolo, além de um tipo contêiner para mensagens de cliente. {% hint style="info" %} O [`WsPacket`](#WsPacket) estrutura não deve ser confundida com a mensagem \[`Packet`]\[Packet]. É uma camada adicional de encapsulamento específica do transporte websocket. As mensagens reais de comms estão contidas no [`WsPeerUpdate`](#WsPeerUpdate) tipo. {% endhint %} | Campo | Tipo | Valor | | --------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `message` | `enum` |

Um de WsIdentification, WsChallengeRequired, WsSignedChallenge,
WsWelcome, WsPeerJoin, WsPeerLeave, WsKicked ou WsPeerUpdate.

| ### Autenticação Antes de começarem a retransmitir mensagens para outros, os clientes devem se autenticar assinando uma string de desafio. Isso é necessário mesmo quando a URI do transporte foi obtida de [Archipelago](https://github.com/decentraland/docs/tree/main/contributor/archipelago/README.md) após uma rodada anterior de autenticação. A primeira mensagem que um cliente envia ao entrar em uma ilha é [`WsIdentification`](https://github.com/decentraland/protocol/blob/c48ea0aa00d8173084571552463a6a05a7f49636/proto/decentraland/kernel/comms/rfc5/ws_comms.proto#L64), que contém um endereço público. Ele receberá como resposta [`WsChallengeRequired`](#WsChallengeRequired), e os clientes enviam um [`WsSignedChallenge`](#WsSignedChallenge) em resposta. ``` .----------. .--------. | Servidor | | Cliente | '----+-----' '---+----' ⋮ | ⋮ Conectar | o - - - - - - - - - - - - -| | | | | | WsIdentification | |<-------------------------+ +------------------------->| | WsChallengeRequired | | | | | | WsSignedChallenge | |<-------------------------+ +------------------------->| | WsWelcome | | | ``` Se o fluxo for concluído com sucesso, o cliente receberá um [`WsWelcome`](#WsWelcome) e poderá começar a enviar mensagens para os peers. *** **`WsIdentification`** [**↗ fonte**](https://github.com/decentraland/protocol/blob/c48ea0aa00d8173084571552463a6a05a7f49636/proto/decentraland/kernel/comms/rfc5/ws_comms.proto#L64) | Campo | Tipo | Valor | | --------- | -------- | ----------------------------------------- | | `address` | `string` | O endereço público de Ethereum do cliente | *** **`WsChallengeRequired`** [**↗ fonte**](https://github.com/decentraland/protocol/blob/c48ea0aa00d8173084571552463a6a05a7f49636/proto/decentraland/kernel/comms/rfc5/ws_comms.proto#L48) | Campo | Tipo | Valor | | ------------------- | -------- | ---------------------------------------------------------------------------------------------- | | `challenge_to_sign` | `string` | A string fornecida pelo servidor para ser assinada como prova de identidade | | `already_connected` | `string` | Uma dica do servidor para os clientes, indicando que conexões anteriores podem ser encerradas. | *** **`WsSignedChallenge`** [**↗ fonte**](https://github.com/decentraland/protocol/blob/c48ea0aa00d8173084571552463a6a05a7f49636/proto/decentraland/kernel/comms/rfc5/ws_comms.proto#L56) | Campo | Tipo | Valor | | ----------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `auth_chain_json` | `string` | Serializado [serializada em JSON](https://github.com/decentraland/docs/tree/main/auth/authchain/README.md) serializada em JSON, terminando com a assinatura do desafio. | *** **`WsWelcome`** [**↗ fonte**](https://github.com/decentraland/protocol/blob/c48ea0aa00d8173084571552463a6a05a7f49636/proto/decentraland/kernel/comms/rfc5/ws_comms.proto#L11) | Campo | Tipo | Valor | | ----------------- | --------------------- | ---------------------------------------------------------- | | `alias` | `uint32` | Um ID gerado pelo servidor para a sessão do cliente | | `peer_identities` | `map` | Os endereços de todos os peers atuais, indexados por alias | ### Conectividade Três mensagens são definidas para ajudar os clientes a acompanhar seus peers e seu próprio status. [`WsPeerJoin`](#WsPeerJoin) é recebida quando outro cliente se conecta à sala e se autentica com sucesso, enquanto [`WsPeerLeave`](#WsPeerLeave) é recebida quando os peers se desconectam. Há também a [`WsKicked`](#WsKicked) mensagem, que informa os clientes de que sua conexão está prestes a ser encerrada e o motivo disso. Na prática atual, o principal motivo pelo qual um servidor pode expulsar um cliente de uma sala é porque ele se conectou simultaneamente a outra sala, quando isso é proibido pela política do servidor. *** **`WsPeerJoin`** [**↗ fonte**](https://github.com/decentraland/protocol/blob/c48ea0aa00d8173084571552463a6a05a7f49636/proto/decentraland/kernel/comms/rfc5/ws_comms.proto#L19) | Campo | Tipo | Valor | | --------- | -------- | -------------------------------------------------------------- | | `alias` | `uint32` | O ID gerado pelo servidor enviado em [`WsWelcome`](#WsWelcome) | | `address` | `string` | O endereço Ethereum do novo peer | *** **`WsPeerLeave`** [**↗ fonte**](https://github.com/decentraland/protocol/blob/c48ea0aa00d8173084571552463a6a05a7f49636/proto/decentraland/kernel/comms/rfc5/ws_comms.proto#L27) | Campo | Tipo | Valor | | ------- | -------- | ---------------------------------------------- | | `alias` | `uint32` | O ID gerado pelo servidor do peer desconectado | *** **`WsKicked`** [**↗ fonte**](https://github.com/decentraland/protocol/blob/c48ea0aa00d8173084571552463a6a05a7f49636/proto/decentraland/kernel/comms/rfc5/ws_comms.proto#L74) | Campo | Tipo | Valor | | -------- | -------- | --------------------------------------------------------------- | | `reason` | `string` | A explicação do servidor sobre por que a conexão será encerrada | ### Mensagens do client Para enviar comms [mensagens](https://github.com/decentraland/docs/tree/main/contributor/messages/README.md), os clientes os envolvem na [`WsPeerUpdate`](#WsPeerUpdate) estrutura. Isso diferencia os tipos de mensagens de controle do transporte das mensagens reais enviadas entre peers. ``` .-------------------. | WsPacket | | .--------------. | | | WsPeerUpdate | | | | .----------. | | | | | Packet | | | | | '----------' | | | '--------------' | '-------------------' ``` *** **`WsPeerUpdate`** [**↗ fonte**](https://github.com/decentraland/protocol/blob/c48ea0aa00d8173084571552463a6a05a7f49636/proto/decentraland/kernel/comms/rfc5/ws_comms.proto#L34) | Campo | Tipo | Valor | | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- | | `from_alias` | `uint32` | O ID gerado pelo servidor do remetente | | `body` | `bytes` | O serializado [message](https://github.com/decentraland/docs/tree/main/contributor/messages/README.md) sendo envolvido | | `não confiável` | `bool` | Se o remetente priorizou velocidade ou confiabilidade ao entregar esta mensagem | Os clientes devem definir o `from_alias` campo para `0` ao enviar, e o servidor o preencherá com o identificador correto antes de entregá-lo aos peers. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.decentraland.org/contributor/contributor-pt/comunicacoes/tipos-de-transporte/websocket.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.