Torii საბოლოო წერტილები
Torii ეს არის HTTP, SSE, და WebSocket შესასვლელი Iroha 3. იგი ემსახურება ორივე ლიდერების მიმართულებით APIs და ოპერატორის საბოლოო წერტილები.
ამჟამინდელი პროტოკოლის წესები არის:
- კანონიკური ბინარული ფორმატი არის Norito
- ბევრი საბოლოო წერტილი ასევე მხარს უჭერს JSON, როდესაც თქვენ გაგზავნით
Accept: application/json - მაჩვენებლები არის გამოქვეყნებული Prometheus ფორმატში
ფორმატის დეტალების, შინაარსის მოლაპარაკებების, განლაგების დროშების, სქემა ჰეშების და Norito RPC სახელმძღვანელოებისათვის იხილეთ Norito რეფერენცია .
საერთო დასასრული პუნქტები
| დასასრული | ფორმატი | მიზანი |
|---|---|---|
POST /transaction | Norito | წარადგინეთ ხელმოწერილი ოპერაცია |
POST /query | Norito | წარადგინეთ ხელმოწერილი გამოკითხვა |
GET /events | WebSocket | გამოწერეთ ღონისძიებების ნაკადები |
GET /block/stream | WebSocket | ბლოკების გადაცემა |
GET /peers | JSON | Torii -ის მიერ გამოქვეყნებული თანატოლთა სია |
GET /health | JSON | მსუბუქი სიცოცხლის საწინააღმდეგო |
GET /api_version | JSON | API რედაქტირება |
GET /status | JSON | ოპერატორებისთვის მაღალი დონის სტატუსის შემაჯამებელი |
GET /metrics | პრომეთეოსი | Prometheus scrape ბოლო წერტილი |
GET /schema | JSON | მონაცემთა მოდელის სქემის გადაღება, რომელიც ემსახურება კვანძს |
GET /openapi ან GET /openapi.json | JSON | OpenAPI დოკუმენტი აქტიური Torii HTTP მარშრუტებისთვის |
GET /v1/parameters | JSON | კვანძის პარამეტრების გადაღება |
GET /v1/node/capabilities | JSON | კვანძის შესაძლებლობა და მონაცემთა მოდელის მეტა-მონაცემები |
GET /v1/api/versions | JSON | მხარდაჭერილი Torii API ვერსიები |
GET /v1/events/sse | SSE | ღონისძიებების ნაკადი ხანგრძლივი კლიენტებისთვის |
GET /v1/time/now | JSON | ნოდის კედლის საათის გადაღება |
GET /v1/time/status | JSON | დროის სინქრონიზაციის სტატუსი |
/openapi არის ავტორიტეტული საბოლოო წერტილების სია მიმდინარე კვანძისთვის. ზუსტი ზედაპირი დამოკიდებულია აშენების მახასიათებლებსა და მიმდინარეობის კონფიგურაციაზე, ამიტომ გენერირებულმა კლიენტებმა უნდა ურჩიონ ცოცხალი OpenAPI დოკუმენტი ხელით გადაწერილი მარშრუტის სიაში. გამოიყენეთ Torii API კონსოლი იმ ცოცხალი დოკუმენტის დატვირთვა, ტესტირება JSON მარშრუტები, კოპირება curl მოთხოვნები, და გენერირებს კლიენტური კოდი მიმდინარე სქემა.
სცადეთ პირდაპირი Taira მარშრუტები
საჯარო Taira ტესტის ქსელი ამჟღავნებს იმავე Torii JSON ზედაპირს, რომელსაც აპლიკაციის კლიენტები მხოლოდ წაკითხვის მიზნით იყენებენ. აღნიშნულ ბრძანებებს არ მოითხოვს გასაღებები:
TAIRA_ROOT=https://taira.sora.org
curl -fsS "$TAIRA_ROOT/status" \
| jq '{blocks, txs_approved, txs_rejected, queue_size, peers}'
curl -fsS "$TAIRA_ROOT/openapi.json" \
| jq -r '.paths | keys[]' \
| grep '^/v1/' \
| head -n 20
curl -fsS "$TAIRA_ROOT/v1/node/capabilities" \
| jq '{abi_version, data_model_version, query: .query.aggregate.supported_resources}'შეეცადეთ რესურსის წაკითხვა დღევანდელი მსოფლიო მდგომარეობის წინააღმდეგ:
curl -fsS "$TAIRA_ROOT/v1/domains?limit=5" \
| jq -r '.items[].id'
curl -fsS "$TAIRA_ROOT/v1/assets/definitions?limit=5" \
| jq -r '.items[] | [.id, .name, .total_quantity] | @tsv'თუ საჯარო ტესტნეტის მარშრუტი ბრუნდება 502, დროთა განმავლობაში ან იუწყება გაჯერებული რიგის შესახებ, განიხილეთ ეს როგორც საბოლოო პუნქტის ხელმისაწვდომობის პრობლემა და კიდევ ერთხელ შეეცადეთ მოგვიანებით თქვენი კლიენტის კოდის დებეგირების წინ.
კონსენსუსი და გამშვები დროის ბოლო წერტილები
| დასასრული | ფორმატი | მიზანი |
|---|---|---|
GET /v1/sumeragi/commit-certificates | JSON | უახლესი ჩაბარების სერტიფიკატის შეჯამებები |
GET /v1/sumeragi/validator-sets | JSON | Validator დაყენების ისტორია |
GET /v1/sumeragi/validator-sets/{height} | JSON | ვლიდატორი განსაზღვრულია ბლოკის სიმაღლეზე |
GET /v1/sumeragi/status | Norito ან JSON | კონსენსუსის სტატუსის დეტალური სურათი |
GET /v1/sumeragi/status/sse | SSE | უწყვეტი კონსენსუსის სტატუსის ნაკადი |
GET /v1/sumeragi/leader | JSON | მიმდინარე ლიდერის ინფორმაცია |
GET /v1/sumeragi/qc | Norito ან JSON | ბოლო კვორუმის სერტიფიკატის შემაჯამებელი |
GET /v1/sumeragi/checkpoints | JSON | კონსენსუსული საკონტროლო პუნქტების შეჯამება |
GET /v1/sumeragi/consensus-keys | JSON | აქტიური კონსენსუსის გასაღები |
GET /v1/sumeragi/bls_keys | JSON | აქტიური BLS კონსენსუსის გასაღები |
GET /v1/sumeragi/phases | JSON | ბოლო ფაზის ლატენციის ნიმუში |
GET /v1/sumeragi/rbc | JSON | RBC სესიის და გამტარობის მაჩვენებლები |
GET /v1/sumeragi/rbc/sessions | JSON | აქტიური RBC სესიის სურათი |
GET /v1/sumeragi/pacemaker | JSON | პეიზმერების სტატუსი |
GET /v1/sumeragi/params | JSON | მიმდინარე ქსელზე Sumeragi პარამეტრები |
GET /v1/sumeragi/collectors | JSON | დეტერმინისტური კოლექტორის გეგმის გადაღება |
GET /v1/sumeragi/key-lifecycle | JSON | კონსენსუსის საკვანძო ცხოვრების ციკლის მდგომარეობა |
GET /v1/sumeragi/telemetry | JSON | კონსენსუსის ტელემეტრიის გადაღება |
GET /v1/sumeragi/evidence | JSON | მტკიცებულებების ჩანაწერები, ვარიანტულად ფილტრირებული შეკითხვის სტრიქონით |
GET /v1/sumeragi/evidence/count | JSON | მტკიცებულებების რაოდენობა. |
POST /v1/sumeragi/evidence/submit | JSON | წარადგინეთ კონსენსუსის მტკიცებულებები |
GET /v1/sumeragi/commit_qc/{hash} | Norito ან JSON | QC ჩანაწერი ბლოკის ჰაშისათვის |
GET /v1/runtime/abi/active | JSON | აქტიური გაშვების დრო ABI დისკრიპტორის |
GET /v1/runtime/abi/hash | JSON | აქტიური გაშვების დრო ABI hash |
GET /v1/runtime/metrics | JSON | გაშვების დროის მაჩვენებლების გადაღება |
GET /v1/runtime/upgrades | JSON | გაშვების დროის განახლების სია |
POST /v1/runtime/upgrades/propose | JSON | შემოთავაზეთ გაუმჯობესება runtime |
POST /v1/runtime/upgrades/activate/{id} | JSON | გააქტიურეთ შემოთავაზებული გამშვები დროის განახლება |
POST /v1/runtime/upgrades/cancel/{id} | JSON | გააუქმეთ შემოთავაზებული განახლება runtime |
App და SORA მარშრუტის ოჯახები
როდესაც Torii აშენებულია აპლიკაციის მიმართულებით ფუნქციების კომპლექსით, ის გამოყოფს დამატებით JSON ოჯახებს ექსპლუატორებისთვის, SORA სერვისებს, ხიდის ნაკადებს, მტკიცებულებებს და შენახვას. ეს ოჯახები ყველა ქსელის პროფილისთვის არ არის ჩართული.
| მარშრუტის ოჯახი | მიზანი |
|---|---|
/v1/accounts/*, /v1/domains/*, /v1/assets/* | JSON წაკითხვა, შეკითხვის დამხმარეები, ჩართვის დამხმარეები და პორტფელის ან მფლობელის ხედვები |
/v1/nfts/*, /v1/rwas/*, /v1/confidential/* | NFT, რეალური აქტივები და კონფიდენციალური აქტივების ნახვა |
/v1/aliases/*, /v1/assets/aliases/*, /v1/sns/*, /v1/identifiers/* | სახელი, საიდუმლო და იდენტიფიკატორის რეზოლუცია |
/v1/explorer/* | Explorer- ორიენტირებული ანგარიში, აქტივი, ბლოკი, ტრანზაქცია, ინსტრუქციები, მეტრიკა და ნაკადი ნახვა |
/v1/transactions/*, /v1/pipeline/*, /v1/iso20022/* | ოპერაციების ისტორია, მილსადენის აღდგენა ან სტატუსი და ISO 20022 დამხმარე |
/v1/contracts/* | კონტრაქტის კოდი, განთავსება, ბუნდი, ზარი, ნახვა, მოვლენა, აქტივობა, გადასვლა და სახელმწიფო მარშრუტები |
/v1/multisig/*, /v1/controls/* | მულტისიგის წინადადებები, დამტკიცებები და გადარიცხვის კონტროლის დამხმარეები |
/v1/bridge/*, /v1/ledger/*, /v1/proofs/* | საბოლოო, სახელმწიფო მტკიცებულება, ბლოკის მტკიცებულება , მტკიცებულებების შენახვა და მტკიცებულების გამოკითხვის გზები |
/v1/da/* | მონაცემთა ხელმისაწვდომობის მიღება, მანიფესტები, დამტკიცების პოლიტიკა, ვალდებულებები და განზრახვები |
/v1/zk/* | ZK ფესვები, მტკიცებულების შემოწმება, IVM დამტკიცება, ხმათა აღრიცხვა, გადამოწმების გასაღებები, მტკიცებულებათა ჩანაწერები და დანართები |
/v1/gov/*, /v1/ministry/* | მმართველობის წინადადებები, კენჭისყრის ბიულეტენები, საკრებულოს სახელმწიფო, დაცული სახელების სივრცეები, დღის წესრიგის წინადადები, კანონმდებლობა და განხორციელება |
/v1/nexus/*, /v1/sccp/* | Nexus ბილიკი, მონაცემთა სივრცე და ჯაჭვური მტკიცებულების დამხმარე |
/v1/musubi/* | Musubi პაკეტების რეესტრის წაკითხვა და ინსტრუქციის შემქმნელი |
/v1/subscriptions/* | აბონენტთა გეგმები, აბონენტის სიცოცხლის ციკლი, გამოყენება და დამხმარეების გადახდა |
/v1/sorafs/*, /sorafs/*, /.well-known/sorafs/* | SoraFS მომწოდებლის აღმოჩენა, სიმძლავრის დამტკიცება, ჩასმა, შენახვის მოძიება და საჯარო შინაარსის სერვისი |
/v1/soracloud/*, /v1/soradns/*, /soradns/*, /api/* | SoraCloud მომსახურების სიცოცხლის ციკლი, კერძო კომპიუტერული / მოდელის ნაკადები, საჯარო აღმოჩენა და ჰოსტებული აპლიკაციების მარშრუტირება |
/v1/connect/*, /v1/vpn/* | Iroha გაერთიანების სესიები, WebSocket ტრანსპორტი, VPN სესიები და პროფილი |
/v1/app-api/*, /v1/api/*, /v1/content/* | App API დამაკავშირებლობა და ბუნდი/CID-ის მხარდაჭერილი შინაარსის მარშრუტი |
/v1/operator/*, /v1/mcp | ოპერატორის ავთენტიფიკაცია და მშობლიური MCP JSON-RPC ხიდი |
/v1/offline/*, /v1/repo/*, /v1/space-directory/*, /v1/ram-lfe/* | Offline მზადყოფნა, რეპოზიტორების შეთანხმებები, მონაცემთა სივრცის მანიფესტები და RAM-LFE დამხმარეები |
/v1/kaigi/*, /v1/webhooks/*, /v1/notify/*, /v1/telemetry/* | თანამშრომლობა, webhook, push შეტყობინება და ცოცხალი ტელემეტრიის ინტეგრაციები |
ISO 20022 ხიდი
Torii გამოყოფს ISO 20022 ხიდს /v1/iso20022/* ქვეშ, როდესაც აპლიკაციის მიმართულება API და ხიდის მუშაობის დროა ჩართული. ხიდზე მიზანმიმართულად არის განსაზღვრული მიზნები: ეს არ არის ზოგადი მიზნების ISO 20022 გადარიცხვის კარიბჭე, არამედ მხარდაჭერილი ქვეჯგუფი შერჩეული გადახდის შეტყობინებების გარდაქმნისთვის ხელმოწერილი Iroha გადარიცხვები და მათი ლიდერის სტატუსის მონიტორინგისთვის.
Torii ISO 20022 საბოლოო წერტილები
| მეთოდი და საბოლოო | მიზანი |
|---|---|
POST /v1/iso20022/pacs008 | წარადგინეთ FI-დან FI მომხმარებელს საკრედიტო გადარიცხვა და შეასრულეთ შესაბამისი Iroha აქტივების გადარიცხვის |
POST /v1/iso20022/pacs009 | წარადგინეთ საკრედიტო გადარიცხვა FI-დან FI-მდე, რომელიც გამოიყენეს PvP ან ფასიანი ქაღალდებთან დაკავშირებული ფულადი დაფინანსებისათვის. |
POST /v1/iso20022/pacs002 | წარადგინეთ ანგარიში გადახდის მდგომარეობის შესახებ |
POST /v1/iso20022/pacs004 | გადახდის დეკლარაციის წარდგენა |
POST /v1/iso20022/camt056 | წარადგინეთ გადახდის გაუქმების მოთხოვნა |
POST /v1/iso20022/sese023 | წარადგინეთ ფასიანი ქაღალდების გადარიცხვის ინსტრუქცია |
POST /v1/iso20022/sese024 | წარადგინეთ შეტყობინება ფასიანი ქაღალდების ანგარიშსწორების მდგომარეობის შესახებ |
POST /v1/iso20022/sese025 | წარადგინეთ ფასიანი ქაღალდების გადარიცხვის დადასტურება |
POST /v1/iso20022/colr012 | წარადგინეთ საკონტაქტო შეცვლის შეტყობინება |
GET /v1/iso20022/messages/{msg_id} | წაიკითხეთ კანონიკური ხიდის ჩანაწერი ერთი შეტყობინებისთვის. |
GET /v1/iso20022/audit/messages | წაკითხეთ საწინააღმდეგო ინფორმაციის აუდიტის მანიფესტი. |
GET /v1/iso20022/messages/{msg_id}/pacs002 | გადახდის მიმდინარე სტატუსი pacs.002 XML |
GET /v1/iso20022/messages/{msg_id}/pacs004 | გადარიცხეთ მიმდინარე გადახდის დეკლარაცია, როგორც pacs.004 XML |
GET /v1/iso20022/messages/{msg_id}/camt029 | ამჟამინდელი გაუქმების რეზოლუცია camt.029 XML |
GET /v1/iso20022/messages/{msg_id}/sese024 | ამჟამინდელი ანგარიშსწორების სტატუსი sese.024 XML |
GET /v1/iso20022/messages/{msg_id}/sese025 | ამჟამინდელი ანგარიშსწორების დადასტურება წარედგინა sese.025 XML |
pacs.008 წარდგენაში უნდა იყოს მითითებული შეტყობინება ID, ბანკთაშორისი ანგარიშსწორების თანხა, ვალუტა, ანგარიშსგების თარიღი, დავალიანებელი და კრედიტორი IBANs და დავალიანებანი და კრედორი BICs. რეფერენციული მონაცემების კონფიგურაციისას, ხიდი ასევე აკონტროლებს BIC, IBAN და ISO 4217 ვალუტის გადასასვლელებს, სანამ წარმოქმნილი ტრანზაქცია მილსადენში შევა.
pacs.009 წარდგენილებში უნდა იყოს წარმოდგენილი საქმიანი შეტყობინება ID, შეტყობინის განსაზღვრა ID, შექმნის დრო, ბანკთაშორისი ანგარიშსწორების თანხა, ვალუტა, ანგარიშგების თარიღი. ინსტრუქციული აგენტი BICs, და ვალდებული და კრედიტორი IBANs. თუ შეტყობინება მოიცავს Purp, ხიდი ამჟამად მხოლოდ ფასიანი ქაღალდების მიზნით დაფინანსებას იღებს: Purp=SECU.
pacs.008 და pacs.009 წარდგენის საბოლოო წერტილები იღებენ XML ISO კონვერტებს ან ხიდის გამოცდებისას გამოყენებულ ფლატურ მოედნის ფორმატს. არამარჩევნო SplmtryData მოედნებს შეუძლიათ მიზნული Iroha ლიდერის ჩაგდება, წყარო და სამიზნე ანგარიში IDs ან მისამართები, და აქტივების განსაზღვრა ID. პასუხი არის 202 Accepted message_id, transaction_hash, status, pacs002_code და გადაჭრილი ლიდერის/ანგარიშის/აქტივის კონტექსტით.
დამატებითი პარსერისა და რუკების დაგეგმვის მხარდაჭერა
IVM ISO დამხმარე ასევე ადასტურებს და მატერიალიზებს შემდეგ შეტყობინებების ოჯახებს კონვერტის ვალიდენციის, განსახლების რუკების ან შემდგომი შერიგებისათვის. მათ არ აქვთ დამოუკიდებელი Torii მარშრუტები.
| შეტყობინების ოჯახი | მიმდინარე მხარდაჭერა |
|---|---|
head.001 | ბიზნეს აპლიკაციის სათაურის ვალიდირება ISO კონვერტებისთვის, მათ შორის BizMsgIdr, MsgDefIdr, შექმნის დროისა და ავტორიული გამგზავნისა/მიღების ველები BIC |
pacs.007, pacs.028, pacs.029 | გადახდის დაბრუნება, სტატუსის მოთხოვნა და საგამოძიებო რეზოლუცია/სტატუსის ანალიზი |
pain.001, pain.002 | მომხმარებლის მიერ გადახდის დაწყება და გადახდის სტატუსის ანგარიშის მოწმობა |
camt.052, camt.053, camt.054 | ანგარიშის მოხსენება, განცხადება და შეტყობინების ვალიდატირება |
Kaigi სესიები
Kaigi უზრუნველყოფს გადახდილ, რეალურ დროში აუდიო / ვიდეო ოთახებს SORA Nexus. გამოიყენეთ მას მაშინ, როდესაც აპლიკაციას სჭირდება წიგნის მხარდაჭერილი სესიის შექმნა, რესტრის ცვლილებები, რელე მანიფესტები, დაშიფრებული სიგნალი და გამოყენების გაზომვა იმის ნაცვლად, რომ ყველა კონფერენციის მდგომარეობა იყოს off-chain.
ლიდერების მიმართული სიცოცხლის ციკლი არის:
CreateKaigi: შექმენით ზარი დომენის ქვეშ და შეინახეთ მისი პოლიტიკა, განრიგი, მეტა მონაცემები და არაკონკრეტული რელე მანიფესტი.JoinKaigiდაLeaveKaigi: განახლება მოწოდების სიაში. კერძო რეჟიმში მონაწილეები პირდაპირი ანგარიშის IDs გამოხატვის ნაცვლად იყენებენ ვალდებულებებს, ბათილებლებსა და სიაში მტკიცებულებებს.RecordKaigiUsage: დაამატეთ გაზომული ხანგრძლივობა და გაზის მთლიანი რაოდენობა.EndKaigi: შეწყვიტეთ სესია და ჩაწერეთ ბოლო დროის ბეჭედი.
Torii გამოყოფს რელეების ტელემეტრიას ქვემოთ /v1/kaigi/relays, /v1/kaigi/relays/{relay_id}, /v1/kaigi/relays/health, და /v1/kaigi/relays/events როდესაც აპლიკაცია API და ტელემეტრიული მახასიათებლები ჩართულია. სესიის მდგომარეობა ასახულია Kaigi დომენის მოვლენები, როგორიცაა KaigiRosterSummary, KaigiRelayManifestUpdated, KaigiRelayHealthUpdated, და KaigiUsageSummary.
CLI სიგარეტის ტესტი
დავიწყოთ iroha kaigi CLI როდესაც გსურთ შეამოწმოთ, რომ a Torii საბოლოო წერტილი იღებს Kaigi ტრანზაქციები, სანამ დაკავშირება UI. სასწრაფო დაწყების ბრძანება ქმნის დროებით ოთახს აქტიური წინააღმდეგ Torii საბოლოო წერტილი და ბეჭდვის შემაჯამებელი ზარის იდენტიფიკატორით, შეუერთდით ბრძანებას, და SoraNet სროლის მინიშნება:
iroha kaigi quickstart --auto-join-host --summary-out kaigi-summary.jsonსკრიპტირებული ნაკადებისათვის, მართეთ ოთახის სიცოცხლის ციკლი მკაფიოდ:
iroha kaigi create \
--domain streaming \
--call-name daily \
--host <i105-account-id> \
--privacy-mode transparent \
--room-policy authenticated
iroha kaigi join --domain streaming --call-name daily --participant <i105-account-id>
iroha kaigi leave --domain streaming --call-name daily --participant <i105-account-id>
iroha kaigi record-usage \
--domain streaming \
--call-name daily \
--duration-ms 120000 \
--billed-gas 1500
iroha kaigi end --domain streaming --call-name dailyგამოიყენეთ --room-policy public იმ ოთახებში, სადაც რელეებს შეუძლიათ გამოავლინონ მაყურებლის ბილეთის გარეშე, ან --room-policy authenticated როდესაც გასასვლელები უნდა მოითხოვოს მაყურებლის ავთენტიფიკაცია. გამოიყენეთ --privacy-mode zk-roster-v1 მხოლოდ ქსელში Kaigi სია და გამოყენების შემოწმების გასაღები კონფიგურირებულია; წინააღმდეგ შემთხვევაში, დეტერმინისტური შემოწმების დროს გაერთიანება, ფოთლები და პირადი გამოყენების ჩანაწერები არ მუშაობს.
ტესტირება JavaScript დემოს საშუალებით
გამოიყენეთ soramitsu/iroha-demo-javascript სამუშაო მაგიდის დემო ბოლოდან ბოლომდე საფულის ტესტისთვის. დემო არის ელექტრონული და Vue აპლიკაცია, რომელიც უშუალოდ საუბრობს Torii ადგილობრივი @iroha/iroha-js კავშირის მეშვეობით და მოიცავს ბრაუზერის მშობლიური ერთ-ერთი მედიისთვის /kaigi მარშრუტს.
გამოიყენეთ დემო @iroha/iroha-js სააგენტოდან Iroha საწყისი რეპროექტორი. დემო პინები SDK მეშვეობით file:../iroha/javascript/iroha_js, ასე რომ, შეინახეთ ორივე ჩანთები ამ ძმების განლაგებაში:
mkdir iroha-wallet-workspace
cd iroha-wallet-workspace
git clone https://github.com/hyperledger-iroha/iroha.git
git clone https://github.com/soramitsu/iroha-demo-javascript.git
cd iroha/javascript/iroha_js
npm install
npm run build:native
npm run build:dist
cd ../../../iroha-demo-javascript
npm install
npm run devგამოიყენეთ Node.js 20 ან უფრო ახალი და ინსტრუმენტების ჯაჭვი Rust, რათა შეიქმნას მშობლიური iroha_js_host მოდული. აღადგინეთ SDK ძმასთან Iroha საფულეში მისი წყაროს შეცვლის შემდეგ; სუფთა პაკეტის განლაგება არ შეიცავს ტვირთის სამუშაო სივრცეს, რომელიც საჭიროა npm run build:native.
კონტროლირებადი ტესტისათვის, მიუთითეთ დემო Kaigi-სუნარიანობის Torii საბოლოო წერტილში:
დაიწყეთ Iroha კვანძი, სადაც არის ჩართული SORA/Kaigi აპლიკაციის მიმართულება APIs ან გამოიყენეთ საჯარო საბოლოო წერტილი, რომელიც გამოყოფს საჭირო Kaigi ზედაპირებს.
შეამოწმეთ ძირითადი ხელმისაწვდომობა
/health, შემდეგ შეამოწმოთ ცოცხალი მარშრუტის ზედაპირი/openapiან/openapi.json. ზოგიერთი განთავსება ასევე გამოხატავს/v1/health, მაგრამ/healthარის გადამტანილი სიცოცხლისუნარიანობის შემოწმება.TAIRA -ისათვის გადაცემის ტელემეტრიული მარშრუტების შემოწმება, სანამ პირდაპირი შეხვედრის ჩატარებას შეეცდებით:
bashTAIRA=https://taira.sora.org curl -fsS "$TAIRA/health" curl -fsS "$TAIRA/v1/kaigi/relays" curl -fsS "$TAIRA/v1/kaigi/relays/health"
აღნიშნული შემოწმებები ადასტურებს, რომ Torii და Kaigi რელიე ტელემეტრიები ხელმისაწვდომია. ისინი არ ქმნიან შეხვედრას; CreateKaigi და JoinKaigi ჯერ კიდევ საჭიროებენ ფინანსურ საფულეებსა და ხელმოწერილ ტრანზაქციების წარდგენას. 4. გახსენით დემო, გადადით პარამეტრები, დააყენეთ Torii URL და მოდით აპლიკაციამ ჩაიტვირთოს ჯაჭვი ID და ქსელის პრეფიქსი ბოლო წერტილიდან. 5. შექმენით ან აღადგინეთ ორი ადგილობრივი საფულე დემოში. გამოიყენეთ ცალკეული აპლიკაციის ფანჯრები, პროფილები ან მანქანები, რათა მასპინძელს და სტუმარს აქვს ცალკე საფულის მდგომარეობა.
Kaigi UI-ის გამოცდისთვის:
- მასპინძელი ფანჯარაში გახსენით Kaigi, აირჩიეთ შეხვედრის დაწყება, დაასახელეთ სათაური და აირჩიეთ Private invite ან Transparent invite.
- აირჩიეთ კამერა და მიკრონი ჩართე, რათა WebRTC ჰქონდეს ადგილობრივ მედიას.
- აირჩიეთ შეკრების ბმული შექმნა. ცოცხალი საფულე წარადგენს
CreateKaigi; აპლიკაცია შემდეგ აჩვენებსiroha://kaigi/join?call=...&secret=...მოწვევას და#/kaigi?...უკან დაბრუნების მარშრუტს. - ფანჯარა ღია იყოს და მიწვევა გაუზიაროს სტუმარს.
- სტუმრების ფანჯარაში, გახსენით მოწვევა ან დააჭირეთ მას შეხვედრაზე შეუერთდით, ჩართეთ ადგილობრივი მედია და აირჩიეთ შეუერთდით შეხვედრას. ცოცხალი საფულე იღებს კოდირებულ მასპინძლის შეთავაზებას Torii-დან და უგზავნის
JoinKaigiკოდირებული პასუხის მეტადატებით. - მასპინძელმა უნდა დააყენოს პირველი პასუხი ავტომატურად სტრიმინგის ან გამოკითხვის გზით Kaigi ზარის სიგნალები. ორივე ფანჯარა უნდა აჩვენოს დაკავშირებული მედია და განახლებული კავშირის დეტალები.
- სესიის დასრულება მასპინძელიდან, ან გამოიყენეთ ბრძანება CLI
iroha kaigi endიმავე ზარისთვის ID.
Private Kaigi needs shielded XOR გადაიხადოს კერძო შესასვლელი საფასური. თუ დემო იუწყება, რომ კერძო Kaigi needs shelded XOR, გამოიყენეთ აპლიკაციის შიდა თვითშეფარვის მოთხოვნა და შეეცადეთ შექმნათ ან შეუერთდით ქმედება. თუ მტკიცებულებების გენერაცია, კერძო დაფინანსება ან ცოცხალი სიგნალიზაცია არ არის ხელმისაწვდომი, დემო შეიძლება დაბრუნდეს გამჭვირვალე / სახელმძღვანელო ნაკადზე. ამ შემთხვევაში, გახსენით მოწინავე სიგნალიზაცია, ასახეთ ნედლეული შეთავაზება ან პასუხის პაკეტი და დააჭირეთ მას მეორე ფანჯარში.
ავტომატიზებული შემოწმებისათვის დემო რეპოში, გაუშვით:
npm test -- tests/kaigiView.spec.ts tests/preloadKaigiBridge.spec.ts
npm run e2e:ui
npm run verifyკონცენტრირებული Vitest სუიტები მოიცავს Kaigi შეხვედრის ბმულების შექმნას, კომპაქტური მოწვევის დატვირთვას, კერძო შექმნა / გაწევრიანება / დასრულების ხიდის ზარებს, თვითშეზღუდვის შეტყობინებებს, სახელმძღვანელო უკან დაბრუნებას და პასუხის მიმოხილვას. UI სიგარეტის ტესტი მოიცავს რუტას /kaigi სამუშაო მაგიდაზე და მობილური ზომის სანახავად პორტებზე. ორი საფულეებს შორის პირდაპირი მედია ჯერ კიდევ საჭიროებს ორ ფანჯრის სახელმძღვანელო ტესტს, რადგან ბრაუზერის კამერა / მიკროფონის ნებართვები და პარტნიორული მედიის ნაკადები გარემოსთვის სპეციფიურია.
ნიმუშის ინტეგრაციის კოდისათვის იხილეთ Embed Kaigi in a JavaScript App.
სტატუსი და მაჩვენებლები
სტატუსისა და მაჩვენებლების ბოლო წერტილები არის პირველი რამ, რომელიც ჩართულია დეშბორდებში:
/statusაღმოაჩენს უმაღლესი დონის პარტნიორი, ბლოკი, რიგები და კონსენსუსის ველები/metricsამჟღავნებს Prometheus- ის მაჩვენებლებს, მზომილებსა და ჰისტოგრამებს
Nexus-ის შესაძლებლობის მქონე კვანძებზე სტატუსის გამოსავალი ასევე მოიცავს მარშრუტის და მონაცემთა სივრცის შესახებ ინფორმირებულ მონაკვეთებს. როდესაც nexus.enabled = false, ეს მონაკვეთები გამორიცხულია.
JSON vs. Norito
რამდენიმე ოპერატორის საბოლოო წერტილი ბრუნდება Norito დეფოლტურად. როდესაც საბოლოო პუნქტი მხარს უჭერს JSON, გაგზავნეთ:
Accept: application/jsonეს განსაკუთრებით სასარგებლოა:
/v1/sumeragi/status/v1/sumeragi/qc/v1/sumeragi/commit_qc/{hash}
როდესაც საბოლოო წერტილი იღებს ან უშუალოდ აგზავნის Norito ტიპს, გამოიყენეთ application/x-norito როგორც შინაარსის ტიპი ან სასურველი Accept ღირებულება. იხილეთ ტრანსპორტის დეტალები Norito.
ტელემეტრიის პროფილები
საბოლოო წერტილების ხილვადობა დამოკიდებულია კვანძის telemetry.profile პარამეტრზე. მიმდინარე კონფიგურაცია ხუთ პროფილის დონეს ხელმისაწვდომს ხდის:
| პროფილი | /status | /metrics | შემქმნელთა მარშრუტები |
|---|---|---|---|
disabled | არა | არა | არა |
operator | დიახ | არა | არა |
extended | დიახ | დიახ | არა |
developer | დიახ | არა | დიახ |
full | დიახ | დიახ | დიახ |
CLI მოკლე გზები
iroha CLI უკვე მოიცავს ამ საბოლოო წერტილების ბევრს:
iroha --config ./localnet/client.toml --output-format text ops sumeragi status
iroha --config ./localnet/client.toml --output-format text ops sumeragi phases
iroha --config ./localnet/client.toml ops sumeragi params
iroha --config ./localnet/client.toml --output-format text ops sumeragi telemetry