Ryder Simulator Tutorial
Setting up the Ryder Simulator on Windows 10
TLDR:
Ryder, a user-centric hardware wallet with the ambition of being an easy-to-use device focused on authentication rather than just fund storage, has released a software simulator to give anyone the opportunity to develop apps before their device is officially released. This tutorial provides a guide on how to set up the simulator and get going in creating your own app.
Intro
Based on a Maker's approach, Ryder is a hardware wallet pioneering a new type of market for hardware-based key storage. Started on the belief that key management needs to be made intuitive for the wider adoption of Web3 and dApps.
Hardware wallets available today are mostly focused on either trading or the hodle use case. Where security is of course paramount, but often comes at the cost of ease of use. Ryder is rather putting the use case of Decentralized Identities (DID) front and center.
While managing funds will be possible Ryder is more focused on a device that you bring with you and use throughout the day. Building on a bold vision for the future Ryder believes that keys and DIDs will be used in all transactions no matter if it's managing your saving, accessing your office, or store your commute credits. With the improved user experience of integrating DID into services, Ryder sees safe and human-centered key management as an important building block to making DID and dApps available for everyone.
For those familiar with it, it might not come as a surprise that Ryder is started by some of the key figures from the stacks.co project. Often mentioned as an ETH competitor, Stacks has a grander vision of being the protocol for own-your-data-apps with minimum disruption to existing web UX. In the Stacks protocol, the DID is central and given its almost stealth integration into existing web apps the need for a similar sleek solution for safe key management is just equally obvious as the need for the stacks.co project itself….
The new Ryder simulator gives anyone the opportunity to get going developing apps and integrate the device to their service even before the wider release of the V 3 device.
Pre-requisite
Since this is a tutorial for the Windows version you need to run 64-bit Windows 10.
A recent version of Node is needed. Files and guide on how to install Node can be found here
Setting up Node should be straightforward, I had some issues with Windows dev tools and the python variable. I can recommend these two links if you are experiencing these issues:
Running Python on Windows for Node.js dependencies
You also need to use a null-modem / virtual com-port solution. I will go through the steps of installing http://com0com.sourceforge.net/ later in the tutorial.
Download and setup
Installing Ryder-CLI
With Node.js installed run the following command in your command prompt
npm install -g @lightlabs/ryder-cli-protoAfter successful installation, you can test that the CLI tool is working by running
ryder-cli-proto –-helpThe command should respond with a list of commands that can be used to manage the device.
Downloading & installing com0com
Before running the simulator, we need to download and install com0com null-modem emulator. The emulator will set up a virtual port to connect your Ryder simulator.
Start by going to the download page com0com and get the installer.
The package contains a version for x64 x86, pick the one matching your CPU. Note: make sure you extract the files before running the installer else it will fail.
Running installation wizard should be straight forward leaving the default setup.
After a few steps, a warning will appear that you need to approve the publisher. If the “Always trust software from…” is unchecked the message will appear a few times during the installation.
Launching the emulator for the first time you should get the following screen. Make sure to take note of the COM*X* of the Port Pair as this will be used to set up the simulator.
The emulator should now be up and running and you can check that things are working as expected by going to the Command Prompt and run the ´mode´ command. The output should be as follows:
Status for device COM4:
-----------------------
Baud: 1200
Parity: None
Data Bits: 7
Stop Bits: 1
Timeout: OFF
XON/XOFF: OFF
CTS handshaking: OFF
DSR handshaking: OFF
DSR sensitivity: OFF
DTR circuit:
ON RTS circuit: ON
Status for device COM5:
-----------------------
Baud: 1200
Parity: None
Data Bits: 7
Stop Bits: 1
Timeout: OFF
XON/XOFF: OFF
CTS handshaking: OFF
DSR handshaking: OFF
DSR sensitivity: OFF
DTR circuit: ON
RTS circuit: ONNow that we have the ports working, we can start to get the Ryder simulator running.
Downloading the Ryder simulator
First, we need to head over to Ryder’s notion page to download the latest version of the simulator.
Make sure you pick the right version for your OS.
The download is a zip-file containing all files needed to run the simulator.
As the subsequent steps will be dependent on you knowing where you extracted the file, I recommend extracting the downloaded file by right-clicking the file and select ‘Extract’. A window prompting you to select a location will appear.
If you select the location according to the above format it will make it easier to follow subsequent steps.
The next step is to start the Command prompt and navigate to the location of the extracted files.
cd Documents/Ryder/ryder-sim-v2-win64_0.0.2The first thing we need to do is Point the Ryder simulator to one end of the virtual com port pair by specifying the com port as a startup parameter. Running the below command should set the parameter and also start the simulator.
ryder-sim-v2-win64.exe COM4After executing the command following window with an uninitialized Ryder device should appear.
Congratulations you have now managed to get the simulator to work!
The next step is to initialize the device using the CLI tool
Setting up device
To manage the device, we use the Ryder-CLI
Start by running:
ryder-cli-proto setup -R 'COM5'This will start the setup process and should render the following screen on the simulator
Follow the instruction by clicking Ok and writing down your seed phrase.
The initialized Ryder will look as follow and it’s now ready to be used for your app!
You can test to interact with the simulator by requesting to export an identities App Key by running this command.
ryder-cli-proto export identity 0 https://ryder.id -R 'COM5'It should render the following screen on the simulator asking you to Confirm or Cancel.
Confirming will return the App Key based on the identity and app domain in the command prompt.
RyderSerial JS library
To start using the Ryder in an application the RyderSerial is provided as an easy way to get going integrating the devices.
You can grab the library with NPM
npm install @lightlabs/ryderserial-protoBelow is a simple example of how you can use the library to extract an app key for the domain https://ryder.id. Further reference and documentation can be found at Light Labs GitHub page.
const RyderSerial = require('ryderserial-proto');
let ryder_port = 'COM5';const options = {
reconnectTime: 1000, // how long to wait before reconnect (ms).
debug: true // enable debug output to stdout.
};const ryder_serial = new RyderSerial(ryder_port, options);
ryder_serial.on('open', async ()=>
{
const response = await ryder_serial.send(RyderSerial.COMMAND_INFO);
console.log(response);
const appkeyresponse = await request_app_key(0, 'https://ryder.id');
console.log(`Response: ${appkeyresponse}`)
});async function request_app_key(identity_number,app_domain){
const data = [RyderSerial.COMMAND_EXPORT_APP_KEY,identity_number];
const response = await ryder_serial.send(data);
if (response === RyderSerial.RESPONSE_SEND_INPUT)
{
// Send the app domain terminated by a null byte.
const app_key = await ryder_serial.send(`${app_domain}\0`);
// app key will be RyderSerial.RESPONSE_REJECTED if the user
// presses Cancel, otherwise the response will be in the following
// format:
// "https://ryder.id,app_key_here"
return app_key;
}else{
console.log('Signin rejected by user');
}
}
Get going
It’s that easy, so if you are yet to download the simulator it’s time to head over to Ryder notion page. With these easy steps, you are on your way to providing your users an easier and safer way to access your application.
As mentioned in the beginning Ryder is a Maker based project and it's the perfect time for you to get involved. Participation, as well as input, is always welcomed. You can find more information by visiting the Ryder.id website and if you want to join the discussion on Discord don't forget to tag me and say hello!
