Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
- [JavaScript Code](#javascript-source-code)

# Overview
Chainlink Functions allows users to request data from almost any API and perform custom computation using JavaScript. It operates using a [decentralized oracle network (DON)](https://chain.link/education/blockchain-oracles#decentralized-oracles). This documentation provides information tailored for integration with Space and Time. This file includes all of the information from the Chainlink Functions read me in case you are not familiar with how Chainlink Functions already works. Knowledge of Chainlink Functions is required before using the Space and Time API endpoints in order to retreive data and publish it to your smart contract. If you have trouble setting up Chainlink Functions this video is a great reference, <a href="https://www.youtube.com/watch?v=I-g1aaZ3_x4">How To Use Chainlink Functions.</a></b></p> If you are already comfortable with Chainlink Functions you can start [here](#boilerplate-contract)
Chainlink Functions allows users to request data from almost any API and perform custom computation using JavaScript. It operates using a [decentralized oracle network (DON)](https://chain.link/education/blockchain-oracles#decentralized-oracles). This documentation provides information tailored for integration with Space and Time. This file includes all of the information from the Chainlink Functions read me in case you are not familiar with how Chainlink Functions already works. Knowledge of Chainlink Functions is required before using the Space and Time API endpoints in order to retrieve data and publish it to your smart contract. If you have trouble setting up Chainlink Functions this video is a great reference, <a href="https://www.youtube.com/watch?v=I-g1aaZ3_x4">How To Use Chainlink Functions.</a></b></p> If you are already comfortable with Chainlink Functions you can start [here](#boilerplate-contract)
<p><b>This project is currently in a closed beta. Request access to send on-chain requests here <a href="https://functions.chain.link/">https://functions.chain.link/</a></b></p>

<p>Chainlink Functions allows users to request data from almost any API and perform custom computation using JavaScript.</p>
Expand Down Expand Up @@ -73,7 +73,7 @@ For more detailed tutorials and examples, check out the [Chainlink Functions Tut

1. Clone this repository to your local machine<br><br>
2. Open this directory in your command line, then run `npm install` to install all dependencies.<br><br>
3. Aquire a Github personal access token which allows reading and writing Gists.
3. Acquire a Github personal access token which allows reading and writing Gists.
1. Visit [https://github.com/settings/tokens?type=beta](https://github.com/settings/tokens?type=beta) and click "Generate new token"
2. Name the token and enable read & write access for Gists from the "Account permissions" drop-down menu. Do not enable any additional permissions.
3. Click "Generate token" and copy the resulting personal access token for step 4.<br><br>
Expand Down Expand Up @@ -130,7 +130,7 @@ The `--path` flag has no effect on the `npx env-enc set-pw` command as the passw

# Functions Command Glossary

The Functions and Functions subscription management commands commands can be executed in the following format:
The Functions and Functions subscription management commands can be executed in the following format:
`npx hardhat command_here --parameter1 parameter_1_value_here --parameter2 parameter_2_value_here`

Example: `npx hardhat functions-read --network polygonMumbai --contract 0x787Fe00416140b37B026f3605c6C72d096110Bb8`
Expand Down Expand Up @@ -252,7 +252,7 @@ Client contracts which initiate a request and receive a fulfillment can be modif
## Simulating Requests

An end-to-end request initiation and fulfillment can be simulated for the default _FunctionsConsumer_ contract using the `functions-simulate` command. This command will report the total estimated gas use.
If the _FunctionsConsumer_ client contract is modified, this task must also be modified to accomodate the changes. See `tasks/Functions-client/simulate` for details.
If the _FunctionsConsumer_ client contract is modified, this task must also be modified to accommodate the changes. See `tasks/Functions-client/simulate` for details.

**Note:** The actual gas use on-chain can vary, so it is recommended to set a higher fulfillment gas limit when making a request to account for any differences.

Expand Down