The Po.et Node offers an innovative way to timestamp documents in a decentralized manner, utilizing the power of the Bitcoin blockchain and IPFS. This guide walks you through the setup and running of the Po.et Node, making everything user-friendly and troubleshooting-friendly!
How to Run the Po.et Node
Follow these steps to get up and running with the Po.et Node:
Dependencies
- Ensure you have Docker and docker-compose installed on your system.
- The Po.et Node also relies on:
Configuration
The Po.et Node comes with default configurations. If you need to enable blockchain anchoring, ensure the Bitcoin Core dependency is running with a funded wallet.
Running the Node
To start, clone the repository:
git clone https://github.com/poetapp/node.git
cd node
Then run this command to start the environment:
docker-compose up --build
If you’re developing and want blocks to generate automatically, follow these additional steps:
cp docker-compose.override.yml.example docker-compose.override.yml
# Edit docker-compose.override.yml uncomment the regtest-watcher service in docker-compose.yml
docker-compose up --build
To shut down, use:
docker-compose down --volumes
This will stop all running containers and clear data. If you wish to keep the data, just use:
docker-compose down
Understanding the Code: An Analogy
Imagine your setup process as preparing a meal. Here’s how the process unfolds:
- When you
git clonethe repository, it’s like gathering all your ingredients from the market. - Running
docker-compose up --buildis akin to mixing and cooking those ingredients together to create your dish. - The
docker-compose down --volumesis similar to cleaning your kitchen after cooking, ensuring no leftover ingredients are lying around. - By configuring the environment, you’re adjusting the recipe to suit your taste preferences (like adding spices).
Troubleshooting Tips
If you run into issues, here are a few common fixes:
- Ensure all dependencies are correctly installed, especially Docker and Docker Compose.
- If the service doesn’t start, check the logs with
docker-compose logsto identify any errors. - For configuration changes to be effective, don’t forget to restart the Node.
- Remember, if you’re facing connectivity issues between services, verifying that all Docker containers are running might resolve your problem.
For additional troubleshooting insights, connect with **fxis.ai** for expert support or collaboration on AI development projects.
API Endpoints and Usage
The Po.et Node provides four essential API endpoints for handling documents:
GET works?issuer=xxx&limit=x&offset=x
This endpoint returns a paginated array of signed verifiable work claims, allowing filtering by issuer and pagination parameters.
GET works:id
Retrieve a single signed verifiable work claim by its ID. Be aware that a 404 error may not mean the claim is absent from the Po.et Network, just unindexed in your Node.
POST works
This is where you publish new claims, sending a fully constructed signed verifiable claim and receiving an acknowledgment. Keep in mind, you will need to confirm the processing status with the GET method.
POST files
Currently, this accepts a single file upload and returns the file’s hash along with its archive URL.
Building Claims
Claims are central to the Po.et Node’s functionality. A claim is a signed, verifiable statement about a document, ensuring its creation and integrity.
For deeper integration with JavaScript or TypeScript, explore the Po.et JS library.
At **fxis.ai**, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.
Conclusion
The Po.et Node provides a robust framework for timestamping documents securely and verifiably. With its simple setup process and powerful API, you’re now ready to make the most of this decentralized technology!