moar docs

Author: mixmix

src/index.ts

@@ -38,13 +38,16 @@ export default class Entropy {
   /** A promise that resolves once all internal setup has been successfully completed. */
   ready: Promise<boolean>
 
-  /* Accessory for ... TODO: */
+  /* Accessor for ... TODO: */
   registrationManager: RegistrationManager
 
-  /* Accessory for ... TODO: */
+  /* Accessor for ... TODO: */
   programs: ProgramManager
 
-  /* Accessory for ... TODO: */
+  /* Accessor for the SignatureRequestManager.
+   * Generally you will use entropy.sign or entropy.signWithAdapter
+   *
+   */
   signingManager: SignatureRequestManager
 
   /** Accessor for the keyring passed at instantiation */
@@ -58,11 +61,18 @@ export default class Entropy {
    *
    * @example
    * ```ts
-   * import { Entropy } from '@entropyxyz/sdk'
+   * import { Entropy, wasmGlobalsReady } from '@entropyxyz/sdk'
    * import { Keyring } from '@entropyxyz/sdk/keys'
    *
-   * const keyring = new Keyring({ seed })
-   * const entropy = new Entropy({ keyring })
+   * async function main () {
+   *   const keyring = new Keyring({ seed })
+   *   const entropy = new Entropy({ keyring })
+   *
+   *   await wasmGlobalsReady()
+   *   await entropy.ready
+   * }
+   *
+   * main()
    * ```
    */
 
@@ -124,15 +134,13 @@ export default class Entropy {
    * @throws {Error} If the address is already registered or if there's a problem during registration.
    */
   async register (params?: RegistrationParams): Promise<HexString> {
+    await this.ready
     const defaultProgram = DEVICE_KEY_PROXY_PROGRAM_INTERFACE
-
     params = params || {
       programData: [defaultProgram],
       programDeployer: this.keyring.accounts.registration.address,
     }
 
-    await Promise.all([this.ready, this.substrate.isReady])
-
     const deviceKey = this.keyring.getLazyLoadAccountProxy(ChildKey.deviceKey)
     deviceKey.used = true
     defaultProgram.program_config.sr25519_public_keys.push(
@@ -147,9 +155,11 @@ export default class Entropy {
     }
 
     const verifyingKey = await this.registrationManager.register(params)
-    // fuck frankie TODO: Make legit function
+
+    // TODO: Make legit function
     const admin = this.keyring.getLazyLoadAccountProxy(ChildKey.registration)
     const vk = admin.verifyingKeys || []
+
     // HACK: these assignments trigger important `account-update` flows via the Proxy 
     admin.verifyingKeys = [...vk, verifyingKey]
     deviceKey.verifyingKeys = [verifyingKey, ...vk]
@@ -178,7 +188,7 @@ export default class Entropy {
    */
 
   async signWithAdaptersInOrder (params: SigWithAdapptersOps): Promise<unknown> {
-    (await this.ready) && this.substrate.isReady
+    await this.ready
     return await this.signingManager.signWithAdaptersInOrder(params)
   }
 

src/keys/index.ts

@@ -20,10 +20,12 @@ const ACCOUNTS = Object.keys(ChildKey)
  */
 export default class Keyring {
   // private
-  // it's a unit8array if it comes from a mnemonic and a string if it comes from the user
-  // The seed used to generate keys, can be a Uint8Array (from mnemonic) or a string (user-provided).
+  // The seed used to generate keys. Can be a Uint8Array (from mnemonic) or a string (from seed).
   #seed: Uint8Array | string
+  // The the names of accounts used in this keyring
   #used: string[]
+
+  /** The accounts  */
   accounts: AccountsEmitter
   crypto: Crypto
 
@@ -48,42 +50,42 @@ export default class Keyring {
    */
 
   constructor (account: KeyMaterial) {
-    // this repersents keys that are used by the user
+    // The the names of accounts used in this keyring
     this.#used = ['admin', ChildKey.registration]
     Object.keys(account).forEach((key) => {
-      if (typeof account[key] === 'object' && account[key].userContext) {
+      if (account[key]?.userContext) {
         this.#used.push(key)
       } else if ((account as EntropyAccount).debug) {
         this.#used.push(key)
       }
     })
+
+    // set #seed
     const { seed, mnemonic } = account
     if (!seed && !mnemonic)
       throw new Error('Need at least a seed or mnemonic to create keys')
-    if (mnemonic) {
-      this.#seed = utils.seedFromMnemonic(mnemonic)
-    } else {
-      this.#seed = seed
-    }
+    this.#seed = mnemonic
+      ? utils.seedFromMnemonic(mnemonic)
+      : seed
+
+    // setup accounts
     const accountsJson = this.#formatAccounts(account)
     this.accounts = this.#createFunctionalAccounts(accountsJson)
     this.accounts.masterAccountView = accountsJson
   }
 
-  #formatAccounts (accounts: EntropyAccount): EntropyAccount {
 
+  #formatAccounts (accounts: EntropyAccount): EntropyAccount {
+    // TODO: refactor to use "account" not "accounts"
     const { seed, type, admin } = accounts
     const debug = true
     const entropyAccountsJson = {
       debug,
-      // previously was seed ? seed : utils.seedFromMnemonic(mnemonic) but this has already been derived in the constructor
-      // @frankie correct if im wrong here
       seed: this.#seed,
       type,
       admin,
     }
 
-
     Object.keys(accounts)
       .concat(ACCOUNTS)
       .forEach((key) => {

src/registration/index.ts

@@ -6,8 +6,9 @@ import { Signer } from '../keys/types/internal'
 import { Address } from '../types/internal'
 
 export interface RegistrationParams {
+  /** initial programs associated with the user */
   programData: ProgramInstance[]
-  /** just testing this functionality, not intending to use this as the set program */
+  /** The account authorized to modify programs on behalf of the user. */
   programDeployer?: SS58Address
 }
 

typedoc.config.cjs

@@ -14,7 +14,7 @@ module.exports = {
 
   tsconfig: './tsconfig.json',
   excludePrivate: true,
-  excludeInternal: true,
+  // excludeInternal: true,
   validation: {
     notExported: true,
     invalidLink: true,