記號分類架構的鷹架式 TypeScript 專案

自動產生的記號方法

Blockchain App Builder 會自動產生支援權杖和權杖生命週期的方法。您可以使用這些方法來初始化記號、管理角色和帳戶，以及完成其他記號生命週期工作，而無需進行任何其他編碼。控制器方法必須要有 修飾器才能呼叫。

Blockchai App Builder automatically generates the means to support the life cycle of the scepter and the scepter. You can use these methods to initialize marks, manage roles and accounts, and complete other marking life cycles without having to perform any other encoding. The control method must have a decorator to call.

• Access Control Management - 存取控制管理
• 權杖組態管理
• 帳戶管理
• 角色管理
• 交易歷史記錄管理
• 權杖行為管理
  • Mintable 行為
  • 可轉移行為
  • 可保留行為
  • 可燒錄行為

存取控制管理的方法

此方法會將使用者新增為鏈碼的 。鏈碼的 只能呼叫此方法。

參數：

• - 目前組織中使用者的成員服務提供者 (MSP) ID。
• - 使用者的使用者名稱或電子郵件 ID。

傳回值：

• 成功時，包含新增為鏈碼 之使用者詳細資訊的訊息。

傳回值範例：

此方法會將使用者移除為鏈碼的 。鏈碼的 只能呼叫此方法。

參數：

• - 目前組織中使用者的成員服務提供者 (MSP) ID。
• - 使用者的使用者名稱或電子郵件 ID。

傳回值：

• 成功時，包含以鏈碼 移除之使用者詳細資訊的訊息。

傳回值範例：

如果函數的呼叫程式是 ，此方法會傳回布林值 ，否則會傳回 。 或 可在區塊鏈網路中的任何其他使用者呼叫此功能。其他使用者只能在自己的帳戶呼叫此方法。

參數：

• - 目前組織中使用者的成員服務提供者 (MSP) ID。
• - 使用者的使用者名稱或電子郵件 ID。

傳回值：

• 如果呼叫程式是 ，此方法會傳回 ，否則會傳回 。

此方法會傳回屬於鏈碼 的所有使用者清單。此方法只能由鏈碼的 或任何 呼叫。

參數：

• 無

傳回值：

• 成功時，JSON 格式的 陣列包含 和 物件。

傳回值範例：

此方法會將使用者新增為組織的 。此方法只能由鏈碼的 或指定組織的 呼叫。

參數：

• - 目前組織中使用者的成員服務提供者 (MSP) ID。
• - 使用者的使用者名稱或電子郵件 ID。

傳回值：

• 成功時，包含新增為組織 之使用者詳細資訊的訊息。

傳回值範例：

此方法會將使用者移除為組織的 。此方法只能由鏈碼的 或由指定組織的 呼叫。

參數：

• - 目前組織中使用者的成員服務提供者 (MSP) ID。
• - 使用者的使用者名稱或電子郵件 ID。

傳回值：

• 成功時，包含作為組織 移除之使用者詳細資訊的訊息。

傳回值範例：

此方法會傳回組織 的所有使用者清單。此方法只能由鏈碼的 或任何組織的 呼叫。

參數：

• 無

傳回值：

• 成功時，JSON 格式的陣列包含 和 物件。

傳回值範例：

記號組態管理的方法

部署或升級鏈碼時會呼叫此方法。每個 都是由必要 參數中的 和 資訊所識別。 是執行處理擁有者或登入執行處理之使用者的使用者名稱或電子郵件 ID。 是目前網路組織中使用者的成員服務提供者 (MSP) ID。

任何 使用者都可以透過呼叫 和 方法來新增和移除其他 使用者。

參數：

• - 指定記號管理員清單的 資訊陣列。 陣列是必要參數。

參數範例：Mac OSX 與 Linux CLI：

參數範例：Microsoft Windows CLI：

參數範例：Oracle Blockchain Platform 主控台：

此方法會建立記號並初始化記號特性。資產及其特性會儲存在狀態資料庫中。此方法只能由鏈碼的 呼叫。

參數：

• - 將記號資產當作此方法的參數傳送。記號資產的特性會在模型檔案中說明。

傳回值：

• 成功時，所建立權杖資產的 JSON 表示法。

傳回值範例：

此方法會更新記號特性。建立權杖資產之後，只能更新 特性和自訂特性。鏈碼的 只能呼叫此方法。

參數：

• - 將記號資產當作此方法的參數傳送。記號資產的特性會在模型檔案中說明。

傳回值：

• 成功時，憑證資產的更新 JSON 表示法。

傳回值範例：

此方法會傳回為小數記號設定的小數位數。如果未指定記號的 行為，則預設值為 0。此方法只能由鏈碼的 或 呼叫。

參數：

• - 記號的 ID。

傳回值：

• 成功時，會顯示記號小數位數的 JSON 字串。

傳回值範例：

如果權杖物件存在於狀態資料庫中，這個方法就會傳回該物件。此方法只能由鏈碼的 或 呼叫。

參數：

• - 記號的 ID。

傳回值：

• 成功時，代表權杖資產的 JSON 物件。

傳回值範例：

此方法會傳回指定記號 ID 的記號歷史記錄。任何使用者都可以呼叫此方法。

參數：

• - 記號的 ID。

傳回值：

• 成功時，代表權杖歷史記錄的 JSON 物件。

傳回值範例：

此方法會傳回所有儲存在狀態資料庫中的記號。此方法只能由鏈碼的 或 呼叫。此方法使用 Berkeley 資料庫 SQL 豐富查詢，且只能在連線至遠端 Oracle Blockchain Platform 網路時呼叫。

參數：

• 無

傳回值：

• 成功時，代表所有權杖資產的 JSON 物件。

此方法會傳回具有指定名稱的所有記號物件。此方法只能由鏈碼的 或 呼叫。此方法使用 Berkeley 資料庫 SQL 豐富查詢，且只能在連線至遠端 Oracle Blockchain Platform 網路時呼叫。

參數：

• - 要擷取的記號名稱。此名稱對應至規格檔案中的 特性。值是記號的類別名稱。

傳回值：

• 成功時，符合名稱之所有權杖資產的 JSON 物件。

帳戶管理方法

此方法會為指定的使用者和記號建立一個帳戶。必須為任何時候會有權杖的任何使用者建立帳戶。帳戶會追蹤餘額、保留餘額及交易歷史記錄。帳戶 ID 是一組文數字字元，前面加上 ，後面接著執行處理擁有者的使用者名稱或電子郵件 ID () 雜湊，或登入執行處理的使用者，即目前網路組織中使用者的成員服務提供者 ID ()。此方法只能由鏈碼的 或由指定組織的 呼叫。

參數：

• - 目前組織中使用者的成員服務提供者 (MSP) ID。
• - 使用者的使用者名稱或電子郵件 ID。
• - 記號的類型，必須是 。

傳回值：

• 成功時，所建立帳戶的 JSON 物件。 參數定義於帳戶物件中供內部使用。

傳回值範例：

此方法會將有趣的記號與帳戶建立關聯。此方法只能由鏈碼的 或相關組織的 呼叫。

參數：

• - 帳戶的 ID。
• - 記號的 ID。

傳回值：

• 成功時，更新帳戶的 JSON 物件。 參數定義於帳戶物件中供內部使用。

傳回值範例：

此方法會傳回指定之使用者和記號的帳戶詳細資訊。此方法只能由鏈碼的 、指定組織的 或帳戶的 呼叫。

參數：

• - 記號的 ID。
• - 目前組織中使用者的成員服務提供者 (MSP) ID。
• - 使用者的使用者名稱或電子郵件 ID。

傳回值：

• 成功時，包含下列特性的 JSON 帳戶物件：
• - 使用者帳戶的 ID。
• - 使用者的使用者名稱或電子郵件 ID。
• - 目前組織中使用者的成員服務提供者 (MSP) ID。
• - 記號的 ID。
• - 記號的名稱。
• - 帳戶的目前餘額。
• - 帳戶的目前保留餘額。
• - 內部使用的帳戶物件參數。
• - 使用者帳戶的目前狀態。

傳回值範例：

此方法會傳回指定之使用者和記號的帳戶歷史記錄詳細資訊。此方法只能由鏈碼的 或帳戶的 呼叫。

參數：

• - 記號的 ID。
• - 目前組織中使用者的成員服務提供者 (MSP) ID。
• - 使用者的使用者名稱或電子郵件 ID。

傳回值：

• 成功時，包含下列特性的 JSON 帳戶物件陣列：
• - 分類帳所傳回之交易的交易 ID。
• - 異動的時間。
• - 帳戶物件的 JSON 字串。

傳回值範例：

此方法會傳回指定帳戶與變數替代字的目前保留餘額。此方法只能由鏈碼的 、指定組織的 或帳戶的 呼叫。

參數：

• - 記號的 ID。
• - 目前組織中使用者的成員服務提供者 (MSP) ID。
• - 使用者的使用者名稱或電子郵件 ID。

傳回值：

• 成功時，代表目前保留餘額的 JSON。

傳回值範例：

此方法會傳回所有帳戶的清單。鏈碼的 只能呼叫此方法。此方法使用 Berkeley 資料庫 SQL 豐富查詢，且只能在連線至遠端 Oracle Blockchain Platform 網路時呼叫。

參數：

• 無

傳回值：

• 成功時，所有帳戶的 JSON 陣列。

此方法會傳回指定帳戶的使用者詳細資訊 ( 和 )。鏈碼的任何使用者都可以呼叫此方法。

參數：

• - 帳戶的 ID。

傳回值：

• 成功時，使用者詳細資料 (、 及 ) 的 JSON 物件。

傳回值範例：

此方法會傳回指定帳戶和權杖的目前餘額。此方法只能由鏈碼的 、指定組織的 或帳戶的 呼叫。

參數：

• - 記號的 ID。
• - 目前組織中使用者的成員服務提供者 (MSP) ID。
• - 使用者的使用者名稱或電子郵件 ID。

傳回值：

• 成功時，代表目前帳戶餘額的 JSON。

傳回值範例：

此方法會傳回屬於指定組織的所有權杖帳戶清單。此方法只能由鏈碼的 或由指定組織的 呼叫。

參數：

• - 組織的成員服務提供者 (MSP) ID。

傳回值：

• 成功時，指定組織的所有帳戶清單。

傳回值範例：

角色管理方法

這個方法會將角色新增至指定的使用者和記號。此方法只能由鏈碼的 或由同時具備指定角色之指定組織的 呼叫。

參數：

• - 記號的 ID。
• - 要新增至指定使用者的角色名稱。 和 行為對應至規格檔案的 和 特性。同樣地， 角色會對應至規格檔案的 特性。
• - 目前組織中使用者的成員服務提供者 (MSP) ID。
• - 使用者的使用者名稱或電子郵件 ID。

傳回值：

• 成功時，會出現含有帳戶詳細資訊的訊息。

傳回值範例：

此方法會從指定的使用者和記號移除角色。此方法只能由鏈碼的 或由同時具備指定角色之指定組織的 呼叫。

參數：

• - 記號的 ID。
• - 要從指定使用者移除的角色名稱。 和 行為對應至規格檔案的 和 特性。同樣地， 角色會對應至規格檔案的 特性。
• - 目前組織中使用者的成員服務提供者 (MSP) ID。
• - 使用者的使用者名稱或電子郵件 ID。

傳回值：

• 成功時，會出現含有帳戶詳細資訊的訊息。

傳回值範例：

此方法會傳回指定角色和權杖的所有帳戶 ID 清單。鏈碼的 只能呼叫此方法。

參數：

• - 記號的 ID。
• - 要搜尋的角色名稱。

傳回值：

• 成功時，帳戶 ID 的 JSON 陣列。

傳回值範例：

此方法會傳回指定之組織 ID 與使用者 ID 的所有帳戶 ID 清單。此方法只能由鏈碼的 、指定組織的 或參數中指定的 呼叫。

參數：

• - 目前組織中使用者的成員服務提供者 (MSP) ID。
• - 使用者的使用者名稱或電子郵件 ID。

傳回值：

• 成功時，帳戶 ID 的 JSON 陣列。

傳回值範例：

此方法會針對指定的角色和記號，傳回所有使用者的清單。鏈碼的 只能呼叫此方法。

參數：

• - 記號的 ID。
• - 要搜尋的角色名稱。

傳回值：

• 成功時，使用者物件的 JSON 陣列 (、 和 )。

傳回值範例：

此方法會傳回布林值，指示使用者和記號是否具有指定的角色。此方法只能由鏈碼的 、帳戶的 或指定組織的 呼叫。

參數：

• - 記號的 ID。
• - 目前組織中使用者的成員服務提供者 (MSP) ID。
• - 使用者的使用者名稱或電子郵件 ID。
• - 要搜尋的角色名稱。

傳回值：

• 成功時，布林結果的 JSON 字串。

傳回值範例：

此方法會傳回在指定組織中具有指定角色之所有帳戶的相關資訊。此方法只能由鏈碼的 或由指定組織的 呼叫。

參數：

• - 記號的 ID。
• - 要檢查之角色的名稱。
• - 組織的成員服務提供者 (MSP) ID。

傳回值：

• 成功時，指定組織中具有指定角色的所有帳戶清單。

傳回值範例：

此方法會傳回在指定組織中具有指定角色之所有使用者的相關資訊。此方法只能由鏈碼的 或由指定組織的 呼叫。

參數：

• - 記號的 ID。
• - 要檢查之角色的名稱。
• - 組織的成員服務提供者 (MSP) ID。

傳回值：

• 成功時，指定組織中具有指定角色的所有使用者清單。

傳回值範例：

交易歷史記錄管理的方法

此方法會傳回指定使用者和權杖的帳戶交易歷史記錄明細陣列。此方法只能由鏈碼的 、指定組織的 或帳戶的 呼叫。

參數：

• - 記號的 ID。
• - 目前組織中使用者的成員服務提供者 (MSP) ID。
• - 使用者的使用者名稱或電子郵件 ID。

傳回值：

• 成功時，包含下列特性的 JSON 帳戶交易物件陣列：
• - 交易的 ID。
• - 進行交易的帳戶。
• - 交易類型。
• - 交易的金額。
• - 異動的時間。
• - 交易時的帳戶餘額。
• - 交易時的保留餘額。
• - 記號的 ID。
• - 方法所傳回的唯一 ID。

傳回值範例：

此方法會傳回指定使用者和權杖的帳戶交易歷史記錄明細陣列。此方法只能由鏈碼的 、指定組織的 或帳戶的 呼叫。連線至遠端 Oracle Blockchain Platform 網路時才能呼叫此方法。

參數：

• - 記號的 ID。
• - 目前組織中使用者的成員服務提供者 (MSP) ID。
• - 使用者的使用者名稱或電子郵件 ID。
• - 選擇性參數。如果空白，則會傳回所有記錄。 特性決定要傳回的記錄數目。如果 為 0，則預設頁面大小為 20。 特性決定要傳回之記錄的開始索引。如需詳細資訊，請參閱 Hyperledger Fabric 文件。必須以 RFC-3339 格式指定 和 特性。

範例：

此方法會傳回指定使用者和權杖的帳戶交易歷史記錄明細陣列。此方法只能由鏈碼的 或帳戶的 呼叫。

參數：

• - 大量傳輸交易的 ID。

傳回值：

• 指定之大量移轉交易 ID 的 JSON 格式帳戶子交易物件陣列。

範例：

此方式會傳回指定交易的帳戶子交易歷史記錄明細陣列。

參數：

• - 交易的 ID。
• - 選擇性參數。如果空白，則會傳回所有記錄。 特性決定要傳回的記錄數目。如果 為 0，則預設頁面大小為 20。 特性決定要傳回之記錄的開始索引。如需詳細資訊，請參閱 Hyperledger Fabric 文件。必須以 RFC-3339 格式指定 和 特性。

傳回值：

• 指定之大量移轉交易 ID 的 JSON 格式帳戶子交易物件陣列。

範例：

此方法會傳回 資產的歷史記錄。

參數：

• - 交易資產的 ID。

傳回值：

• 成功時，交易歷史記錄的 JSON 陣列。

傳回值範例：

此方法會從狀態資料庫中刪除較舊的交易。

參數：

• - 表示何時刪除交易的時戳。將會刪除早於指定時間的交易資產。

傳回值範例：

記號行為管理方法 - 可調整行為

這個方法會提示記號，然後由方法的呼叫程式所擁有。呼叫者必須具有帳戶與較小者角色。可提示的記號數目受規格檔案中 行為的 特性限制。如果未指定 特性，則可提示不限數目的記號。數量必須在規格檔案中 行為的 參數所指定的小數值內。只有具備較小角色的帳戶 才能呼叫此方法。

參數：

• - 記號的 ID。
• - 要進行 mint 的記號數目。

傳回值：

• 成功時，會出現含有帳戶詳細資訊的訊息。

傳回值範例：

此方法會傳回指定記號的 Minted 記號總數。此方法只能由鏈碼的 或任何 呼叫。

參數：

• - 記號的 ID。

傳回值：

• 成功時，表示記號總數的 JSON 字串。

傳回值範例：

此方法會傳回系統中特定記號可用的記號總數。淨記號總計是記號燒錄後剩餘的記號量。在方程式形式中：淨記號=提示的記號總計 - 消耗的記號總計。如果沒有燒錄記號，則淨記號的數目等於提示的記號總數。此方法只能由鏈碼的 或任何 呼叫。

參數：

• - 記號的 ID。

傳回值：

• 成功時，表示記號淨數的 JSON 字串。

傳回值範例：

記號行為管理方法 - 可傳輸行為

此方法會將記號從呼叫程式傳輸至指定的帳戶。方法的呼叫程式必須要有一個帳戶。數量必須在規格檔案中 行為的 參數所指定的小數值內。此方法只能由帳戶的 呼叫。

參數：

• - 記號的 ID。
• - 目前組織中接收者 (受款人) 的成員服務提供者 (MSP) ID。
• - 接收者的使用者名稱或電子郵件 ID。
• - 要傳輸的記號數目。

傳回值：

• 成功時，包含付款人與受款人帳戶明細的訊息。

傳回值範例：

此方法是用來執行從呼叫程式帳戶到 物件中指定帳戶的大量記號傳輸。此方法之規格 file.The 呼叫程式中 行為的 參數所指定的數量必須在已建立帳戶的小數值內。此方法只能由帳戶的 呼叫。

參數：

• - 記號的 ID。
• - 指定接收者和數量的 JSON 物件陣列。
  • - 目前組織中接收者的成員服務提供者 (MSP) ID。
  • - 接收者的使用者名稱或電子郵件 ID。
  • - 要傳輸的記號數目。

傳回值：

• 表示成功的訊息。

傳回值範例：

記號行為管理方法 - 可保留行為

此方法會代表記號擁有者的 帳戶建立保留。已指定公證人帳戶，其負責完成或解除保留。建立保留時，付款人的指定變數替代字餘額會設為保留。保留餘額必須等到完成或解除後才能移轉。這個方法的呼叫程式必須已經建立帳戶。此方法只能由帳戶的 呼叫。

參數：

• - 記號的 ID。
• - 識別保留作業的唯一 ID。通常這個 ID 會由用戶端應用程式傳送。
• - 目前組織中接收者的成員服務提供者 (MSP) ID。
• - 接收者的使用者名稱或電子郵件 ID。
• - 目前組織中公證人的會員服務提供者 (MSP) ID。
• - 公證人的使用者名稱或電子郵件 ID。
• - 要保留的記號數目。
• - 保留到期的時間。為永久保留指定 0 。否則，請採用 RFC-3339 格式。例如，2021-06-02T12：46:06Z 。

傳回值：

• 成功時，包含來電者帳戶與保留明細的訊息。

傳回值範例：

這個方法會完成記號的保留。權杖擁有者之前持有的權杖數量會轉移給接收者。如果 值小於實際保留值，則記號的原始擁有者可再使用剩餘金額。只有具有指定作業 ID 之 角色的 ID 才能呼叫此方法。保留只能由公證人完成。

參數：

• - 記號的 ID。
• - 識別保留作業的唯一 ID。通常這個 ID 會由用戶端應用程式傳送。
• - 要傳輸的保留記號數目。

傳回值：

• 成功時，包含來電者帳戶 ID 與交易數量的訊息。

傳回值範例：

此方法會解除記號的保留。移轉未完成，所有保留的變數替代字會再次可供原始擁有者使用。 ID 可在指定的時間限制內以 角色呼叫此方法，或在指定的時間限制之後由付款人、受款人或公證人呼叫。

參數：

• - 記號的 ID。
• - 識別保留作業的唯一 ID。通常這個 ID 會由用戶端應用程式傳送。

傳回值：

• 成功時，表示已解除保留的訊息。

傳回值範例：

這個方法會傳回指定帳戶之所有持有 ID 的清單。此方法可由鏈碼的 、指定組織的 或帳戶的 呼叫。

參數：

• - 記號的 ID。
• - 目前組織中使用者的成員服務提供者 (MSP) ID。
• - 使用者的使用者名稱或電子郵件 ID。

傳回值：

• 成功時，JSON 保留 ID 清單。

傳回值範例：

此方法會傳回指定作業 ID 和記號的保留交易詳細資訊。任何人都可以呼叫這個方法。

參數：

• - 記號的 ID。
• - 識別保留作業的唯一 ID。通常這個 ID 會由用戶端應用程式傳送。

傳回值：

• 成功時，包含下列特性的 JSON 保留物件：
• - 交易的持有 ID。
• - 識別保留作業的唯一 ID。通常這個 ID 會由用戶端應用程式傳送。
• - 保留權杖目前擁有者的帳戶 ID。
• - 接收者的帳戶 ID。
• - 公證人的帳戶 ID。
• - 已儲存記號的 ID。
• - 保留 ID 的記號數量。
• - 保留到期的持續時間。

傳回值範例：

此方法會傳回指定作業 ID 與變數替代字的保留餘額。任何人都可以呼叫這個方法。

參數：

• - 記號的 ID。
• - 識別保留作業的唯一 ID。通常這個 ID 會由用戶端應用程式傳送。

傳回值：

• 成功時，表示保留餘額的 JSON 字串。

傳回值範例：

記號行為管理方法 - 可燒錄行為

此方法會停用或燒錄來自交易呼叫程式帳戶的記號。這個方法的呼叫程式必須具有一個帳戶以及 burner 角色。數量必須在規格檔案中 行為的 參數所指定的小數值內。帳戶的 可以使用工作人員角色呼叫此方法。

參數：

• - 記號的 ID。
• - 要燒錄的記號數目。

傳回值：

• 成功時，會出現一則成功訊息，內含已燒錄記號的數量與帳戶 ID。

傳回值範例：