Skip to content

Commit

Permalink
chore: bump to latest version (#28)
Browse files Browse the repository at this point in the history
This PR bumps the docs to reflect the latest version of fuel-core

---------

Co-authored-by: Brandon Vrooman <brandon.vrooman@gmail.com>
  • Loading branch information
sarahschwartz and bvrooman committed May 29, 2024
1 parent ab8ccc0 commit ab1a0a6
Show file tree
Hide file tree
Showing 40 changed files with 1,048 additions and 1,341 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,6 @@ jobs:
- name: Coverage Check
run: |
npm install
node scripts/coverage/index.mjs
npm run test:coverage
4 changes: 2 additions & 2 deletions docs/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ The playground is an interactive and graphical IDE that includes a reference for

You can test out the Fuel GraphQL API playground here:

https://beta-5.fuel.network/playground
https://testnet.fuel.network/v1/playground

## RPC Endpoint

https://beta-5.fuel.network/graphql
https://testnet.fuel.network/v1/graphql
6 changes: 3 additions & 3 deletions docs/querying-from-a-dapp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This section covers just a few options available to get you started.

```javascript
export async function getHealth() {
let response = await fetch('https://beta-5.fuel.network/graphql', {
let response = await fetch(TESTNET_ENDPOINT, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Expand All @@ -36,7 +36,7 @@ npm install @apollo/client graphql
import { ApolloClient, InMemoryCache, gql } from '@apollo/client';

const apolloClient = new ApolloClient({
uri: 'https://beta-5.fuel.network/graphql',
uri: TESTNET_ENDPOINT,
cache: new InMemoryCache(),
});

Expand Down Expand Up @@ -66,7 +66,7 @@ npm install urql graphql
import { Client, cacheExchange, fetchExchange } from 'urql';

const urqlClient = new Client({
url: 'https://beta-5.fuel.network/graphql',
url: TESTNET_ENDPOINT,
exchanges: [cacheExchange, fetchExchange],
});

Expand Down
49 changes: 49 additions & 0 deletions docs/reference/enums.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,34 @@ category: Reference

# Enums

## `ConsensusParametersVersion`

The version of the consensus parameters.

`V1`:
Version 1.

## `ContractParametersVersion`

The version of the contract-specific consensus parameters.

`V1`:
Version 1.

## `FeeParametersVersion`

The version of the fee-specific consensus parameters.

`V1`:
Version 1.

## `GasCostsVersion`

The version of the gas-specific consensus parameters.

`V1`:
Version 1.

## `MessageState`

The state of a message, either `UNSPENT`, `SPENT`, or `NOT_FOUND`.
Expand Down Expand Up @@ -61,6 +89,13 @@ The receipt was generated from a mint.
`BURN`:
The receipt was generated from a burn.

## `PredicateParametersVersion`

The version of the predicate-specific consensus parameters.

`V1`:
Version 1.

## `ReturnType`

The type of return response for a transaction
Expand All @@ -83,3 +118,17 @@ All breakpoints have been processed, and the program has terminated.

`BREAKPOINT`:
The program stopped on a breakpoint.

## `ScriptParametersVersion`

The version of the script-specific consensus parameters.

`V1`:
Version 1.

## `TxParametersVersion`

The version of the transaction-specific consensus parameters.

`V1`:
Version 1.
6 changes: 3 additions & 3 deletions docs/reference/mutations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -108,15 +108,15 @@ The session ID.

## `dryRun`

Spin up a new temporary node from the current state and emulate a given transaction.
Spin up a new temporary node from the current state and emulate a given transaction or set of transactions.
Returns a [`[Receipt!]!`](/docs/reference/objects/#receipt) for the emulated transaction.
You can optionally use UTXO validation.

**args:**

`tx`: [`HexString!`](/docs/reference/scalars/#hexstring)
`txs`: [`[HexString!]!`](/docs/reference/scalars/#hexstring)

The transaction hex string.
An array of transaction hex strings.

`utxoValidation`: `Boolean`
Whether or not to use UTXO validation.
Expand Down
Loading

0 comments on commit ab1a0a6

Please sign in to comment.