Skip to content

Commit 758178d

Browse files
authored
Merge pull request #90 from smartcontractkit/zp-patch
Update README.
2 parents 7961c33 + c9256ed commit 758178d

File tree

2 files changed

+19
-4
lines changed

2 files changed

+19
-4
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,6 @@ dist
77
# Reports
88
/coverage
99
coverage.json
10-
*report.json
10+
*report.json
11+
12+
*.env

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ Up-to-date documentation on Chainlink Functions can be found [here](https://docs
77
# Table of Contents
88

99
- [Table of Contents](#table-of-contents)
10+
- [Use in Remix](#use-in-remix)
11+
- [Browser Use](#browser-use)
1012
- [Prerequisites](#prerequisites)
1113
- [Functions Billing Subscription Management](#functions-billing-subscription-management)
1214
- [Subscription Initialization](#subscription-initialization)
@@ -34,7 +36,15 @@ Up-to-date documentation on Chainlink Functions can be found [here](https://docs
3436
- [Building Functions Request CBOR Bytes](#building-functions-request-cbor-bytes)
3537
- [Browser use](#browser-use)
3638

37-
# Prerequisites
39+
# Use in Remix
40+
41+
Chainlink Functions-toolkit can also be imported as a scripting dependency inside [Remix IDE scripts](https://remix-ide.readthedocs.io/en/latest/running_js_scripts.html). The rest of this README contains instructions on how to use the package.
42+
43+
# Browser use
44+
45+
This package can also be used in most modern web browsers. You can import the package in your front-end application, and call the APIs as you would in a back end NodeJs/Deno environment.
46+
47+
# Prerequisites For NodeJS Projects
3848

3949
Install Node.js version `18.18.0` or higher _and_ Deno version `1.36.0` or higher.
4050

@@ -638,6 +648,7 @@ export const maxQueryResponseBytes = 2097152 // Maximum size of incoming HTTP re
638648
functionsRouterContract: Contract // Mock FunctionsRouter contract
639649
}
640650
```
651+
641652
where Anvil instance is defined as [such](https://github.com/wevm/anvil.js/blob/main/packages/anvil.js/src/anvil/createAnvil.ts#L10)
642653

643654
Now you can connect to the local Functions testnet RPC node with your preferred blockchain tooling, deploy a FunctionsConsumer contract, instantiate and initialize the`SubscriptionManager`, create, add the consumer contract and fund the subscription, send requests, and use the `ResponseListener` to listen for responses all on your machine.
@@ -730,6 +741,8 @@ const functionsRequestBytesHexString: string = buildRequestCBOR({
730741
})
731742
```
732743

733-
## Browser use
744+
# Chainlink Functions Status
734745

735-
This package can also be used in most modern web browsers. You can import the package in your front-end application, and call the APIs as you would in a back end NodeJs/Deno environment.
746+
**Caution**: Chainlink Functions is still in BETA.
747+
748+
The use of secrets (including your private keys) in scripts inside Remix IDE is an experimental feature that may not operate as expected and is subject to change. Please be aware that Chainlink does not control how your secrets or environment variables are used or accessed within Remix or when executing scripts within Remix, and the safekeeping of secrets and environment variables is your responsibility.

0 commit comments

Comments
 (0)