Package google.cloud.universalledger.v1

אינדקס

UniversalLedger

שירות ליצירת אינטראקציה עם Google Cloud Universal Ledger. נקודות הקצה נוצרות מראש ומנוהלות על ידי Google, והמשתמשים לא יכולים לשנות אותן. שמות נקודות הקצה הזמינות יופיעו בתיעוד הציבורי. נקודת קצה היא משאב אזורי ברשת Universal Ledger. בקשות שנשלחות לנקודת קצה עשויות להיות מנותבות למאמתים שונים ברשת הנתונה באזור הנתון.

GetEndpoint

rpc GetEndpoint(GetEndpointRequest) returns (Endpoint)

מקבלים את הפרטים של נקודת קצה ספציפית.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListEndpoints

rpc ListEndpoints(ListEndpointsRequest) returns (ListEndpointsResponse)

מציגה רשימה של כל נקודות הקצה של פרויקט ומיקום נתונים.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

QueryAccount

rpc QueryAccount(QueryAccountRequest) returns (QueryAccountResponse)

שליחת שאילתה לגבי כל המידע שמאוחסן על חשבון ברשת. פרטי החשבון שמוחזרים עשויים להיות שונים בין קריאות, כי נקודת קצה עשויה לנתב בקשות למאמתים שונים ברשת ובאזור, והמאמתים לא בהכרח נמצאים באותו מזהה סבב בכל זמן נתון.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

QueryData

rpc QueryData(QueryDataRequest) returns (QueryDataResponse)

שליחת שאילתות לרשת כדי לקבל מידע שמאוחסן בספר החשבונות, כמו חשבונות וטרנזקציות.

הגישה לשדות רגישים מסוימים, כמו יתרות בחשבון, עשויה להיות מוגבלת בהתאם לזהות השולח שנגזרת מהחתימה בבקשה. אם לשולח אין הרשאה, השדות הרגישים יוסתרו מהתגובה ויופיעו בשדה redacted_fields.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

QueryTransactionState

rpc QueryTransactionState(QueryTransactionStateRequest) returns (QueryTransactionStateResponse)

שאילתה לגבי מצב העסקה. אפשר להפעיל את השיטה הזו לכל עסקה שנשלחת לרשת. פרטי העסקה שמוחזרים עשויים להיות שונים בין קריאות, כי נקודת קצה עשויה לנתב בקשות למאמתים שונים ברשת ובאזור, והמאמתים לא בהכרח נמצאים באותו מזהה סבב בכל זמן נתון.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

SubmitOperationalTransaction

rpc SubmitOperationalTransaction(SubmitOperationalTransactionRequest) returns (SubmitOperationalTransactionResponse)

שולח עסקה תפעולית לרשת. השיטה הזו מחזירה ערך רק אחרי שהשכפול של העסקה מסתיים ברוב מאמתים ברשת, או אם העסקה נכשלת.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

SubmitTransaction

rpc SubmitTransaction(SubmitTransactionRequest) returns (SubmitTransactionResponse)

שליחת עסקה לרשת. קודם כל, המערכת בודקת שהבקשה תקינה. אם האימות ייכשל, הבקשה תיכשל באופן מיידי. אם האימות מצליח, השיטה הזו מחזירה ערך רק אחרי שהעסקה משוכפלת ברוב מאמתים ברשת, או עד שהבקשה נכשלת.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

חשבון

מייצג את מצב החשבון בספר החשבונות.

שדות
sequence_number

int64

פלט בלבד. המספר הסידורי של החשבון. המספר הזה גדל בכל עסקה שנשלחת מהחשבון הזה.

public_key

bytes

פלט בלבד. המפתח הציבורי הראשי שמשויך לחשבון הזה, ומשמש לאימות חתימות.

round_id

int64

פלט בלבד. המזהה של סבב ההפעלה (דומה ל'גובה' הבלוק) שבו פרטי החשבון שסופקו מדויקים.

comment

string

פלט בלבד. הערה על החשבון שנשמרה כשנוצר החשבון הזה.

שדה איחוד account_details. פרטים ספציפיים בהתאם לסוג החשבון. הערך account_details יכול להיות רק אחד מהבאים:
user_details

UserDetails

פלט בלבד. פרטים על חשבון משתמש רגיל.

account_manager_details

AccountManagerDetails

פלט בלבד. פרטים על חשבון ניהול.

token_manager_details

TokenManagerDetails

פלט בלבד. פרטים של חשבון ניהול אסימונים.

contract_token_manager_details

ContractTokenManagerDetails

פלט בלבד. פרטים על חשבון ניהול של אסימוני חוזה.

contract_details

ContractDetails

פלט בלבד. פרטים של חשבון חוזה חכם.

clearinghouse_details

ClearingHouseDetails

פלט בלבד. פרטים של חשבון סליקה.

currency_operator_details

CurrencyOperatorDetails

פלט בלבד. פרטים על חשבון של מפעיל מטבע.

platform_operator_details

PlatformOperatorDetails

פלט בלבד. פרטים של חשבון של מפעיל פלטפורמה.

AccountIdList

רשימה של מספרי חשבונות.

שדות
values[]

string

זה שינוי אופציונלי. ערכי מזהה החשבון.

AccountManagerDetails

פרטים שספציפיים למנהל חשבון.

שדות
token_manager
(deprecated)

Entity

פלט בלבד. הוצא משימוש: במקומו, צריך להשתמש ב-token_manager_id. מנהל האסימונים שמוגדר כברירת מחדל לחשבונות שנוצרו על ידי מנהל החשבונות הזה.

num_accounts

int32

פלט בלבד. מספר החשבונות שנוצרו על ידי מנהל החשבון הזה.

token_manager_id

string

פלט בלבד. המזהה של מנהל האסימונים שמוגדר כברירת מחדל בחשבונות שנוצרו על ידי מנהל החשבונות הזה.

AccountStatus

הסטטוס של החשבון.

טיפוסים בני מנייה (enum)
ACCOUNT_STATUS_UNSPECIFIED סטטוס לא תקין.
ACCOUNT_STATUS_ACTIVE מצב פעיל שבו החשבון יכול לבצע את הפעולות שמותרות לו בהתאם לתפקידים שהוגדרו בו.
ACCOUNT_STATUS_INACTIVE מצב לא פעיל שבו אסור לבצע טרנזקציות בחשבון. האדמין של החשבון עדיין יכול לשלוח עסקאות לניהול החשבון.

ActivateAccount

סימון חשבון כACCOUNT_STATUS_ACTIVE. השולח צריך להיות מנהל החשבון של החשבון שרוצים להפעיל.

בעל החשבון יכול להמשיך בפעולות הרגילות שמותרות לו במסגרת התפקידים בחשבון.

שדות
account
(deprecated)

Entity

זה שינוי אופציונלי. הוצא משימוש: במקומו, צריך להשתמש ב-account_id. מזהה החשבון שרוצים להפעיל.

account_id

string

זה שינוי אופציונלי. מזהה החשבון שרוצים להפעיל. צריך לציין את account או את account_id. הערך מוגבל ל-60 תווים.

AddRoles

הפקודה מוסיפה לחשבון את התפקידים שצוינו. השולח צריך להיות מנהל החשבון של החשבון שרוצים לשנות.

שדות
account
(deprecated)

Entity

זה שינוי אופציונלי. הוצא משימוש: במקומו, צריך להשתמש ב-account_id. המזהה של החשבון שרוצים לשנות.

account_id

string

זה שינוי אופציונלי. המזהה של החשבון שרוצים לשנות. צריך לציין את account או את account_id. הערך מוגבל ל-60 תווים.

roles[]

Role

חובה. התפקידים שרוצים להוסיף.

AmountValue

מייצג סכום במטבע מסוים.

שדות
currency

QualifiedCurrencyValue

חובה. המטבע של הסכום.

amount_value

int64

חובה. מספר היחידות המשניות של המטבע.

BalanceToSettle

יתרה לסגירה בין שני מנהלי אסימונים.

שדות
balance_payer
(deprecated)

Entity

פלט בלבד. הוצא משימוש: במקומו, צריך להשתמש ב-balance_payer_id. החשבון שבו יש יתרה לתשלום.

balance_payer_id

string

פלט בלבד. מספר החשבון שחייב את היתרה שצריך להסדיר.

balance_receiver
(deprecated)

Entity

פלט בלבד. הוצא משימוש: במקומו, צריך להשתמש ב-balance_receiver_id. החשבון שבו יש יתרה שצריך להסדיר.

balance_receiver_id

string

פלט בלבד. המזהה של החשבון שבו יש יתרה לתשלום.

balance

CurrencyValue

פלט בלבד. היתרה להסדרה. הערך חייב להיות חיובי.

BoolList

רשימה של ערכים בוליאניים.

שדות
values[]

bool

זה שינוי אופציונלי. הערכים הבוליאניים.

Burn

מבצע המרה של אסימוני מטבע. השולח חייב להיות מנהל אסימונים, והחשבון שמספק את האסימונים לשריפה חייב גם לחתום על העסקה.

התהליך הצפוי הוא שמנהל האסימונים יקצה חשבון שריפה שאליו הלקוחות יעבירו את האסימונים לפני שהם יישרפו. לחלופין, הלקוחות יכולים לחתום ישירות על העסקה, ובמקרה כזה היא תפעל כעסקת 'העברה והשמדה' אטומית.

שדות
burn_amount

CurrencyValue

חובה. הסכום לשריפה.

payer
(deprecated)

Entity

זה שינוי אופציונלי. הוצא משימוש: במקומו, צריך להשתמש ב-payer_id. החשבון שמספק את הטוקנים לשריפה. צריך להפעיל בחשבון את האפשרות ROLE_PAYER.

payer_id

string

זה שינוי אופציונלי. המזהה של החשבון שמספק את האסימונים לשריפה. צריך להפעיל את ROLE_PAYER בחשבון של הגורם המשלם. צריך לציין את payer או את payer_id.

ChangeAccountManager

העברת האחריות לניהול חשבון מסוים לחשבון ניהול אחר. השולח צריך להיות מנהל החשבון הנוכחי של החשבון, ומנהל החשבון החדש צריך גם לחתום על העסקה הזו כדי להביע את הסכמתו.

שדות
account
(deprecated)

Entity

זה שינוי אופציונלי. הוצא משימוש: במקומו, צריך להשתמש ב-account_id. המזהה של החשבון שרוצים לשנות את חשבון הניהול שלו.

account_id

string

זה שינוי אופציונלי. המזהה של החשבון שרוצים לשנות את חשבון הניהול שלו. צריך לציין את account או את account_id. הערך מוגבל ל-60 תווים.

next_manager
(deprecated)

Entity

זה שינוי אופציונלי. הוצא משימוש: במקומו, צריך להשתמש ב-next_manager_id. המזהה של מנהל החשבון החדש המוצע. כדי שהאימות יתבצע, גם המנהל החדש צריך לחתום על העסקה הזו.

next_manager_id

string

זה שינוי אופציונלי. המזהה של מנהל החשבון החדש המוצע. כדי שהאימות יתבצע, גם המנהל החדש צריך לחתום על העסקה הזו. צריך לציין את next_manager או את next_manager_id. הערך מוגבל ל-60 תווים.

ClearingHouseDetails

פרטים ספציפיים למוסד סליקה.

שדות
account_status

AccountStatus

פלט בלבד. הסטטוס של החשבון הזה.

balances[]

BalanceToSettle

פלט בלבד. היתרות שהמרכז הזה עוקב אחריהן כרגע לצורך סליקה.

settlement_mode

SettlementMode

פלט בלבד. מצב הסליקה של חברת הסליקה הזו.

ClientTransaction

מייצג טרנזקציה שאותחלה על ידי לקוח.

שדות
source
(deprecated)

Entity

זה שינוי אופציונלי. השולח של הטרנזקציה. הוצא משימוש: במקומו, צריך להשתמש ב-sender_id.

sender_id

string

זה שינוי אופציונלי. המזהה של החשבון ששולח את העסקה הזו. צריך להגדיר את אחד מהמאפיינים source או sender_id.

signatories[]
(deprecated)

Entity

זה שינוי אופציונלי. חשבונות שחתמו על העסקה הזו בנוסף לשולח. הוצא משימוש: במקומו, צריך להשתמש ב-other_signatory_ids.

other_signatory_ids[]

string

זה שינוי אופציונלי. מזהי החשבונות שבנוסף לשולח חתמו על העסקה הזו.

sequence_number

int64

חובה. מספר ייחודי שגדל באופן מונוטוני, החל מ-0.

המספר הזה צריך לגדול באחד לכל עסקה שנשלחה בעבר לרשת על ידי אותו שולח עסקאות.

הערה: הנתונים לא כוללים יחידות של עסקאות שאולי נשלחו כחלק משרשרת, שבהן אסור להגדיר מספר סידורי. אבל הוא כן כולל את השולח של שרשרת הטרנזקציות עצמה.

chained_unit

bool

הערך חייב להיות true אם העסקה של הלקוח היא חלק משרשרת עסקאות. אחרת, צריך להגדיר את הערך שלו כ-false.

ההגבלה הזו נחוצה כדי למנוע שליחה של עסקה חתומה שנועדה להיות חלק משרשרת, כעסקה עצמאית.

שדה איחוד kind. ההודעה הספציפית לעסקה של הלקוח. הערך kind יכול להיות רק אחד מהבאים:
app
(deprecated)

Any

זה שינוי אופציונלי. הוצא משימוש: במקום זאת, צריך להשתמש באחד מהשדות הספציפיים להודעה. הודעה ספציפית לעסקה של לקוח. אפשר להשתמש באחד מהערכים הבאים:

operational

Any

זה שינוי אופציונלי. הודעה תפעולית על עסקה. הערה: רק מפעיל הפלטפורמה יכול לשלוח את ההודעה הזו. אפשר להשתמש באחד מהערכים הבאים:

transfer_platform_operator_transaction

TransferPlatformOperator

זה שינוי אופציונלי. הודעה להעברת התפקיד של מפעיל הפלטפורמה לחשבון חדש.

create_currency_operator_transaction

CreateCurrencyOperator

זה שינוי אופציונלי. הודעה ליצירת אופרטור מטבע חדש.

transfer_currency_operator_transaction

TransferCurrencyOperator

זה שינוי אופציונלי. הודעה להעברת התפקיד 'מפעיל מטבע' לחשבון חדש.

create_clearinghouse_transaction

CreateClearinghouse

זה שינוי אופציונלי. הודעה ליצירת מרכז מידע חדש.

create_account_manager_transaction

CreateAccountManager

זה שינוי אופציונלי. הודעה ליצירת מנהל חשבון חדש.

create_token_manager_transaction

CreateTokenManager

זה שינוי אופציונלי. הודעה ליצירת מנהל אסימונים חדש שמשויך למטבע של המפעיל ששולח את הבקשה.

increase_token_issuance_limit_transaction

IncreaseTokenIssuanceLimit

זה שינוי אופציונלי. הודעה לרשת שחשבון היעד הפקיד כספים לקרן מילואים, והגדלת המגבלה על הנפקת אסימונים.

decrease_token_issuance_limit_transaction

DecreaseTokenIssuanceLimit

זה שינוי אופציונלי. הודעה לרשת שחשבון היעד רוצה למשוך כספים מהרזרבה, והקטנת מגבלת הנפקת האסימונים שלו.

settlement_request_transaction

SettlementRequest

זה שינוי אופציונלי. הודעה להפעלת פעולת הסדר.

mint_transaction

Mint

זה שינוי אופציונלי. הודעה ליצירת טוקנים של מטבעות והעברתם לחשבון.

burn_transaction

Burn

זה שינוי אופציונלי. הודעה לשריפת טוקנים של מטבע מחשבון.

create_account_transaction

CreateAccount

זה שינוי אופציונלי. הודעה ליצירת חשבון משתמש חדש.

deactivate_account_transaction

DeactivateAccount

זה שינוי אופציונלי. הודעה על השבתה של חשבון משתמש.

activate_account_transaction

ActivateAccount

זה שינוי אופציונלי. הודעה להפעלת חשבון משתמש.

add_roles_transaction

AddRoles

זה שינוי אופציונלי. הודעה להוספת תפקידים לחשבון.

remove_roles_transaction

RemoveRoles

זה שינוי אופציונלי. הודעה להסרת תפקידים מחשבון.

change_account_manager_transaction

ChangeAccountManager

זה שינוי אופציונלי. הודעה לשינוי מנהל החשבון של חשבון מסוים.

transfer_transaction

Transfer

זה שינוי אופציונלי. הודעה להעברת אסימונים מחשבון משתמש אחד לחשבון משתמש אחר.

create_contract_transaction

CreateContract

זה שינוי אופציונלי. הודעה ליצירת חוזה חדש בפנקס הראשי.

grant_contract_permissions_transaction

GrantContractPermissions

זה שינוי אופציונלי. הודעה למתן הרשאות לחוזה.

invoke_contract_method_transaction

InvokeContractMethod

זה שינוי אופציונלי. הודעה להפעלת שיטה של חוזה.

create_contract_token_manager_transaction

CreateContractTokenManager

זה שינוי אופציונלי. הודעה ליצירת מנהל אסימונים חדש שמשויך למטבע של המפעיל ששולח את הבקשה.

transfer_contract_token_manager_transaction

TransferContractTokenManager

זה שינוי אופציונלי. הודעה להעברת התפקיד של ניהול אסימונים במטבע מסוים מחשבון אחד לחשבון אחר.

remove_signing_public_key_transaction

RemoveSigningPublicKey

זה שינוי אופציונלי. הודעה להסרת מפתח לחתימה על חשבון.

replace_signing_public_key_transaction

ReplaceSigningPublicKey

זה שינוי אופציונלי. הודעה להחלפת מפתח לחתימה על חשבון.

chain

TransactionChain

זה שינוי אופציונלי. הודעה לשרשרת עסקאות שכוללת כמה יחידות עסקה לביצוע ברצף.

ContractDetails

פרטים ספציפיים לחוזה חכם.

שדות
owner
(deprecated)

Entity

פלט בלבד. הוצא משימוש: במקומו, צריך להשתמש ב-owner_id. הבעלים של החוזה.

owner_id

string

פלט בלבד. המזהה של הבעלים של החוזה.

code

bytes

פלט בלבד. קוד החוזה שעבר סריאליזציה.

contract_fields

Fields

פלט בלבד. שדות החוזה (שם השדה -> ערך) של החוזה הזה.

currency_balances

map<string, CurrencyValue>

פלט בלבד. היתרות במטבעות שמוחזקות בחוזה (אופרטור מטבע -> יתרה).

ContractPermission

קבוצת ההרשאות שאפשר להעניק לחוזה. בעתיד צפויים להתווסף עוד ערכים.

טיפוסים בני מנייה (enum)
CONTRACT_PERMISSION_UNSPECIFIED הרשאה לא תקפה.
CONTRACT_PERMISSION_STORAGE

מאפשרת לחוזה לקרוא ולכתוב באחסון שבבעלות החשבון שהעניק את ההרשאה. החוזה יכול לקרוא ולכתוב רק את המאפיינים שהוא כתב בעבר.

הערה: ההרשאה הזו לא מאפשרת לחוזה לקרוא או לכתוב נתונים שמנוהלים על ידי חוזים אחרים, והיא גם לא מאפשרת לחוזה לעדכן ישירות מאפיינים אחרים של החשבון (לדוגמה, היתרה בחשבון במטבע המקומי).

ContractTokenManagerDetails

פרטים ספציפיים לגבי Contract Token Manager.

שדות
issuance_limit

CurrencyValue

פלט בלבד. מספר הטוקנים שמנהל הטוקנים של החוזה הזה יכול לספק עבורם גיבוי.

מנהלי אסימונים בחוזה לא יכולים להגדיל או להקטין את מגבלת ההנפקה שלהם, ולכן היא צריכה להיות שווה ל-issued_tokens.

issued_tokens

CurrencyValue

פלט בלבד. מספר האסימונים שמנהל האסימונים הזה מספק גיבוי עבורם (כלומר, האחריות הכוללת שלו).

הסכום הזה שווה לסכום של כל היתרות שמוחזקות בחוזים במטבע הזה, בתוספת המיקום נטו במטריצת הסליקה.

previous_contract_token_manager_id

string

פלט בלבד. מספר החשבון של מנהל אסימוני החוזה הקודם במטבע הזה. כך נוצר נתיב ביקורת שאפשר לעבור עליו כדי לגלות את כל חשבונות הניהול הקודמים. אם זהו מנהל האסימונים הראשון של החוזה עבור המטבע, השדה הזה יהיה ריק.

account_status

AccountStatus

פלט בלבד. הסטטוס של החשבון הזה.

CreateAccount

יצירת חשבון משתמש חדש. השולח צריך להיות מנהל חשבון.

אם העסקה תבוצע בהצלחה, המזהה של החשבון החדש שנוצר יוחזר כאירוע בשדה TransactionCertificate של העסקה הסופית.

שדות
public_key

bytes

חובה. המפתח הציבורי של בעל החשבון. חשוב לזכור שזה לא המפתח הציבורי של השולח. זהו המפתח הציבורי של הבעלים החדשים של החשבון, והוא יאוחסן בספר החשבונות. הוא ישמש לאימות החתימה של העסקאות שמגיעות מהחשבון שנוצר.

הפורמט של המפתח הציבורי מוגדר בשדה key_format. נחשב למידע ציבורי.

key_format

KeyFormat

זה שינוי אופציונלי. אי אפשר לשנות. פורמט המפתח של המפתח הציבורי. אם לא מציינים את הפרמטר הזה, ברירת המחדל היא קבוצת מפתחות בינארית שעברה סריאליזציה בפורמט Tink wire. נחשב למידע ציבורי.

roles[]

Role

זה שינוי אופציונלי. רשימת התפקידים שרוצים להקצות לחשבון הזה.

account_status

AccountStatus

זה שינוי אופציונלי. הסטטוס של החשבון שייווצר. כברירת מחדל, סטטוס החשבון של חשבון שנוצר לאחרונה יהיה ACCOUNT_STATUS_ACTIVE.

account_comment

string

זה שינוי אופציונלי. אי אפשר לשנות. שדה תגובה אטום שלא מפוענח על ידי המערכת, אבל מאוחסן בפנקס החשבונות בחשבון. נחשב למידע ציבורי. האורך המרבי הוא 128 תווים. אפשר להשאיר את השדה ריק. אחרי שיוצרים את השדה, אי אפשר לשנות אותו.

token_manager
(deprecated)

Entity

זה שינוי אופציונלי. הוצא משימוש: במקומו, צריך להשתמש ב-token_manager_id. הכלי לניהול טוקנים בחשבון הזה. השדה הזה הוא אופציונלי, ואם לא מספקים אותו, המערכת תשתמש בניהול האסימונים שמשויך לחשבון הניהול (כלומר, השולח של העסקה הזו).

token_manager_id

string

זה שינוי אופציונלי. המזהה של מנהל האסימונים בחשבון הזה. השדה הזה הוא אופציונלי, ואם לא מספקים אותו, המערכת תשתמש בניהול האסימונים שמשויך לחשבון הניהול (כלומר, השולח של העסקה הזו). הערך מוגבל ל-60 תווים.

CreateAccountManager

יוצר מנהל חשבון חדש. השולח חייב להיות מפעיל מטבע.

אם העסקה תבוצע בהצלחה, המזהה של החשבון החדש שנוצר יוחזר כאירוע בשדה TransactionCertificate של העסקה הסופית.

שדות
public_key

bytes

חובה. המפתח הציבורי של מנהל החשבון החדש. חשוב לזכור שזה לא המפתח הציבורי של המפעיל. המפתח הציבורי הזה ישויך למנהל החשבון ויישמר בספר החשבונות. הוא ישמש לאימות החתימה של העסקאות שמתבצעות מחשבון הניהול.

הפורמט של המפתח הציבורי מוגדר בשדה key_format. נחשב למידע ציבורי.

key_format

KeyFormat

זה שינוי אופציונלי. אי אפשר לשנות. פורמט המפתח של המפתח הציבורי. אם לא מציינים את הפרמטר הזה, ברירת המחדל היא קבוצת מפתחות בינארית שעברה סריאליזציה בפורמט Tink wire. נחשב למידע ציבורי.

default_token_manager
(deprecated)

Entity

זה שינוי אופציונלי. הוצא משימוש: במקומו, צריך להשתמש ב-default_token_manager_id. מנהל האסימונים שמוגדר כברירת מחדל בחשבונות שייווצרו על ידי חשבון הניהול הזה.

default_token_manager_id

string

זה שינוי אופציונלי. המזהה של מנהל האסימונים שמוגדר כברירת מחדל בחשבונות שייווצרו על ידי חשבון הניהול הזה. הערך מוגבל ל-60 תווים.

account_comment

string

זה שינוי אופציונלי. אי אפשר לשנות. שדה תגובה אטום שלא מפוענח על ידי המערכת, אבל מאוחסן בפנקס החשבונות בחשבון. נחשב למידע ציבורי. האורך המרבי הוא 128 תווים. אפשר להשאיר את השדה ריק. אחרי שיוצרים את השדה, אי אפשר לשנות אותו.

CreateClearinghouse

יצירת מרכז מידע חדש. השולח חייב להיות מפעיל מטבע.

אם העסקה תבוצע בהצלחה, המזהה של החשבון החדש שנוצר יוחזר כאירוע בשדה TransactionCertificate של העסקה הסופית.

שדות
public_key

bytes

חובה. המפתח הציבורי של מרכז הסליקה החדש. חשוב לזכור שזה לא המפתח הציבורי של המפעיל. המפתח הציבורי הזה ישויך למרכז המידע ויישמר בספר החשבונות. הוא ישמש לאימות החתימה של העסקאות שמגיעות מחשבון המרכז לסליקה.

הפורמט של המפתח הציבורי מוגדר בשדה key_format. נחשב למידע ציבורי.

key_format

KeyFormat

זה שינוי אופציונלי. אי אפשר לשנות. פורמט המפתח של המפתח הציבורי. אם לא מציינים את הפרמטר הזה, ברירת המחדל היא קבוצת מפתחות בינארית שעברה סריאליזציה בפורמט Tink wire. נחשב למידע ציבורי.

account_comment

string

זה שינוי אופציונלי. אי אפשר לשנות. שדה תגובה אטום שלא מפוענח על ידי המערכת, אבל מאוחסן בפנקס החשבונות בחשבון. נחשב למידע ציבורי. האורך המרבי הוא 128 תווים. אפשר להשאיר את השדה ריק. אחרי שיוצרים את השדה, אי אפשר לשנות אותו.

settlement_mode

SettlementMode

חובה. מצב הסליקה של מרכז הסליקה הזה. חובה. נחשב למידע ציבורי.

CreateContract

אחסון חוזה בספר החשבונות.

שדות
contract_bytes

bytes

בייטים של חוזה שעברו סריאליזציה.

arguments
(deprecated)

map<string, Value>

זה שינוי אופציונלי. אי אפשר לשנות. הוצא משימוש: במקומו, צריך להשתמש ב-init_arguments. ארגומנטים של השיטה __init__.

init_arguments

map<string, Value>

זה שינוי אופציונלי. אי אפשר לשנות. מכיל ארגומנטים לשיטה __init__.

contract_comment

string

זה שינוי אופציונלי. אי אפשר לשנות. שדה תגובה אטום שלא מפוענח על ידי המערכת, אבל מאוחסן בספר החשבונות בחוזה. נחשב למידע ציבורי. האורך המרבי הוא 128 תווים. אפשר להשאיר את השדה ריק. אחרי שיוצרים את השדה, אי אפשר לשנות אותו.

CreateContractTokenManager

יוצר מנהל חדש של אסימוני חוזה שמשויך למטבע של המפעיל ששולח את הבקשה. השולח חייב להיות מפעיל מטבע. כברירת מחדל, מנהל הטוקנים של החוזה שנוצר חדש פעיל. אם צריך להחליף את מנהל הטוקנים של החוזה, צריך לשלוח במקום זאת את העסקה TransferContractTokenManager. אם קיים עוד מנהל אסימוני חוזים שמשויך לאותו מטבע, העסקה הזו תיכשל.

בניגוד למנהלי אסימונים רגילים, למנהלי אסימונים של חוזים אסור לבצע עסקאות כמו יצירה או ביטול של אסימונים. עם זאת, הם יכולים להשתתף בפעולות של הסדרים.

אם העסקה תבוצע בהצלחה, המזהה של החשבון החדש שנוצר יוחזר כאירוע בשדה TransactionCertificate של העסקה הסופית.

שדות
public_key

bytes

חובה. המפתח הציבורי של מנהל הטוקנים החדש של החוזה. חשוב לזכור שזה לא המפתח הציבורי של המפעיל. המפתח הציבורי הזה ישויך למנהל אסימוני החוזים ויאוחסן בספר החשבונות. הוא ישמש לאימות החתימה של העסקאות שמגיעות מהחשבון של מנהל האסימונים בחוזה.

הפורמט של המפתח הציבורי מוגדר בשדה key_format. נחשב למידע ציבורי.

account_comment

string

זה שינוי אופציונלי. אי אפשר לשנות. שדה תגובה אטום שלא מפוענח על ידי המערכת, אבל מאוחסן בפנקס החשבונות בחשבון. נחשב למידע ציבורי. האורך המרבי הוא 128 תווים. אפשר להשאיר את השדה ריק. אחרי שיוצרים את השדה, אי אפשר לשנות אותו.

key_format

KeyFormat

זה שינוי אופציונלי. אי אפשר לשנות. פורמט המפתח של המפתח הציבורי. אם לא מציינים את הפרמטר הזה, ברירת המחדל היא קבוצת מפתחות בינארית שעברה סריאליזציה בפורמט Tink wire. נחשב למידע ציבורי.

CreateCurrencyOperator

יצירת אופרטור מטבע חדש. השולח חייב להיות מפעיל הפלטפורמה.

אם העסקה תבוצע בהצלחה, המזהה של החשבון החדש שנוצר יוחזר כאירוע בשדה TransactionCertificate של העסקה הסופית.

העסקה הזו חייבת להציג מטבע חדש במערכת. אם המטבע שצוין כבר קיים, העסקה תיכשל. אם צריך להחליף את מפעיל המטבע, צריך לשלוח במקום זאת את העסקה TransferCurrencyOperator.

שדות
public_key

bytes

חובה. המפתח הציבורי של המפעיל של המטבע החדש. המפתח הציבורי הזה ישויך למפעיל המטבע ויישמר בספר החשבונות. הוא ישמש לאימות החתימה של העסקאות שמגיעות מהחשבון של המפעיל.

הפורמט של המפתח הציבורי מוגדר בשדה key_format. נחשב למידע ציבורי.

key_format

KeyFormat

זה שינוי אופציונלי. אי אפשר לשנות. פורמט המפתח של המפתח הציבורי. אם לא מציינים את הפרמטר הזה, ברירת המחדל היא קבוצת מפתחות בינארית שעברה סריאליזציה בפורמט Tink wire. נחשב למידע ציבורי.

account_comment

string

זה שינוי אופציונלי. אי אפשר לשנות. שדה תגובה אטום שלא מפוענח על ידי המערכת, אבל מאוחסן בפנקס החשבונות בחשבון. נחשב למידע ציבורי. האורך המרבי הוא 128 תווים. אפשר להשאיר את השדה ריק. אחרי שיוצרים את השדה, אי אפשר לשנות אותו.

currency
(deprecated)

string

זה שינוי אופציונלי. הוצא משימוש: במקומו, צריך להשתמש ב-currency_code. המטבע הרגיל שמשויך למפעיל הזה, שמיוצג כקוד בן 3 אותיות גדולות לפי תקן ISO 4217. נחשב למידע ציבורי.

currency_code

string

זה שינוי אופציונלי. המטבע הרגיל שמשויך למפעיל הזה, שמיוצג כקוד בן 3 אותיות גדולות לפי תקן ISO 4217. נחשב למידע ציבורי.

CreateSnapshot

בסוג הזה אין שדות.

מפעיל את יצירת ה-snapshot של הרשת. השולח חייב להיות מפעיל הפלטפורמה.

CreateTokenManager

יוצר מנהל אסימונים חדש שמשויך למטבע של המפעיל ששולח את הבקשה. השולח חייב להיות מפעיל מטבע.

אם העסקה תצליח, המזהה של החשבון החדש שנוצר יוחזר כאירוע בשדה TransactionCertificate של העסקה הסופית.

שדות
public_key

bytes

חובה. המפתח הציבורי של הכלי החדש לניהול אסימונים. חשוב לזכור שזה לא המפתח הציבורי של המפעיל. המפתח הציבורי הזה ישויך למנהל הטוקנים ויאוחסן בספר החשבונות. הוא ישמש לאימות החתימה של העסקאות שמגיעות מהחשבון של מנהל האסימונים.

הפורמט של המפתח הציבורי מוגדר בשדה key_format. נחשב למידע ציבורי.

key_format

KeyFormat

זה שינוי אופציונלי. אי אפשר לשנות. פורמט המפתח של המפתח הציבורי. אם לא מציינים את הפרמטר הזה, ברירת המחדל היא קבוצת מפתחות בינארית שעברה סריאליזציה בפורמט Tink wire. נחשב למידע ציבורי.

account_comment

string

זה שינוי אופציונלי. אי אפשר לשנות. שדה תגובה אטום שלא מפוענח על ידי המערכת, אבל מאוחסן בפנקס החשבונות בחשבון. נחשב למידע ציבורי. האורך המרבי הוא 128 תווים. אפשר להשאיר את השדה ריק. אחרי שיוצרים את השדה, אי אפשר לשנות אותו.

CurrencyOperatorDetails

פרטים ספציפיים לגבי מפעילי מטבעות.

שדות
currency
(deprecated)

string

פלט בלבד. הוצא משימוש: במקומו, צריך להשתמש ב-currency_code. המטבע שמשויך לחשבון הזה, שמיוצג על ידי קוד בן 3 אותיות לפי תקן ISO 4217.

currency_code

string

פלט בלבד. המזהה של המטבע שמשויך לחשבון הזה, שמיוצג על ידי קוד בן 3 אותיות לפי תקן ISO 4217.

account_status

AccountStatus

פלט בלבד. הסטטוס של החשבון הזה.

previous_entity_id
(deprecated)

Entity

פלט בלבד. הוצא משימוש: במקומו, צריך להשתמש ב-previous_currency_operator_id. המפעיל הקודם של המטבע שהעביר את הבעלות על התפקיד של מפעיל המטבע לחשבון הזה. אם זה האופרטור הראשון של המטבע, השדה הזה יהיה ריק.

previous_currency_operator_id

string

פלט בלבד. המזהה של המפעיל הקודם של המטבע שהעביר את הבעלות על תפקיד המפעיל של המטבע לחשבון הזה. אם זה האופרטור הראשון של המטבע, השדה הזה יהיה ריק.

platform_operator_entity_id
(deprecated)

Entity

פלט בלבד. הוצא משימוש: במקומו, צריך להשתמש ב-platform_operator_id. מפעיל הפלטפורמה שיצר את אופרטור המטבע הזה.

platform_operator_id

string

פלט בלבד. המזהה של מפעיל הפלטפורמה שיצר את מפעיל המטבע הזה.

contract_token_manager
(deprecated)

Entity

פלט בלבד. הוצא משימוש: במקומו, צריך להשתמש ב-contract_token_manager_id. מנהל אסימוני החוזה שמשויך למפעיל המטבע הזה.

contract_token_manager_id

string

פלט בלבד. המזהה של מנהל אסימוני החוזה שמשויך לאופרטור המטבע הזה.

clearinghouse_id

string

פלט בלבד. המזהה של מרכז הסליקה שמשויך למפעיל המטבע הזה.

CurrencyValue

מייצג סכום במטבע (כלומר כסף). שימו לב שהמטבע שבו מבוצעת ההמרה לא נכלל בהודעה הזו. המטבע הרלוונטי נקבע על ידי החשבון ששולח את העסקה. לכל חשבון משויך מטבע ייחודי שלא ניתן לשינוי.

שדות
value

int64

חובה. מספר היחידות המשניות של המטבע.

הערך הזה נקרא 'יחידות משנה' והוא מוגדר בתקן ISO 4217. לדוגמה, אם המטבע הוא דולר ארה"ב, הערך יהיה מספר הסנטים, ואם המטבע הוא פאונד בריטי, הערך יהיה מספר הפני. במקרה של ין יפני, שאין לו יחידה משנית, זה יהיה מספר הין.

DeactivateAccount

סימון חשבון כACCOUNT_STATUS_INACTIVE. השולח צריך להיות מנהל החשבון שרוצים להשבית.

המשמעות היא שבעל החשבון לא יוכל לבצע טרנזקציות בחשבון, ללא קשר לתפקידים.

שדות
account
(deprecated)

Entity

זה שינוי אופציונלי. הוצא משימוש: במקומו, צריך להשתמש ב-account_id. המזהה של החשבון שרוצים להשבית.

account_id

string

זה שינוי אופציונלי. המזהה של החשבון שרוצים להשבית. צריך לציין את account או את account_id. הערך מוגבל ל-60 תווים.

DecreaseTokenIssuanceLimit

הודעה לרשת שחשבון היעד רוצה למשוך כספים מהרזרבה, והקטנת מגבלת הנפקת האסימונים שלו. השולח צריך להיות חשבון של מרכז סליקה.

חשוב לזכור שצריך להשלים את העסקה לפני שאפשר למשוך את הכספים ששמורים. הדבר נחוץ כי יכול להיות שהעסקה תיכשל (לדוגמה, אם הסכום שנוצר כבר גבוה מהמגבלה המופחתת המבוקשת).

שדות
token_manager
(deprecated)

Entity

זה שינוי אופציונלי. הוצא משימוש: במקומו, צריך להשתמש ב-token_manager_id. המזהה של החשבון המוסדי שרוצים להקטין את מגבלת הטבעת שלו. החשבון הזה צריך להיות מנהל אסימונים כדי שהעסקה תהיה תקפה.

token_manager_id

string

זה שינוי אופציונלי. המזהה של החשבון המוסדי שהגבלת הטבעת האסימונים שלו צריכה להיות מופחתת. החשבון הזה צריך להיות מנהל אסימונים כדי שהעסקה תהיה תקפה. צריך לציין את אחד מהמאפיינים הבאים: token_manager_id (מומלץ) או token_manager (יצא משימוש).

amount

CurrencyValue

חובה. הסכום שבו רוצים להקטין את המגבלה. הסכום חייב להיות חיובי. העסקה תיכשל אם המגבלה המופחתת תהיה נמוכה מהטוקנים שהונפקו כרגע.

DictList

רשימה של מילונים.

שדות
values[]

DictValue

זה שינוי אופציונלי. הערכים של DictValue. כל המילונים המקוננים צריכים להיות מאותו סוג קונקרטי.

DictValue

האינדקסים ממפים מפתח לערך. לדוגמה, המקש keys[0] ממופה ל-values[0].

שדות
שדה איחוד keys. כל מפתח יכול להיות מסוג אחד בלבד. הערך keys יכול להיות רק אחד מהבאים:
bool_keys

BoolList

זה שינוי אופציונלי. רשימה של מפתחות בוליאניים.

string_keys

StringList

זה שינוי אופציונלי. רשימה של מפתחות מחרוזת.

int64_keys

Int64List

זה שינוי אופציונלי. רשימה של מפתחות int64.

account_id_keys

AccountIdList

זה שינוי אופציונלי. רשימה של מפתחות מזהי חשבונות.

שדה איחוד values. כל ערך יכול להיות מסוג אחד בלבד. הערך values יכול להיות רק אחד מהבאים:
bool_values

BoolList

זה שינוי אופציונלי. רשימה של ערכים בוליאניים.

string_values

StringList

זה שינוי אופציונלי. רשימה של ערכי מחרוזת.

int64_values

Int64List

זה שינוי אופציונלי. רשימה של ערכי int64.

dict_values

DictList

זה שינוי אופציונלי. הערכים הם רשימה של מילונים מקוננים.

נקודת קצה (endpoint)

מייצג נקודת קצה של Universal Ledger.

שדות
name

string

מזהה. שם המשאב של נקודת הקצה. פורמט: projects/{project}/locations/{location}/endpoints/{endpoint}

ישות

ישות ברשת Universal Ledger. כל החשבונות משויכים לישות. מזהה הישות, שנקרא גם מזהה החשבון, הוא ייחודי וקבוע ברשת.

שדות
id

string

פלט בלבד. המזהה שהוקצה לישות. המספר הזה מוקצה על ידי הרשת כשיוצרים את החשבון.

EventDetails

מייצג פרטים נוספים של אירוע סטטוס.

שדות
שדה איחוד event_details. פרטי האירוע. הערך event_details יכול להיות רק אחד מהבאים:
execution_details

ExecutionDetails

פלט בלבד. פרטים נוספים על אירוע הרצה.

EventType

מייצג את הסוג של אירוע בתהליך של טרנזקציה, כפי שנצפה על ידי כלי האימות שהבקשה הועברה אליו.

טיפוסים בני מנייה (enum)
EVENT_TYPE_UNSPECIFIED אירוע לא ידוע או לא מוגדר.
EVENT_TYPE_RECEIVED העסקה התקבלה ישירות מהלקוח על ידי כלי האימות הזה.
EVENT_TYPE_BROADCASTED העסקה שודרה על ידי המאמת הזה למאמתים אחרים.
EVENT_TYPE_ORDERED העסקה הוזמנה ותוכננה לביצוע על ידי מאמת זה.
EVENT_TYPE_EXECUTION_STARTED הביצוע של העסקה התחיל.
EVENT_TYPE_EXECUTION_COMPLETED ההרצה של העסקה הסתיימה.
EVENT_TYPE_FINALIZED העסקה הסתיימה על ידי מאמת התשלומים הזה.

ExecutionDetails

פרטים נוספים על אירוע הרצה.

שדות
round_id

int64

פלט בלבד. מזהה הסיבוב שבו התרחש אירוע ההפעלה.

שדות

מיפוי של שדות (שם השדה -> ערך) מחוזה שמשמש לייצוג שדות בחוזה או שדות בחשבון.

שדות
fields

map<string, Value>

פלט בלבד. מיפוי של שמות השדות לערכים שלהם.

GetEndpointRequest

הודעת בקשה ל-GetEndpoint.

שדות
name

string

חובה. השם של נקודת הקצה לאחזור. פורמט: projects/{project}/locations/{location}/endpoints/{endpoint}

GrantContractPermissions

השולח של הטרנזקציה מעניק הרשאות לחוזה. אם מציינים את delegate_contract_id, ההרשאות והאחסון התואם ניתנים באופן בלעדי לחוזה delegate_contract_id, ולא לשולח.

חשוב לדעת: אין תמיכה בביטול הרשאות.

שדות
contract
(deprecated)

Entity

זה שינוי אופציונלי. הוצא משימוש: במקומו, צריך להשתמש ב-contract_id. המזהה של החוזה שלגביו מוענקות ההרשאות.

contract_id

string

זה שינוי אופציונלי. המזהה של החוזה שלגביו מוענקות ההרשאות. צריך לציין את contract או את contract_id.

permissions[]

ContractPermission

ההרשאות שיינתנו.

delegate_contract_id

string

זה שינוי אופציונלי. מזהה החוזה שלגביו מוענקות הרשאות. השולח של העסקה חייב להיות הבעלים של החוזה הזה.

IncreaseTokenIssuanceLimit

עסקאות להנפקת טוקנים וליצירת מטבעות קריפטו. הודעה לרשת שחשבון היעד הפקיד כספים לקרן מילואים, והגדלת המגבלה על הנפקת אסימונים. השולח צריך להיות חשבון של מרכז סליקה.

שדות
token_manager
(deprecated)

Entity

זה שינוי אופציונלי. הוצא משימוש: במקומו, צריך להשתמש ב-token_manager_id. המזהה של החשבון המוסדי שרוצים להגדיל את מגבלת הטבעת המטבעות שלו. החשבון הזה צריך להיות מנהל אסימונים כדי שהעסקה תהיה תקפה.

token_manager_id

string

זה שינוי אופציונלי. המזהה של החשבון המוסדי שרוצים להגדיל את מגבלת הטבעת המטבעות שלו. החשבון הזה צריך להיות מנהל אסימונים כדי שהעסקה תהיה תקפה. צריך לציין את token_manager או את token_manager_id.

amount

CurrencyValue

חובה. הסכום שבו רוצים להגדיל את המגבלה. הסכום חייב להיות חיובי.

Int64List

רשימה של int64.

שדות
values[]

int64

זה שינוי אופציונלי. ערכי int64.

InvokeContractMethod

מפעיל את הביצוע של שיטת חוזה.

שדות
contract
(deprecated)

Entity

זה שינוי אופציונלי. הוצא משימוש: במקומו, צריך להשתמש ב-contract_id. המזהה של החוזה להפעלה.

contract_id

string

זה שינוי אופציונלי. המזהה של החוזה להפעלה. צריך לציין את contract או את contract_id.

method_name

string

שם ה-method להפעלה.

arguments
(deprecated)

map<string, Value>

זה שינוי אופציונלי. אי אפשר לשנות. הוצא משימוש: במקומו, צריך להשתמש ב-method_arguments. ארגומנטים של השיטה.

method_arguments

map<string, Value>

זה שינוי אופציונלי. אי אפשר לשנות. מכיל ארגומנטים להעברה לשיטה.

payment

CurrencyValue

הסכום לתשלום. הערך חייב להיות גדול מאפס כשמפעילים שיטות שניתן לשלם עבורן, ואפס כשמפעילים שיטות שלא ניתן לשלם עבורן.

KeyFormat

מציין את הפורמט שבו מסופק מפתח ציבורי. יכול להיות שבעתיד יתווספו ערכים חדשים ל-enum הזה.

טיפוסים בני מנייה (enum)
KEY_FORMAT_UNSPECIFIED פורמט המפתח לא צוין. הערך הזה לא תקין ואין להשתמש בו.
KEY_FORMAT_TINK_WIRE_FORMAT קבוצת מפתחות בינארית שעברה סריאליזציה בפורמט Tink wire.
KEY_FORMAT_PEM_EC_P256_SHA256 מפתח חתימה של עקומת אליפטית בקידוד PEM באמצעות עקומת P-256 עם גיבוב SHA256. חתימות חייבות להיות בפורמט DER.

KeySlot

מזהה של המשבצות שיכולות להכיל מפתחות בחשבון.

טיפוסים בני מנייה (enum)
KEY_SLOT_UNSPECIFIED לא צוין משבצת מפתח.
KEY_SLOT_PRIMARY משבצת המפתח הראשי.
KEY_SLOT_ALTERNATE משבצת המפתח החלופי.

ListEndpointsRequest

הודעת בקשה עבור ListEndpoints.

שדות
parent

string

חובה. ההורה, שהוא הבעלים של אוסף נקודות הקצה הזה. פורמט: projects/{project}/locations/{location}

page_size

int32

זה שינוי אופציונלי. המספר המקסימלי של נקודות קצה שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מציינים ערך, יוחזרו לכל היותר 50 נקודות קצה. הערך המקסימלי הוא 1,000. ערכים גבוהים יותר יומרו ל-1,000.

page_token

string

זה שינוי אופציונלי. טוקן של דף שהתקבל מקריאה קודמת של ListEndpoints. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

ListEndpointsResponse

הודעת התגובה של ListEndpoints.

שדות
endpoints[]

Endpoint

נקודות הקצה של הפרויקט והמיקום שצוינו.

next_page_token

string

טוקן שאפשר לשלוח כ-page_token כדי לאחזר את הדף הבא. אם משמיטים את השדה הזה, לא יופיעו דפים נוספים.

MerkleTree

עץ מרקל עם תקציר קריפטוגרפי של צומת השורש.

שדות
root_hash_hex
(deprecated)

string

פלט בלבד. התקציר הקריפטוגרפי של צומת הבסיס. הוצא משימוש: במקומו, צריך להשתמש ב-root_digest_hex.

root_digest_hex

string

פלט בלבד. הייצוג ההקסדצימלי של הגיבוב של צומת הבסיס. פורמט: מחרוזת הקסדצימלית באורך 64 תווים.

num_transactions

int64

פלט בלבד. מספר העסקאות בעץ.

מנטה

יוצר אסימוני מטבע ומעביר אותם לחשבון שצוין. השולח חייב להיות מנהל אסימונים.

שדות
mint_amount

CurrencyValue

חובה. הסכום להנפקה. הסכום צריך להיות כזה שהמספר הכולל של האסימונים שנוצרו על ידי מנהל האסימונים לא יעלה על מגבלת הטבעת האסימונים. אם הסכום גבוה יותר, צריך לדחות את העסקה

beneficiary
(deprecated)

Entity

זה שינוי אופציונלי. הוצא משימוש: במקומו, צריך להשתמש ב-beneficiary_id. החשבון שאליו יועבר הסכום שהונפק. צריך להפעיל את ROLE_RECEIVER בחשבון המוטב.

beneficiary_id

string

זה שינוי אופציונלי. המזהה של החשבון שאליו צריך להעביר את הסכום שהונפק. צריך להפעיל את ROLE_RECEIVER בחשבון המקבל. צריך לציין את beneficiary או את beneficiary_id.

NoneValue

מספור יחיד שמייצג את הערך None.

טיפוסים בני מנייה (enum)
NONE_VALUE_UNSPECIFIED הערך None.

PlatformOperatorDetails

פרטים ספציפיים למפעיל פלטפורמה.

שדות
account_status

AccountStatus

פלט בלבד. הסטטוס של החשבון הזה.

previous_entity_id
(deprecated)

Entity

פלט בלבד. הוצא משימוש: במקומו, צריך להשתמש ב-previous_platform_operator_id. המפעיל הקודם של הפלטפורמה שהעביר את הבעלות על תפקיד המפעיל של הפלטפורמה לחשבון הזה. אם זה המפעיל הראשון של הפלטפורמה, השדה הזה יהיה ריק.

previous_platform_operator_id

string

פלט בלבד. המזהה של מפעיל הפלטפורמה הקודם שהעביר את הבעלות על תפקיד מפעיל הפלטפורמה לחשבון הזה. אם זה המפעיל הראשון של הפלטפורמה, השדה הזה יהיה ריק.

ProofOfInclusion

אישור על הכללת ההשפעות של טרנזקציה במצב העולמי.

שדות
transaction_certificate

TransactionCertificate

פלט בלבד. אישור על הכללת ההשפעות של העסקה בסבב ספציפי.

round_certificate

RoundCertificate

פלט בלבד. אישור על ביצוע הסבב.

path_to_round_root[]

MerkleTreeNode

פלט בלבד. הוכחה קריפטוגרפית להכללה של השפעות העסקה בסבב הביצוע.

הוא ניתן כנתיב מעלה נתון (תקציר טרנזקציה) אל שורש סבב הביצוע. הנתיב מיוצג כרשימה של זוגות (צאצא שמאלי, צאצא ימני), והזוג הראשון הוא הצאצא השמאלי והצאצא הימני של צומת האב של העלה הנתון. לדוגמה, נניח שעץ מרקל נבנה עם שמונה תמציות של עלים [t0, t1, t2, t3, t4, t5, t6, t7], עם המבנה הבא:

       _____root_digest____
      |                    |
   __ h20__             __h21__
  |        |           |       |
 h10     h11          h12     h13
 | |     | |          | |     | |
t0 t1   t2 t3        t4 t5   t6 t7

בקטע הזה, path_to_round_root עבור t0 יכלול את: [(t0, t1), (h10, h11), (h20, h21)].

אפשר לחשב ברצף את הגיבובים של SHA-256 של כל צומת בנתיב כדי לוודא שהגיבוב של הנתיב יוצר את אותו ערך כמו round_certificate.merkle_tree.root_digest_hex. כך מוודאים שהעלה נכלל בעץ מרקל של הסיבוב.

MerkleTreeNode

מייצג צומת בנתיב של עץ מרקל.

שדות
left_child_hash_hex
(deprecated)

string

פלט בלבד. הייצוג ההקסדצימלי של ה-digest של צאצא שמאלי של צומת. הוצא משימוש: במקומו, צריך להשתמש ב-left_child_digest_hex.

right_child_hash_hex
(deprecated)

string

פלט בלבד. הייצוג ההקסדצימלי של ה-digest של צאצא ימני של צומת. הוצא משימוש: במקומו, צריך להשתמש ב-right_child_digest_hex.

left_child_digest_hex

string

פלט בלבד. הייצוג ההקסדצימלי של ה-digest של צאצא שמאלי של צומת. פורמט: מחרוזת הקסדצימלית באורך 64 תווים.

right_child_digest_hex

string

פלט בלבד. הייצוג ההקסדצימלי של ה-digest של צאצא ימני של צומת. פורמט: מחרוזת הקסדצימלית באורך 64 תווים.

QualifiedCurrencyValue

מייצג מטבע בספר החשבונות, שמוגדר על ידי מפעיל המטבע.

שדות
operator_id

string

חובה. מזהה האופרטור של המטבע שמנהל את המטבע.

QueryAccountRequest

הודעת בקשה ל-QueryAccount.

שדות
endpoint

string

חובה. נקודת הקצה למילוי הבקשה. פורמט: projects/{project}/locations/{location}/endpoints/{endpoint} המיקום הוא אזור.

account_id

string

חובה. מספר החשבון שרוצים לקבל עליו מידע. הערך מוגבל ל-60 תווים.

round_id

int64

זה שינוי אופציונלי. המזהה של סבב ההפעלה (דומה ל'גובה' הבלוק) שבו רוצים לבקש נתונים. פרטי החשבון שיוחזרו יהיו מדויקים לגבי מצב העולם בסבב הביצוע הזה. אם לא מציינים את מספר הסיבוב, המערכת משתמשת בסיבוב האחרון שהושלם, כפי שהוא ידוע לכלי לאימות התצוגה. המצב במזהה סבב נתון הוא תמיד עקבי וקנוני.

QueryAccountResponse

הודעת תגובה ל-QueryAccount.

שדות
account

Account

פרטי החשבון, כולל הגובה שבו התקבלו.

QueryDataRequest

הודעת בקשה ל-QueryData.

שדות
endpoint

string

חובה. נקודת הקצה למילוי הבקשה. פורמט: projects/{project}/locations/{location}/endpoints/{endpoint} המיקום הוא אזור.

serialized_signed_query_request

bytes

חובה. ‫protobuf מסוג serialized SignedQueryRequest לשאילתת רשת Universal Ledger.

QueryDataResponse

הודעת התגובה ל-QueryData.

שדות
redacted_fields[]

RedactedField

מציין אילו שדות צונזרו מהתשובה בגלל הגבלות הרשאה.

שדה איחוד kind. התוצאה שספציפית לשאילתה. הערך kind יכול להיות רק אחד מהבאים:
account

Account

פרטי החשבון, אם השאילתה הייתה לגבי חשבון.

transaction_state

TransactionState

המצב של העסקה, אם השאילתה הייתה לגבי עסקה.

QueryTransactionStateRequest

הודעת בקשה ל-QueryTransactionState.

שדות
endpoint

string

חובה. נקודת הקצה למילוי הבקשה. פורמט: projects/{project}/locations/{location}/endpoints/{endpoint} המיקום הוא אזור.

transaction_digest_hex

string

חובה. מזהה העסקה שרוצים לקבל את הסטטוס שלה.

QueryTransactionStateResponse

הודעת תגובה ל-QueryTransactionState.

שדות
transaction_attempts[]

TransactionAttempt

רשומה אחת לכל שליחה ידועה של העסקה לכלי האימות שמטפל בבקשה.

RedactedField

מידע על שדה שהוסר מהתשובה.

שדות
redacted_path

FieldMask

פלט בלבד. הנתיבים המוגדרים במלואם של השדות שצונזרו במטען הייעודי (payload).

reason

string

פלט בלבד. הסבר קריא (לבני אדם) לסיבה להסתרת השדות.

reason_code

Code

פלט בלבד. קוד שמתאים לקריאה למחשב שמציין למה השדות צונזרו.

RemoveRoles

הסרת התפקידים שצוינו מהחשבון. השולח צריך להיות מנהל החשבון של החשבון שרוצים לשנות.

שדות
account
(deprecated)

Entity

זה שינוי אופציונלי. הוצא משימוש: במקומו, צריך להשתמש ב-account_id. המזהה של החשבון שרוצים לשנות.

account_id

string

זה שינוי אופציונלי. המזהה של החשבון שרוצים לשנות. צריך לציין את account או את account_id. הערך מוגבל ל-60 תווים.

roles[]

Role

חובה. התפקידים שרוצים להסיר.

RemoveSigningPublicKey

הסרת מפתח החתימה של החשבון מהמשבצת שצוינה. המשבצת השנייה לא יכולה להיות ריקה, והיא צריכה להכיל את המפתח ששימש לחתימה על ClientTransaction.

שדות
key_slot

KeySlot

חובה. משבצת המפתח שממנה אנחנו מסירים את המפתח. אם השדה הזה כבר ריק, העסקה תיכשל.

ReplaceSigningPublicKey

החלפת מפתח החתימה של החשבון במשבצת שצוינה. המשבצת השנייה לא יכולה להיות ריקה, והיא צריכה להכיל את המפתח ששימש לחתימה על ClientTransaction.

שדות
key_slot

KeySlot

חובה. משבצת המפתח שבה אנחנו מחליפים את המפתח.

new_public_key

bytes

חובה. המפתח הציבורי החדש, שיחליף את המפתח הציבורי במשבצת שצוינה.

הפורמט של המפתח הציבורי מוגדר בשדה new_key_format. נחשב למידע ציבורי.

new_key_format

KeyFormat

חובה. פורמט המפתח של המפתח הציבורי החדש. רשימת הפורמטים הנתמכים מופיעה בהגדרה של KeyFormat. נחשב למידע ציבורי.

תפקיד

קבוצת התפקידים הרגילה.

טיפוסים בני מנייה (enum)
ROLE_UNSPECIFIED תפקיד לא חוקי.
ROLE_PAYER התפקיד שמאפשר לחשבון ליזום עסקת תשלום.
ROLE_RECEIVER התפקיד שמאפשר לחשבון לקבל תשלומים.
ROLE_CONTRACT_CREATOR התפקיד שמאפשר לחשבון לפרוס חוזים.
ROLE_CONTRACT_PARTICIPANT התפקיד שמאפשר לחשבון ליצור אינטראקציה עם חוזים שנפרסו.

RoundCertificate

אישור על ביצוע סבב על ידי מאמת ספציפי.

שדות
round_id

int64

פלט בלבד. המזהה של הסבב שאליו משויך האישור.

validator_id

string

פלט בלבד. מזהה כלי התיקוף בפורמט שקריא לאנשים. הערך הזה משמש לחיפוש המפתח הציבורי שמשמש לאימות של validator_signatures.

round_state_checksum_hex

string

פלט בלבד. ייצוג הקסדצימלי של ה-digest ההומומורפי של מצב העולם אחרי שההשפעות של הסיבוב הזה מיושמות.

round_delta_checksum_hex

string

פלט בלבד. ייצוג הקסדצימלי של התמצית ההומומורפית של השפעות העסקאות המצטברות בסבב הזה.

merkle_tree

MerkleTree

פלט בלבד. עץ מרקל שבו הסיבוב הזה הוא צומת השורש, ואצוות העסקאות (שבוצעו בסיבוב) הן העלים.

validator_signatures[]

bytes

זה שינוי אופציונלי. החתימה של המאמת. החתימה הזו מתבצעת על ה-digest של המטען הייעודי הקודם של הרשומה הזו.

is_finalized

bool

פלט בלבד. ערך בוליאני שמציין אם הסבב הסתיים, כלומר אם מספר מספיק של מאמתים אישרו את הסבב הזה באותו אישור.

SettlementMode

מצב הסליקה של מרכז סליקה.

טיפוסים בני מנייה (enum)
SETTLEMENT_MODE_UNSPECIFIED מצב הסליקה לא מוגדר. הערך הזה לא תקין ואין להשתמש בו.
SETTLEMENT_MODE_DEFERRED המרכז לקלירינג אחראי למעקב אחר הבעלות על הכספים מחוץ לספר החשבונות, ולהנפקת עסקאות SettlementRequest מעת לעת כדי לשמור על סנכרון היתרות התואמות בספר החשבונות.
SETTLEMENT_MODE_INSTANT המרכז לניהול מידע שומר על מאגר יחיד של כספים, והספר הראשי משמש כמקור המהימן לחלוקת הכספים האלה בין מנהלי הטוקנים. אפשר גם לתאר את מצב ההסדר הזה כ "הסדר מיידי ברוטו".

SettlementRequest

הפעולה יוזמת תהליך סליקה בין שני מנהלי אסימונים. השולח צריך להיות חשבון של מרכז סליקה.

במקרה של דחייה SettlementMode שבה מרכז הסליקה מחזיק בכספים של מנהל האסימונים, זו העסקה היחידה שצריך לשלוח כדי לבצע סליקה בין שני מנהלי האסימונים.

שדות
payer
(deprecated)

Entity

זה שינוי אופציונלי. אי אפשר לשנות. הוצא משימוש: במקומו, צריך להשתמש ב-payer_id. מספר החשבון של הגורם שצריך לבצע את העברת הכספים.

payer_id

string

זה שינוי אופציונלי. אי אפשר לשנות. מספר החשבון של הגורם שצריך לבצע את העברת הכספים. צריך לציין את payer או את payer_id.

beneficiary
(deprecated)

Entity

זה שינוי אופציונלי. אי אפשר לשנות. הוצא משימוש: במקומו, צריך להשתמש ב-beneficiary_id. מספר החשבון של הגורם שצריך לקבל תשלום.

beneficiary_id

string

זה שינוי אופציונלי. אי אפשר לשנות. מספר החשבון של הצד שיקבל את הכספים. צריך לציין את beneficiary או את beneficiary_id.

balance

CurrencyValue

חובה. אי אפשר לשנות. היתרה של האסימונים שהונפקו ושצריך להעביר מחשבון payer לחשבון beneficiary בפנקס החשבונות.

round_id

int64

חובה. אי אפשר לשנות. מזהה הסבב שבו חושב סכום ההסדר הזה.

SignedTransaction

עסקה עם חתימות מצורפות. כדי לשלוח עסקה, צריך לבצע סריאליזציה של ההודעה הזו ולכלול אותה ב-SubmitTransactionRequest.

שדות
serialized_client_transaction

bytes

חובה. מחרוזת ClientTransaction עם פרטי העסקה.

sender_signature

bytes

חובה. החתימה של שולח העסקה.

החתימה צריכה להיות מחושבת על ידי חתימה על הבייטים serialized_client_transaction באמצעות המפתח הפרטי שלהם.

בשרשרת עסקאות, הבייטים שצריך לחתום עליהם מחושבים כצירוף של: – תקציר של העסקה הסדרתית של הלקוח בשרשרת כולה. – תקציר של העסקה החתומה שעברה סריאליזציה של כל יחידה בשרשרת, בסדר שבו הן מופיעות בשרשרת. התקצירים מחושבים באמצעות SHA-256.

sender_signing_key_slot

KeySlot

זה שינוי אופציונלי. משבצת המפתח של השולח שמשמשת לחתימה על העסקה. אם לא מציינים, המערכת משתמשת במשבצת הראשית של חשבון השולח.

other_signatures[]

bytes

זה שינוי אופציונלי. החתימות של החשבונות שמופיעים כחותמים נוספים על העסקה. מספר החתימות והסדר שלהן צריכים להיות זהים לאלה שמופיעים בשדה signatories ב-ClientTransaction.

הבייטים שצריך לחתום עליהם זהים לאלה של sender_signature, וכל חותם צריך לחתום עליהם באמצעות המפתח הפרטי שלו.

המספר והזהות של החותמים הנוספים תלויים בסוג העסקה. בשרשרת עסקאות, נדרש חתימה אחת לכל חשבון שמופיע כשולח או כחותם של יחידה בשרשרת.

other_signing_key_slots[]

KeySlot

זה שינוי אופציונלי. משבצות המפתחות של החשבונות שמופיעים כחותמים נוספים על העסקה. אם השדה הזה מוגדר, המספר והסדר של משבצות המפתחות האלה צריכים להיות זהים לאלה שבשדה other_signatures ב-SignedTransaction. אם לא מציינים ערך, ברירת המחדל היא המשבצת הראשית של כל חשבון.

StatusEvent

מייצג אירוע בתהליך של עסקה כפי שנצפה על ידי מאמת יחיד.

כל הערכים שמדווחים הם מנקודת המבט של כלי האימות שמטפל בבקשה, ועשויים להיות שונים מנקודת המבט של כלי אימות אחרים.

שדות
event_time

Timestamp

פלט בלבד. השעה שבה האירוע תועד על ידי הכלי הזה לאימות.

event_type

EventType

פלט בלבד. סוג האירוע.

event_details

EventDetails

פלט בלבד. פרטים נוספים שמשויכים לאירוע.

StringList

רשימה של מחרוזות.

שדות
values[]

string

זה שינוי אופציונלי. ערכי המחרוזת.

SubmitOperationalTransactionRequest

הודעת בקשה ל-SubmitOperationalTransaction.

שדות
endpoint

string

חובה. נקודת הקצה למילוי הבקשה. פורמט: projects/{project}/locations/{location}/endpoints/{endpoint} המיקום הוא אזור.

serialized_signed_operational_transaction

bytes

חובה. ‫protobuf מסוג SignedTransaction שסודר בסדר מסוים כדי לשלוח אותו לספר החשבונות. העסקה של הלקוח שצורפה חייבת להיות עסקה תפעולית, והשולח חייב להיות מפעיל הפלטפורמה. שימוש בפורמט סדרתי מבטיח שכל כלי האימות יחשבו את אותו מזהה עסקה כסיכום SHA-256 של הבייטים הסדרתיים.

SubmitOperationalTransactionResponse

הודעת התגובה של SubmitOperationalTransaction.

שדות
transaction_digest_hex

string

מזהה שמייצג באופן ייחודי את העסקה התפעולית שנשלחה. זהו הייצוג ההקסדצימלי של תקציר SHA-256 של serialized_signed_operational_transaction. מזהה העסקה הזה מסופק כדי שהלקוח יוכל לעקוב אחרי העסקה בלי להטמיע בעצמו את לוגיקת הגיבוב. אפשר להשתמש במזהה ישירות בקריאות API הבאות, למשל כדי לשלוח שאילתה לגבי מצב העסקה.

SubmitTransactionRequest

הודעת בקשה ל-SubmitTransaction.

שדות
endpoint

string

חובה. נקודת הקצה שאליה שולחים את העסקה. פורמט: projects/{project}/locations/{location}/endpoints/{endpoint} המיקום הוא אזור.

serialized_signed_transaction

bytes

חובה. ‫protobuf מסוג SignedTransaction שסודר בסדר מסוים כדי לשלוח אותו לספר החשבונות. שימוש בפורמט סדרתי מבטיח שכל כלי האימות יחשבו את אותו מזהה עסקה כסיכום SHA-256 של הבייטים הסדרתיים.

SubmitTransactionResponse

הודעת התגובה של SubmitTransaction.

שדות
transaction_digest_hex

string

מזהה שמייצג באופן ייחודי את העסקה שנשלחה. זהו הייצוג ההקסדצימלי של תקציר SHA-256 של serialized_signed_transaction. מזהה העסקה הזה מסופק כדי שהלקוח יוכל לעקוב אחרי העסקה בלי להטמיע בעצמו את לוגיקת הגיבוב. אפשר להשתמש במזהה ישירות בקריאות API הבאות, למשל כדי לשלוח שאילתה לגבי מצב העסקה.

TokenManagerDetails

פרטים ספציפיים ל-Token Manager.

שדות
issuance_limit

CurrencyValue

פלט בלבד. מספר האסימונים שמנהל הטוקנים הזה יכול ליצור.

issued_tokens

CurrencyValue

פלט בלבד. מספר הטוקנים שנוצרו על ידי מנהל הטוקנים הזה. המספר הזה יגדל כשמנפיקים טוקנים ויקטן כשמבצעים שריפה.

TransactionAttempt

המצב של ניסיון לשליחת עסקה.

שדות
status

TransactionStatus

פלט בלבד. הסטטוס הנוכחי של ניסיון העסקה.

proof_of_inclusion

ProofOfInclusion

פלט בלבד. אישור על הכללת השפעות העסקה במצב העולמי. הערך הזה מסופק רק אם הסטטוס הוא FINALIZED.

status_events[]

StatusEvent

פלט בלבד. אירועי הסטטוס של ההזמנה שנרשמו לניסיון העסקה.

TransactionStatus

הסטטוס של ניסיון העסקה.

טיפוסים בני מנייה (enum)
TRANSACTION_STATUS_UNSPECIFIED מצב לא ידוע או לא מאותחל.
PENDING העסקה מוכרת לכלי האימות הזה, אבל היא עדיין לא סופית.
FINALIZED העסקה הושלמה. ההשפעות שלה נשמרו בבלוקצ'יין ואי אפשר לבטל אותן.

TransactionCertificate

אישור על ביצוע עסקה ספציפית בסבב.

שדות
transaction_digest_hex

string

פלט בלבד. המזהה של העסקה שאליה מתייחס האישור הזה.

round_id

int64

פלט בלבד. המזהה של סבב הביצוע שבו בוצעה העסקה הזו.

transaction_effects

TransactionEffects

פלט בלבד. ההשפעות מביצוע העסקה.

events[]

TransactionEvent

פלט בלבד. אירועים שנוצרו על ידי העסקה.

transaction_effects_state_checksum_hex

string

פלט בלבד. סכום ביקורת הומומורפי של האפקטים. ערך בגודל 2048 בתים (bytes) שמקודד כמחרוזת הקסדצימלית.

certification_results_digest_hex

string

פלט בלבד. תמצית קריפטוגרפית של כל השדות הקודמים ברצף. הוא משמש לבניית עץ מרקל להוכחת ההכללה.

TransactionChain

שרשרת של עסקאות שכוללת כמה יחידות של עסקאות שצריך לבצע ברצף.

היחידות יופעלו ברצף, לפי הסדר שבו הן מופיעות. אם כל היחידות יצליחו, ההשפעות המצטברות שלהן יתבצעו באופן אטומי במצב העולמי. אחרת, אם אחת מהן נכשלת, כל השרשרת תיכשל ואף אחת מההשפעות שלה לא תחול.

שדות
units[]

bytes

היחידות הנפרדות של הרשת. כל יחידה חייבת להיות SignedTransaction מסוג serialized.

שימו לב: הבייטים שעברו סריאליזציה נדרשים כדי לקבוע את הבייטים שצריך לחתום עליהם עבור השרשרת עצמה.

TransactionEffect

מייצג עדכון של מצב העולם על ידי עסקה כלשהי.

אם יש לו delta_val, מניחים שמדובר בדלתא (היסט של מספר שלם) שמוחלת על הערך שאוחסן קודם במפתח נתון. במקרה כזה, העמודות new_val ו-old_val צריכות להיות ריקות.

אחרת, המערכת מניחה שיש לו לפחות את old_val או new_val (או את שניהם). אם התג old_val ריק, המשמעות היא שהערך הוכנס. ערך ריק new_val מציין שהערך נמחק.

שדות
key

bytes

פלט בלבד. המפתח במצב העולמי שעודכן.

old_val

bytes

פלט בלבד. הערך של המפתח לפני ביצוע העסקה.

new_val

bytes

פלט בלבד. הערך של המפתח אחרי ביצוע העסקה.

delta_val

int64

פלט בלבד. היסטוריית שינויים של מספר שלם שהוחל על הערך הקודם ששמור.

TransactionEffects

ההשפעות של ביצוע עסקה.

שדות
status

TransactionStatus

פלט בלבד. הסטטוס שמתקבל של ביצוע העסקה.

effects[]
(deprecated)

TransactionEffect

פלט בלבד. הוצא משימוש: במקום זאת, אפשר להריץ שאילתה לגבי מצב הרשת כדי לקבוע אם חלו שינויים במצב העולמי. ההשפעות של העסקה על מצב העולם.

TransactionEvent

אירוע שנוצר על ידי עסקה.

שדות
type

string

פלט בלבד. סוג האירוע. אירוע מיוחד מסוג transaction_output מכיל את התוצאות שהתקבלו מהעסקה – לדוגמה, מזהה החשבון של חשבון חדש שנוצר.

attributes[]

EventAttribute

פלט בלבד. מאפייני האירוע כצמדי מפתח/ערך שרירותיים.

EventAttribute

מאפיין בודד כצמד מפתח/ערך.

שדות
key

string

פלט בלבד. המפתח של המאפיין.

value

string

פלט בלבד. הערך של המאפיין.

TransactionState

הסטטוס של העסקה.

שדות
transaction_attempts[]

TransactionAttempt

רשומה אחת לכל שליחה ידועה של העסקה לכלי האימות שמטפל בבקשה.

TransactionStatus

מייצג את הסטטוס של ביצוע עסקה.

שדות
code

int32

פלט בלבד. קוד הסטטוס, ערך מספרי שהמשמעות שלו מוגדרת על ידי קוד הסטטוס התואם של gRPC.

message

bytes

פלט בלבד. הודעת השגיאה, אם יש כזו. ההגדרה הזו רלוונטית רק אם הקוד הוא לא OK. זו מחרוזת שמקודדת כבייטים בקידוד utf-8. הנתונים מאוחסנים כבייטים כדי למנוע בעיות בדטרמיניזם של הקידוד.

העברה

העברת טוקנים מחשבון משתמש אחד לחשבון משתמש אחר. השולח צריך להיות חשבון משתמש רגיל, ולא חשבון עם הרשאות מיוחדות כמו חשבון לניהול אסימונים או חשבון ניהול.

בנוסף, השולח של העסקה חייב להפעיל את ROLE_PAYER, והמקבל חייב להפעיל את ROLE_RECEIVER.

שדות
beneficiary
(deprecated)

Entity

זה שינוי אופציונלי. הוצא משימוש: במקומו, צריך להשתמש ב-beneficiary_id. החשבון שמקבל את האסימונים.

beneficiary_id

string

זה שינוי אופציונלי. המזהה של החשבון שמקבל את האסימונים. צריך לציין את beneficiary או את beneficiary_id.

amount

CurrencyValue

חובה. הסכום להעברה. הסכום חייב להיות חיובי.

TransferContractTokenManager

העברת הבעלות על מנהל טוקנים של חוזה לחשבון חדש. השולח חייב להיות המפעיל הנוכחי של המטבע.

אם העסקה תצליח, המערכת תשבית את מנהל אסימוני החוזה הנוכחי למטבע, ומזהה החשבון שנוצר יוחזר כאירוע ב-TransactionCertificate של העסקה הסופית.

שדות
public_key

bytes

חובה. המפתח הציבורי של מנהל הטוקנים החדש של החוזה. חשוב לזכור שזה לא המפתח הציבורי של המפעיל. זהו המפתח הציבורי של מנהל הטוקנים של החוזה החדש, והוא יישמר בספר החשבונות. הוא ישמש לאימות החתימה של העסקאות שמגיעות מהחשבון של מנהל האסימונים בחוזה.

הפורמט של המפתח הציבורי מוגדר בשדה key_format. נחשב למידע ציבורי.

account_comment

string

זה שינוי אופציונלי. אי אפשר לשנות. שדה תגובה אטום שלא מפוענח על ידי המערכת, אבל מאוחסן בפנקס החשבונות בחשבון. נחשב למידע ציבורי. האורך המרבי הוא 128 תווים. אפשר להשאיר את השדה ריק. אחרי שיוצרים את השדה, אי אפשר לשנות אותו.

key_format

KeyFormat

זה שינוי אופציונלי. אי אפשר לשנות. פורמט המפתח של המפתח הציבורי. אם לא מציינים את הפרמטר הזה, ברירת המחדל היא קבוצת מפתחות בינארית שעברה סריאליזציה בפורמט Tink wire. נחשב למידע ציבורי.

TransferCurrencyOperator

העברת הבעלות על האופרטור של המטבע שצוין לחשבון חדש. השולח חייב להיות מפעיל הפלטפורמה.

אם העסקה תצליח, המערכת תשבית את האופרטור של המטבע שצוין, ומזהה החשבון שנוצר יוחזר כאירוע בשדה TransactionCertificate של העסקה הסופית.

שדות
public_key

bytes

חובה. המפתח הציבורי של המפעיל של המטבע החדש. המפתח הציבורי הזה ישויך למפעיל המטבע ויישמר בספר החשבונות. הוא ישמש לאימות החתימה של העסקאות שמגיעות מהחשבון של מפעיל המטבע.

הפורמט של המפתח הציבורי מוגדר בשדה key_format. נחשב למידע ציבורי.

key_format

KeyFormat

זה שינוי אופציונלי. אי אפשר לשנות. פורמט המפתח של המפתח הציבורי. אם לא מציינים את הפרמטר הזה, ברירת המחדל היא קבוצת מפתחות בינארית שעברה סריאליזציה בפורמט Tink wire. נחשב למידע ציבורי.

account_comment

string

זה שינוי אופציונלי. אי אפשר לשנות. שדה תגובה אטום שלא מפוענח על ידי המערכת, אבל מאוחסן בפנקס החשבונות בחשבון. נחשב למידע ציבורי. האורך המרבי הוא 128 תווים. אפשר להשאיר את השדה ריק. אחרי שיוצרים את השדה, אי אפשר לשנות אותו.

currency_operator
(deprecated)

Entity

זה שינוי אופציונלי. הוצא משימוש: במקומו, צריך להשתמש ב-currency_operator_id. אופרטור המטבע שיוחלף. חייב להיות פעיל.

currency_operator_id

string

זה שינוי אופציונלי. המזהה של אופרטור המטבע שרוצים להחליף. חייב להיות פעיל. צריך לציין את currency_operator או את currency_operator_id. הערך מוגבל ל-60 תווים.

TransferPlatformOperator

העברת הבעלות על מפעיל הפלטפורמה לחשבון חדש. השולח חייב להיות המפעיל הנוכחי של הפלטפורמה.

אם העסקה תצליח, המפעיל הנוכחי של הפלטפורמה יושבת, ומזהה החשבון שנוצר יוחזר כאירוע ב-TransactionCertificate של העסקה הסופית.

שדות
public_key

bytes

חובה. המפתח הציבורי של מפעיל הפלטפורמה החדש. המפתח הציבורי הזה ישויך למפעיל הפלטפורמה ויאוחסן בספר החשבונות. הוא ישמש לאימות החתימה של העסקאות שמגיעות מחשבון מפעיל הפלטפורמה.

הפורמט של המפתח הציבורי מוגדר בשדה key_format. נחשב למידע ציבורי.

key_format

KeyFormat

זה שינוי אופציונלי. אי אפשר לשנות. פורמט המפתח של המפתח הציבורי. אם לא מציינים את הפרמטר הזה, ברירת המחדל היא קבוצת מפתחות בינארית שעברה סריאליזציה בפורמט Tink wire. נחשב למידע ציבורי.

account_comment

string

זה שינוי אופציונלי. אי אפשר לשנות. שדה תגובה אטום שלא מפוענח על ידי המערכת, אבל מאוחסן בפנקס החשבונות בחשבון. נחשב למידע ציבורי. האורך המרבי הוא 128 תווים. אפשר להשאיר את השדה ריק. אחרי שיוצרים את השדה, אי אפשר לשנות אותו.

UserDetails

פרטים ספציפיים לחשבון משתמש.

שדות
account_manager
(deprecated)

Entity

פלט בלבד. הוצא משימוש: במקומו, צריך להשתמש ב-account_manager_id. מנהל החשבון של המשתמש.

account_manager_id

string

פלט בלבד. המזהה של מנהל החשבון של המשתמש הזה.

token_manager
(deprecated)

Entity

פלט בלבד. הוצא משימוש: במקומו, צריך להשתמש ב-token_manager_id. הכלי לניהול אסימונים של המשתמש הזה.

token_manager_id

string

פלט בלבד. המזהה של מנהל האסימונים של המשתמש.

roles[]

Role

פלט בלבד. רשימת התפקידים שהוקצו לחשבון הזה.

account_status

AccountStatus

פלט בלבד. הסטטוס של החשבון הזה.

balance

CurrencyValue

פלט בלבד. יתרת האסימונים בחשבון המשתמש הזה.

account_fields
(deprecated)

map<string, Fields>

פלט בלבד. הוצא משימוש: במקומו, צריך להשתמש ב-contract_account_fields. שדות חשבון החוזה (מזהה החוזה -> שדות) של המשתמש הזה.

contract_account_fields

map<string, Fields>

פלט בלבד. שדות חשבון החוזה (מזהה החוזה -> שדות) של המשתמש הזה.

ערך

ערך קונקרטי מסוג מסוים.

שדות
שדה איחוד value. הערך בפועל. הערך value יכול להיות רק אחד מהבאים:
none_value

NoneValue

זה שינוי אופציונלי. מייצג ערך None.

bool_value

bool

זה שינוי אופציונלי. ערך בוליאני.

int64_value

int64

זה שינוי אופציונלי. ערך int64.

string_value

string

זה שינוי אופציונלי. ערך מחרוזת.

account_id

string

זה שינוי אופציונלי. מזהה חשבון.

dict_value

DictValue

זה שינוי אופציונלי. ערך במילון.

qualified_currency_value

QualifiedCurrencyValue

זה שינוי אופציונלי. ערך מטבע תקין.

amount_value

AmountValue

זה שינוי אופציונלי. ערך של סכום.