vpl-relying-party-cli

Getting started

Requirements

Background

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

Linux

Install devtools: ```bash sudo apt install build-essential libcurl4-gnutls-dev libxml2-dev libssl-dev ```

MacOS & Linux

[Install Rust](https://rustup.rs/)

Installation

Install the package from the [crates](https://crates.io/crates/libc) through `cargo`: ```bash $ git clone https://github.com/velas/velas-program-library.git && cargo install --path velas-program-library/relying-party/cli ```

Usage

You can use the following list of the addresses of the nodes to execute commands to: md5-72e9e854d14e0addf48b486806543c06

Configuration

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

To get current velas command-line tool configuration:

```bash $ velas config get

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

To set Cluster RPC URL

See Velas clusters for cluster-specific RPC URLs

bash $ velas config set --url https://mainnet.velas.com/rpc

Default Keypair

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

Keypair File

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

Hardware Wallet URL (See URL spec)

bash $ velas config set --keypair usb://ledger/

Service

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

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

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

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

USAGE: vpl-relying-party [FLAGS] [OPTIONS]

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

OPTIONS: --authority Filepath or URL to a relying-party authority keypair. Relying-party authority needs to close the account. [default: client keypair] -C, --config Configuration file to use [default: /Users/user/.config/velas/cli/config.yml] --fee-payer Filepath or URL to a fee-payer keypair [default: client keypair] --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:

| Arguments | Type | Required | Description | | :-------------------: | :----: | :------: | ------------------------------------ | | relying-party-address | Pubkey | Yes | Account address to get a parsed data.| | node-url | URL | No | Node URL to apply a command to. |

```bash $ vpl-relying-party account Bu1dW7aAyWXDgHPiLS5ch6KFgzaiwFknzKRkmNrzf8xH --url http://127.0.0.1:8899

Public Key: Bu1dW7aAyWXDgHPiLS5ch6KFgzaiwFknzKRkmNrzf8xH

Relying Party Data: version: 1 authority: 9atTpuaX8WoxWr7xDanvMmE41bPWkCLnSM4V4CMTu4Lq Releted program data: name: azino333 iconcid: QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u domainname: http://azino.com redirect_uri: ["http://azino.com/pay", "http://azino.com/play"] ```

Create Account

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

| Arguments | Type | Required | Description | | :--------------------: | :----: | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------- | | program-name | String | Yes | The program name that associated with relying-party account. | | program-icon-cid | String | Yes | Content identifier to the associated with relying-party program: https://docs.ipfs.io/concepts/content-addressing/ | | program-domain-name | URL | Yes | Domain name of the associated with relying-party program. | | program-redirect-uris | URIs | Yes | Allowed redirect URIs for Vaccount. | | lamports | Number | No | Lamports to create a new relying-party account. | | authority | Keypair | No | Filepath or URL to a relying-party authority keypair. Relying-party authority needs to close the account. [default: client keypair] | | fee-payer | Keypair | No | Filepath or URL to a fee-payer keypair [default: client keypair] |

```bash $ vpl-relying-party create-account "azino333" QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u http://azino.com http://azino.com/pay http://azino.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:

| Arguments | Type | Required | Description | | :-------: | :-----: | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------- | | relying-party-address | Pubkey | Yes | The address of the relying-party account. | | new-authority | Pubkey | Yes | The new authority of the relying-party account. | | authority | Keypair | No | Filepath or URL to a relying-party authority keypair. Relying-party authority needs to close the account. [default: client keypair] | | fee-payer | Keypair | No | Filepath or URL to a fee-payer keypair [default: client keypair] |

```bash $ 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:

| Arguments | Type | Required | Description | | :-------: | :-----: | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------- | | relying-party-address | Pubkey | Yes | The address of the relying-party account. | | receiver-address | Pubkey | Yes | The address to send lamports from relying-party. | | authority | Keypair | No | Filepath or URL to a relying-party authority keypair. Relying-party authority needs to close the account. [default: client keypair] | | fee-payer | Keypair | No | Filepath or URL to a fee-payer keypair [default: client keypair] |

```bash $ vpl-relying-party close-account Bu1dW7aAyWXDgHPiLS5ch6KFgzaiwFknzKRkmNrzf8xH V9u7QR3Ff6mUMdyjvJ67M23Gr6ERzVenuyhXqcc7hFk --authority V9u7QR3Ff6mUMdyjvJ67M23Gr6ERzVenuyhXqcc7hFk.json --url http://127.0.0.1:8899

Signature: 2SFk6rASKYD2Nv8CiiG3TVJavpYj6FRA2xMtWTjSYXwMDEN5RMbA9wEv481DbwZGNeWeLgqmjGZrgESJ99qTxpUJ Relying-party account closed successful! ```

Development

Requirements