Skip to content

[Docs] AleoKeyProvider.fetchKeys is actually AleoKeyProvider.fetchRemoteKeys #1071

@zklimaleo

Description

@zklimaleo

📚 Documentation

The comments and example codes shown are keyProvider.fetchKeys but the actual method available in FunctionKeyProvider is keyProvider.fetchRemoteKeys.

* @example
* // Create a new AleoKeyProvider object
* const networkClient = new AleoNetworkClient("https://api.explorer.provable.com/v1");
* const keyProvider = new AleoKeyProvider();
* const recordProvider = new NetworkRecordProvider(account, networkClient);
*
* // Initialize a program manager with the key provider to automatically fetch keys for value transfers
* const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
* programManager.transfer(1, "aleo166q6ww6688cug7qxwe7nhctjpymydwzy2h7rscfmatqmfwnjvggqcad0at", "public", 0.5);
*
* // Keys can also be fetched manually
* const [transferPrivateProvingKey, transferPrivateVerifyingKey] = await keyProvider.fetchKeys(
* CREDITS_PROGRAM_KEYS.transfer_private.prover,
* CREDITS_PROGRAM_KEYS.transfer_private.verifier,
* );
*/

async fetchRemoteKeys(proverUrl: string, verifierUrl: string, cacheKey?: string): Promise<FunctionKeyPair> {

Same Inconsistent example code in the Provable SDK docs too.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions