Imports #197
Merged
Imports #197
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Crystal Gomes <[email protected]>
Co-authored-by: Crystal Gomes <[email protected]>
zeuslawyer
reviewed
Nov 30, 2023
README.md
Outdated
|
|
||
| > ⚠️ **Users are fully responsible for any dependencies their JavaScript source code imports. Chainlink is not responsible for any imported dependencies and provides no guarantees of the validity, availability or security of any libraries a user chooses to import. Developers are advised to fully vet any imported dependencies or avoid dependencies altogether to avoid any risks associated with a compromised library or a compromised repository from which the dependency is downloaded.** | ||
|
|
||
| Chainlink Functions supports importing ESM-compatible modules with are supported by Deno within the JavaScript source code. It also supports importing some NPM packages [via the `npm:` specifier](https://docs.deno.com/runtime/manual/node/npm_specifiers) and some built-in Node.js modules [via the `node:` specifier](https://docs.deno.com/runtime/manual/node/node_specifiers). Check out the [Deno documentation on importing modules](https://docs.deno.com/runtime/manual/basics/modules/) for more information or visit [deno.land/x](https://deno.land/x) to find 3rd party modules which have been built for Deno. |
There was a problem hiding this comment.
nit: is Nodejs standard library a better way to indicate "built in"? I'm divided on this so either way works.
zeuslawyer
reviewed
Nov 30, 2023
README.md
Outdated
|
|
||
| > ⚠️ **Users are fully responsible for any dependencies their JavaScript source code imports. Chainlink is not responsible for any imported dependencies and provides no guarantees of the validity, availability or security of any libraries a user chooses to import. Developers are advised to fully vet any imported dependencies or avoid dependencies altogether to avoid any risks associated with a compromised library or a compromised repository from which the dependency is downloaded.** | ||
|
|
||
| Chainlink Functions supports importing ESM-compatible modules with are supported by Deno within the JavaScript source code. It also supports importing some NPM packages [via the `npm:` specifier](https://docs.deno.com/runtime/manual/node/npm_specifiers) and some built-in Node.js modules [via the `node:` specifier](https://docs.deno.com/runtime/manual/node/node_specifiers). Check out the [Deno documentation on importing modules](https://docs.deno.com/runtime/manual/basics/modules/) for more information or visit [deno.land/x](https://deno.land/x) to find 3rd party modules which have been built for Deno. |
There was a problem hiding this comment.
This para could be broken up? Example:
You can import
- ESM-compatible NPM packages via the
npm:specifier - ESM-compatible built-in Node.js modules via the
node:specifier - ESM-Compatible 3rd party modules which have been built for Deno from deno.land/x
Check out the Deno documentation on importing modules for more information
There was a problem hiding this comment.
Yes, I agree with this, except make it an unordered (bullet point) list
There was a problem hiding this comment.
@thedriftofwords @zeuslawyer This is good feedback. @thedriftofwords Would you be able to break up this paragraph on this PR? Else maybe I can do it later tonight.
zeuslawyer
reviewed
Nov 30, 2023
|
|
||
| All other execution restrictions still apply to imported dependencies. This means the dependencies will not have access to the file system, environment variables or any other Deno permissions. If an imported library requires restricted permissions, importing the library may result in an error. Furthermore, dependencies are downloaded at runtime, meaning the time required to download a dependency is counted toward the total JavaScript source code execution time limit. | ||
|
|
||
| Sometimes imported dependencies use additional fetch requests to load additional code or resources. These fetch requests count toward the total number of HTTP requests that the JavaScript source code is allowed to perform. If the imported dependencies exceed this total number of allowed fetch requests, the import attempt will fail with an error. |
There was a problem hiding this comment.
Recommend we link to the docs (https://docs.chain.link/chainlink-functions/resources/service-limits) in the test "allowed to perform".
And/or expressly use the phrase "service limits" so that it maps in the readers head to what they see in the docs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.