Unable to install Octane as a node library per documented instructions #30
Description
Describe the bug
I am attempting to install octane via the instructions documented here:
https://github.com/solana-labs/octane/blob/master/docs/library.md#install
I attempted using an existing repo as well as a new blank repo. I am using yarn v3.5.0.
To Reproduce
Steps to reproduce the behavior:
- Create new repo initiated with
yarn init - Attempt to install octane with provided instructions
- See error:
Usage Error: It seems you are trying to add a package using a https:... url; we now require package names to be explicitly specified.
Try running the command again with the package name prefixed: yarn add my-package@https:...
- Attempt to reinstall by prepending
octane-core@to the install command per error - See next error:
➤ YN0000: ┌ Resolution step
➤ YN0001: │ Error: octane-core@https://gitpkg.now.sh/solana-labs/octane/packages/core?[...] isn't supported by any available resolver
at xf.getResolverByDescriptor (/Users/warly/.cache/node/corepack/yarn/3.5.0/yarn.js:391:1647)
at xf.bindDescriptor (/Users/warly/.cache/node/corepack/yarn/3.5.0/yarn.js:391:1036)
at _ (/Users/warly/.cache/node/corepack/yarn/3.5.0/yarn.js:439:6900)
at async Promise.allSettled (index 0)
at async to (/Users/warly/.cache/node/corepack/yarn/3.5.0/yarn.js:390:10398)
at async /Users/warly/.cache/node/corepack/yarn/3.5.0/yarn.js:439:8205
at async Ge.startProgressPromise (/Users/warly/.cache/node/corepack/yarn/3.5.0/yarn.js:390:47579)
at async je.resolveEverything (/Users/warly/.cache/node/corepack/yarn/3.5.0/yarn.js:439:6233)
at async /Users/warly/.cache/node/corepack/yarn/3.5.0/yarn.js:442:2137
at async Ge.startSectionPromise (/Users/warly/.cache/node/corepack/yarn/3.5.0/yarn.js:409:3292)
➤ YN0000: └ Completed
➤ YN0000: Failed with errors in 0s 14ms
- See that nothing has been installed to the
node_modulesfolder.
Expected behavior
The package should be installed in node_modules as expected.
Screenshots
Desktop (please complete the following information):
- OS: macOS Ventura v13.2.1
- Browser: N/A
Additional context
I tested with yarn in an empty repo for creating this issue, however I prefer using pnpm. Until the octane library is on NPM it would be helpful to have more complete install instructions for different package managers. Ideally it would be on NPM so devs could just run pnpm add @solana-labs/octane (or preferred package manager equivalent).