%YAML 1.2
%TAG !strict! tag:https://lnp-bp.org/lnp/strict.yaml
%TAG !wallet! tag:https://lnp-bp.org/lnp/wallet.yaml
---
name: keyring
type: RPC
desctiption: RPC API for Keyring service by Pandora Core
author: Dr Maxim Orlovsky <orlovsky@pandoracore.com>
---

types:
  second_auth_factor: !!u32
    max: 999999

  key:
    - id: !wallet!xpubid
    - xpubkey: !wallet!xpubkey
    - path: !wallet!derivation_path
    - fingerprint: !wallet!key_fingerprint

version:
  - features: 0

    messages:
      &success 1:

      &failure 0:
        - code: !!u16
        - info: !strict!utf8
            max: 256

      # Requests key listing
      &keys 1000:

      # Returned key list
      &keylist 1001:
        - keys: !strict!array
            item: !key
            max: 1024

      # Generates a new seed & extended master private key
      &seed 2000:
        - auth_code: !second_auth_factor

      &export 2100:
        - key_id: !wallet!xpubid
        - auth_code: !second_auth_factor

      &xpriv 2101:
        - xpriv: !wallet!xprivkey

      &xpub 2102:
        - xpub: !wallet!xpubkey

      &derive 3000:
        - from: !wallet!xpubid
        - path: !wallet!derivation_path
        - auth_code: !second_auth_factor

      &sign 4000:
        - psbt: !wallet!psbt

      &psbt 4001:
        - psbt: !wallet!psbt

    extensions:
      # No TLV extensions are defined

rpc:
  # Responses returning either ok or error
  - requests:
      - &seed
      - &derive
    responses:
      - &ok
      - &error

  - request: &keys
    responses: 
      - &error 
      - &keylist

  - request: &export
    responses:
      - &error
      - &xpriv
      - &xpub

  - request: &sign
    responses:
      - &psbt
      - &error

vocabulary:
  rules:
    rust: pascalise
  types:
    second_auth_factor:
      rust: AuthCode
  messages:
    xpriv:
      rust: XPriv
    xpub:
      rust: XPub
...