إنشاء مشروع NFT بإستخدام IPFS

سيقوم هذا المشروع بتوفير NFTs للمستخدمين بحيث يتمكن كل شخص من سك NFT

المتطلبات الاساسية للبدء في هذا الدرس:

1. انتهيت من قرأة درس اساسيات لغة Solidity.
   
2. انتهيت من قرأة درس ما هو بروتوكل IPFS؟

إعداد المشروع

خلال هذا الدرس ستقوم بإنشاء العقد الذكي من اجل تخزين بيانات الفيديوهات التي سيقوم المستخدمين بنشرها ومن ثم ربط العقد الذكي بالموقع الذي سنقوم ببنائه.

ستقوم بفتح terminal وستدخل هذه الاوامر:

mkdir W3ArabsNFT && cd W3ArabsNFT
mkdir contract-tutorial && mkdir my-app

• في المجلد contract-tutorial سنقوم بإعداد ونشر العقد الذكي.
• في المجلد my-app سنقوم ببناء الواجهة الامامية للمشروع وربطها بالعقد الذكي في الدروس القادمة.

العقد الذكي

سنقوم بإستخدام عقود OpenZeppelin وهي عبارة عن مكتبة لتطوير العقود الذكية الآمنة. يتضمن أكثر عمليات التنفيذ أمانًا واختبارًا للمعايير المشتركة مثل الرموز المميزة ERC20 و ERC721. كما أنه يوفر أنماطًا آمنة للترقية، مما يسمح لك بنشر العقود الذكية وتحديثها بشكل آمن. بالإضافة إلى ذلك، يتميز بواجهة برمجة تطبيقات مستقرة، مما يعني أن عقودك لن تنكسر بشكل غير متوقع عند الترقية إلى إصدار ثانوي أحدث.

يُستخدم العقد Ownable.sol لتنفيذ الملكية في عقودك. ويوفر آليات أساسية للتحكم في الوصول، مما يسمح لك بتقييد وظائف معينة لمالك العقد فقط. كما يوفر أيضًا مفتاح إيقاف تشغيل اختياريًا قابلًا للتعيين من قبل المالك، مما يسمح للمالك بإيقاف العقد من قبول أي معاملات أخرى، والسماح للمالك باستعادة أي أموال متبقية.

العقد ERC721Enumerable.sol و ERC721URIStorage.sol هو عقد يضيف طرق تمديد يمكن عدها إلى معيار ERC721. يتيح ذلك سهولة الوصول إلى بيانات الرمز المميز، مثل عدد الرموز المميزة التي يمتلكها عنوان، وبيانات تعريف رمزية محددة، والمزيد... بالإضافة إلى ذلك، يضيف العقد أيضًا طريقة لنقل العديد من الرموز المميزة في وقت واحد.

العقد Strings.sol يوفر العديد من وظائف معالجة السلاسل. يتضمن وظائف لمقارنة السلاسل، والتحقق مما إذا كانت السلسلة فارغة، والحصول على طول السلسلة

بناء العقد

قبل كل شيء يفضل ان تقوم بأخذ نظرة كاملة على عقد ERC721 لكي يكون لديك معرفة جيدة في التعامل معه

سنستخدم أحد أقوى وأسرع الادوات التي ستساعدنا في التعامل مع العقود الذكية وهي Foundry. يعتبر Foundry هي بيئة وإطار تطوير شبكة Ethereum مصمم للتعامل بشكل كامل مع لغة Solidity.

يمكنك إعداد وتثبيت أداة Foundry في جهازك بواسطة أحد المقالات لدينا من هنا.

سنقوم بفتح المجلد contract-tutorial على terminal ونقوم بإنشاء مشروع Foundry بواسطة هذا الأمر:

cd contract-tutorial
forge init

سنقوم بحذف الملفات التلقائية بالمشروع التي لا نحتاجها عن طريق تشغيل هذا الأمر:

rm src/Counter.sol script/Counter.s.sol test/Counter.t.sol

ستقوم بتثبيت OpenZeppelin في المشروع عن طريق تشغيل هذا الأمر:

forge install openzeppelin/openzeppelin-contracts --no-commit

يمكنك الان فتح مشروعك على محرر الاكواد الخاص بك.

سنلاحظ ان التطبيق يحتوي على 4 مجلدات رئيسية وهي:

1. lib: يحتوي على المُشغل الاساسي للمشروع بالكامل ولن نقوم بالتعديل عليه على الإطلاق.
2. script: والذي سنقوم من خلاله بالتعامل مع العقود الذكية او رفعها على الشبكات.
3. src: الذي سنقوم من خلاله بكتابة العقود الذكية.
4. test: والذي سنقوم من خلاله بإجراء اختبارات لعقدنا الذكي.

يمكنك الان البدء في إنشاء عقدك الذكي. قم بإنشاء ملف بإسم W3ArabsNFT.sol في مجلد src:

// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.24;

import "openzeppelin-contracts/contracts/token/ERC721/extensions/ERC721URIStorage.sol";
import "openzeppelin-contracts/contracts/access/Ownable.sol";

contract W3ArabsNFT is ERC721URIStorage, Ownable {
    // parameters إلى سلاسل عند تمريرها كمعلمات uint256 يشير إلى أنه سيتم تحويل قيم
    using Strings for uint256;

    // لكل رمز مميز URI يتم استخدام هذا المتغير لتخزين
    string _tokenURI;

    // 0.01 يقوم بتخصيص قيمة للرمز المميز وهي
    uint256 public _price = 0.01 ether;

    // إجمالي عدد الرموز المميزة التي تم قبضها
    uint256 public tokenIds;

    /**
    * لتحديد اسم ورمز لمشروعنا ERC721 يُستخدم
    * _tokenURI الخاص بمشروعنا في المتغير baseURI يتم تمرير
    */
    constructor (string memory baseURI, address initialOwner) 
        ERC721("W3ArabsNFT", "W3AN") 
        Ownable(initialOwner)
    {
        _tokenURI = baseURI;
    }

    // NFT تسمح هذه الدالة للمستخدم بقبض 1
    function mint(address recipient) public payable {
        // يجب ان يمتلك المستخدم ايثير بقيمة اكثر من او يساوي 0.01
        require(msg.value >= _price, "You have not a ether");
        // NFT في كل مرة يقوم المستخدم بسك tokenIds يقوم بزيادة
        tokenIds += 1;
        _safeMint(recipient, tokenIds);
    }

    function _baseURI() internal view virtual override returns (string memory) {
        return _tokenURI;
    }

    function tokenURI(uint256 tokenId) public view virtual override returns (string memory) {
        require(tokenId <= tokenIds);

        string memory baseURI = _baseURI();
        return bytes(baseURI).length > 0 ? string(abi.encodePacked(baseURI)) : "";
    }

    function withdraw(address recipient) public onlyOwner {
        uint256 amount = address(this).balance;
        (bool sent, ) =  recipient.call{value: amount}("");
        require(sent, "Error to send Ether");
    }

    receive() external payable {}

    fallback() external payable {}
}

كل ما تحتاجه الان لاكمال عقدك الذكي هو كتابة الوظائف التي تريد تشغليها في داخل العقد الذكي كما تريد ان يعمل العقد الذكي الخاص بك

دعنا نقوم بتوضيح بعض function التي استخدمت في العقد الذكي

function _baseURI() internal view virtual override returns (string memory) {
    return _tokenURI;
}

تقوم الدالة ()baseURI_ بتجاوز الدالة ()baseURI_ التي توفرها Openzeppelin، والتي تُرجع افتراضيًا سلسلة فارغة. تُرجع الدالة الجديدة ()baseURI_ قيمة tokenURI__ وهي متغير مخزن في العقد ويمكن للمالك تعيينه. يسمح هذا للمالك بتعيين URI أساسي لاستخدامه كقاعدة لجميع URIs المميزة.

function tokenURI(uint256 tokenId) public view virtual override returns (string memory) {
    _requireMinted(tokenId);

    string memory baseURI = _baseURI();
    return bytes(baseURI).length > 0 ? string(abi.encodePacked(baseURI)) : "";
}

تقوم الدالة ()tokenURI بتجاوز الدالة ()tokenURI التي توفرها Openzeppelin، والتي تأخذ uint256 tokenId كوسيطة وتعيد سلسلة تحتوي على رمز URI. تتطلب دالة tokenURI أن يكون tokenId قد تم سكه مسبقًا وستعيد baseURI المتسلسل مع tokenId إذا لم يكن baseURI فارغًا.

function withdraw(address recipient) public onlyOwner {
    uint256 amount = address(this).balance;
    (bool sent, ) =  recipient.call{value: amount}("");
    require(sent, "Error to send Ether");
}

يستخدم لسحب الأموال من عقد ذكي. يحصل أولاً على عنوان مالك العقد باستخدام دالة المالك (). ثم يحصل على مقدار إيثر الذي يحتفظ به العقد حاليًا باستخدام العنوان (هذا). تعبير التوازن. ثم يستدعي الرمز دالة call () على عنوان المالك، ويمرر مقدار Ether كمعامل قيمة. أخيرًا، يتحقق للتأكد من إرسال إيثر بنجاح، ويعطي خطأ إذا لم يكن كذلك.

receive() external payable {}

fallback() external payable {}

تُستخدم دالة receive() لتلقي إيثر من مصادر خارجية ، مثل من المستخدمين الذين يرسلون المعاملات إلى العقد.

تُستخدم دالة fallback() للتعامل مع أي معاملات أخرى تدخل في العقد ، مثل استدعاءات الوظائف غير الموجودة.

يتم تمييز كلتا الوظيفتين على أنهما قابلان للدفع، مما يعني أنهما يمكنهما قبول الأثير كجزء من مدخلاتهما

رفع NFT والبيانات الوصفية على IPFS

سنقوم بإستخدام منصة Pinata من اجل ان نقوم برفع الملفات على IPFS ونتحكم بها بكل سهولة.

قم بإنشاء حساب على Pinata حتى يتم إعادك الى لوحة التحكم.

سنقوم برفع صورة بسيطة من جهازنا على Pinata من هنا:

بعد ان قمت برفع الصورة على pinata قم بنسخ CID الخاص بالصورة حتى تقوم بإضافته في ملف metadata.json لاحقاً.

بعد ان قمت برفع صورة NFT ستحتاج الى إضافة البيانات البيانات الوصفية. قم بإنشاء ملف في جهازك بإسم metadata.json وقم بإضافة هذا

سنقوم الان بإنشاء ملف metadata.json في مشروعنا (او على الجهاز) ومن ثم إضافة CID الخاص بالصورة.. يمكنك نسخ هذا وإضافته إلى ملف metadata.json

قم بإستبدال كلمة add_your_ipfs_cid التي في الكود بال CID المتعلق بالصورة التي قمت برفعها على Pinata

{
    "description": "This NFT I've deployed an ERC721 Smart Contract",
    "external_url": "https://web3arabs.com",
    "image": "https://copper-colonial-lamprey-141.mypinata.cloud/ipfs/add_your_ipfs_cid",
    "name": "ERC721 PUG",
    "attributes": [
        {
            "trait_type": "Coolness",
            "value": "A lot"
        },
        {
            "trait_type": "W3A",
            "value": "web3arabs.com"
        },
        {
            "trait_type": "Token",
            "value": "ERC721"
        }
    ]
}

ستقوم الان برفع ملف metadata.json على Pinata كما قمت سابقاٌ يرفع الصورة.

قم بنسخ CID الخاص بملف metadata.json سنقوم بإستخدامه اثناء نشر العقد الذكي.

نشر العقد الذكي

يمكنك الان رفع عقدك الذكي بكل سهولة. سنقوم باستخدام شبكة الاختبارات وهي sepolia.

سنقوم بنشر العقد الذكي بطريقة مختلفة قليلاً عن السابق. قم بإنشاء ملف بإسم W3ArabsNFT.s.sol في المجلد script:

// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.24;

import "forge-std/Script.sol";
import "../src/W3ArabsNFT.sol";

contract W3ArabsScript is Script {
    W3ArabsNFT w3arabs;

    function setUp() public {
        uint256 deployerPrivateKey = vm.envUint("PRIVATE_KEY");
        vm.startBroadcast(deployerPrivateKey);

        w3arabs = new W3ArabsNFT(
            "https://copper-colonial-lamprey-141.mypinata.cloud/ipfs/add_your_ipfs_cid", 
            add_your_address
        );

        vm.stopBroadcast();
    }

    function run() public {
    }
}

الان ستحتاج الى مزود عقدة يتيح لك الاتصال بالعديد من سلاسل الكتل المختلفة. يمكنك استخدام QuickNode كمزود للعقد الخاصة بك بكل سهولة.

قم بإنشاء حساب على QuickNode من خلال النقر على Create account وإذا كان لديك حساب بالفعل قم بتسجيل الدخول مباشرة من خلال النقر على Sign in.

بمجرد تسجيل الدخول سيتقم نقلك إلى لوحة التحكم هذه:

سنقوم بالذهاب الى قسم Endpoints من خلال القسم الايسر ومن ثم النقر على الزر Create Endpoint من اجل إنشاء مزود عُقدة

سنقوم بإنشاء Endpoints بهذه الطريقة:

1- سنقوم بإستخدام سلسلة Ethereum فلذلك سنقوم بتحديدها هكذا والنقر على الزر Continue:

2- بما ان الغرض من الدرس هو التعلم فلذلك سنقوم بتحديد شبكة الإختبار Sepolia والنقر على الزر Continue:

3- سنقوم بالنقر على الزر Create Endpoint لإنشاء المزود:

4- أخيراً - ستقوم بنسخ HTTP Provider لأننا سنحتاجه لاحقاً من اجل نشر عقدنا الذكي على شبكة Sepolia

ستقوم الان بنسخ Private Key الخاص بمحفظتك المشفرة عن طريق:

1. فتح المحفظة الخاصة بك ومن ثم النقر على الثلاث النقاط التي في الاعلى على اليمين.
2. النقر على زر Account details ومن ثم النقر على Show private key.
3. قم بكتابة كلمة السر الخاصة بك ومن ثم سيتم عرض لك private key المرتبطة بحسابك.

قم بإضافة كل ما قمت بنسخه في ملف (.env):

QUICKNODE_HTTP_PROVIDER="add-quicknode-http-url-here"
PRIVATE_KEY="add-private-key-here"

في حال لم تقوم بإضافة المحفظة من قبل، ستقوم بإضافة معلومات محفظتك في جهازك عن طريق المفتاح الخاص (Private Key) الذي قمت بنسخه عن طريق تشغيل هذا الأمر:

ستقوم أولاً بإضافة العنوان الخاص ومن ثم كلمة سر خاصه بك وتذكرها جيداً، لأن سيتم مطالبتك بها في كل مره تريد استخدام محفظتك في نشر عقد ذكي.

cast wallet import deployer --interactive

ستقوم بالتأكيد عن طريق تشغيل هذا الأمر:

cast wallet list

قم بتجميع العقد الذكي الخاص بك الان. تأكد من انك في مسار تطبيقك (contract) وقم بتشغيل هذا الامر:

forge build

ملاحظة: يمكنك الحصول على بعض العملات التي تساعدك في اختبار ونشر تطبيقاتك على شبكة Sepolia من صنبور Web3Arabs هنا - قم بتوصيل محفظتك بالصنبور وإنقر على الزر إرسال.

الان ستقوم بتفعيل المتغير المتواجد في ملف .env في terminal من أجل إستخدامها في الخطوة القادمة:

source .env

حان وقت نشر عقدك الذكي :) قم بكتابة هذا الامر

forge script script/W3ArabsNFT.s.sol:W3ArabsScript —rpc-url $QUICKNODE_HTTP_PROVIDER --account deployer --broadcast 

قم بنسخ عنوان عقدك الذكي من أجل إجتياز الاختبار في الاسفل وحفظه حتى نتمكن من استخدامه اثناء جعله يعمل في الواجهة الامامية.

كما هو الحال دائمًا، إذا كانت لديك أي أسئلة أو شعرت بالتعثر أو أردت فقط أن تقول مرحبًا، فقم بالإنضمام على Telegram او Discord وسنكون أكثر من سعداء لمساعدتك!