Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: added realminfo documentation #244

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

AlejandroAlvarezMelucciDCL
Copy link
Contributor

Added documentation to realm info protobuf definition

Copy link

github-actions bot commented Feb 4, 2025

Test this pull request

  • The @dcl/protocol package can be tested in scenes by running
    npm install "https://sdk-team-cdn.decentraland.org/@dcl/protocol/branch//dcl-protocol-1.0.0-13144139716.commit-c9761fd.tgz"

int32 network_id = 3; // the Ethereum network
string comms_adapter = 4; // comms adapter, removing all query parameters (credentials)
bool is_preview = 5; // true if the scene is running as a local preview, instead of published in Decentraland.
optional string room = 6; // the room session id.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm thinking of changing this to
optional string room = 6; // (internal use) the room session id.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think can be useful for Scene Developer to know if the clients are in the same room and they see each other

string base_url = 1; // the domain of the realm server
string realm_name = 2; // the name of the realm server
int32 network_id = 3; // the Ethereum network
string comms_adapter = 4; // comms adapter, removing all query parameters (credentials)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
string comms_adapter = 4; // comms adapter, removing all query parameters (credentials)
string comms_adapter = 4; // comms adapter (more info https://adr.decentraland.org/adr/ADR-180)

optional string room = 6;
optional bool is_connected_scene_room = 7;
string base_url = 1; // the domain of the realm server
string realm_name = 2; // the name of the realm server
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
string realm_name = 2; // the name of the realm server
string realm_name = 2; // the name of the realm server (more info https://adr.decentraland.org/adr/ADR-110)

optional bool is_connected_scene_room = 7;
string base_url = 1; // the domain of the realm server
string realm_name = 2; // the name of the realm server
int32 network_id = 3; // the Ethereum network
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
int32 network_id = 3; // the Ethereum network
int32 network_id = 3; // the network id (1=Ethereum, more info https://chainlist.org/)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants