Überblick Token-Ressourcen
Grundlegendes zur Erstellung von Token und zum Abrufen von Guthaben innerhalb der OmniSafe API.
Dieses Dokument erläutert, wie Sie Token erstellen und Guthaben innerhalb der OmniSafe API abrufen können.
Erstellen eines Tokens und Prägen des anfänglichen Angebots
Verwenden Sie den Endpunkt POST /v1/tokens
, um einen neuen Token zu erstellen und ein anfängliches Angebot an eine bestimmte Eigentümeradresse zu prägen.
- Endpunkt:
POST /v1/tokens
- API-Referenz zum Erstellen und Prägen von Token - Zusammenfassung: Erstellen Sie einen Token und prägen Sie ihn.
- Beschreibung: Erstellt einen neuen Token und prägt ein anfängliches Angebot an eine bestimmte Eigentümeradresse. OmniSafe wickelt die notwendigen Blockchain-Interaktionen ab, um den Token zu registrieren und die anfänglichen Token dem Eigentümer auf der Blockchain zuzuweisen.
Anfragetext:
Der Anfragetext sollte dem TokenMintDto
-Schema entsprechen (definiert in der OpenAPI-Spezifikation). Er enthält typischerweise:
symbol
: Das Symbol des Tokens (z. B. “MEINTOKEN”).name
: Der Name des Tokens (z. B. “Mein Token”).decimals
: Die Anzahl der Dezimalstellen für den Token (z. B. 18).initialQuantity
: Die anfängliche Menge der zu prägenden Token.ownerAddress
: Die Wallet-Adresse, an die das anfängliche Angebot an Token gehen soll.
Antwort:
201 Erstellt
: Gibt die erstellte Token-Adresse zurück (als Klartext). Beispiel:"0x1234567890abcdef..."
Wichtige Hinweise:
- Token-Standards: OmniSafe wickelt die zugrunde liegenden Blockchain-Interaktionen ab. Stellen Sie sicher, dass die von Ihnen angegebenen Parameter mit den unterstützten Token-Standards kompatibel sind.
- Eigentümeradresse: Die
ownerAddress
muss eine gültige Wallet-Adresse innerhalb des OmniSafe-Systems sein. - Asynchrone Erstellung: Die Token-Erstellung kann asynchrone Blockchain-Operationen beinhalten. Es wird empfohlen, den Status des Tokens mithilfe einer separaten API (falls implementiert) zu überprüfen oder die Token-Erstellungstransaktion in Blockchain-Explorern zu überwachen.
Abrufen des Token-Guthabens
Verwenden Sie den Endpunkt GET /v1/tokens/{token-address}/{owner}
, um das Token/ETH-Guthaben für eine bestimmte Wallet-Adresse abzurufen.
- Endpunkt:
GET /v1/tokens/{token-address}/{owner}
- API-Referenz zum Abrufen des Guthabens - Zusammenfassung: Guthaben abrufen.
- Beschreibung: Ruft das Token-Guthaben für eine bestimmte Wallet-Adresse in der Blockchain ab.
Parameter:
token-address
(Pfadparameter, erforderlich): Die Adresse des Tokens, die Sie von der Antwort aufPOST /v1/tokens
erhalten haben.owner
(Pfadparameter, erforderlich): Die Adresse der Wallet, für die Sie das Guthaben abrufen möchten.
Antwort:
200 OK
: Gibt das Wallet-Guthaben zurück (als Zahl). Beispiel:1000
Wichtige Hinweise:
- Token-Adresse: Die
token-address
muss eine gültige Token-Adresse sein, die zuvor über den EndpunktPOST /v1/tokens
erstellt wurde. - Eigentümeradresse: Die
owner
-Adresse muss eine gültige Wallet-Adresse innerhalb des OmniSafe-Systems sein.