Gerüstetes TypeScript-Projekt für Token Taxonomy Framework
Blockchain App Builder übernimmt die Eingabe aus Ihrer Token-Spezifikationsdatei 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 Persistenzfunktion werden automatisch unterstützt.
Informationen zu dem gerüsteten Projekt und den Methoden, die nicht direkt mit Token verknüpft sind, finden Sie unter Gerüstetes TypeScript Chaincode-Projekt.
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 (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;
}
Verantwortlicher
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 Tokenmethoden
Blockchain App Builder generiert automatisch Methoden zur Unterstützung von Token und Token-Lebenszyklen. Mit diesen Methoden können Sie Token initialisieren, Rollen und Accounts verwalten und andere Tokenlebenszyklusaufgaben ohne zusätzliche Codierung abschließen. Controller-Methoden müssen einen @Validator(...params)
-Dekorator aufweisen, damit sie aufgerufen werden können.
- Access Control Management
- Tokenkonfigurationsverwaltung
- Accountverwaltung
- Rollenverwaltung
- Transaktionshistorienmanagement
- Tokenverhaltensverwaltung
Methoden für die Zugriffskontrollverwaltung
-
addTokenAdmin
- Diese Methode fügt einen Benutzer als
Token Admin
des Chaincodes hinzu. Diese Methode kann nur von einemToken Admin
des Chaincodes aufgerufen werden. -
removeTokenAdmin
- Mit dieser Methode wird ein Benutzer als
Token Admin
des Chaincodes entfernt. Diese Methode kann nur von einemToken Admin
des Chaincodes aufgerufen werden. -
isTokenAdmin
- Diese Methode gibt den booleschen Wert
true
zurück, wenn der Aufrufer der Funktion einToken Admin
ist. Andernfalls gibt siefalse
zurück. EineToken Admin
oderOrg Admin
kann diese Funktion für jeden anderen Benutzer im Blockchain-Netzwerk aufrufen. Andere Benutzer können diese Methode nur für ihre eigenen Accounts aufrufen. -
getAllTokenAdmins
- Diese Methode gibt eine Liste aller Benutzer zurück, die ein
Token Admin
des Chaincodes sind. Diese Methode kann nur von derToken Admin
oder einer beliebigenOrg Admin
des Chaincodes aufgerufen werden. -
addOrgAdmin
- Diese Methode fügt einen Benutzer als
Org Admin
der Organisation hinzu. Diese Methode kann nur von einemToken Admin
des Chaincodes oder einemOrg Admin
der angegebenen Organisation aufgerufen werden. -
removeOrgAdmin
- Mit dieser Methode wird ein Benutzer als
Org Admin
der Organisation entfernt. Diese Methode kann nur durch eineToken Admin
des Chaincodes oder durch eineOrg Admin
der angegebenen Organisation aufgerufen werden. -
getOrgAdmins
- Diese Methode gibt eine Liste aller Benutzer zurück, die eine
Org Admin
einer Organisation sind. Diese Methode kann nur durch eineToken Admin
des Chaincodes oder durch eineOrg Admin
einer beliebigen Organisation aufgerufen werden.
-
addTokenAdmin
- Diese Methode fügt einen Benutzer als
Token Admin
des Chaincodes hinzu. Diese Methode kann nur von einemToken Admin
des Chaincodes aufgerufen werden. -
removeTokenAdmin
- Mit dieser Methode wird ein Benutzer als
Token Admin
des Chaincodes entfernt. Diese Methode kann nur von einemToken Admin
des Chaincodes aufgerufen werden. -
isTokenAdmin
- Diese Methode gibt den booleschen Wert
true
zurück, wenn der Aufrufer der Funktion einToken Admin
ist. Andernfalls gibt siefalse
zurück. EineToken Admin
,Token Auditor
, eine beliebigeOrg Admin
oder eine beliebigeOrg Auditor
kann diese Funktion für jeden anderen Benutzer im Blockchain-Netzwerk aufrufen. Andere Benutzer können diese Methode nur für ihre eigenen Accounts aufrufen. -
getAllTokenAdmins
- Diese Methode gibt eine Liste aller Benutzer zurück, die ein
Token Admin
des Chaincodes sind. Diese Methode kann nur von derToken Admin
oderToken Auditor
des Chaincodes aufgerufen werden. -
addOrgAdmin
- Diese Methode fügt einen Benutzer als
Org Admin
der Organisation hinzu. Diese Methode kann nur von einemToken Admin
des Chaincodes oder einemOrg Admin
der angegebenen Organisation aufgerufen werden. -
removeOrgAdmin
- Mit dieser Methode wird ein Benutzer als
Org Admin
der Organisation entfernt. Diese Methode kann nur durch eineToken Admin
des Chaincodes oder durch eineOrg Admin
der angegebenen Organisation aufgerufen werden. -
getOrgAdmins
- Diese Methode gibt eine Liste aller Benutzer zurück, die eine
Org Admin
einer Organisation sind. Diese Methode kann nur mit einemToken Admin
,Token Auditor
, einem beliebigenOrg Admin
oder einem beliebigenOrg Auditor
aufgerufen werden. -
addTokenAuditor
- Diese Methode fügt einen Benutzer als
Token Auditor
des Chaincodes hinzu. Diese Methode kann nur von einemToken Admin
des Chaincodes aufgerufen werden. -
removeTokenAuditor
- Mit dieser Methode wird ein Benutzer als
Token Auditor
des Chaincodes entfernt. Diese Methode kann nur von einemToken Admin
des Chaincodes aufgerufen werden. -
getTokenAuditors
- Diese Methode gibt alle
Token Auditors
des Chaincodes zurück. Diese Methode kann nur mit einerToken Admin
oderToken Auditor
des Chaincodes aufgerufen werden. -
addOrgAuditor
- Diese Methode fügt einen Benutzer als
Org Auditor
des Chaincodes hinzu. Diese Methode kann nur mit einerToken Admin
oderOrg Admin
des Chaincodes aufgerufen werden. -
removeOrgAuditor
- Mit dieser Methode wird ein Benutzer als
Org Auditor
des Chaincodes entfernt. Diese Methode kann nur mit einerToken Admin
oderOrg Admin
des Chaincodes aufgerufen werden. -
getOrgAuditors
- Diese Methode gibt alle
Org Auditors
des Chaincodes zurück. Diese Methode kann nur mitToken Admin
,Token Auditor
,Org Admin
oderOrg Auditor
aufgerufen werden.
Methoden für die Verwaltung der Tokenkonfiguration
-
init
- Diese Methode wird aufgerufen, wenn der Chaincode bereitgestellt oder aktualisiert wird. Jede
Token Admin
wird durch die Informationenuser_id
undorg_id
im obligatorischen ParameteradminList
identifiziert. Dieuser_id
ist der Benutzername oder die E-Mail-ID des Instanzeigentümers oder des Benutzers, der bei der Instanz angemeldet ist. Dieorg_id
ist die MSP-ID (Member Service Provider) 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 Admin
des Chaincodes aufgerufen werden. -
update<Token Name>Token
- Diese Methode aktualisiert Tokeneigenschaften. Nachdem ein Tokenasset erstellt wurde, können nur die Eigenschaft
token_desc
und benutzerdefinierte Eigenschaften aktualisiert werden. Diese Methode kann nur von einemToken Admin
des Chaincodes aufgerufen werden. -
getTokenDecimals
- Diese Methode gibt die Anzahl der Dezimalstellen zurück, die für ein Bruchteil-Token konfiguriert wurden. Wenn das Verhalten
divisible
für das Token nicht angegeben wurde, ist der Standardwert 0. Diese Methode kann nur mit einerToken Admin
oderOrg Admin
des Chaincodes aufgerufen werden. -
getTokenById
- Diese Methode gibt ein Tokenobjekt zurück, wenn es in der Statusdatenbank vorhanden ist. Diese Methode kann nur mit einer
Token Admin
oder einerOrg Admin
des 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 mit einer
Token Admin
oder einerOrg Admin
des Chaincodes aufgerufen werden. Diese Methode verwendet SQL-reiche Berkeley DB-Abfragen und kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Oracle Blockchain Platform-Netzwerk besteht. -
getTokensByName
- Diese Methode gibt alle Tokenobjekte mit einem angegebenen Namen zurück. Diese Methode kann nur mit einer
Token Admin
oderOrg Admin
des Chaincodes aufgerufen werden. Diese Methode verwendet SQL-reiche Berkeley DB-Abfragen und kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Oracle Blockchain Platform-Netzwerk besteht.
-
init
- Diese Methode wird aufgerufen, wenn der Chaincode bereitgestellt oder aktualisiert wird. Jede
Token Admin
wird durch die Informationenuser_id
undorg_id
im obligatorischen ParameteradminList
identifiziert. Dieuser_id
ist der Benutzername oder die E-Mail-ID des Instanzeigentümers oder des Benutzers, der bei der Instanz angemeldet ist. Dieorg_id
ist die MSP-ID (Member Service Provider) 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 Admin
des Chaincodes aufgerufen werden. -
update<Token Name>Token
- Diese Methode aktualisiert Tokeneigenschaften. Nachdem ein Tokenasset erstellt wurde, können nur die Eigenschaft
token_desc
und benutzerdefinierte Eigenschaften aktualisiert werden. Diese Methode kann nur von einemToken Admin
des Chaincodes aufgerufen werden. -
getTokenDecimals
- Diese Methode gibt die Anzahl der Dezimalstellen zurück, die für ein Bruchteil-Token konfiguriert wurden. Wenn das Verhalten
divisible
für das Token nicht angegeben wurde, ist der Standardwert 0. Diese Methode kann nur mitToken Admin
,Token Auditor
,Org Admin
oderOrg Auditor
aufgerufen werden. -
getTokenById
- Diese Methode gibt ein Tokenobjekt zurück, wenn es in der Statusdatenbank vorhanden ist. Diese Methode kann nur mit
Token Admin
,Token Auditor
,Org Admin
oderOrg Auditor
aufgerufen werden. -
getTokenHistory
- Diese Methode gibt die Tokenhistorie für eine angegebene Token-ID zurück. Diese Methode kann nur mit
Token Admin
,Token Auditor
,Org Admin
oderOrg Auditor
aufgerufen werden. -
getAllTokens
- Diese Methode gibt alle Token zurück, die in der Statusdatenbank gespeichert sind. Diese Methode kann nur mit
Token Admin
,Token Auditor
,Org Admin
oderOrg Auditor
aufgerufen werden. Diese Methode verwendet SQL-reiche Berkeley DB-Abfragen und kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Oracle Blockchain Platform-Netzwerk besteht. -
getTokensByName
- Diese Methode gibt alle Tokenobjekte mit einem angegebenen Namen zurück. Diese Methode kann nur mit
Token Admin
,Token Auditor
,Org Admin
oderOrg Auditor
aufgerufen werden. Diese Methode verwendet SQL-reiche Berkeley DB-Abfragen und kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Oracle Blockchain Platform-Netzwerk besteht.
Methoden für die Kontenverwaltung
-
createAccount
- Mit dieser Methode wird ein Account für einen angegebenen Benutzer und ein bestimmtes Token erstellt. Ein Konto muss für jeden Benutzer erstellt werden, der zu einem beliebigen Zeitpunkt Token hat. Konten verfolgen Salden, einbehaltene Salden und die Transaktionshistorie. Eine Account-ID ist eine alphanumerische Gruppe von Zeichen 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 durch eineToken Admin
des Chaincodes oder durch eineOrg Admin
der angegebenen Organisation aufgerufen werden. -
associateTokenToAccount
- Diese Methode verknüpft ein fungibles Token mit einem Konto. Diese Methode kann nur durch eine
Token Admin
des Chaincodes oder durch eineOrg Admin
der relevanten Organisation aufgerufen werden. -
getAccount
- Diese Methode gibt Accountdetails für einen angegebenen Benutzer und ein bestimmtes Token zurück. Diese Methode kann nur durch eine
Token Admin
des Chaincodes, eineOrg Admin
der angegebenen Organisation oder dieAccountOwner
des Accounts aufgerufen werden. -
getAccountHistory
- Diese Methode gibt Accounthistoriendetails für einen angegebenen Benutzer und ein bestimmtes Token zurück. Diese Methode kann nur mit einer
Token Admin
des Chaincodes oder derAccountOwner
des Accounts aufgerufen werden. -
getAccountOnHoldBalance
- Diese Methode gibt den aktuellen Zurückstellungssaldo für ein angegebenes Konto und Token zurück. Diese Methode kann nur durch eine
Token Admin
des Chaincodes, eineOrg Admin
der angegebenen Organisation oder dieAccountOwner
des Accounts aufgerufen werden. -
getAllAccounts
- Diese Methode gibt eine Liste aller Konten zurück. Diese Methode kann nur von einem
Token Admin
des Chaincodes aufgerufen werden. Diese Methode verwendet SQL-reiche Berkeley DB-Abfragen und kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Oracle Blockchain Platform-Netzwerk besteht. -
getUserByAccountId
- Diese Methode gibt Benutzerdetails (
org_id
unduser_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 durch eine
Token Admin
des Chaincodes, eineOrg Admin
der angegebenen Organisation oder dieAccountOwner
des Accounts aufgerufen werden. -
getAllOrgAccounts
- Diese Methode gibt eine Liste aller Token-Accounts zurück, die zu einer bestimmten Organisation gehören. Diese Methode kann nur durch eine
Token Admin
des Chaincodes oder durch eineOrg Admin
der angegebenen Organisation aufgerufen werden.
-
createAccount
- Mit dieser Methode wird ein Account für einen angegebenen Benutzer und ein bestimmtes Token erstellt. Ein Konto muss für jeden Benutzer erstellt werden, der zu einem beliebigen Zeitpunkt Token hat. Konten verfolgen Salden, einbehaltene Salden und die Transaktionshistorie. Eine Account-ID ist eine alphanumerische Gruppe von Zeichen 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 durch eineToken Admin
des Chaincodes oder durch eineOrg Admin
der angegebenen Organisation aufgerufen werden. -
associateTokenToAccount
- Diese Methode verknüpft ein fungibles Token mit einem Konto. Diese Methode kann nur durch eine
Token Admin
des Chaincodes oder durch eineOrg Admin
der relevanten Organisation aufgerufen werden. -
getAccount
- Diese Methode gibt Accountdetails für einen angegebenen Benutzer und ein bestimmtes Token zurück. Diese Methode kann nur von einer
Token Admin
oderToken Auditor
, einerOrg Admin
oderOrg Auditor
der angegebenen Organisation oder derAccountOwner
des Accounts aufgerufen werden. -
getAccountHistory
- Diese Methode gibt Accounthistoriendetails für einen angegebenen Benutzer und ein bestimmtes Token zurück. Diese Methode kann nur mit einer
Token Admin
des Chaincodes oder derAccountOwner
des Accounts aufgerufen werden. -
getAccountOnHoldBalance
- Diese Methode gibt den aktuellen Zurückstellungssaldo für ein angegebenes Konto und Token zurück. Diese Methode kann nur von einer
Token Admin
oderToken Auditor
, einerOrg Admin
oderOrg Auditor
der angegebenen Organisation oder derAccountOwner
des Accounts aufgerufen werden. -
getAllAccounts
- Diese Methode gibt eine Liste aller Konten zurück. Diese Methode kann nur mit einer
Token Admin
oderToken Auditor
aufgerufen werden. Diese Methode verwendet SQL-reiche Berkeley DB-Abfragen und kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Oracle Blockchain Platform-Netzwerk besteht. -
getUserByAccountId
- Diese Methode gibt Benutzerdetails (
org_id
unduser_id
) für einen angegebenen Account zurück. Diese Methode kann von einerToken Admin
oderToken Auditor
oder von einerOrg Admin
oderOrg Auditor
der angegebenen Organisation aufgerufen werden. -
getAccountBalance
- Diese Methode gibt den aktuellen Saldo für ein angegebenes Konto und Token zurück. Diese Methode kann nur von einer
Token Admin
oderToken Auditor
, einerOrg Admin
oderOrg Auditor
der angegebenen Organisation oder derAccountOwner
des Accounts aufgerufen werden. -
getAllOrgAccounts
- Diese Methode gibt eine Liste aller Token-Accounts zurück, die zu einer bestimmten Organisation gehören. Diese Methode kann nur von einer
Token Admin
oderToken Auditor
oder von einerOrg Admin
oderOrg Auditor
der angegebenen Organisation aufgerufen werden.
Methoden für die Rollenverwaltung
-
addRole
- Diese Methode fügt einem angegebenen Benutzer und Token eine Rolle hinzu. Diese Methode kann nur von einer
Token Admin
des Chaincodes oder von einerOrg Admin
der angegebenen Organisation aufgerufen werden, die auch die angegebene Rolle enthält. -
removeRole
- Mit dieser Methode wird eine Rolle aus einem angegebenen Benutzer und Token entfernt. Diese Methode kann nur von einer
Token Admin
des Chaincodes oder von einerOrg Admin
der angegebenen Organisation aufgerufen werden, die auch die angegebene Rolle enthält. -
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 Admin
des Chaincodes aufgerufen werden. -
getAccountsByUser
- Diese Methode gibt eine Liste aller Konto-IDs für eine angegebene Organisations-ID und Benutzer-ID zurück. Diese Methode kann nur von der
Token Admin
des Chaincodes, von derOrg Admin
der angegebenen Organisation oder von derAccount Owner
aufgerufen werden, die in den Parametern angegeben ist. -
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 Admin
des Chaincodes aufgerufen werden. -
isInRole
- Diese Methode gibt einen booleschen Wert zurück, um anzugeben, ob ein Benutzer und ein Token eine bestimmte Rolle haben. Diese Methode kann nur von einem
Token Admin
des Chaincodes, demAccountOwner
des Accounts oder einemOrg Admin
der angegebenen Organisation aufgerufen werden. -
getOrgAccountsByRole
- Diese Methode gibt Informationen zu allen Konten zurück, die eine bestimmte Rolle in einer bestimmten Organisation haben. Diese Methode kann nur durch eine
Token Admin
des Chaincodes oder durch eineOrg Admin
der 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 durch eine
Token Admin
des Chaincodes oder durch eineOrg Admin
der angegebenen Organisation aufgerufen werden.
-
addRole
- Diese Methode fügt einem angegebenen Benutzer und Token eine Rolle hinzu. Diese Methode kann nur von einer
Token Admin
des Chaincodes oder von einerOrg Admin
der angegebenen Organisation aufgerufen werden, die auch die angegebene Rolle enthält. -
removeRole
- Mit dieser Methode wird eine Rolle aus einem angegebenen Benutzer und Token entfernt. Diese Methode kann nur von einer
Token Admin
des Chaincodes oder von einerOrg Admin
der angegebenen Organisation aufgerufen werden, die auch die angegebene Rolle enthält. -
getAccountsByRole
- Diese Methode gibt eine Liste aller Konto-IDs für eine angegebene Rolle und ein bestimmtes Token zurück. Diese Methode kann nur mit einer
Token Admin
oderToken Auditor
aufgerufen werden. -
getAccountsByUser
- Diese Methode gibt eine Liste aller Konto-IDs für eine angegebene Organisations-ID und Benutzer-ID zurück. Diese Methode kann nur von
Token Admin
oderToken Auditor
, von derOrg Admin
oderOrg Auditor
der angegebenen Organisation oder von der in den Parametern angegebenenAccount Owner
aufgerufen werden. -
getUsersByRole
- Diese Methode gibt eine Liste aller Benutzer für eine angegebene Rolle und ein bestimmtes Token zurück. Diese Methode kann nur mit einer
Token Admin
oderToken Auditor
aufgerufen werden. -
isInRole
- Diese Methode gibt einen booleschen Wert zurück, um anzugeben, ob ein Benutzer und ein Token eine bestimmte Rolle haben. Diese Methode kann nur von einer
Token Admin
oderToken Auditor
, derAccountOwner
des Accounts oder einerOrg Admin
oderOrg Auditor
der angegebenen Organisation aufgerufen werden. -
getOrgAccountsByRole
- Diese Methode gibt Informationen zu allen Konten zurück, die eine bestimmte Rolle in einer bestimmten Organisation haben. Diese Methode kann nur mit
Token Admin
,Token Auditor
,Org Admin
oderOrg Auditor
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 einer
Token Admin
oderToken Auditor
, einerOrg Admin
oderOrg Auditor
der angegebenen Organisation aufgerufen werden.
Methoden für 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 Admin
des Chaincodes, einerOrg Admin
der angegebenen Organisation oder derAccountOwner
des 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 Admin
des Chaincodes, einerOrg Admin
der angegebenen Organisation oder derAccountOwner
des Accounts aufgerufen werden. Diese Methode kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Oracle Blockchain Platform-Netzwerk besteht. -
getSubTransactionsById
- 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 Admin
des Chaincodes oder derAccountOwner
des Accounts aufgerufen werden. -
getSubTransactionsByIdWithFilters
- Diese Methode gibt ein Array von Details der Kontenuntertransaktionshistorie für eine angegebene Transaktion zurück.
-
getTransactionById
- Diese Methode gibt die Historie eines
Transaction
-Assets zurück. -
deleteHistoricalTransactions
- Mit dieser Methode werden ältere Transaktionen aus der Statusdatenbank gelöscht.
-
getAccountTransactionHistoryWithFiltersFromRichHistDB
- Sie können Daten mit der Rich-History-Datenbank synchronisieren und die Daten dann mit Chaincode-API-Aufrufen abrufen. Diese Methode ruft die Transaktionshistorie aus der Rich-History-Datenbank ab. Bevor Sie diese Methode verwenden können, müssen Sie Oracle Autonomous Database mit aktivierten Oracle REST Data Services (ORDS) und OAuth ausführen, wie unter Oracle Database View Definitions for Wholesale CBDC in der Oracle Blockchain Platform Digital Assets Edition beschrieben.
-
getAccountTransactionHistory
- Diese Methode gibt ein Array von Kontotransaktionshistoriendetails für einen angegebenen Benutzer und ein bestimmtes Token zurück. Diese Methode kann nur von
Token Admin
oderToken Auditor
, einerOrg Admin
oderOrg Auditor
der angegebenen Organisation oder derAccountOwner
des Accounts aufgerufen werden. -
getAccountTransactionHistoryWithFilters
- Diese Methode gibt ein gefiltertes Array von Kontotransaktionshistoriendetails für einen angegebenen Benutzer und ein bestimmtes Token zurück. Diese Methode kann nur von
Token Admin
oderToken Auditor
, einerOrg Admin
oderOrg Auditor
der angegebenen Organisation oder derAccountOwner
des Accounts aufgerufen werden. -
getSubTransactionsById
- Diese Methode gibt ein Array von Kontotransaktionshistoriendetails für einen angegebenen Benutzer und ein bestimmtes Token zurück. Diese Methode kann nur von
Token Admin
,Token Auditor
oderAccountOwner
aufgerufen werden, der die Transaktion aufgerufen hat. -
getSubTransactionsByIdWithFilters
- Diese Methode gibt ein Array von Details der Kontenuntertransaktionshistorie für eine angegebene Transaktion zurück.
-
getTransactionById
- Diese Methode gibt die Historie eines
Transaction
-Assets zurück. Diese Methode kann nur von einerToken Admin
oderToken Auditor
, von einerOrg Admin
oderOrg Auditor
der angegebenen Organisation oder von einem Transaktionsteilnehmer (Absender, Empfänger oder Notar) aufgerufen werden. -
deleteHistoricalTransactions
- Mit dieser Methode werden ältere Transaktionen aus der Statusdatenbank gelöscht.
Methoden für die Verwaltung des Tokenverhaltens - Mintable-Verhalten
-
issueTokens
- Mit dieser Methode werden Token abgebildet, die dann dem Aufrufer der Methode gehören. Der Anrufer muss über ein Konto und die Nebenrolle verfügen. Die Anzahl der Token, die geprägt werden können, wird durch die Eigenschaft
max_mint_quantity
des Verhaltensmintable
in der Spezifikationsdatei begrenzt. Wenn die Eigenschaftmax_mint_quantity
nicht angegeben ist, kann eine unbegrenzte Anzahl von Token geprägt werden. Die Menge muss innerhalb der Dezimalwerte liegen, die durch den Parameterdecimal
des Verhaltensdivisible
in der Spezifikationsdatei angegeben werden. Diese Methode kann nur von derAccountOwner
des Kontos mit der Minter-Rolle aufgerufen werden. -
getTotalMintedTokens
- Diese Methode gibt die Gesamtanzahl der ausgeprägten Token für ein angegebenes Token zurück. Diese Methode kann nur mit einer
Token Admin
oder einer beliebigenOrg Admin
des Chaincodes aufgerufen werden. -
getNetTokens
- Diese Methode gibt die Gesamtanzahl der Token zurück, die im System für ein angegebenes Token verfügbar sind. Die Nettotokensumme ist die Anzahl der verbleibenden Token, nachdem Token gebrannt wurden. In Gleichungsform: Nettotoken = Gesamtanzahl abgebrannter Token - Gesamtanzahl verbrannter Token. Wenn keine Token verbrannt werden, ist die Anzahl der Nettotoken gleich der Gesamtanzahl der abgebauten Token. Diese Methode kann nur mit einer
Token Admin
oder einer beliebigenOrg Admin
des Chaincodes aufgerufen werden.
-
requestMint
- Diese Methode kann von einem Minter aufgerufen werden, um eine Anforderung an den Minter Notar zu senden, um eine bestimmte Anzahl von Token zu erstellen.
-
approveMint
- Diese Methode kann von einem Minter Notar aufgerufen werden, um eine Prägeanforderung zu genehmigen.
-
rejectMint
- Diese Methode kann von einem Minter Notar aufgerufen werden, um eine Prägeanforderung abzulehnen.
-
issueTokens
- Mit dieser Methode werden Token abgebildet, die dann dem Aufrufer der Methode gehören.
-
getTotalMintedTokens
- Diese Methode gibt die Gesamtanzahl der ausgeprägten Token für ein angegebenes Token zurück. Diese Methode kann nur mit
Token Admin
,Token Auditor
,Org Admin
oderOrg Auditor
aufgerufen werden. -
getNetTokens
- Diese Methode gibt die Gesamtanzahl der Token zurück, die im System für ein angegebenes Token verfügbar sind. Die Nettotokensumme ist die Anzahl der verbleibenden Token, nachdem Token gebrannt wurden. In Gleichungsform: Nettotoken = Gesamtanzahl abgebrannter Token - Gesamtanzahl verbrannter Token. Wenn keine Token verbrannt werden, ist die Anzahl der Nettotoken gleich der Gesamtanzahl der abgebauten Token. Diese Methode kann nur mit
Token Admin
,Token Auditor
,Org Admin
oderOrg Auditor
aufgerufen werden.
Methoden für Token Behavior Management - Übertragbares Verhalten
-
transferTokens
- Mit dieser Methode werden Token vom Aufrufer an ein bestimmtes Konto übertragen. Der Aufrufer der Methode muss ein Konto haben. Die Menge muss innerhalb der Dezimalwerte liegen, die durch den Parameter
decimal
des Verhaltensdivisible
in der Spezifikationsdatei angegeben werden. Diese Methode kann nur von derAccountOwner
des Accounts aufgerufen werden. -
bulkTransferTokens
- Diese Methode überträgt Token im Massenverfahren vom aufrufenden Konto auf die Konten, die im Objekt
flow
angegeben sind. Die Mengen müssen innerhalb der Dezimalwerte liegen, die durch den Parameterdecimal
des Verhaltensdivisible
im Spezifikationsaufrufer file.The dieser Methode angegeben werden, und es muss bereits ein Konto erstellt sein. Diese Methode kann nur von derAccountOwner
des Accounts aufgerufen werden.
-
transferTokens
- Mit dieser Methode werden Token vom Aufrufer an ein bestimmtes Konto übertragen.
-
bulkTransferTokens
- Diese Methode überträgt Token im Massenverfahren vom aufrufenden Konto auf die Konten, die im Objekt
flow
angegeben sind. Die Mengen müssen innerhalb der Dezimalwerte liegen, die durch den Parameterdecimal
des Verhaltensdivisible
im Spezifikationsaufrufer file.The dieser Methode angegeben werden, und es muss bereits ein Konto erstellt sein. Diese Methode kann nur von derAccountOwner
des Accounts aufgerufen werden.
Methoden für Token Behavior Management - Holdable Behavior
-
holdTokens
- Mit dieser Methode wird eine Sperre im Namen des Eigentümers der Token mit dem Konto
to_account_id
erstellt. Es wird ein Notarkonto angegeben, das die Sperre entweder abschließen oder freigeben muss. 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 Konto erstellt sein. Diese Methode kann nur von derAccountOwner
des Accounts aufgerufen werden. -
executeHoldTokens
- Mit dieser Methode wird eine Sperre für ein Token abgeschlossen. Eine Menge von Token, die zuvor von einem Token-Eigentümer gehalten wurden, wird an einen Empfänger übertragen. Wenn der Wert
quantity
kleiner als der tatsächliche Zurückstellungswert ist, ist der verbleibende Betrag wieder für den ursprünglichen Eigentümer der Token verfügbar. Diese Methode kann nur von derAccountOwner
-ID mit der Rollenotary
für die angegebene Vorgangs-ID aufgerufen werden. Die Sperre kann nur vom Notar abgeschlossen werden. -
releaseHoldTokens
- Diese Methode gibt eine Sperre für Token frei. Die Übertragung ist nicht abgeschlossen, und alle zurückgestellten Token stehen dem ursprünglichen Eigentümer erneut zur Verfügung. Diese Methode kann durch die
AccountOwner
-ID mit der Rollenotary
innerhalb der angegebenen Frist oder durch den 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 durch eine
Token Admin
des Chaincodes, eineOrg Admin
der angegebenen Organisation oder dieAccountOwner
des Accounts aufgerufen werden. -
getOnHoldDetailsWithOperationId
- Diese Methode gibt die Details der zurückgestellten Transaktion für eine angegebene Vorgangs-ID und ein bestimmtes Token zurück. Diese Methode kann von jedem aufgerufen werden.
-
getOnHoldBalanceWithOperationId
- Diese Methode gibt den Saldo für eine bestimmte Vorgangs-ID und ein bestimmtes Token zurück. Diese Methode kann von jedem aufgerufen werden.
-
holdTokens
- Mit dieser Methode wird eine Sperre im Namen des Eigentümers der Token mit dem Konto
to_account_id
erstellt. -
executeHoldTokens
- Mit dieser Methode wird eine Sperre für ein Token abgeschlossen. Eine Menge von Token, die zuvor von einem Token-Eigentümer gehalten wurden, wird an einen Empfänger übertragen. Wenn der Wert
quantity
kleiner als der tatsächliche Zurückstellungswert ist, ist der verbleibende Betrag wieder für den ursprünglichen Eigentümer der Token verfügbar. Diese Methode kann nur von derAccountOwner
-ID mit der Rollenotary
für die angegebene Vorgangs-ID aufgerufen werden. Die Sperre kann nur vom Notar abgeschlossen werden. -
releaseHoldTokens
- Diese Methode gibt eine Sperre für Token frei. Die Übertragung ist nicht abgeschlossen, und alle zurückgestellten Token stehen dem ursprünglichen Eigentümer erneut zur Verfügung. Diese Methode kann durch die
AccountOwner
-ID mit der Rollenotary
innerhalb der angegebenen Frist oder durch den 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 durch eine
Token Admin
oderToken Auditor
des Chaincodes, eineOrg Admin
oderOrg Auditor
der angegebenen Organisation oder dieAccountOwner
des Accounts aufgerufen werden. -
getOnHoldDetailsWithOperationId
- Diese Methode gibt die Details der zurückgestellten Transaktion für eine angegebene Vorgangs-ID und ein bestimmtes Token zurück. Diese Methode kann durch eine
Token Admin
oderToken Auditor
des Chaincodes oder durch einen Transaktionsteilnehmer (Absender, Empfänger, Notar) aufgerufen werden. -
getOnHoldBalanceWithOperationId
- Diese Methode gibt den Saldo für eine bestimmte Vorgangs-ID und ein bestimmtes Token zurück. Diese Methode kann durch eine
Token Admin
oderToken Auditor
des Chaincodes oder durch einen Transaktionsteilnehmer (Absender, Empfänger, Notar) aufgerufen werden.
Methoden für Token Behavior Management - Burnable Behavior
-
burnTokens
- Mit dieser Methode werden Token aus dem Konto des Transaktionsaufrufers deaktiviert oder verbrannt. Der Aufrufer dieser Methode muss einen Account und die Burner-Rolle aufweisen. Die Menge muss innerhalb der Dezimalwerte liegen, die durch den Parameter
decimal
des Verhaltensdivisible
in der Spezifikationsdatei angegeben werden. Diese Methode kann von derAccountOwner
des Accounts mit der Burner-Rolle aufgerufen werden.
-
requestBurn
- Diese Methode kann von einem Brenner aufgerufen werden, um eine Anforderung an den Brennernotar zu senden, um eine bestimmte Anzahl von Token zu zerstören, die kleiner oder gleich dem verfügbaren Saldo sein müssen. Wenn eine Burn-Anforderung beginnt, wird der angegebene Betrag sofort vom verfügbaren Saldo abgezogen und dem Feld
onhold_burn_balance
hinzugefügt. Wenn der Antrag genehmigt wird, werden die Token verbrannt. Wenn die Anforderung abgelehnt wird, werden die Token aus dem Feldonhold_burn_balance
an den verfügbaren Saldo zurückgegeben. -
approveBurn
- Diese Methode kann von einem Brennernotar aufgerufen werden, um eine Brennanforderung zu genehmigen.
-
rejectBurn
- Diese Methode kann von einem Brennernotar aufgerufen werden, um eine Brennanforderung abzulehnen.
-
getAccountOnHoldBurnBalance
- Diese Methode gibt den gesperrten Burn-Balance für einen angegebenen Benutzer zurück. Diese Methode kann nur von
Token Admin
,Token Auditor
,Org Admin
,Org Auditor
oder vom Accounteigentümer aufgerufen werden. -
burnTokens
- Mit dieser Methode werden Token aus dem Konto des Transaktionsaufrufers deaktiviert oder verbrannt.
Benutzerdefinierte Methoden
Mit den Token-SDK-Methoden können Sie benutzerdefinierte Methoden für Ihre Geschäftsanwendung schreiben.
Um Doppelausgaben zu vermeiden, sollten Sie nicht mehrere asynchrone Funktionen kombinieren, die mit denselben Schlüssel/Wert-Paaren in der Statusdatenbank arbeiten. Verwenden Sie stattdessen die Methode bulkTransferTokens
, um mehrere Übertragungen in einer Methode vorzunehmen.
Im folgenden Beispiel wird gezeigt, 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 mehrere Token-SDK-Methoden in einer benutzerdefinierten Methode verwenden, verwenden Sie keine Methoden, die sich auf dieselben Schlüssel/Wert-Paare in der Statusdatenbank auswirken. Das folgende Beispiel zeigt, wie mehrere Transfers falsch durchgeführt werden können:
@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 von dem Konto des Aufrufers aus auf mehrere Konten zu übertragen, wie im folgenden Code-Snippet dargestellt.
bulkTransferTokens(token_id: string, flow: object[])
Hinweis:
Wenn Sie mehrere Token-SDK-Methoden in einer benutzerdefinierten Methode 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
- Transaktionshistorienmanagement
- Tokenverhaltensverwaltung
Methoden für die Zugriffskontrollverwaltung
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. Unbefugter 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 Admin
des Token-Chaincodes hinzu. -
removeAdmin
- Mit dieser Methode wird ein Benutzer als
Token Admin
des Token-Chaincodes entfernt. -
isUserTokenAdmin
- Diese Methode gibt den booleschen Wert
true
zurück, wenn der Aufrufer der Funktion einToken Admin
ist. Andernfalls gibt die Methodefalse
zurück. -
getAllAdmins
- Diese Methode gibt eine Liste aller Benutzer zurück, die eine
Token Admin
des Token-Chaincodes sind. -
checkAuthorization
- Mit dieser Methode können Sie einem Vorgang eine Zugriffskontrollprüfung hinzufügen. Bestimmte Tokenmethoden können nur von einer
Token Admin
oderAccountOwner
des Tokens oder vonMultipleAccountOwner
für Benutzer mit mehreren Accounts ausgeführt werden. Die Zuordnung der Zugriffskontrolle wird in der Datei../lib/constant.ts
beschrieben. Sie können die Zugriffskontrolle ändern, indem Sie die Datei../lib/constant.ts
bearbeiten. Um Ihre eigene Zugriffskontrolle zu verwenden oder die Zugriffskontrolle zu deaktivieren, entfernen Sie den Zugriffskontrollcode aus den automatisch generierten Controller-Methoden 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"], }, }
-
addOrgAdmin
- Diese Methode fügt einen Benutzer als
Org Admin
der Organisation hinzu. -
removeOrgAdmin
- Mit dieser Methode wird ein Benutzer als
Org Admin
der Organisation entfernt. -
getOrgAdmins
- Diese Methode gibt eine Liste aller Benutzer zurück, die eine
Org Admin
einer Organisation sind.
-
addAdmin
- Diese Methode fügt einen Benutzer als
Token Admin
des Token-Chaincodes hinzu. -
removeAdmin
- Mit dieser Methode wird ein Benutzer als
Token Admin
des Token-Chaincodes entfernt. -
isUserTokenAdmin
- Diese Methode gibt den booleschen Wert
true
zurück, wenn der Aufrufer der Funktion einToken Admin
ist. Andernfalls gibt die Methodefalse
zurück. -
getAllAdmins
- Diese Methode gibt eine Liste aller Benutzer zurück, die eine
Token Admin
des Token-Chaincodes sind. -
checkAuthorization
- Mit dieser Methode können Sie einem Vorgang eine Zugriffskontrollprüfung hinzufügen. Bestimmte Tokenmethoden können nur von einer
Token Admin
oderAccountOwner
des Tokens oder vonMultipleAccountOwner
für Benutzer mit mehreren Accounts ausgeführt werden. Die Zuordnung der Zugriffskontrolle wird in der Datei../lib/constant.ts
beschrieben. Sie können die Zugriffskontrolle ändern, indem Sie die Datei../lib/constant.ts
bearbeiten. Um Ihre eigene Zugriffskontrolle zu verwenden oder die Zugriffskontrolle zu deaktivieren, entfernen Sie den Zugriffskontrollcode aus den automatisch generierten Controller-Methoden 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"], }, }
-
addOrgAdmin
- Diese Methode fügt einen Benutzer als
Org Admin
der Organisation hinzu. -
removeOrgAdmin
- Mit dieser Methode wird ein Benutzer als
Org Admin
der Organisation entfernt. -
getOrgAdmins
- Diese Methode gibt eine Liste aller Benutzer zurück, die eine
Org Admin
einer Organisation sind. -
addTokenAuditor
- Diese Methode fügt einen Benutzer als
Token Auditor
des Chaincodes hinzu. -
removeTokenAuditor
- Mit dieser Methode wird ein Benutzer als
Token Auditor
des Chaincodes entfernt. -
getTokenAuditors
- Diese Methode gibt alle
Token Auditors
des Chaincodes zurück. -
addOrgAuditor
- Diese Methode fügt einen Benutzer als
Org Auditor
des Chaincodes hinzu. -
removeOrgAuditor
- Mit dieser Methode wird ein Benutzer als
Org Auditor
des Chaincodes entfernt. -
getOrgAuditors
- Diese Methode gibt alle
Org Auditors
des Chaincodes zurück.
Methoden für die Verwaltung der Tokenkonfiguration
-
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_desc
und die zugehörigen benutzerdefinierten Eigenschaften. -
getTokenDecimals
- Diese Methode gibt die Anzahl der Dezimalstellen zurück, die für ein Bruchteil-Token verfügbar sind. Wenn das Verhalten
divisible
nicht angegeben ist, ist der Standardwert 0. -
get
- Diese Methode gibt ein Tokenobjekt zurück, wenn es in der Statusdatenbank vorhanden ist.
-
history
- Diese Methode gibt die Historie für das angegebene Token zurück.
-
getAllTokens
- Diese Methode gibt alle Tokenassets zurück, die in der Statusdatenbank gespeichert sind. Diese Methode verwendet SQL-reiche Berkeley DB-Abfragen und kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Oracle Blockchain Platform-Netzwerk besteht.
-
getTokensByName
- Diese Methode gibt alle Tokenassets mit dem angegebenen Namen zurück. Diese Methode verwendet SQL-reiche Berkeley DB-Abfragen und kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Oracle Blockchain Platform-Netzwerk besteht.
-
isTokenType
- Diese Methode gibt an, ob ein Tokenasset mit der angegebenen ID vorhanden ist.
-
getByRange
- Diese Methode ruft die
getStateByRange
-Methode der Struktur intern auf. Auch wenn ein Vermögensgegenstand mit der angegebenen ID vom Buch zurückgegeben wird, wirft diese Methode den Vermögensgegenstand in den aufrufenden Vermögensgegenstandstyp um.
Methoden für die Kontenverwaltung
-
getCallerAccountId
- Diese Methode gibt die Konto-ID des Aufrufers zurück.
-
generateAccountId
- Diese Methode gibt eine Account-ID zurück, bei der es sich um eine alphanumerische Gruppe von Zeichen mit dem Präfix
oaccount~<token asset name>~
handelt, 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 Mitgliedsdienstanbieter-ID (org_id
) des Benutzers in der aktuellen Netzwerkorganisation und der eindeutigen Token-ID (token_id
). -
createAccount
- Mit dieser Methode wird ein Account für einen angegebenen Benutzer und ein bestimmtes Token erstellt. Jeder Benutzer, der zu einem beliebigen Zeitpunkt Token hat, muss über ein Konto verfügen. Konten verfolgen den Saldo eines Benutzers, den Sperrsaldo und die Transaktionshistorie. Eine Account-ID ist eine alphanumerische Gruppe von Zeichen 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 durch dieToken Admin
des Chaincodes oder durch eineOrg Admin
der angegebenen Organisation aufgerufen werden. -
associateTokenToAccount
- Diese Methode verknüpft ein fungibles Token mit einem Konto. Diese Methode kann nur durch eine
Token Admin
des Chaincodes oder durch eineOrg Admin
der relevanten Organisation aufgerufen werden. -
getAccountWithStatus
- Diese Methode gibt Kontodetails für ein angegebenes 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 einbehaltenen Saldo für ein angegebenes Konto zurück.
-
getAllAccounts
- Diese Methode gibt eine Liste aller Konten zurück. Diese Methode verwendet SQL-reiche Berkeley DB-Abfragen und kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Oracle Blockchain Platform-Netzwerk besteht.
-
getUserByAccountId
- Diese Methode gibt die Benutzerdetails für einen angegebenen Account zurück.
-
getAccountBalance
- Diese Methode gibt den Kontensaldo für ein angegebenes Konto zurück.
-
getAllOrgAccounts
- Diese Methode gibt eine Liste aller Token-Accounts zurück, die zu einer bestimmten Organisation gehören.
Methoden für die Rollenverwaltung
-
addRoleMember
- Diese Methode fügt einem angegebenen Benutzer und Token eine Rolle hinzu.
-
removeRoleMember
- Mit dieser Methode wird eine Rolle aus einem angegebenen Benutzer und Token entfernt.
-
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 eine bestimmte Rolle haben.
-
getOrgAccountsByRole
- Diese Methode gibt Informationen zu allen Konten zurück, die eine bestimmte Rolle in einer bestimmten Organisation haben.
-
getOrgUsersByRole
- Diese Methode gibt Informationen zu allen Benutzern zurück, die eine bestimmte Rolle in einer bestimmten Organisation haben.
-
roleCheck
- Diese Methode prüft, ob die angegebene Konto-ID Mitglied einer Rolle ist.
Methoden für Transaktionshistorienmanagement
-
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.
-
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.
Tokenverhaltensverwaltung
Token
aus dem Modul ../lib/token
.
import { Token } from '../lib/token';
Methoden für die Verwaltung des Tokenverhaltens - Mintable-Verhalten
-
mint
- Diese Methode prägt eine Anzahl von Token, die dann dem Aufrufer der Methode gehören. Der Anrufer muss über ein Konto und die Nebenrolle verfügen. Die Menge muss innerhalb der Dezimalwerte liegen, die durch den Parameter
decimal
des Verhaltensdivisible
in der Spezifikationsdatei angegeben werden. -
getTotalMintedTokens
- Diese Methode gibt die Gesamtanzahl der eingeprägten Token zurück.
-
getNetTokens
- Diese Methode gibt die Nettomenge der Token zurück, die im System verfügbar sind. Die Nettotoken sind die Anzahl der Token, die nach dem Verbrennen von Token übrig bleiben. In Gleichungsform: Nettotoken = Gesamtanzahl abgebrannter Token - Gesamtanzahl verbrannter Token. Wenn keine Token verbrannt werden, ist die Anzahl der Nettotoken gleich der Gesamtanzahl der abgebauten Token.
-
getMaxMintQuantity
- Diese Methode gibt die maximale mintable-Menge für ein Token zurück. Wenn das Verhalten
max_mint_quantity
nicht angegeben ist, ist der Standardwert 0, wodurch eine beliebige Anzahl von Token geprägt werden kann.
Methoden für Token Behavior Management - Übertragbares Verhalten
-
transfer
- Bei dieser Methode werden Token vom Transaktionsaufrufer an das Konto
to_account_id
übertragen. Der Aufrufer dieser Methode muss ein Konto haben, und die Menge muss innerhalb der Dezimalwerte liegen, die durch den Parameterdecimal
des Verhaltensdivisible
in der Spezifikationsdatei angegeben werden. -
bulkTransfer
- Diese Methode überträgt Token im Massenverfahren vom aufrufenden Konto auf die Konten, die im Objekt
flow
angegeben sind. Für den Aufrufer dieser Methode muss bereits ein Konto erstellt sein.
Methoden für Token Behavior Management - Holdable Behavior
-
hold
- Mit dieser Methode wird eine Sperre im Namen des Eigentümers der Token mit dem Konto
to_account_id
erstellt. Es wird ein Notarkonto angegeben, das die Sperre entweder abschließen oder freigeben muss. 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 Konto erstellt sein. -
executeHold
- Diese Methode schließt eine Sperre von Token ab und überträgt die angegebene Menge von Token, die zuvor zurückgestellt wurden, an den Empfänger. Wenn der Wert
quantity
kleiner als der tatsächliche Zurückstellungswert ist, ist der verbleibende Betrag wieder für den ursprünglichen Eigentümer der Token verfügbar. Diese Methode kann nur von derAccountOwner
-ID mit der Rollenotary
für die angegebene Vorgangs-ID aufgerufen werden. Die Sperre kann nur vom Notar abgeschlossen werden. -
releaseHold
- Diese Methode gibt eine Sperre für Token frei. Die Übertragung ist nicht abgeschlossen, und alle zurückgestellten Token stehen dem ursprünglichen Eigentümer erneut zur Verfügung. Diese Methode kann durch die
AccountOwner
-ID mit der Rollenotary
innerhalb der angegebenen Frist oder durch den 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 Details der zurückgestellten Transaktion für eine angegebene Vorgangs-ID und ein bestimmtes Token zurück.
-
getOnHoldBalanceWithOperationId
- Diese Methode gibt den Saldo für eine bestimmte Vorgangs-ID und ein bestimmtes Token zurück. Diese Methode kann von jedem aufgerufen werden.
Methoden für Token Behavior Management - Burnable Behavior
-
burn
- Mit dieser Methode werden Token aus dem Konto des Transaktionsaufrufers deaktiviert oder verbrannt. Der Aufrufer dieser Methode muss einen Account und die Burner-Rolle aufweisen. Die Menge muss innerhalb der Dezimalwerte liegen, die durch den Parameter
decimal
des Verhaltensdivisible
in der Spezifikationsdatei angegeben werden.