Hello World (โฮสต์บน SubQuery)
Hello World (โฮสต์บน SubQuery)
จุดมุ่งหมายของ quick start นี้คือการแสดงวิธีการเริ่มใช้งานเริ่มต้นสำหรับทำงานใน SubQuery Projects (บริการของเรา) ไม่กี่ขั้นตอนง่ายๆ
เราจะใช้ starter project ที่เรียบง่ายนี้ (รวมถึงทุกอย่างที่เราได้เรียนรู้มาจนถึงตอนนี้) แต่แทนที่จะเรียกใช้ Docker เราจะใช้ประโยชน์จากโครงสร้างพื้นฐานของโฮสติ้งที่มีการจัดการโดย SubQuery กล่าวอีกนัยหนึ่ง เราให้ SubQuery จัดการโครงสร้างพื้นฐานของงาน production การรัน และจัดการงานหนักๆทั้งหมด
วัตถุประสงค์การเรียนรู้
เมื่อจบจากคู่มือใช้งานสำหรับผู้ใช้งานแรกเข้า คุณจะ:
- เข้าใจข้อกำหนดเบื้องต้นที่จำเป็น
- สามารถโฮสต์โปรเจกต์ใน SubQuery Managed Service ได้
- รัน query อย่างง่ายเพื่อรับค่า block height ของเครือข่าย Polkadot mainnet โดยใช้ Playground
- รัน GET query อย่างง่ายเพื่อรับค่า block height ของเครือข่าย Polkadot mainnet โดยใช้ cURL
กลุ่มเป้าหมาย
คู่มือนี้จัดทำขึ้นสำหรับนักพัฒนาหน้าใหม่ที่มีประสบการณ์ด้านการพัฒนามาบ้างแล้ว และสนใจที่จะเรียนรู้เพิ่มเติมเกี่ยวกับ SubQuery
คู่มือวิดีโอ
ข้อกำหนดเบื้องต้น
คุณจะต้องมี:
- บัญชี GitHub
1. สร้างโปรเจกต์ของคุณ
เริ่มสร้างโปรเจกต์ที่ชื่อว่า subqlHelloWorld โดยการรัน subql init และสร้างบนเครือข่าย Polkadot และเริ่มต้นด้วยเทมเพลต subql-starter ผู้ใช้งานจำเป็นต้องติดตั้ง codegen และสร้างด้วยตัวจัดการแพ็คเกจที่คุณต้องการ
> subql init subqlHelloWorld
yarn install
yarn codegen
yarn build
อย่ารันโดยใช้คำสั่ง docker
2. สร้าง GitHub repo
ที่ GitHub ให้สร้าง repository ใหม่ ระบุชื่อและตั้งค่าการเปิดเผยของบัญชีคุณเป็นสาธารณะ ทุกอย่างในนี้จะถูกเก็บไว้เป็นค่าเริ่มต้น
จด GitHub URL ของคุณ ซึ่งต้องตั้งให้เป็นสาธารณะเพื่อให้ SubQuery เข้าถึงได้
3. Push ไปยัง GitHub
กลับไปที่ project directory ของคุณ ให้ตั้งค่าเป็น git directory มิฉะนั้น คุณอาจได้รับ error "fatal: not a git repository (or any of the parent directories): .git"
git init
จากนั้นเพิ่ม remote repository ด้วยคำสั่ง:
git remote add origin https://github.com/seandotau/subqlHelloWorld.git
โดยทั่วไปจะตั้งค่าที่ remote repository ของคุณเป็น "https://github.com/seandotau/subqlHelloWorld.git" และตั้งชื่อว่า "origin" ซึ่งเป็นมาตรฐานการตั้งชื่อ remote repository ใน GitHub
จากนั้น เราจะเพิ่มโค้ดใน repo ของเราด้วยคำสั่งต่อไปนี้:
> git add .
> git commit -m "First commit"
[master (root-commit) a999d88] First commit
10 files changed, 3512 insertions(+)
create mode 100644 .gitignore
create mode 100644 README.md
create mode 100644 docker-compose.yml
create mode 100644 package.json
create mode 100644 project.yaml
create mode 100644 schema.graphql
create mode 100644 src/index.ts
create mode 100644 src/mappings/mappingHandlers.ts
create mode 100644 tsconfig.json
create mode 100644 yarn.lock
> git push origin master
Enumerating objects: 14, done.
Counting objects: 100% (14/14), done.
Delta compression using up to 12 threads
Compressing objects: 100% (13/13), done.
Writing objects: 100% (14/14), 59.35 KiB | 8.48 MiB/s, done.
Total 14 (delta 0), reused 0 (delta 0)
To https://github.com/seandotau/subqlHelloWorld.git
* [new branch] master -> master
คำสั่ง push หมายถึง "โปรด push โค้ดของฉันไปที่ origin repo จาก master local repo ของฉัน" การรีเฟรช GitHub จะแสดงโค้ดทั้งหมดใน GitHub
ในตอนนี้คุณได้นำโค้ดของคุณเข้าไปอยู่ใน GitHub แล้ว มาดูวิธีที่เราจะสามารถโฮสต์โค้ดนั้นใน SubQuery Projects
4. สร้างโปรเจกต์ของคุณ
ไปที่ https://managedservice.subquery.network และเข้าสู่ระบบด้วยบัญชี GitHub ของคุณ
จากนั้นสร้างโปรเจกต์ใหม่
และกรอกข้อมูลในช่องต่างๆให้ครบถ้วน ด้วยรายละเอียดที่เหมาะสม
- GitHub account: หากคุณมีบัญชี GitHub มากกว่าหนึ่งบัญชี ให้เลือกบัญชีที่จะใช้สร้างนี้ โปรเจกต์ที่สร้างขึ้นในบัญชี GitHub organisation จะถูกแชร์ระหว่างสมาชิกใน organisation นั้นๆ
- Project Name: ใส่ ชื่อโปรเจกต์ของคุณที่นี่
- Subtitle: กรอกชื่อรองสำหรับชื่อโปรเจกต์ของคุณ
- Description: อธิบายว่าโปรเจกต์ SubQuery ของคุณทำอะไร
- GitHub Repository URL: ต้องเป็น GitHub URL ที่ใช้งานได้ซึ่งชี้ไปยัง repository สาธารณะที่มีโปรเจกต์ SubQuery ของคุณ ไฟล์ schema.graphql ต้องอยู่ในรูทไดเร็กทอรีของคุณ
- Hide project: หากเลือก จะเป็นการซ่อนจาก SubQuery explorer สาธารณะ อย่าเลือกตัวเลือกนี้หากคุณต้องการแชร์ SubQuery ของคุณกับคอมมูนิตี้! อย่าเลือกตัวเลือกนี้ หากคุณต้องการแบ่งปัน SubQuery ของคุณแก่คอมมูนิตี้!
เมื่อคุณคลิก create คุณจะถูกพาไปที่แดชบอร์ดของคุณ
แดชบอร์ดประกอบด้วยข้อมูลที่เป็นประโยชน์มากมาย เช่น เครือข่ายที่ใช้, GitHub repository URL ของซอร์สโค้ดที่กำลังทำงาน, ข้อมูลเวลาที่ถูกสร้างขึ้นและอัปเดตล่าสุด และโดยเฉพาะอย่างยิ่งรายละเอียดการ deploy
5. Deploy โปรเจกต์ของคุณ
ในตอนนี้ คุณได้สร้างโปรเจกต์ของคุณภายใน SubQuery Projects และตั้งค่าลักษณะการแสดงผลแล้ว ขั้นตอนต่อไปคือการ deploy ของโปรเจกต์คุณเพื่อให้สามารถทำงานได้ การ deploy เวอร์ชันจะทริกเกอร์การทำ SubQuery indexing ใหม่ให้เริ่มต้น และทำการตั้งค่า query service ที่จำเป็นเพื่อเริ่มยอมรับ GraphQL requests คุณยังสามารถ deploy โปรเจกต์เวอร์ชันใหม่บนนี้ได้
คุณสามารถเลือก deploy กับสภาพแวดล้อมต่างๆ เช่น production slot หรือ staging slot เราจะ deploy กับ production slot การคลิกที่ปุ่ม "Deploy" จะแสดงหน้าจอที่มีหัวข้อต่อไปนี้:
- Commit Hash of new Version: ให้คัดลอก commit hash แบบเต็มจากโค้ดโปรเจกต์ SubQuery ที่คุณต้องการ deploy จาก GitHub
- Indexer Version: คือเวอร์ชันของ node service ของ SubQuery ที่คุณต้องการรัน SubQuery อ่าน @subql/node
- Query Version: คือเวอร์ชันของ query service ของ SubQuery ที่คุณต้องการรัน SubQuery อ่าน @subql/node
เนื่องจากเรามีเพียงหนึ่ง commit จึงมีเพียงตัวเลือกเดียวในรายการ drop down นอกจากนี้ เราจะใช้ indexer และ query version ล่าสุด ดังนั้นเราจะยอมรับค่าเริ่มต้น จากนั้นให้คลิก "Deploy Update"
จากนั้นคุณจะเห็นสถานะการ deploy ของคุณเป็น "Processing" โค้ดของคุณกำลังถูก deploy ไปยังโครงสร้างพื้นฐานที่ได้รับการจัดการโดย SubQuery โดยพื้นฐานแล้วเซิร์ฟเวอร์จะขยายตัวตามความต้องการและที่ได้จัดเตรียมไว้ให้คุณ จะใช้เวลาสักครู่ นี่เป็นเวลาที่จะไปดื่มกาแฟสักแก้ว!
ขณะนี้ กำลังดำเนินการการ deploy
6. ทดสอบโปรเจกต์ของคุณ
หากต้องการทดสอบโปรเจกต์ของคุณ ให้คลิกที่จุดไข่ปลา 3 จุด และเลือก "View on SubQuery Explorer"
ซึ่งจะนำคุณไปยัง "Playground" ที่คุ้นเคย ซึ่งคุณสามารถคลิกปุ่ม play และดูผลลัพธ์ของการ query ได้
7. ขั้นตอนโบนัส
สำหรับผู้ที่สังเกตรายละเอียด คุณจะจำได้ว่าในขั้นตอนสุดท้ายของวัตถุประสงค์การเรียนรู้ คือการรันคำสั่ง GET อย่างง่าย ในการดำเนินการนี้ เราจะต้องสนใจ "Query Endpoint" ที่แสดงในรายละเอียดการ deploy ในการดำเนินการนี้ เราจะต้องสนใจ "Query Endpoint" ที่แสดงในรายละเอียดการ deploy
จากนั้น ให้คุณสามารถส่ง GET request ไปยัง endpoint นี้โดยใช้ client ที่คุณชื่นชอบ เช่น Postman หรือ Mockoon หรือผ่าน cURL ในเทอร์มินัลของคุณ สำหรับ cURL จะแสดงด้านล่าง
คำสั่ง curl ที่จะเรียกใช้คือ:
curl https://api.subquery.network/sq/seandotau/subqueryhelloworld -d "query=query { starterEntities (first: 5, orderBy: CREATED_AT_DESC) { totalCount nodes { id field1 field2 field3 } } }"
ซึ่งจะได้ผลลัพธ์คือ:
{"data":{"starterEntities":{"totalCount":23098,"nodes":[{"id":"0x29dfe9c8e5a1d51178565c2c23f65d249b548fe75a9b6d74cebab777b961b1a6","field1":23098,"field2":null,"field3":null},{"id":"0xab7d3e0316a01cdaf9eda420cf4021dd53bb604c29c5136fef17088c8d9233fb","field1":23097,"field2":null,"field3":null},{"id":"0x534e89bbae0857f2f07b0dea8dc42a933f9eb2d95f7464bf361d766a644d17e3","field1":23096,"field2":null,"field3":null},{"id":"0xd0af03ab2000a58b40abfb96a61d312a494069de3670b509454bd06157357db6","field1":23095,"field2":null,"field3":null},{"id":"0xc9f5a92f4684eb039e11dffa4b8b22c428272b2aa09aff291169f71c1ba0b0f7","field1":23094,"field2":null,"field3":null}]}}}
การอ่านไม่ได้เป็นปัญหาในขั้นตอนนี้ เนื่องจากคุณอาจมี front end code เพื่อใช้และแยกวิเคราะห์การแสดงผล JSON นี้
สรุป
ใน SubQuery ที่โฮสต์ quick start นี้ เราแสดงให้เห็นว่าการนำ Subql มา deploy กับ SubQuery Managed Service นั้นง่ายและรวดเร็วเพียงใด ซึ่งมีโครงสร้างพื้นฐานทั้งหมดเพื่อความสะดวกของคุณ มี Playground ในตัวสำหรับการรัน query ต่างๆ รวมถึง API endpoint สำหรับการอินทิเกรตโค้ดของคุณ