Xuất bản Dự Án SubQuery của bạn

... 2022-8-5 Khoảng 9 phút

# Xuất bản Dự Án SubQuery của bạn

# Lợi ích của việc lưu trữ dự án của bạn với SubQuery

  • Chúng tôi sẽ chạy các dự án SubQuery cho bạn trong một dịch vụ công khai có hiệu suất cao, có thể mở rộng và được quản lý
  • Dịch vụ này đang được cung cấp đến cộng đồng miễn phí!
  • Bạn có thể tạo ra các dự án công khai do đó chúng sẽ được liệt kê trong SubQuery Explorer (opens new window) và bất cứ ai trên khắp thế giới cũng đều có thể xem chúng
  • Chúng tôi được tích hợp với GitHub, vì thế bất kỳ ai trong các tổ chức GitHub của bạn cũng sẽ xem được các dự án đã chia sẻ của tổ chức

# Tạo dự án đầu tiên của bạn trong Dự án SubQuery

# Lưu trữ Codebase dự án

Có hai cách để bạn có thể lưu trữ codebase của dự án SubQuery của mình trước khi xuất bản.

** GitHub **: Codebase của dự án của bạn phải nằm trong kho lưu trữ GitHub công khai

IPFS: Codebase dự án của bạn có thể được lưu trữ trong IPFS, bạn có thể làm theo hướng dẫn lưu trữ IPFS của chúng tôi để xem cách xuất bản lần đầu lên IPFS

# Đăng nhập vào Các Dự Án SubQuery

Trước khi bắt đầu, vui lòng đảm bảo rằng codebase dự án SubQuery của bạn trực tuyến trong kho lưu trữ GitHub công khai hoặc trên IPFS. Tệp tin schema.graphql phải được nằm trong thư mục gốc của bạn.

Để tạo ra dự án đầu tiên, hãy đến project.subquery.network (opens new window). Bạn sẽ cần xác thực tài khoản GitHub của mình để đăng nhập.

Trong lần đăng nhập đầu tiên, bạn sẽ được yêu cầu cấp quyền cho SubQuery. Chúng tôi chỉ cần địa chỉ email của bạn để định dạnh tài khoản của bạn, và chúng tôi không sử dụng bất kỳ dữ liệu nào từ tài khoản GitHub của bạn vì bất kỳ lý do gì. Trong bước này, bạn cũng có thể yêu cầu cấp quyền truy cập đến tài khoản GitHub Organization của bạn để đăng các dự án SubQuery dưới GitHub Organization của mình thay vì tài khoản cá nhân.

Thu hồi chấp thuận từ một tài khoản GitHub

SubQuery Projects là nơi bạn quản lý tất cả các dự án của bạn đã được tải lên nền tảng SubQuery. Bạn có thể tạo, xóa, và thậm chí nâng cấp các dự án từ ứng dụng này.

Đăng Nhập Các Dự Án

Nếu bạn có kết nối các tài khoản GitHub Organization, bạn có thể sử dụng tính năng chuyển đổi ở đầu trang để thay đổi giữa tài khoản cá nhân và tài khoản GitHub Organization. Các dự án được tạo ra trong tài khoản GitHub Organization đều được chia sẻ giữa các thành viên trong GitHub Organization đó. Để kết nối tài khoản GitHub Organization của bạn, bạn có thể làm theo các bước tại đây.

Chuyển đổi giữa các tài khoản GitHub

# Tạo Dự Án Đầu Tiên

Có hai phương pháp để tạo một dự án trong Dịch vụ quản lý SubQuery, bạn có thể sử dụng giao diện người dùng hoặc trực tiếp thông qua công cụ subql cli.

# Sử dụng giao diện người dùng

Chúng ta hãy bắt đầu bằng cách nhấp vào "Create Project". Bạn sẽ được đưa đến biểu mẫu New Project. Vui lòng nhập theo hướng dẫn sau (bạn có thể thay đổi trong tương lai):

  • Tài khoản GitHub: Nếu bạn có nhiều hơn một tài khoản GitHub, hãy chọn ra tài khoản mà dự án sẽ được tạo ra bởi nó. Các dự án được tạo ra trong tài khoản GitHub Organization đều được chia sẻ giữa các thành viên trong cùng tổ chức.
  • Tên dự án
  • Phụ đề
  • Mô tả
  • URL Kho Lưu Trữ GitHub: Đây phải là một URL GitHub hợp lệ chỉ đến kho lưu trữ công khai có chứa dự án SubQuery của bạn. Tập tin schema.graphql phải nằm trong thư mục gốc của bạn (tìm hiểu thêm về cấu trúc thư mục gốc).
  • Cơ sở dữ liệu: Khách hàng cao cấp có thể truy cập cơ sở dữ liệu chuyên dụng để lưu trữ các dự án SubQuery sản xuất từ đó. Nếu điều này khiến bạn quan tâm, bạn có thể liên hệ với sales@subquery.network để kích hoạt cài đặt này.
  • Nguồn triển khai: Bạn có thể chọn triển khai dự án từ kho lưu trữ GitHub hoặc triển khai cách khác từ IPFS CID, xem hướng dẫn của chúng tôi về lưu trữ với IPFS.
  • Ẩn dự án: Nếu được chọn, điều này sẽ ẩn dự án khỏi trình khám phá SubQuery công khai. Hãy bỏ chọn mục này nếu bạn muốn chia sẻ SubQuery của mình với cộng đồng! Tạo Dự Án đầu tiên của bạn

Hãy tạo dự án cho riêng mình và bạn sẽ thấy nó trong danh sách ubQuery Project's của bạn. Chúng ta sắp xong rồi! Chúng ta chỉ cần triển khai một phiên bản mới của nó.

Tạo Dự án mà không cần triển khai

# Sử dụng CLI

Bạn cũng có thể sử dụng @subql/cli để triển khai mới của dự án lên dịch vụ được quản lý của chúng tôi. Điều này yêu cầu:

  • @subql/cli phiên bản 1.1.0 trở lên.
  • Một SUBQL_ACCESS_TOKEN hợp lệ đã sẵn sàng.
// Tạo dự án sử dụng CLI
$ subql project:create-project

// HOẶC không tác động đến, nó sẽ nhắc bạn nếu thiếu các trường bắt buộc
$ subql project:create-project
    --apiVersion=apiVersion      Api version is default to 2
    --description=description    Enter description
    --gitRepo=gitRepo            Enter git repository
    --org=org                    Enter organization name
    --project_name=project_name  Enter project name
1
2
3
4
5
6
7
8
9
10

# Triển khai phiên bản đầu tiên

Có hai phương pháp để triển khai một phiên bản mới của dự án của bạn cho Dịch vụ quản lý SubQuery, bạn có thể sử dụng giao diện người dùng hoặc trực tiếp thông qua công cụ subql cli.

# Sử dụng giao diện người dùng

Trong khi đang khởi tạo, dự án sẽ thiết lập hành vi hiển thị của nó, bạn phải triển khai một phiên bản của nó trước khi dự án đi vào vận hành. Triển khai một phiên bản sẽ kích hoạt khởi động lập chỉ mục SubQuery mới để bắt đầu, và cài đặt dịch vụ truy vấn để chấp nhận các yêu cầu từ GraphQl. Bạn cũng có thể triển khai các phiên bản mới đối với các dự án hiện tại tại đây.

Cùng với dự án mới của mình, bạn sẽ thấy một nút bấm Deploy New Version. Nhấp vào nút này, và điền vào các thông tin bắt buộc để thực hiện triển khai:

  • Branch: Từ GitHub, chọn nhánh của dự án mà bạn muốn triển khai
  • Commit Hash: Từ GitHub, hãy chọn commit cụ thể của phiên bản codebase dự án SubQuery mà bạn muốn triển khai
  • IPFS: Nếu triển khai từ IPFS, hãy dán CID triển khai IPFS của bạn (không có ipfs: // đứng đầu)
  • Override Network and Dictionary Endpoints: Bạn có thể ghi đè các điểm cuối trong tệp kê khai dự án của mình tại đây
  • Indexer Version: Đây là phiên bản của dịch vụ nút SubQuery mà bạn muốn chạy SubQuery này. Xem @subql/node (opens new window)
  • Query Version: Đây là phiên bản của dịch vụ truy vấn SubQuery mà bạn muốn chạy SubQuery này. Xem @subql/query (opens new window)

Triển khai Dự Án đầu tiên của bạn

Nếu được triển khai thành công, bạn sẽ thấy trình lập chỉ mục bắt đầu hoạt động và báo cáo về tiến độ lập chỉ mục cho chuỗi hiện tại. Tiến trình này có thể mất nhiều thời gian cho tới khi nó đạt đến 100%.

# Sử dụng CLI

Bạn cũng có thể sử dụng @subql/cli để tạo một triển khai mới của dự án cho dịch vụ được quản lý của chúng tôi. Điều này yêu cầu:

  • @subql/cli phiên bản 1.1.0 trở lên.
  • Một SUBQL_ACCESS_TOKEN hợp lệ đã sẵn sàng.
// Triển khai sử dụng CLI
$ suqbl deployment:deploy

// Hoặc triển khai không tác động tới CLI
$ suqbl deployment:deploy
  --dict=dict                      Enter Dictionary Endpoint
  --endpoint=endpoint              Enter Network Endpoint
  --indexerVersion=indexerVersion  Enter indexer-version
  --ipfsCID=ipfsCID                Enter IPFS CID
  --org=org                        Enter Organization Name
  --project_name=project_name      Enter Project Name
  --queryVersion=queryVersion      Enter Query-version
  --type=type                      Enter deployment type e.g. primary or stage
1
2
3
4
5
6
7
8
9
10
11
12
13

# Các Bước Tiếp Theo - Kết nối đến Dự Án của bạn

Sau khi việc triển khai đã thành công và các nút của chúng ta đã lập chỉ mục dữ liệu của bạn trên chuỗi, bạn sẽ có thể kết nối với dự án của mình thông qua hiển thị của điêm cuối truy vấn GraphQL.

Các dự án đang được triển khai và đồng bộ

Ngoài ra, bạn có thể nhấp vào ba dấu chấm bên cạnh tiêu đề dự án của mình và xem nó trên SubQuery Explorer. Tại đó bạn có thể sử dụng nền tảng trong trình duyệt để tiến hành - tìm hiểu nhiều hơn về cách sử dụng Explorer của chúng tôi tại đây.

Projects trong SubQuery Explorer

# Thêm Tài Khoản GitHub Organization vào các Dự Án SubQuery

Xuất bản dự án SubQuery dưới tên tài khoản GitHub Organization của bạn thay vì dùng tài khoản GitHub cá nhân là điều phổ biến. Bạn có thể thay đổi tài khoản hiện đang chọn trên SubQuery Projects (opens new window) bất cứ lúc nào bằng cách sử dụng tính năng chuyển đổi tài khoản.

Chuyển đổi giữa các tài khoản GitHub

Nếu bạn không thể nhìn thấy tài khoản GitHub Organization của mình được liệt kê trong phần chuyển đổi tài khoản, bạn có thể cần phải cấp quyền truy cập vào SubQuery đối với GitHub Organization của bạn (hoặc yêu cầu quyền này từ một quản trị viên). Để thực hiện việc này, trước tiên bạn cần thu hồi quyền từ tài khoản GitHub của mình đối với Ứng dụng SubQuery. Để thực hiện việc này, hãy đăng nhập vào phần cài đặt tài khoản của bạn trong GitHub, đến Applications, và bên dưới thẻ Authorized Oauth Apps, thu hồi SubQuery - bạn có thể làm theo các bước chính xác tại đây (opens new window). Đừng lo, việc này sẽ không xóa đi dự án SubQuery của bạn và bạn sẽ không bị mất bất kỳ dữ liệu nào.

Thu hồi truy cập đối với tài khoản GitHub

Sau khi bạn đã thu hồi quyền truy cập, hãy đăng xuất ra khỏi SubQuery Projects (opens new window) và đăng nhập vào lại. Bạn sẽ được điều hướng đến một trang có tiêu đề Authorize SubQuery đây là trang bạn có thể yêu cầu cấp quyền truy cập SubQuerry đến tài khoản GitHub Organization của bạn. Nếu bạn không có các quyền quản trị, bạn cần phải yêu cầu một quản trị quyên cấp các quyền này cho bạn.

Thu hồi chấp thuận từ một tài khoản GitHub

Sau khi yêu cầu đã được chấp thuận bởi quản trị viên (hoặc nếu bạn có thể tự cấp quyền cho mình), bạn sẽ thấy tài khoản GitHub Organization chính xác trong khu vực chuyển đổi tài khoản.

Cập nhật gần nhất lúc: August 5, 2022 10:08