Gestaffeltes TypeScript-Projekt für Token Taxonomy Framework
Blockchain App Builder übernimmt die Eingabe aus Ihrer Tokenspezifikationsdatei und generiert ein voll funktionsfähiges gerüstetes Chaincode-Projekt.
Das Projekt generiert automatisch Tokenlebenszyklusklassen und -funktionen, einschließlich CRUD- und Nicht-CRUD-Methoden. Validierung von Argumenten, Marshalling/Unmarshalling und transparente Persistenzfähigkeit werden automatisch unterstützt.
Informationen zum gerüsteten Projekt und zu Methoden, die nicht direkt mit Token zusammenhängen, finden Sie unter Scaffolded TypeScript Chaincode Project.
Referenz:
Modell
Jede tokenisierte Modellklasse erweitert die Klasse Token, die wiederum die Klasse OchainModel erweitert. Die Klasse Token wird aus ../lib/token importiert. Transparent Persistence Capability (transparente Persistenzfunktion) oder vereinfachtes ORM wird in der Klasse OchainModel erfasst.
import * as yup from 'yup';
import { Id, Mandatory, Validate, ReadOnly } from '../lib/decorators';
import { Token } from '../lib/token';
@Id('token_id')
export class Digicur extends Token<Digicur> {
public readonly assetType = 'otoken';
@Mandatory()
@Validate(yup.string().required().matches(/^[A-Za-z0-9][A-Za-z0-9_-]*$/).max(16))
public token_id: string;
@ReadOnly('digicur')
public token_name: string;
@Validate(yup.string().trim().max(256))
public token_desc: string;
@ReadOnly('fungible')
public token_type: string;
@ReadOnly(["divisible","mintable","transferable","burnable","holdable","roles"])
public behaviors: string[];
@ReadOnly({minter_role_name: "minter", burner_role_name: "burner", notary_role_name: "notary"})
public roles: object;
@ReadOnly({max_mint_quantity: 20000})
public mintable: object;
@ReadOnly({decimal: 1})
public divisible: object;
@Validate(yup.number())
public token_to_currency_ratio: number;
@Validate(yup.string())
public currency_representation: string;
}Controller
Die Hauptcontrollerklasse erweitert die Klasse OchainController. Es gibt nur einen Hauptcontroller.
export class DigiCurrCCController extends OchainController{Sie können eine beliebige Anzahl von Klassen, Funktionen oder Dateien erstellen, aber nur die Methoden, die in der Hauptcontrollerklasse definiert sind, können aufgerufen werden. Die anderen Methoden sind versteckt.
Mit den Token-SDK-Methoden können Sie benutzerdefinierte Methoden für Ihre Geschäftsanwendung schreiben.
Automatisch generierte Token-Methoden
Blockchain App Builder generiert automatisch Methoden zur Unterstützung von Token und Tokenlebenszyklen. Mit diesen Methoden können Sie Token initialisieren, Rollen und Konten verwalten und andere Tokenlebenszyklusaufgaben ohne zusätzliche Codierung ausführen. Controller-Methoden müssen über einen @Validator(...params)-Dekorator verfügen, damit sie aufgerufen werden können.
- Access Control Management
- Tokenkonfigurationsverwaltung
- Accountverwaltung
- Rollenverwaltung
- Verwaltung der Transaktionshistorie
- Tokenverhaltensverwaltung
Methoden für Access Control Management
-
addTokenAdmin - Mit dieser Methode wird ein Benutzer als
Token Admindes Chaincodes hinzugefügt. Diese Methode kann nur von einemToken Admindes Chaincodes aufgerufen werden. -
removeTokenAdmin - Mit dieser Methode wird ein Benutzer als
Token Admindes Chaincodes entfernt. Diese Methode kann nur von einemToken Admindes Chaincodes aufgerufen werden. -
isTokenAdmin - Diese Methode gibt den booleschen Wert
truezurück, wenn der Aufrufer der Funktion einToken Administ. Andernfalls wirdfalsezurückgegeben. EineToken AdminoderOrg Adminkann diese Funktion für jeden anderen Benutzer im Blockchain-Netzwerk aufrufen. Andere Benutzer können diese Methode nur für ihre eigenen Konten aufrufen. -
getAllTokenAdmins - Diese Methode gibt eine Liste aller Benutzer zurück, die ein
Token Admindes Chaincodes sind. Diese Methode kann nur vomToken Adminoder einem beliebigenOrg Admindes Chaincodes aufgerufen werden. -
addOrgAdmin - Mit dieser Methode wird ein Benutzer als
Org Adminder Organisation hinzugefügt. Diese Methode kann nur von einemToken Admindes Chaincodes oder einemOrg Adminder angegebenen Organisation aufgerufen werden. -
removeOrgAdmin - Mit dieser Methode wird ein Benutzer als
Org Adminder Organisation entfernt. Diese Methode kann nur von einemToken Admindes Chaincodes oder von einemOrg Adminder angegebenen Organisation aufgerufen werden. -
getOrgAdmins - Diese Methode gibt eine Liste aller Benutzer zurück, die eine
Org Admineiner Organisation sind. Diese Methode kann nur von einemToken Admindes Chaincodes oder von einemOrg Admineiner beliebigen Organisation aufgerufen werden.
Methoden für die Verwaltung der Tokenkonfiguration
-
init - Diese Methode wird aufgerufen, wenn der Chaincode bereitgestellt oder aktualisiert wird. Jede
Token Adminwird durch die Informationenuser_idundorg_idim obligatorischen ParameteradminListidentifiziert.user_idist der Benutzername oder die E-Mail-ID des Instanzeigentümers oder des Benutzers, der bei der Instanz angemeldet ist.org_idist die Mitgliedschaftsserviceprovider-(MSP-)ID des Benutzers in der aktuellen Netzwerkorganisation. -
initialize<Token Name>Token - Diese Methode erstellt ein Token und initialisiert die Tokeneigenschaften. Das Asset und seine Eigenschaften werden in der Statusdatenbank gespeichert. Diese Methode kann nur von einem
Token Admindes Chaincodes aufgerufen werden. -
update<Token Name>Token - Diese Methode aktualisiert Tokeneigenschaften. Nachdem ein Tokenasset erstellt wurde, können nur die Eigenschaft
token_descund benutzerdefinierte Eigenschaften aktualisiert werden. Diese Methode kann nur von einemToken Admindes Chaincodes aufgerufen werden. -
getTokenDecimals - Diese Methode gibt die Anzahl der Dezimalstellen zurück, die für ein partielles Token konfiguriert wurden. Wenn das
divisible-Verhalten für das Token nicht angegeben wurde, ist der Standardwert 0. Diese Methode kann nur von einemToken AdminoderOrg Admindes Chaincodes aufgerufen werden. -
getTokenById - Diese Methode gibt ein Tokenobjekt zurück, wenn es in der Statusdatenbank vorhanden ist. Diese Methode kann nur von einem
Token Adminoder einemOrg Admindes Chaincodes aufgerufen werden. -
getTokenHistory - Diese Methode gibt die Tokenhistorie für eine angegebene Token-ID zurück. Jeder Benutzer kann diese Methode aufrufen.
-
getAllTokens - Diese Methode gibt alle Token zurück, die in der Statusdatenbank gespeichert sind. Diese Methode kann nur von einem
Token Adminoder einemOrg Admindes Chaincodes aufgerufen werden. Diese Methode verwendet SQL-Rich-Abfragen von Berkeley DB und kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Netzwerk von Oracle Blockchain Platform besteht. -
getTokensByName - Diese Methode gibt alle Tokenobjekte mit einem angegebenen Namen zurück. Diese Methode kann nur von einem
Token AdminoderOrg Admindes Chaincodes aufgerufen werden. Diese Methode verwendet SQL-Rich-Abfragen von Berkeley DB und kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Netzwerk von Oracle Blockchain Platform besteht.
Methoden für die Accountverwaltung
-
createAccount - Diese Methode erstellt einen Account für einen angegebenen Benutzer und ein bestimmtes Token. Ein Konto muss für jeden Benutzer erstellt werden, der zu einem beliebigen Zeitpunkt Token hat. Konten verfolgen Salden, gesperrte Salden und die Transaktionshistorie. Eine Account-ID ist ein alphanumerisches Zeichenset mit dem Präfix
oaccount~<token asset name>~, gefolgt von einem Hash des Benutzernamens oder der E-Mail-ID (user_id) des Instanzeigentümers oder des Benutzers, der bei der Instanz angemeldet ist, der Mitgliedschaftsserviceprovider-ID (org_id) des Benutzers in der aktuellen Netzwerkorganisation. Diese Methode kann nur von einemToken Admindes Chaincodes oder von einemOrg Adminder angegebenen Organisation aufgerufen werden. -
associateTokenToAccount - Diese Methode verknüpft ein fungibles Token mit einem Konto. Diese Methode kann nur von einem
Token Admindes Chaincodes oder von einemOrg Adminder relevanten Organisation aufgerufen werden. -
getAccount - Diese Methode gibt Kontodetails für einen angegebenen Benutzer und ein bestimmtes Token zurück. Diese Methode kann nur von einem
Token Admindes Chaincodes, einemOrg Adminder angegebenen Organisation oder demAccountOwnerdes Accounts aufgerufen werden. -
getAccountHistory - Diese Methode gibt Accounthistoriendetails für einen angegebenen Benutzer und ein bestimmtes Token zurück. Diese Methode kann nur von einem
Token Admindes Chaincodes oder demAccountOwnerdes Accounts aufgerufen werden. -
getAccountOnHoldBalance - Diese Methode gibt den aktuellen gesperrten Saldo für ein angegebenes Konto und Token zurück. Diese Methode kann nur von einem
Token Admindes Chaincodes, einemOrg Adminder angegebenen Organisation oder demAccountOwnerdes Accounts aufgerufen werden. -
getAllAccounts - Diese Methode gibt eine Liste aller Konten zurück. Diese Methode kann nur von einem
Token Admindes Chaincodes aufgerufen werden. Diese Methode verwendet SQL-Rich-Abfragen von Berkeley DB und kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Netzwerk von Oracle Blockchain Platform besteht. -
getUserByAccountId - Diese Methode gibt Benutzerdetails (
org_idunduser_id) für einen angegebenen Account zurück. Diese Methode kann von jedem Benutzer des Chaincodes aufgerufen werden. -
getAccountBalance - Diese Methode gibt den aktuellen Saldo für ein angegebenes Konto und Token zurück. Diese Methode kann nur von einem
Token Admindes Chaincodes, einemOrg Adminder angegebenen Organisation oder demAccountOwnerdes Accounts aufgerufen werden. -
getAllOrgAccounts - Diese Methode gibt eine Liste aller Tokenaccounts zurück, die zu einer angegebenen Organisation gehören. Diese Methode kann nur von einem
Token Admindes Chaincodes oder von einemOrg Adminder angegebenen Organisation aufgerufen werden.
Methoden für die Rollenverwaltung
-
addRole - Mit dieser Methode wird eine Rolle zu einem angegebenen Benutzer und Token hinzugefügt. Diese Methode kann nur von einer
Token Admindes Chaincodes oder von einerOrg Adminder angegebenen Organisation aufgerufen werden, die auch die angegebene Rolle innehat. -
removeRole - Diese Methode entfernt eine Rolle aus einem angegebenen Benutzer und Token. Diese Methode kann nur von einer
Token Admindes Chaincodes oder von einerOrg Adminder angegebenen Organisation aufgerufen werden, die auch die angegebene Rolle innehat. -
getAccountsByRole - Diese Methode gibt eine Liste aller Konto-IDs für eine angegebene Rolle und ein bestimmtes Token zurück. Diese Methode kann nur von einem
Token Admindes Chaincodes aufgerufen werden. -
getAccountsByUser - Diese Methode gibt eine Liste aller Konto-IDs für eine bestimmte Organisationskennung und Benutzerkennung zurück. Diese Methode kann nur von der
Token Admindes Chaincodes, von derOrg Adminder angegebenen Organisation oder von der in den Parametern angegebenenAccount Owneraufgerufen werden. -
getUsersByRole - Diese Methode gibt eine Liste aller Benutzer für eine angegebene Rolle und ein bestimmtes Token zurück. Diese Methode kann nur von einem
Token Admindes Chaincodes aufgerufen werden. -
isInRole - Diese Methode gibt einen booleschen Wert zurück, um anzugeben, ob ein Benutzer und ein Token über eine angegebene Rolle verfügen. Diese Methode kann nur von einem
Token Admindes Chaincodes, demAccountOwnerdes Accounts oder einemOrg Adminder angegebenen Organisation aufgerufen werden. -
getOrgAccountsByRole - Diese Methode gibt Informationen zu allen Firmen zurück, die eine bestimmte Rolle in einer bestimmten Organisation haben. Diese Methode kann nur von einem
Token Admindes Chaincodes oder von einemOrg Adminder angegebenen Organisation aufgerufen werden. -
getOrgUsersByRole - Diese Methode gibt Informationen zu allen Benutzern zurück, die eine bestimmte Rolle in einer bestimmten Organisation haben. Diese Methode kann nur von einem
Token Admindes Chaincodes oder von einemOrg Adminder angegebenen Organisation aufgerufen werden.
Methoden für das Transaktionshistorienmanagement
-
getAccountTransactionHistory - Diese Methode gibt ein Array von Kontotransaktionshistoriendetails für einen angegebenen Benutzer und ein bestimmtes Token zurück. Diese Methode kann nur von der
Token Admindes Chaincodes, einerOrg Adminder angegebenen Organisation oder derAccountOwnerdes Accounts aufgerufen werden. -
getAccountTransactionHistoryWithFilters - Diese Methode gibt ein Array von Kontotransaktionshistoriendetails für einen angegebenen Benutzer und ein bestimmtes Token zurück. Diese Methode kann nur von der
Token Admindes Chaincodes, einerOrg Adminder angegebenen Organisation oder derAccountOwnerdes Accounts aufgerufen werden. Diese Methode kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Oracle Blockchain Platform-Netzwerk besteht. -
getSubTransactionById - Diese Methode gibt ein Array von Kontotransaktionshistoriendetails für einen angegebenen Benutzer und ein bestimmtes Token zurück. Diese Methode kann nur vom
Token Admindes Chaincodes oder vomAccountOwnerdes Accounts aufgerufen werden. -
getSubTransactionsByIdWithFilters - Diese Methode gibt ein Array von Kontotransaktionshistoriendetails für eine angegebene Transaktion zurück.
-
getTransactionById - Diese Methode gibt die Historie eines
Transaction-Assets zurück. -
deleteHistoricalTransactions - Diese Methode löscht ältere Transaktionen aus der Statusdatenbank.
Methoden für das Tokenverhaltensmanagement - Mintable Behavior
-
issueTokens - Diese Methode bildet Token ab, die dann dem Aufrufer der Methode gehören. Der Anrufer muss über einen Account und die Minter-Rolle verfügen. Die Anzahl der Token, die geprägt werden können, wird durch die Eigenschaft
max_mint_quantitydes Verhaltensmintablein der Spezifikationsdatei begrenzt. Wenn die Eigenschaftmax_mint_quantitynicht angegeben ist, kann eine unbegrenzte Anzahl von Token geprägt werden. Die Menge muss innerhalb der Dezimalwerte liegen, die durch den Parameterdecimaldes Verhaltensdivisiblein der Spezifikationsdatei angegeben werden. Diese Methode kann nur von derAccountOwnerdes Accounts mit der Minter-Rolle aufgerufen werden. -
getTotalMintedTokens - Diese Methode gibt die Gesamtanzahl der geminteten Token für ein angegebenes Token zurück. Diese Methode kann nur von einem
Token Adminoder einem beliebigenOrg Admindes Chaincodes aufgerufen werden. -
getNetTokens - Diese Methode gibt die Gesamtanzahl der im System verfügbaren Token für ein angegebenes Token zurück. Die Nettotokensumme ist die Anzahl der verbleibenden Token, nachdem Token verbrannt wurden. In Gleichungsform: net tokens = insgesamt geprägte tokens - insgesamt gebrannte tokens. Wenn keine Token gebrannt werden, entspricht die Anzahl der Net Token der Gesamtanzahl der geprägten Token. Diese Methode kann nur von einem
Token Adminoder einem beliebigenOrg Admindes Chaincodes aufgerufen werden.
Methoden für das Tokenverhaltensmanagement - Übertragbares Verhalten
-
transferTokens - Diese Methode überträgt Token vom Aufrufer auf ein angegebenes Konto. Der Aufrufer der Methode muss einen Account haben. Die Menge muss innerhalb der Dezimalwerte liegen, die durch den Parameter
decimaldes Verhaltensdivisiblein der Spezifikationsdatei angegeben werden. Diese Methode kann nur von derAccountOwnerdes Accounts aufgerufen werden. -
bulkTransferTokens - Diese Methode wird verwendet, um eine Massenübertragung von Token aus dem Aufruferkonto auf die Konten durchzuführen, die im Objekt
flowangegeben sind. Die Mengen müssen innerhalb der Dezimalwerte liegen, die durch den Parameterdecimaldes Verhaltensdivisibleim Aufrufer der Spezifikation file.The dieser Methode angegeben werden, und ein Account muss bereits erstellt sein. Diese Methode kann nur von derAccountOwnerdes Accounts aufgerufen werden.
Methoden für das Tokenverhaltensmanagement - Zurückstellbares Verhalten
-
holdTokens - Diese Methode erstellt eine Sperre im Namen des Eigentümers der Token mit dem Konto
to_account_id. Es wird ein Notarkonto angegeben, das für den Abschluss oder die Freigabe der Sperre verantwortlich ist. Wenn die Sperre erstellt wird, wird der angegebene Tokensaldo des Zahlers gesperrt. Ein gesperrter Saldo kann erst übertragen werden, wenn die Sperre abgeschlossen oder freigegeben wurde. Für den Aufrufer dieser Methode muss bereits ein Account erstellt sein. Diese Methode kann nur von derAccountOwnerdes Accounts aufgerufen werden. -
executeHoldTokens - Diese Methode schließt eine Sperre eines Tokens ab. Eine Menge von Token, die zuvor von einem Token-Eigentümer gehalten wurden, wird an einen Empfänger übertragen. Wenn der Wert
quantitykleiner als der tatsächliche Sperrwert ist, ist der Restbetrag wieder für den ursprünglichen Eigentümer der Token verfügbar. Diese Methode kann nur von derAccountOwner-ID mit der Rollenotaryfür die angegebene Vorgangs-ID aufgerufen werden. Die Sperre kann nur durch den Notar abgeschlossen werden. -
releaseHoldTokens - Diese Methode gibt eine Sperre für Token frei. Die Übertragung ist nicht abgeschlossen, und alle gespeicherten Token stehen dem ursprünglichen Eigentümer wieder zur Verfügung. Diese Methode kann von der
AccountOwner-ID mit der Rollenotaryinnerhalb der angegebenen Frist oder vom Zahler, Zahlungsempfänger oder Notar nach der angegebenen Frist aufgerufen werden. -
getOnHoldIds - Diese Methode gibt eine Liste aller Halte-IDs für ein angegebenes Konto zurück. Diese Methode kann von einer
Token Admindes Chaincodes, einerOrg Adminder angegebenen Organisation oder derAccountOwnerdes Accounts aufgerufen werden. -
getOnHoldDetailsWithOperationId - Diese Methode gibt die zurückgestellten Transaktionsdetails für eine angegebene Vorgangs-ID und ein bestimmtes Token zurück. Diese Methode kann von jedem aufgerufen werden.
-
getOnHoldBalanceWithOperationId - Diese Methode gibt den gesperrten Saldo für eine angegebene Vorgangs-ID und ein Token zurück. Diese Methode kann von jedem aufgerufen werden.
Methoden für das Tokenverhaltensmanagement - Burnable Behavior
-
burnTokens - Diese Methode deaktiviert oder verbrennt Token aus dem Konto des Transaktionsaufrufers. Der Aufrufer dieser Methode muss über einen Account und die Brennerrolle verfügen. Die Menge muss innerhalb der Dezimalwerte liegen, die durch den Parameter
decimaldes Verhaltensdivisiblein der Spezifikationsdatei angegeben werden. Diese Methode kann von derAccountOwnerdes Accounts mit der Brennerrolle aufgerufen werden.
Benutzerdefinierte Methoden
Mit den Token-SDK-Methoden können Sie benutzerdefinierte Methoden für Ihre Geschäftsanwendung schreiben.
Um doppelte Ausgaben zu vermeiden, kombinieren Sie nicht mehrere asynchrone Funktionen, die auf denselben Schlüssel/Wert-Paaren in der Statusdatenbank arbeiten. Verwenden Sie stattdessen die Methode bulkTransferTokens, um mehrere Übertragungen in einer Methode vorzunehmen.
Das folgende Beispiel zeigt, wie Sie Token-SDK-Methoden in benutzerdefinierten Methoden verwenden. Wenn die Methode buyTicket aufgerufen wird, überträgt sie 20 Token vom Konto des Anrufers auf das Konto des Verkäufers und gibt die Transaktionsnachricht der Übertragung zurück.
@Validator(yup.string(), yup.string(), yup.string(), yup.string(), yup.string())
public async buyTicket(token_id: string, seller_org_id: string, seller_user_id: string) {
const token = await this.getTokenObject(token_id);
/**
* The following method this.Ctx.Account.generateAccountId(token_id, seller_org_id, seller_user_id) generates account id of the seller.
*/
const seller_account_id = await this.Ctx.Account.generateAccountId(token_id, seller_org_id, seller_user_id);
/**
* The following method this.Ctx.Token.transfer(seller_account_id, 20, token) transfers the quantity 20 from caller's
* account & to seller's account.
*/
const transaction = await this.Ctx.Token.transfer(seller_account_id, 20, token);
return transaction;
}Wenn Sie in einer benutzerdefinierten Methode mehrere Token-SDK-Methoden verwenden, verwenden Sie keine Methoden, die sich auf dieselben Schlüssel/Wert-Paare in der Statusdatenbank auswirken. Das folgende Beispiel zeigt die falsche Möglichkeit, mehrere Übertragungen vorzunehmen:
@Validator(yup.string(), yup.string(), yup.string(), yup.string(), yup.string())
public async sendTokens(token_id: string, user1_org_id: string, user1_user_id: string, user2_org_id: string, user2_user_id: string) {
const token = await this.getTokenObject(token_id);
const user1_account_id = await Account.generateAccountId(token_id, user1_org_id, user1_user_id);
const user2_account_id = await Account.generateAccountId(token_id, user2_org_id, user2_user_id);
await token.transfer(user1_account_id, 20);
await token.transfer(user2_account_id, 30);
}Verwenden Sie stattdessen die Methode bulkTransferTokens, um aus dem Konto des Anrufers auf mehrere Konten zu übertragen, wie im folgenden Code-Snippet dargestellt.
bulkTransferTokens(token_id: string, flow: object[])Hinweis:
Wenn Sie in einer benutzerdefinierten Methode mehrere Token-SDK-Methoden verwenden, die sich auf dieselben Schlüssel/Wert-Paare in der Statusdatenbank auswirken können, aktivieren Sie die MVCC-Optimierung für Token Chaincodes. Weitere Informationen finden Sie unter MVCC-Optimierung.Token-SDK-Methoden
- Access Control Management
- Tokenkonfigurationsverwaltung
- Accountverwaltung
- Rollenverwaltung
- Verwaltung der Transaktionshistorie
- Tokenverhaltensverwaltung
Methoden für die Zugriffskontrolle
Das Token-SDK stellt eine Zugriffskontrollfunktion bereit. Einige Methoden können nur von einem
Token Admin, Org Admin oder AccountOwner des Tokens aufgerufen werden. Mit dieser Funktion können Sie sicherstellen, dass Vorgänge nur von den beabsichtigten Benutzern ausgeführt werden. Jeder nicht autorisierte Zugriff führt zu einem Fehler. Um die Zugriffskontrollfunktion zu verwenden, importieren Sie die Klasse Authorization aus dem Modul ../lib/auth.import { Authorization } from '../lib/auth';-
addAdmin - Diese Methode fügt einen Benutzer als
Token Admindes Token Chaincodes hinzu. -
removeAdmin - Diese Methode entfernt einen Benutzer als
Token Admindes Token Chaincodes. -
getAllAdmins - Diese Methode gibt eine Liste aller Benutzer zurück, die ein
Token Admindes Token Chaincodes sind. -
checkAuthorization - Mit dieser Methode können Sie einem Vorgang eine Zugriffskontrollprüfung hinzufügen. Bestimmte Tokenmethoden können nur von einem
Token AdminoderAccountOwnerdes Tokens oder vonMultipleAccountOwnerfür Benutzer mit mehreren Accounts ausgeführt werden. Die Zugriffskontrollzuordnung wird in der Datei../lib/constant.tsbeschrieben. Sie können die Zugriffskontrolle ändern, indem Sie die Datei../lib/constant.tsbearbeiten. Um Ihre eigene Zugriffskontrolle zu verwenden oder die Zugriffskontrolle zu deaktivieren, entfernen Sie den Zugriffskontrollcode aus den automatisch generierten Controllermethoden und benutzerdefinierten Methoden.export const TOKENACCESS = { ADMIN: { isUserTokenAdmin: ["Admin", "OrgAdmin"], addTokenAdmin: ["Admin"], removeTokenAdmin: ["Admin"], getAllAdmins: ["Admin", "OrgAdmin"], addOrgAdmin: ["Admin", "OrgAdminForOrgId"], removeOrgAdmin: ["Admin", "OrgAdminForOrgId"], getOrgAdmins: ["Admin", "OrgAdmin"], }, TOKEN: { save: ["Admin"], getAllTokens: ["Admin", "OrgAdmin"], get: ["Admin", "OrgAdmin"], update: ["Admin"], getDecimals: ["Admin", "OrgAdmin"], getTokensByName: ["Admin", "OrgAdmin"], addRoleMember: ["Admin", "OrgAdminRoleCheck"], removeRoleMember: ["Admin", "OrgAdminRoleCheck"], isInRole: ["Admin", "OrgAdminForAccountId", "AccountOwner"], getTotalMintedTokens: ["Admin", "OrgAdmin"], getNetTokens: ["Admin", "OrgAdmin"], getTokenHistory: ["Admin", "OrgAdmin"], }, ROLE: { getAccountsByRole: ["Admin"], getOrgAccountsByRole: ["Admin", "OrgAdminForOrgId"], getUsersByRole: ["Admin"], getOrgUsersByRole: ["Admin", "OrgAdminForOrgId"], }, TRANSACTION: { deleteTransactions: ["Admin"], },ACCOUNT: { createAccount: ["Admin", "OrgAdminForOrgId"], associateToken: ["Admin", "OrgAdminForAccountId"], getAllAccounts: ["Admin"], getAllOrgAccounts: ["Admin", "OrgAdminForOrgId"], getAccountsByUser: ["Admin", "OrgAdminForOrgId", "MultipleAccountOwner"], getAccount: ["Admin", "OrgAdminForAccountId", "AccountOwner"], history: ["Admin", "AccountOwner"], getAccountTransactionHistory: ["Admin", "OrgAdminForAccountId", "AccountOwner"], getAccountTransactionHistoryWithFilters: ["Admin", "OrgAdminForAccountId", "AccountOwner"], getSubTransactionsById: ["Admin", "TransactionInvoker"], getSubTransactionsByIdWithFilters: ["Admin", "TransactionInvoker"], getAccountBalance: ["Admin", "OrgAdminForAccountId", "AccountOwner"], getAccountOnHoldBalance: ["Admin", "OrgAdminForAccountId", "AccountOwner"], getOnHoldIds: ["Admin", "OrgAdminForAccountId", "AccountOwner"], getConversionHistory: ["Admin", "OrgAdminForAccountId", "AccountOwner"], }, ACCOUNT_STATUS: { get: ["Admin", "OrgAdminForAccountId", "AccountOwner"], history: ["Admin", "OrgAdminForAccountId", "AccountOwner"], activateAccount: ["Admin", "OrgAdminForOrgId"], suspendAccount: ["Admin", "OrgAdminForOrgId"], deleteAccount: ["Admin", "OrgAdminForOrgId"], }, TOKEN_CONVERSION: { initializeExchangePoolUser: ["Admin"], addConversionRate: ["Admin"], updateConversionRate: ["Admin"], getConversionRate: ["Admin", "OrgAdmin", "AnyAccountOwner"], getConversionRateHistory: ["Admin", "OrgAdmin", "AnyAccountOwner"], tokenConversion: ["Admin", "AnyAccountOwner"], getExchangePoolUser: ["Admin"], }, } -
isUserTokenAdmin - Diese Methode gibt den booleschen Wert
truezurück, wenn der Aufrufer der Funktion einToken Administ. Andernfalls gibt die Methodefalsezurück. -
addOrgAdmin - Mit dieser Methode wird ein Benutzer als
Org Adminder Organisation hinzugefügt. -
removeOrgAdmin - Mit dieser Methode wird ein Benutzer als
Org Adminder Organisation entfernt. -
getOrgAdmins - Diese Methode gibt eine Liste aller Benutzer zurück, die eine
Org Admineiner Organisation sind.
Methoden für die Verwaltung der Tokenkonfiguration
-
getTokenDecimals - Diese Methode gibt die Anzahl der Dezimalstellen zurück, die für ein partielles Token verfügbar sind. Wenn das
divisible-Verhalten nicht angegeben ist, ist der Standardwert 0. -
getAllTokens - Diese Methode gibt alle in der Statusdatenbank gespeicherten Tokenassets zurück. Diese Methode verwendet SQL-Rich-Abfragen von Berkeley DB und kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Netzwerk von Oracle Blockchain Platform besteht.
-
getTokensByName - Diese Methode gibt alle Tokenassets mit dem angegebenen Namen zurück. Diese Methode verwendet SQL-Rich-Abfragen von Berkeley DB und kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Netzwerk von Oracle Blockchain Platform besteht.
-
get - Diese Methode gibt ein Tokenobjekt zurück, wenn es in der Statusdatenbank vorhanden ist.
-
isTokenType - Diese Methode gibt an, ob ein Tokenasset mit der angegebenen ID vorhanden ist.
-
save - Diese Methode erstellt ein Token und speichert seine Eigenschaften in der Statusdatenbank.
-
update - Diese Methode aktualisiert Tokeneigenschaften. Nachdem ein Tokenasset erstellt wurde, aktualisieren Sie nur den Wert
token_descund die zugehörigen benutzerdefinierten Eigenschaften. -
getByRange - Diese Methode ruft die Stoffmethode
getStateByRangeintern auf. Obwohl ein Vermögensgegenstand mit der angegebenen ID aus dem Buch zurückgegeben wird, überträgt diese Methode den Vermögensgegenstand in den aufrufenden Vermögensgegenstandstyp. -
history - Diese Methode gibt die Historie für das angegebene Token zurück.
Methoden für die Accountverwaltung
-
getCallerAccountId - Diese Methode gibt die Konto-ID des Aufrufers zurück.
-
generateAccountId - Diese Methode gibt eine Konto-ID zurück, die aus einem alphanumerischen Zeichensatz mit dem Präfix
oaccount~<token asset name>~besteht, gefolgt von einem Hash des Benutzernamens oder der E-Mail-ID (user_id) des Instanzeigentümers oder des Benutzers, der bei der Instanz angemeldet ist, der Mitgliedschaftsserviceprovider-ID (org_id) des Benutzers in der aktuellen Netzwerkorganisation und der eindeutigen Token-ID (token_id). -
createAccount - Diese Methode erstellt einen Account für einen angegebenen Benutzer und ein bestimmtes Token. Jeder Benutzer, der Token hat, muss ein Konto haben. Konten verfolgen den Saldo, den gesperrten Saldo und die Transaktionshistorie eines Benutzers. Eine Account-ID ist ein alphanumerisches Zeichenset mit dem Präfix
oaccount~<token asset name>~, gefolgt von einem Hash des Benutzernamens oder der E-Mail-ID (user_id) des Instanzeigentümers oder des Benutzers, der bei der Instanz angemeldet ist, der Mitgliedschaftsserviceprovider-ID (org_id) des Benutzers in der aktuellen Netzwerkorganisation. Diese Methode kann nur vomToken Admindes Chaincodes oder von einemOrg Adminder angegebenen Organisation aufgerufen werden. -
associateTokenToAccount - Diese Methode verknüpft ein fungibles Token mit einem Konto. Diese Methode kann nur von einem
Token Admindes Chaincodes oder von einemOrg Adminder relevanten Organisation aufgerufen werden. -
getAccountWithStatus - Diese Methode gibt Kontodetails für ein bestimmtes Konto zurück, einschließlich Kontostatus.
-
getAccount - Diese Methode gibt Kontodetails für ein angegebenes Konto zurück.
-
history - Diese Methode gibt ein Array der Kontohistoriendetails für ein angegebenes Konto zurück.
-
getAccountOnHoldBalance - Diese Methode gibt den gesperrten Saldo für ein angegebenes Konto zurück.
-
getAllAccounts - Diese Methode gibt eine Liste aller Konten zurück. Diese Methode verwendet SQL-Rich-Abfragen von Berkeley DB und kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Netzwerk von Oracle Blockchain Platform besteht.
-
getUserByAccountId - Diese Methode gibt die Benutzerdetails für einen angegebenen Account zurück.
-
getAccountBalance - Diese Methode gibt den Kontensaldo für ein bestimmtes Konto zurück.
-
getAllOrgAccounts - Diese Methode gibt eine Liste aller Tokenaccounts zurück, die zu einer angegebenen Organisation gehören.
Methoden für die Rollenverwaltung
-
addRoleMember - Mit dieser Methode wird eine Rolle zu einem angegebenen Benutzer und Token hinzugefügt.
-
removeRoleMember - Diese Methode entfernt eine Rolle aus einem angegebenen Benutzer und Token.
-
getAccountsByRole - Diese Methode gibt eine Liste aller Konten für eine angegebene Rolle und ein bestimmtes Token zurück.
-
getAccountsByUser - Diese Methode gibt eine Liste aller Konto-IDs für einen angegebenen Benutzer zurück.
-
getUsersByRole - Diese Methode gibt eine Liste aller Benutzer für eine angegebene Rolle und ein bestimmtes Token zurück.
-
isInRole - Diese Methode gibt an, ob ein Benutzer und ein Token über eine angegebene Rolle verfügen.
-
roleCheck - Diese Methode prüft, ob die angegebene Konto-ID Mitglied einer beliebigen Rolle ist.
-
getOrgUsersByRole - Diese Methode gibt Informationen zu allen Benutzern zurück, die eine bestimmte Rolle in einer bestimmten Organisation haben.
-
getOrgAccountsByRole - Diese Methode gibt Informationen zu allen Firmen zurück, die eine bestimmte Rolle in einer bestimmten Organisation haben.
Methoden für das Transaktionshistorienmanagement
-
getTransactionById - Diese Methode gibt die Historie eines
Transaction-Assets zurück. -
deleteHistoricalTransactions - Diese Methode gibt ein Array der Transaktionshistoriendetails für ein angegebenes Konto zurück.
-
getAccountTransactionHistory - Diese Methode gibt ein Array der Transaktionshistoriendetails für ein angegebenes Konto zurück.
-
getAccountTransactionHistoryWithFilters - Diese Methode gibt ein Array der Transaktionshistoriendetails für ein angegebenes Konto zurück. Diese Methode kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Oracle Blockchain Platform-Netzwerk besteht.
-
getSubTransactionHistory - Diese Methode gibt ein Array der Transaktionshistoriendetails für eine angegebene Transaktion zurück.
-
getSubTransactionHistoryWithFilters - Diese Methode gibt ein Array der Details der Untertransaktionshistorie für eine angegebene Transaktion zurück.
Tokenverhaltensverwaltung
Die Methoden für das Tokenlebenszyklusmanagement basieren auf den Standards des Token Taxonomy Frameworks. Um die Tokenlebenszyklusmethoden zu verwenden, importieren Sie die Klasse
Token aus dem Modul ../lib/token.
import { Token } from '../lib/token';Methoden für das Tokenverhaltensmanagement - Mintable Behavior
-
mint - Mit dieser Methode wird eine Anzahl von Token abgebaut, die dann dem Aufrufer der Methode gehören. Der Anrufer muss über einen Account und die Minter-Rolle verfügen. Die Menge muss innerhalb der Dezimalwerte liegen, die durch den Parameter
decimaldes Verhaltensdivisiblein der Spezifikationsdatei angegeben werden. -
getTotalMintedTokens - Diese Methode gibt die Gesamtanzahl der Token zurück, die geprägt wurden.
-
getNetTokens - Diese Methode gibt die Nettomenge der im System verfügbaren Token zurück. Die Netto-Token sind die Anzahl der verbleibenden Token, nachdem Token verbrannt wurden. In Gleichungsform: net tokens = insgesamt geprägte tokens - insgesamt gebrannte tokens. Wenn keine Token gebrannt werden, entspricht die Anzahl der Net Token der Gesamtanzahl der geprägten Token.
-
getMaxMintQuantity - Diese Methode gibt die maximale Münzmenge für ein Token zurück. Wenn das
max_mint_quantity-Verhalten nicht angegeben ist, ist der Standardwert 0. Dadurch kann eine beliebige Anzahl von Token geprägt werden.
Methoden für das Tokenverhaltensmanagement - Übertragbares Verhalten
-
transfer - Diese Methode überträgt Token vom Transaktionsaufrufer auf das Konto
to_account_id. Der Aufrufer dieser Methode muss einen Account haben, und die Menge muss innerhalb der Dezimalwerte liegen, die durch den Parameterdecimaldes Verhaltensdivisiblein der Spezifikationsdatei angegeben werden. -
bulkTransfer - Diese Methode wird verwendet, um eine Massenübertragung von Token aus dem Aufruferkonto auf die Konten durchzuführen, die im Objekt
flowangegeben sind. Für den Aufrufer dieser Methode muss bereits ein Account erstellt sein.
Methoden für das Tokenverhaltensmanagement - Zurückstellbares Verhalten
-
hold - Diese Methode erstellt eine Sperre im Namen des Eigentümers der Token mit dem Konto
to_account_id. Es wird ein Notarkonto angegeben, das für den Abschluss oder die Freigabe der Sperre verantwortlich ist. Wenn die Sperre erstellt wird, wird der angegebene Tokensaldo des Zahlers gesperrt. Ein gesperrter Saldo kann erst übertragen werden, wenn die Sperre abgeschlossen oder freigegeben wurde. Für den Aufrufer dieser Methode muss bereits ein Account erstellt sein. -
executeHold - Diese Methode schließt eine Tokensperre ab und überträgt die angegebene Anzahl zuvor gesperrter Token an den Empfänger. Wenn der Wert
quantitykleiner als der tatsächliche Sperrwert ist, ist der Restbetrag wieder für den ursprünglichen Eigentümer der Token verfügbar. Diese Methode kann nur von derAccountOwner-ID mit der Rollenotaryfür die angegebene Vorgangs-ID aufgerufen werden. Die Sperre kann nur durch den Notar abgeschlossen werden. -
releaseHold - Diese Methode gibt eine Sperre für Token frei. Die Übertragung ist nicht abgeschlossen, und alle gespeicherten Token stehen dem ursprünglichen Eigentümer wieder zur Verfügung. Diese Methode kann von der
AccountOwner-ID mit der Rollenotaryinnerhalb der angegebenen Frist oder vom Zahler, Zahlungsempfänger oder Notar nach der angegebenen Frist aufgerufen werden. -
getOnHoldIds - Diese Methode gibt eine Liste aller Halte-IDs für ein angegebenes Konto zurück.
-
getOnHoldDetailsWithOperationId - Diese Methode gibt die zurückgestellten Transaktionsdetails für eine angegebene Vorgangs-ID und ein bestimmtes Token zurück.
-
getOnHoldBalanceWithOperationId - Diese Methode gibt den gesperrten Saldo für eine angegebene Vorgangs-ID und ein Token zurück. Diese Methode kann von jedem aufgerufen werden.
Methoden für das Tokenverhaltensmanagement - Burnable Behavior
-
burn - Diese Methode deaktiviert oder verbrennt Token aus dem Konto des Transaktionsaufrufers. Der Aufrufer dieser Methode muss über einen Account und die Brennerrolle verfügen. Die Menge muss innerhalb der Dezimalwerte liegen, die durch den Parameter
decimaldes Verhaltensdivisiblein der Spezifikationsdatei angegeben werden.