[SPEC] Keyring

[frankiebee]

@entropyxyz/sdk/keys

The purpose of the keyring is to create functional signers for the keyData provided

example from app perspective:

import  Keyring, { generateMnemonic, mnemonicToKeyData } from `@entropyxyz/keyring`

// 1. create (and write down) mnemonic
const mnemonic = generateMnemonic()

// 2. use mnemonic to generate keyData
const keyData = mnemonicToKeyData(mnemonic)

// 3. instantiate keyring
const keyring = new Keyring(keyData)

// 4. export keyData + persist
const keyData = keyring.json()
/*
    {
      programMod: { type, secret },
      developer: { type, secret },
      device: { type, secret }
    } 
*/
await writeKeyData(keyData) // some function

types

export interface KeyPairJson {
type: 'sr25519' | 'ed25519'
private: string
public: string
}


export interface KeyData {
programMod: KeyPairJson
deviceKey?: KeyPairJson
developer?: KeyPairJson
[key: string]?: KeyPairJson

}

// signer is polkadot signer

methods

Instance Methods

• new Keyring(keyData: Keydata) => keyring
• keyring.json() => KeyData
• keyring[context].signer => Signer
• keyring. creatEephemeralSigner() => Signer

Class Methods

• Keyring.createSigner(pair: KeyPairJson) => Signer

notes

should take all "3" seeds but only requires programMod i'm still stuck on this name i'd prefer not to call it it the program mod sense it's not that till we register it

are curent way of thinking is to have an admin key and registration key
the key that pays for registartion and the key that gets set as the programMod

they can be one in the same (infact they are right now)
however they can also be different. In my personal case i would want them to be different

i think also for "sponsorship" reason we should allow them to be different

Open questions:

• should you be able to set a different keyring to an already initialized entropy?

entropy.setKeyring(Keyring)

[frankiebee]

all the "known" keys we "need"

registration:

• a funded key to pay for the cost of registration (???)
• a program modification key (admin) to modify the program list register to the verifying key (can be cold at the time of registration but required to change programs and configs)
• the device key (if registered with the default program)

signing:

• an ephemeral key for encryption of the message to the validators (no persistance)
• the device key for local signature if the default program is registered (local only)

program deployment:

• a funding key

registered accounts program modification

• the admin key/ program mod key at time of registration

[frankiebee]

possible api alterations to be made in the entropy class (future issue?):
the last argument of methods that submit extrinsic's are optional signers

[frankiebee]

the last argument of methods that submit extrinsic's are optional signers

if done this way we can make keyring optional on initialization

[frankiebee]

@mixmix and i did some thinking around the example code here are the "notes" from that

[frankiebee]

live notes for/from mix https://hackmd.io/@esjFsrEDTMahtSwNs1zZHA/SJYA3SVwJg