Adding privateKeyPath back to PolykeyAgent

[addievo]

Description

In

#582

Changes were made to PolykeyAgentOptions and it was flattened to remove dependency on types, this resulted in privateKeyPath being removed from PolykeyAgentOptions which is causing issues in Polykey-CLI.

This PR aims to add it back to PolykeyAgentOptions.

    privateKey: string;
    privateKeyPath: string;

Tasks

• 1. Add privateKey and privateKeyPath back to PolykeyAgentOptions.

Final checklist

• Domain specific tests
• Full tests
• Updated inline-comment documentation
• Lint fixed
• Squash and rebased
• Sanity check the final build

[ghost]

👇 Click on the image for a new way to code review

Legend

[CMCDragonkai]

@addievo I don't think you lintfixed this?

[CMCDragonkai]

• Your PR isn't lintfixed - this is why the lintfixing is meant to be done at the end.
• If the PR doesn't fix anything, delete that section
• Don't tick things off until the end
• Don't we need a default value for the configuration on agent options?

[CMCDragonkai]

The privateKey: PrivateKey should be using a more open type, instead the opaque type because of PolykeyAgent taking parameters from outside world.

So if you want to keep this then you should be using privateKey: Buffer.

Also privateKey should be moved up top.

privateKey: Buffer;
privateKeyPath: string;

[CMCDragonkai]

These 2 options aren't even being used, if these 2 options are to be used, they should be passed to the KeyRing.createKeyRing.

[CMCDragonkai]

@addievo link the new PR to fix this.

[addievo]

#601

[CMCDragonkai]

The PolykeyAgent.start should be taking DeepPartial of options, and the options need to keys: { recoveryCode; privateKey; privateKeyPath; }.

And also in the KeyRing.createKeyRing and KeyRing.start methods, these need to receive those options if you want to make them useful.

[CMCDragonkai]

Also the PolykeyAgentOptions needs to match:

  } & ( // eslint-disable-next-line @typescript-eslint/ban-types
    | {}
    | {
        recoveryCode: RecoveryCode;
      }
    | {
        privateKey: PrivateKey;
      }
    | {
        privateKeyPath: string;
      }

Which ensures mutually independent options.

[CMCDragonkai]

So:

keys: ({} | { recoveryCode: string; } | { privateKey: Buffer } | { privateKeyPath: string })

And PolykeyAgent.start should take this.