Skip to content

A remote procedure call (RPC) function generator for the Nakama server 🌐🔗🖥️. A template to help users of the nakama server write backend server code⭐⭐

Notifications You must be signed in to change notification settings

AnthonyAniobi/Nakama_RPC

Repository files navigation

Nakama RPC

This is a script for generating Remote Procedure Calls in nakama.

This project was inspired by my need to update wallet details in nakama. The wallet can only be updated using RPC calls which can be triggered by the client. You can work with the RPC calls using the nakama api explorer

Current RPC functions available

  • Wallet
  • Health Check

How to use

To use the RPC as it is (without any changes) follow the instructions below

  1. copy the index.js in the build folder
  2. paste the index.js file in the module folder in your nakama folder
  3. you can start the nakama server as usual

If you would like to make some changes to the RPC, read the instructions below and then run the command:

sudo docker-compose up

this generates the build/index.js file using this file repeat the instructions above

Wallet RPC

The source code for this function is found in backend/walletupdate.ts. Feel free to edit it as you wish.

Note:

while editing the wallet RPC note that the changeset contains data that would be sent to the wallet data storage. The current file uses a token for wallet data

using wallet in API Expolorer

  1. find the walletupdate function in the api explorer
  2. Paste the user id in the 'user id request form'
  3. add the payload
    {
    "token": -25
    }
    
  4. Click on the send request button
  5. on sucessful update of the wallet it returns
    {
    "title": "successful",
    "data": {
        "token": -25
    }
    }
    
  6. you have sucessfully updated your wallet token

Health Check RPC

This is a sample RPC created by Heroic Labs. This is a simple RPC that does not take any input, but returns a json on sucessful implementation. The sucess message is shown below

{
  "success": true
}

You can update the healthcheck code and it can be found in backend/healthcheck.ts.

using wallet in API Expolorer

  1. find the healthcheck function in the api explorer
  2. Paste the user id in the 'user id request form'
  3. Click on the send request button
  4. the successful message is shown on the screen

Screenshots

Wallet RPC request

About

A remote procedure call (RPC) function generator for the Nakama server 🌐🔗🖥️. A template to help users of the nakama server write backend server code⭐⭐

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published