vpl-relying-party-cli

• Getting started
  • Background
  • Requirements
    • MacOS & Linux
  • Installation
• Usage
  • Configuration file
  • Service
  • Account
  • Create Account
  • Set Authority
  • Close Account
• Development
  • Requirements

Getting started

Requirements

Background

Velas's programming model and the definitions of the Velas terms used in this document are available at:

• https://docs.velas.com/apps
• https://docs.velas.com/terminology

Linux

Install devtools:

sudo apt install build-essential libcurl4-gnutls-dev libxml2-dev libssl-dev libudev-dev

MacOS & Linux

Install Rust

Installation

Install the package from the crates through cargo:

$ cargo install vpl-relying-party-cli

Usage

You can use the following list of the addresses of the nodes to execute commands to:

• https://api.velas.com,
• https://api.testnet.velas.com,
• https://api.devnet.velas.com.

Configuration

The vpl-relying-party configuration is shared with the velas command-line tool.

To get current velas command-line tool configuration:

$ velas config get

Config File: ${HOME}/.config/velas/cli/config.yml
RPC URL: https://api.velas.com/
WebSocket URL: wss://api.velas.com/ (computed)
Keypair Path: ${HOME}/.config/velas/id.json

To set Cluster RPC URL

See Velas clusters for cluster-specific RPC URLs

$ velas config set --url https://api.velas.com

Default Keypair

See Keypair conventions for information on how to setup a keypair if you don't already have one.

Keypair File

$ velas config set --keypair ${HOME}/new-keypair.json

Service

Get the version of the package — vpl-relying-party --version:

$ vpl-relying-party --version
vpl-relying-party-cli 0.1.0

Get all possible package's commands — vpl-relying-party --help:

vpl-relying-party-cli 0.1.0
VPL Relying Party Command-line Utility

USAGE:
    vpl-relying-party [FLAGS] [OPTIONS] <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information
    -v, --verbose    Show additional information

OPTIONS:
        --authority <KEYPAIR>    Filepath or URL to a relying-party authority keypair. This authority will be able to
                                 close the account. [default: client keypair]
    -C, --config <PATH>          Configuration file to use [default: /Users/user/.config/velas/cli/config.yml]
        --fee-payer <KEYPAIR>    Filepath or URL to a fee-payer keypair [default: client keypair]
        --url <URL>              JSON RPC URL for the cluster [default: value from configuration file]

SUBCOMMANDS:
    account           Display information stored in relying-party account
    close-account     Close relying-party account
    create-account    Create a new relying-party account
    help              Prints this message or the help of the given subcommand(s)
    set-authority     Set close authority of the relying-party account

Account

Get relying-party account parsed data by its address — vpl-relying-party account:

$ vpl-relying-party account Bu1dW7aAyWXDgHPiLS5ch6KFgzaiwFknzKRkmNrzf8xH

Public Key: Bu1dW7aAyWXDgHPiLS5ch6KFgzaiwFknzKRkmNrzf8xH
-------------------------------------------------------------------
Relying Party Data:
    version: 1
    authority: 9atTpuaX8WoxWr7xDanvMmE41bPWkCLnSM4V4CMTu4Lq
    Related program data:
        name: example-dapp333
        icon_cid: QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u
        domain_name: http://example-dapp.com
        redirect_uri: ["http://example-dapp.com/pay", "http://example-dapp.com/play"]

Create Account

Create relying-party account — vpl-relying-party create-account:

$ vpl-relying-party create-account "example-dapp333" QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u http://example-dapp.com http://example-dapp.com/pay http://example-dapp.com/play  --url http://127.0.0.1:8899                                                                                                          

Signature: 4CH13f432ygibj2kBsoRJpG4HsnhDRA4pMgrd384bRNS37p5HYEtKQ4mR9iEviiugCMqoBUWa6BLHnEW4CzibatV
Relying Party Address: Bu1dW7aAyWXDgHPiLS5ch6KFgzaiwFknzKRkmNrzf8xH
Created!

Set Authority

Set close authority of the relying-party account — vpl-relying-party set-authority:

$ vpl-relying-party set-authority Bu1dW7aAyWXDgHPiLS5ch6KFgzaiwFknzKRkmNrzf8xH V9u7QR3Ff6mUMdyjvJ67M23Gr6ERzVenuyhXqcc7hFk  --url http://127.0.0.1:8899  

Signature: 4GTJMcrAbQEsqVNz7G4UUUrnWctL6h55fefdwkJGapKrAZyjzeaLusSTS2Kwjp8AnMaEBU7TBeoiUHRJQs9GoQ8S
Authority changed from 9atTpuaX8WoxWr7xDanvMmE41bPWkCLnSM4V4CMTu4Lq to V9u7QR3Ff6mUMdyjvJ67M23Gr6ERzVenuyhXqcc7hFk successful!     

Close Account

Close relying-party account — vpl-relying-party close-account:

$ vpl-relying-party close-account Bu1dW7aAyWXDgHPiLS5ch6KFgzaiwFknzKRkmNrzf8xH V9u7QR3Ff6mUMdyjvJ67M23Gr6ERzVenuyhXqcc7hFk --authority V9u7QR3Ff6mUMdyjvJ67M23Gr6ERzVenuyhXqcc7hFk.json

Signature: 2SFk6rASKYD2Nv8CiiG3TVJavpYj6FRA2xMtWTjSYXwMDEN5RMbA9wEv481DbwZGNeWeLgqmjGZrgESJ99qTxpUJ
Relying-party account closed successful!

Development

Requirements

• Rust — https://rustup.rs/. Install it with the following reference.
• Velas-CLI — https://docs.velas.com/cli. Install it with the following reference.