-
Notifications
You must be signed in to change notification settings - Fork 47
feat: add IPC Chain Testnet documentation and user guide #1472
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.
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
Open
phutchins
wants to merge
1
commit into
main
Choose a base branch
from
docs/add-metamask-ipc-chain-testnet-instructions
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| # GitBook Assets | ||
|
|
||
| This directory contains images and other assets used in the IPC GitBook documentation. | ||
|
|
||
| ## Usage | ||
|
|
||
| When adding images to GitBook documentation: | ||
|
|
||
| 1. Save images to this directory with descriptive names | ||
| 2. Use lowercase with hyphens for filenames (e.g., `ipc-testnet-metamask.png`) | ||
| 3. Reference images in markdown using the relative path: `.gitbook/assets/filename.png` | ||
|
|
||
| ## Current Assets | ||
|
|
||
| - `ipc-testnet-metamask.png` - MetaMask configuration screenshot for IPC Chain Testnet | ||
|
|
||
| ## Best Practices | ||
|
|
||
| - Use PNG format for screenshots | ||
| - Use JPG format for photos | ||
| - Optimize images for web (compress when possible) | ||
| - Use descriptive filenames that indicate the content | ||
| - Keep images organized and remove unused assets | ||
|
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| --- | ||
| description: Learn how to connect to the IPC Chain Testnet using MetaMask to interact with the IPC ecosystem. | ||
| --- | ||
|
|
||
| # Connecting to IPC Chain Testnet | ||
|
|
||
| The IPC Chain Testnet (also known as "IPC Cal") is a public testnet where you can experiment with IPC features, deploy smart contracts, and test your applications before moving to production. | ||
|
|
||
| ## Network Details | ||
|
|
||
| The IPC Chain Testnet has the following parameters: | ||
|
|
||
| * **Network Name**: IPC Cal | ||
| * **RPC URL**: `http://node-1.test.ipc.space:8545` | ||
| * **Chain ID**: `385401` | ||
| * **Currency Symbol**: `tFIL` | ||
| * **Block Explorer**: _Coming soon_ | ||
|
|
||
| ## Adding IPC Chain Testnet to MetaMask | ||
|
|
||
| Follow these steps to add the IPC Chain Testnet to your MetaMask wallet: | ||
|
|
||
| ### Step 1: Open MetaMask Network Settings | ||
|
|
||
| 1. Open your MetaMask extension | ||
| 2. Click on the network dropdown at the top of MetaMask | ||
| 3. Click "Add network" or "Add a network manually" | ||
|
|
||
| ### Step 2: Enter Network Details | ||
|
|
||
| Enter the following information in the network configuration form: | ||
|
|
||
|  | ||
|
|
||
| * **Network name**: `IPC Cal` | ||
| * **New RPC URL**: `http://node-1.test.ipc.space:8545` | ||
| * **Chain ID**: `385401` | ||
| * **Currency symbol**: `tFIL` | ||
| * **Block explorer URL**: _(Leave empty for now)_ | ||
|
|
||
| ### Step 3: Save and Switch | ||
|
|
||
| 1. Click "Save" to add the network | ||
| 2. MetaMask will automatically switch to the IPC Chain Testnet | ||
| 3. You should now see "IPC Cal" as your active network | ||
|
|
||
| ## Getting Test Tokens | ||
|
|
||
| To interact with the IPC Chain Testnet, you'll need test tFIL tokens. | ||
|
|
||
| {% hint style="info" %} | ||
| A testnet faucet will be made available soon. In the meantime, please reach out to the IPC team for test tokens. | ||
| {% endhint %} | ||
|
|
||
| ## Verifying Your Connection | ||
|
|
||
| Once connected, you can verify your connection by: | ||
|
|
||
| 1. Checking that your MetaMask shows "IPC Cal" as the active network | ||
| 2. Your account balance should display in tFIL | ||
| 3. Try sending a small test transaction to confirm the connection is working | ||
|
|
||
| ## Next Steps | ||
|
|
||
| Now that you're connected to the IPC Chain Testnet, you can: | ||
|
|
||
| * Deploy smart contracts using Remix or Hardhat | ||
| * Interact with existing IPC subnet contracts | ||
| * Test cross-subnet communication features | ||
| * Explore IPC-specific functionality | ||
|
|
||
| For more information on deploying and interacting with subnets, see: | ||
|
|
||
| * [Deploy a subnet](../quickstarts/deploy-a-subnet.md) | ||
| * [Performing transactions in a subnet](performing-transactions-in-a-subnet.md) | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### Connection Issues | ||
|
|
||
| If you're having trouble connecting to the testnet: | ||
|
|
||
| * Ensure you've entered the RPC URL correctly: `http://node-1.test.ipc.space:8545` | ||
| * Check that the Chain ID is exactly `385401` | ||
| * Try refreshing MetaMask or restarting your browser | ||
|
|
||
| ### Transaction Failures | ||
|
|
||
| If transactions are failing: | ||
|
|
||
| * Verify you have sufficient tFIL for gas fees | ||
| * Check the network status - the testnet may be undergoing maintenance | ||
| * Ensure you're connected to the correct network (IPC Cal) | ||
|
|
||
| For additional help, see the [Troubleshooting guide](../reference/troubleshooting.md) or reach out to the IPC community. | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: Image Path Error in User Guides
The image path for
ipc-testnet-metamask.pngon line 33 is incorrect. The current relative path doesn't account for the file's location within theuser-guidesdirectory, so the image won't display.