Skip to content

Commit

Permalink
Merge pull request #1 from FuelLabs/init
Browse files Browse the repository at this point in the history
feat: Initialize book
  • Loading branch information
calldelegation authored Oct 4, 2024
2 parents 0ddd6b1 + 00053b9 commit 638856c
Show file tree
Hide file tree
Showing 14 changed files with 1,427 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Docs

on:
push:
branches:
- master
pull_request:

jobs:
lint-docs:
name: Lint Docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: FuelLabs/github-actions/setups/node@master
- name: Lint Check
run: |
pnpm install
pnpm lint:check
markdown-link-check:
name: Check Links
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v3
- uses: gaurav-nelson/[email protected]

docs-hub-check:
name: Docs Hub Checks
uses: FuelLabs/github-actions/.github/workflows/mdbook-docs.yml@master
with:
docs-src-path: 'docs/src'
spellcheck-config-path: 'docs/.spellcheck.yml'
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules
34 changes: 34 additions & 0 deletions docs/.spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Docs

on:
push:
branches:
- master
pull_request:

jobs:
lint-docs:
name: Lint Docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: FuelLabs/github-actions/setups/node@master
- name: Lint Check
run: |
pnpm install
pnpm lint:check
markdown-link-check:
name: Check Links
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v3
- uses: gaurav-nelson/[email protected]

docs-hub-check:
name: Docs Hub Checks
uses: FuelLabs/github-actions/.github/workflows/mdbook-docs.yml@master
with:
docs-src-path: 'docs/src'
spellcheck-config-path: 'docs/.spellcheck.yml'
85 changes: 85 additions & 0 deletions docs/spell-check-custom-words.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
SDK
testnet
testnets
mainnet
config
JSON
abigen
blockchain
blockchain's
ABI
ABIs
ERC
Ethereum
Ethereum's
natively
toolchain
toolchains
relayer
relayers
Infura
RPC
Sepolia
PoA
PoS
PoW
validator
validators
codespace
codespaces
Github
quickstart
forc
bytecode
struct
Fuelup
fuelup
LSP
graphQL
GraphQL
repo
customizations
VSCode
frontend
dapp
fullstack
TypeScript
params
VM
FuelVM
FVM
stateful
runnable
CLI
dev
TODO
intrinsics
configs
runtime
ethers
utils
MyContract
Typegen
StdString
sw
tx
LW
GTF
UX
structs
const
Configurables
asm
cli
SDKs
api
abi
transpiler
FuelLabs
github
https
script
namespacing
SRC
SDK's
utxo
5 changes: 5 additions & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Summary

[Verifed Addresses](./index.md)
[Assets](./assets.md)
[Contracts](./contracts.md)
97 changes: 97 additions & 0 deletions docs/src/assets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# Verified Assets

## Ethereum Sepolia Testnet

| Name | Address | Decimals |
|------|---------|----------|
| `Ethereum` | | `18` |
| `USDC` | [`0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238`](https://sepolia.etherscan.io/address/0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238) | `6` |
| `USDe` | [`0xc6387efad0f184a90b34f397c3d6fd63135ef790`](https://sepolia.etherscan.io/address/0xc6387efad0f184a90b34f397c3d6fd63135ef790) | `18` |
| `sUSDe` | [`0xb8f4f4eafc1d2a3c0a4d519bbf1114c311cc9b1b`](https://sepolia.etherscan.io/address/0xb8f4f4eafc1d2a3c0a4d519bbf1114c311cc9b1b) | `18` |
| `wstETH` | [`0xB82381A3fBD3FaFA77B3a7bE693342618240067b`](https://sepolia.etherscan.io/address/0xB82381A3fBD3FaFA77B3a7bE693342618240067b) | `18` |

## Ethereum Foundry

| Name | Address | Decimals |
|------|---------|----------|
| `Ethereum` | | `18` |

## Ethereum L1

| Name | Address | Decimals |
|------|---------|----------|
| `Ethereum` | | `18` |
| `WETH` | [`0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2`](https://etherscan.io/address/0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2) | `18` |
| `weETH` | [`0xCd5fE23C85820F7B72D0926FC9b05b43E359b7ee`](https://etherscan.io/address/0xCd5fE23C85820F7B72D0926FC9b05b43E359b7ee) | `18` |
| `rsETH` | [`0xA1290d69c65A6Fe4DF752f95823fae25cB99e5A7`](https://etherscan.io/address/0xA1290d69c65A6Fe4DF752f95823fae25cB99e5A7) | `18` |
| `rETH` | [`0xae78736cd615f374d3085123a210448e74fc6393`](https://etherscan.io/address/0xae78736cd615f374d3085123a210448e74fc6393) | `18` |
| `wbETH` | [`0xa2E3356610840701BDf5611a53974510Ae27E2e1`](https://etherscan.io/address/0xa2E3356610840701BDf5611a53974510Ae27E2e1) | `18` |
| `rstETH` | [`0x7a4EffD87C2f3C55CA251080b1343b605f327E3a`](https://etherscan.io/address/0x7a4EffD87C2f3C55CA251080b1343b605f327E3a) | `18` |
| `amphrETH` | [`0x5fD13359Ba15A84B76f7F87568309040176167cd`](https://etherscan.io/address/0x5fD13359Ba15A84B76f7F87568309040176167cd) | `18` |
| `Manta mBTC` | [`0x4041381e947CFD3D483d67a25C6aa9Dc924250c5`](https://etherscan.io/address/0x4041381e947CFD3D483d67a25C6aa9Dc924250c5) | `18` |
| `Manta mETH` | [`0x8CdF550C04Bc9B9F10938368349C9c8051A772b6`](https://etherscan.io/address/0x8CdF550C04Bc9B9F10938368349C9c8051A772b6) | `18` |
| `Manta mUSD` | [`0x3f24E1d7a973867fC2A03fE199E5502514E0e11E`](https://etherscan.io/address/0x3f24E1d7a973867fC2A03fE199E5502514E0e11E) | `18` |
| `pumpBTC` | [`0xf469fbd2abcd6b9de8e169d128226c0fc90a012e`](https://etherscan.io/address/0xf469fbd2abcd6b9de8e169d128226c0fc90a012e) | `8` |
| `FBTC` | [`0xc96de26018a54d51c097160568752c4e3bd6c364`](https://etherscan.io/address/0xc96de26018a54d51c097160568752c4e3bd6c364) | `8` |
| `SolvBTC` | [`0x7a56e1c57c7475ccf742a1832b028f0456652f97`](https://etherscan.io/address/0x7a56e1c57c7475ccf742a1832b028f0456652f97) | `18` |
| `SolvBTC.BBN` | [`0xd9d920aa40f578ab794426f5c90f6c731d159def`](https://etherscan.io/address/0xd9d920aa40f578ab794426f5c90f6c731d159def) | `18` |
| `Mantle mETH` | [`0xd5F7838F5C461fefF7FE49ea5ebaF7728bB0ADfa`](https://etherscan.io/address/0xd5F7838F5C461fefF7FE49ea5ebaF7728bB0ADfa) | `18` |
| `sDAI` | [`0x83f20f44975d03b1b09e64809b757c47f942beea`](https://etherscan.io/address/0x83f20f44975d03b1b09e64809b757c47f942beea) | `18` |
| `USDT` | [`0xdAC17F958D2ee523a2206206994597C13D831ec7`](https://etherscan.io/address/0xdAC17F958D2ee523a2206206994597C13D831ec7) | `6` |
| `USDC` | [`0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48`](https://etherscan.io/address/0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48) | `6` |
| `USDe` | [`0x4c9edd5852cd905f086c759e8383e09bff1e68b3`](https://etherscan.io/address/0x4c9edd5852cd905f086c759e8383e09bff1e68b3) | `18` |
| `sUSDe` | [`0x9d39a5de30e57443bff2a8307a4256c8797a3497`](https://etherscan.io/address/0x9d39a5de30e57443bff2a8307a4256c8797a3497) | `18` |
| `rsUSDe` | [`0x82f5104b23FF2FA54C2345F821dAc9369e9E0B26`](https://etherscan.io/address/0x82f5104b23FF2FA54C2345F821dAc9369e9E0B26) | `18` |
| `wstETH` | [`0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0`](https://etherscan.io/address/0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0) | `18` |
| `ezETH` | [`0xbf5495Efe5DB9ce00f80364C8B423567e58d2110`](https://etherscan.io/address/0xbf5495Efe5DB9ce00f80364C8B423567e58d2110) | `18` |
| `pzETH` | [`0x8c9532a60e0e7c6bbd2b2c1303f63ace1c3e9811`](https://etherscan.io/address/0x8c9532a60e0e7c6bbd2b2c1303f63ace1c3e9811) | `18` |
| `Re7LRT` | [`0x84631c0d0081FDe56DeB72F6DE77abBbF6A9f93a`](https://etherscan.io/address/0x84631c0d0081FDe56DeB72F6DE77abBbF6A9f93a) | `18` |
| `steakLRT` | [`0xBEEF69Ac7870777598A04B2bd4771c71212E6aBc`](https://etherscan.io/address/0xBEEF69Ac7870777598A04B2bd4771c71212E6aBc) | `18` |

## Fuel Devnet

| Name | Asset ID | Contract Address | Decimals |
|------|----------|------------------|----------|
| `Ethereum` | `0xf8f8b6283d7fa5b672b530cbb84fcccb4ff8dc40f8176ef4544ddb1f1952ad07` | | `9` |

## Fuel Testnet

| Name | Asset ID | Contract Address | Decimals |
|------|----------|------------------|----------|
| `Ethereum` | `0xf8f8b6283d7fa5b672b530cbb84fcccb4ff8dc40f8176ef4544ddb1f1952ad07` | | `9` |
| `USDC` | `0xc26c91055de37528492e7e97d91c6f4abe34aae26f2c4d25cff6bfe45b5dc9a9` | `0xd02112ef9c39f1cea7c8527c26242ca1f5d26bcfe8d1564bee054d3b04175471` | `6` |
| `USDe` | `0x86a1beb50c844f5eff9afd21af514a13327c93f76edb89333af862f70040b107` | `0xd02112ef9c39f1cea7c8527c26242ca1f5d26bcfe8d1564bee054d3b04175471` | `9` |
| `sUSDe` | `0xd2886b34454e2e0de47a82d8e6314b26e1e1312519247e8e2ef137672a909aeb` | `0xd02112ef9c39f1cea7c8527c26242ca1f5d26bcfe8d1564bee054d3b04175471` | `9` |
| `wstETH` | `0xb42cd9ddf61898da1701adb3a003b0cf4ca6df7b5fe490ec2c295b1ca43b33c8` | `0xd02112ef9c39f1cea7c8527c26242ca1f5d26bcfe8d1564bee054d3b04175471` | `9` |

## Fuel Mainnet

| Name | Asset ID | Contract Address | Decimals |
|------|----------|------------------|----------|
| `Ethereum` | `0xf8f8b6283d7fa5b672b530cbb84fcccb4ff8dc40f8176ef4544ddb1f1952ad07` | | `9` |
| `WETH` | `0xa38a5a8beeb08d95744bc7f58528073f4052b254def59eba20c99c202b5acaa3` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
| `weETH` | `0x239ed6e12b7ce4089ee245244e3bf906999a6429c2a9a445a1e1faf56914a4ab` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
| `rsETH` | `0xbae80f7fb8aa6b90d9b01ef726ec847cc4f59419c4d5f2ea88fec785d1b0e849` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
| `rETH` | `0xf3f9a0ed0ce8eac5f89d6b83e41b3848212d5b5f56108c54a205bb228ca30c16` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
| `wbETH` | `0x7843c74bef935e837f2bcf67b5d64ecb46dd53ff86375530b0caf3699e8ffafe` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
| `rstETH` | `0x962792286fbc9b1d5860b4551362a12249362c21594c77abf4b3fe2bbe8d977a` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
| `amphrETH` | `0x05fc623e57bd7bc1258efa8e4f62b05af5471d73df6f2c2dc11ecc81134c4f36` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
| `Manta mBTC` | `0xaf3111a248ff7a3238cdeea845bb2d43cf3835f1f6b8c9d28360728b55b9ce5b` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
| `Manta mETH` | `0xafd219f513317b1750783c6581f55530d6cf189a5863fd18bd1b3ffcec1714b4` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
| `Manta mUSD` | `0x89cb9401e55d49c3269654dd1cdfb0e80e57823a4a7db98ba8fc5953b120fef4` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
| `pumpBTC` | `0x0aa5eb2bb97ca915288b653a2529355d4dc66de2b37533213f0e4aeee3d3421f` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `8` |
| `FBTC` | `0xb5ecb0a1e08e2abbabf624ffea089df933376855f468ade35c6375b00c33996a` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `8` |
| `SolvBTC` | `0x1186afea9affb88809c210e13e2330b5258c2cef04bb8fff5eff372b7bd3f40f` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
| `SolvBTC.BBN` | `0x7a4f087c957d30218223c2baaaa365355c9ca81b6ea49004cfb1590a5399216f` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
| `Mantle mETH` | `0x642a5db59ec323c2f846d4d4cf3e58d78aff64accf4f8f6455ba0aa3ef000a3b` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
| `sDAI` | `0x9e46f919fbf978f3cad7cd34cca982d5613af63ff8aab6c379e4faa179552958` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
| `USDT` | `0xa0265fb5c32f6e8db3197af3c7eb05c48ae373605b8165b6f4a51c5b0ba4812e` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `6` |
| `USDC` | `0x286c479da40dc953bddc3bb4c453b608bba2e0ac483b077bd475174115395e6b` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `6` |
| `USDe` | `0xb6133b2ef9f6153eb869125d23dcf20d1e735331b5e41b15a6a7a6cec70e8651` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
| `sUSDe` | `0xd05563025104fc36496c15c7021ad6b31034b0e89a356f4f818045d1f48808bc` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
| `rsUSDe` | `0x78d4522ec607f6e8efb66ea49439d1ee48623cf763f9688a8eada025def033d9` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
| `wstETH` | `0x1a7815cc9f75db5c24a5b0814bfb706bb9fe485333e98254015de8f48f84c67b` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
| `ezETH` | `0x91b3559edb2619cde8ffb2aa7b3c3be97efd794ea46700db7092abeee62281b0` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
| `pzETH` | `0x1493d4ec82124de8f9b625682de69dcccda79e882b89a55a8c737b12de67bd68` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
| `Re7LRT` | `0xf2fc648c23a5db24610a1cf696acc4f0f6d9a7d6028dd9944964ab23f6e35995` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
| `steakLRT` | `0x4fc8ac9f101df07e2c2dec4a53c8c42c439bdbe5e36ea2d863a61ff60afafc30` | `0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8` | `9` |
29 changes: 29 additions & 0 deletions docs/src/contracts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Verified Deployed Contracts

## Ethereum Mainnet

Contract Name | Contract Address | Implementation Address
--- | --- | ---
FuelChainState | [0xf3D20Db1D16A4D0ad2f280A5e594FF3c7790f130](https://etherscan.io/address/0xf3D20Db1D16A4D0ad2f280A5e594FF3c7790f130) | [0x725B2b1a15D818E1f25c68be77816802e6036559](https://etherscan.io/address/0x725B2b1a15D818E1f25c68be77816802e6036559)
FuelERC20GatewayV4 | [0xa4cA04d02bfdC3A2DF56B9b6994520E69dF43F67](https://etherscan.io/address/0xa4cA04d02bfdC3A2DF56B9b6994520E69dF43F67) | [0xdE2D792ca3C4d02DE3CE1cD1456d8D0990cC3fab](https://etherscan.io/address/0xdE2D792ca3C4d02DE3CE1cD1456d8D0990cC3fab)
FuelMessagePortal | [0xAEB0c00D0125A8a788956ade4f4F12Ead9f65DDf](https://etherscan.io/address/0xAEB0c00D0125A8a788956ade4f4F12Ead9f65DDf) | [0x05f886DDeE0FE07496f6e38b0e140F8eF4655B16](https://etherscan.io/address/0x05f886DDeE0FE07496f6e38b0e140F8eF4655B16)

## Fuel Mainnet

Contract Name | Contract Address | Implementation Address
--- | --- | ---
FuelL2BridgeId | [0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8](https://app.fuel.network/contract/0x4ea6ccef1215d9479f1024dff70fc055ca538215d2c8c348beddffd54583d0e8/minted-assets) | [0x0ceafc5ef55c66912e855917782a3804dc489fb9e27edfd3621ea47d2a281156](https://app.fuel.network/contract/0x0ceafc5ef55c66912e855917782a3804dc489fb9e27edfd3621ea47d2a281156/minted-assets)

## Ethereum Testnet

Contract Name | Contract Address | Implementation Address
--- | --- | ---
FuelChainState | [0xf38F1e65adc58fc74BaaA132f645Aa5307F2d304](https://sepolia.etherscan.io/address/0xf38F1e65adc58fc74BaaA132f645Aa5307F2d304) | [0xdCF1bdBF5341c15e9C1285202f6F6bEA70Db6172](https://sepolia.etherscan.io/address/0xdCF1bdBF5341c15e9C1285202f6F6bEA70Db6172)
FuelERC20GatewayV4 | [0xd1d5a4379dccC46D5c8D1c6c2656ce705698e359](https://sepolia.etherscan.io/address/0xd1d5a4379dccC46D5c8D1c6c2656ce705698e359) | [0x5F9eAEB3b7ec396F01617e9BAd787D0A6f93B7a3](https://sepolia.etherscan.io/address/0x5F9eAEB3b7ec396F01617e9BAd787D0A6f93B7a3)
FuelMessagePortal | [0x01855B78C1f8868DE70e84507ec735983bf262dA](https://sepolia.etherscan.io/address/0x01855B78C1f8868DE70e84507ec735983bf262dA) | [0x6A541330221BE3df4aD6D696Cd3513c0cBFB4752](https://sepolia.etherscan.io/address/0x6A541330221BE3df4aD6D696Cd3513c0cBFB4752)

## Fuel Testnet

Contract Name | Contract Address | Implementation Address
--- | --- | ---
FuelL2BridgeId | 0xd02112ef9c39f1cea7c8527c26242ca1f5d26bcfe8d1564bee054d3b04175471 | 0xfb233ce0bbdc826d1fefa567f025d6f61199f55b59930189841970943cbe6794
3 changes: 3 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Verified Addresses

Verified assets and deployed contract addresses across the Fuel ecosystem.
Loading

0 comments on commit 638856c

Please sign in to comment.