Échafaudé TypeScript Projet NFT pour ERC-721
Blockchain App Builder prend l'entrée de votre fichier de spécification NFT et génère un projet de code chaîne entièrement fonctionnel.
Le projet génère automatiquement des classes de cycle de vie et des fonctions NFT, y compris des méthodes CRUD et non-CRUD, ainsi qu'un SDK de tokenisation. La validation des arguments, la sérialisation/désérialisation et la capacité de persistance transparente sont toutes prises en charge automatiquement.
Pour plus d'informations sur le projet échafaudé et les méthodes qui ne sont pas directement liées aux NFT, reportez-vous à Projet de code chaîne TypeScript échafaudé.
Modèle
Chaque classe de modèle avec jeton étend la classe OchainModel
. La capacité de persistance transparente, ou ORM simplifié, est capturée dans la classe OchainModel
.
import * as yup from 'yup';
import { Id, Mandatory, Validate, Default, Embedded, Derived, ReadOnly } from '../../lib/decorators';
import { OchainModel } from '../../lib/ochain-model';
import { STRATEGY } from '../../lib/utils';
import { EmbeddedModel } from '../../lib/ochain-embedded-model';
export class ArtCollectionMetadata extends EmbeddedModel<ArtCollectionMetadata> {
@Validate(yup.string())
public painting_name: string;
@Validate(yup.string())
public description: string;
@Validate(yup.string())
public image: string;
@Validate(yup.string())
public painter_name: string;
}
@Id('tokenId')
export class ArtCollection extends OchainModel<ArtCollection> {
public readonly assetType = 'otoken';
@Mandatory()
@Validate(yup.string().required().matches(/^[A-Za-z0-9][A-Za-z0-9_-]*$/).max(16))
public tokenId: string;
@ReadOnly('artcollection')
public tokenName: string;
@Validate(yup.string().trim().max(256))
public tokenDesc: string;
@ReadOnly('ART')
public symbol: string;
@ReadOnly('erc721+')
public tokenStandard: string;
@ReadOnly('nonfungible')
public tokenType: string;
@ReadOnly('whole')
public tokenUnit: string;
@ReadOnly(["indivisible","singleton","mintable","transferable","burnable","roles"])
public behaviors: string[];
@ReadOnly({minter_role_name: "minter"})
public roles: object;
@ReadOnly({max_mint_quantity: 20000})
public mintable: object;
@Validate(yup.string())
public owner: string;
@Validate(yup.string())
public createdBy: string;
@Validate(yup.string())
public transferredBy: string;
@Validate(yup.string())
public creationDate: string;
@Validate(yup.string())
public transferredDate: string;
@Validate(yup.bool())
public isBurned: boolean;
@Validate(yup.string())
public burnedBy: string;
@Validate(yup.string())
public burnedDate: string;
@Validate(yup.string().max(2000))
public tokenUri: string;
@Embedded(ArtCollectionMetadata)
public metadata: ArtCollectionMetadata;
@Validate(yup.number())
public price: number;
@Validate(yup.boolean())
public on_sale_flag: boolean;
}
Contrôleur
La classe de contrôleur principale étend la classe OchainController
. Il n'y a qu'un seul contrôleur principal.
export class DigiCurrCCController extends OchainController{
Vous pouvez créer autant de classes, de fonctions ou de fichiers que vous le souhaitez, mais seules les méthodes définies dans la classe de contrôleur principale peuvent être appelées. Les autres méthodes sont masquées.
Vous pouvez utiliser les méthodes SDK de jeton pour écrire des méthodes personnalisées pour votre application métier.
Méthodes NFT générées automatiquement
Blockchain App Builder génère automatiquement des méthodes pour prendre en charge les NFT et les cycles de vie NFT. Vous pouvez utiliser ces méthodes pour initialiser les NFT, gérer les rôles et les comptes et effectuer d'autres tâches de cycle de vie NFT sans codage supplémentaire. Les méthodes de contrôleur doivent avoir un décorateur @Validator(...params)
pour pouvoir être appelées.
- Gestion des contrôles d'accès
- Gestion de la configuration des jetons
- Gestion des comptes
- Gestion des rôles
- Gestion de l'historique des transactions
- Gestion du comportement des jetons
Méthodes de gestion du contrôle d'accès
-
addTokenAdmin
- Cette méthode ajoute un utilisateur en tant qu'utilisateur
Token Admin
du code chaîne. Cette méthode ne peut être appelée que par un élémentToken Admin
du code chaîne. -
removeTokenAdmin
- Cette méthode enlève un utilisateur en tant qu'utilisateur
Token Admin
du code chaîne. Cette méthode ne peut être appelée que par un élémentToken Admin
du code chaîne. -
isTokenAdmin
- Cette méthode renvoie la valeur booléenne
true
si l'appelant de la fonction est unToken Admin
, sinon elle renvoiefalse
. UnToken Admin
peut appeler cette fonction sur n'importe quel autre utilisateur du réseau de chaîne de blocs. D'autres utilisateurs ne peuvent appeler cette méthode que sur leurs propres comptes. -
getAllTokenAdmins
- Cette méthode renvoie la liste de tous les utilisateurs qui sont un
Token Admin
du code chaîne. Cette méthode ne peut être appelée que parToken Admin
du code chaîne.
Méthodes de gestion de la configuration de jeton
-
init
- Cette méthode est appelée lorsque le code chaîne est instancié. Chaque élément
Token Admin
est identifié par les informationsuserId
etorgId
dans le paramètreadminList
.userId
est le nom utilisateur ou l'ID courriel du propriétaire de l'instance ou de l'utilisateur connecté à l'instance.orgId
est l'ID du fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation réseau actuelle. Le paramètreadminList
est obligatoire lors du premier déploiement du code chaîne. Si vous mettez à niveau le code chaîne, transmettez une liste vide ([]
). Toutes les autres informations du paramètreadminList
sont ignorées lors des mises à niveau. -
getAllTokens
- Cette méthode renvoie toutes les ressources de jeton enregistrées dans la base de données d'état. Cette méthode ne peut être appelée que par un élément
Token Admin
du code chaîne. Cette méthode utilise des requêtes Berkeley DB SQL riches et ne peut être appelée qu'en cas de connexion au réseau Oracle Blockchain Platform distant. -
getAllTokensByUser
- Cette méthode renvoie toutes les ressources de jeton appartenant à un utilisateur spécifié. Cette méthode utilise des requêtes Berkeley DB SQL riches et ne peut être appelée qu'en cas de connexion au réseau Oracle Blockchain Platform distant. Cette méthode peut uniquement être appelée par un élément
Token Admin
du code chaîne ou par le propriétaire du compte. -
getTokenById
- Cette méthode renvoie un objet de jeton si le jeton est présent dans la base de données d'état. Cette méthode ne peut être appelée que par un élément
Token Admin
du code chaîne ou du propriétaire du jeton. -
getTokenHistory
- Cette méthode renvoie l'historique d'un ID de jeton spécifié. Il s'agit d'une méthode asynchrone. Cette méthode ne peut être appelée qu'en cas de connexion au réseau Oracle Blockchain Platform distant. Tout le monde peut appeler cette méthode.
-
getTokenObject
- Il s'agit d'une méthode utilitaire qui renvoie une instance du jeton pour un ID de jeton spécifié. Cette méthode est utilisée par la plupart des méthodes générées automatiquement pour extraire les objets de jeton. Vous pouvez appeler cette méthode selon vos besoins à partir de vos méthodes personnalisées. Lorsque vous créez une classe ou une ressource avec jeton, mettez à jour la casse du commutateur avec la classe
Token
correspondante pour renvoyer l'objet de jeton correct. La commandeochain sync
dans Blockchain App Builder crée automatiquement un cas de commutateur lorsqu'une ressource avec jeton est créée dans le fichier de spécification. Cette méthode n'a pas de décorateur de méthode@Validator()
, ce qui signifie que cette méthode n'est pas directement invocable et ne peut être appelée qu'à partir d'autres méthodes. -
ownerOf
- Cette méthode renvoie l'ID de compte du propriétaire de l'ID de jeton spécifié. Tout le monde peut appeler cette méthode.
-
name
- Cette méthode renvoie le nom de la classe de jeton. Tout le monde peut appeler cette méthode.
-
symbol
- Cette méthode renvoie le symbole de la classe de jeton. Tout le monde peut appeler cette méthode.
-
tokenURI
- Cette méthode renvoie l'URI d'un jeton spécifié. Tout le monde peut appeler cette méthode.
-
totalSupply
- Cette méthode renvoie le nombre total de jetons extraits. Cette méthode ne peut être appelée que par un élément
Token Admin
du code chaîne. -
totalNetSupply
- Cette méthode renvoie le nombre total de jetons frappés moins le nombre de jetons brûlés. Cette méthode ne peut être appelée que par un élément
Token Admin
du code chaîne.
Méthodes de gestion des comptes
-
createAccount
- Cette méthode crée un compte pour un utilisateur et un jeton spécifiés. Un compte doit être créé pour tout utilisateur qui aura des jetons à tout moment. Les comptes suivent le nombre de NFT dont dispose un utilisateur. Les utilisateurs doivent disposer de comptes sur le réseau pour effectuer les opérations liées aux jetons. Vous ne pouvez créer qu'un seul compte NFT par utilisateur.
Un ID de compte est un ensemble alphanumérique de caractères, préfixé par
oaccount~
et suivi d'un hachage SHA-256 de l'ID de fournisseur de services d'appartenance (orgId
) de l'utilisateur dans l'organisation réseau en cours, du nom utilisateur ou de l'ID de courriel (userId
) du propriétaire de l'instance ou de l'utilisateur connecté à l'instance, et de la chaîne constantenft
. Cette méthode ne peut être appelée que parToken Admin
du code chaîne. -
balanceOf
- Cette méthode renvoie le nombre total de NFT détenus par un utilisateur spécifié. Cette méthode peut uniquement être appelée par un élément
Token Admin
du code chaîne ou par le propriétaire du compte. -
getAllAccounts
- Cette méthode renvoie la liste de tous les comptes. Cette méthode ne peut être appelée que par un élément
Token Admin
du code chaîne. Cette méthode utilise des requêtes Berkeley DB SQL riches et ne peut être appelée qu'en cas de connexion au réseau Oracle Blockchain Platform distant. -
getAccountByUser
- Cette méthode renvoie les détails du compte d'un utilisateur spécifié. Cette méthode peut uniquement être appelée par
Token Admin
du code chaîne ou parAccount Owner
du compte. -
getUserByAccountId
- Cette méthode renvoie les détails utilisateur d'un compte spécifié. Cette méthode peut être appelée par n'importe quel utilisateur.
-
getAccountHistory
- Cette méthode renvoie l'historique des comptes d'un utilisateur spécifié. Il s'agit d'une méthode asynchrone. Cette méthode peut uniquement être appelée par l'élément
Token Admin
du code chaîne ou par le propriétaire du compte.
Méthodes de gestion des rôles
-
addRole
- Cette méthode ajoute un rôle à un utilisateur spécifié. Cette méthode ne peut être appelée que par un élément
Token Admin
du code chaîne. -
removeRole
- Cette méthode supprime un rôle d'un utilisateur spécifié. Cette méthode ne peut être appelée que par un élément
Token Admin
du code chaîne. -
getAccountsByRole
- Cette méthode renvoie la liste de tous les ID de compte pour un rôle spécifié. Cette méthode ne peut être appelée que par un élément
Token Admin
du code chaîne. -
getUsersByRole
- Cette méthode renvoie la liste de tous les utilisateurs pour un rôle spécifié. Cette méthode ne peut être appelée que par un élément
Token Admin
du code chaîne. -
isInRole
- Cette méthode renvoie une valeur booléenne pour indiquer si un utilisateur a un rôle spécifié. Cette méthode peut uniquement être appelée par
Token Admin
du code chaîne ou parAccount Owner
du compte.
Méthodes de gestion de l'historique des transactions
-
getAccountTransactionHistory
- Cette méthode renvoie l'historique des transactions de compte pour un utilisateur spécifié. Il s'agit d'une méthode asynchrone. Cette méthode peut uniquement être appelée par l'élément
Token Admin
du code chaîne ou par le propriétaire du compte. -
getAccountTransactionHistoryWithFilters
- Cette méthode renvoie l'historique des transactions de compte pour un utilisateur spécifié, filtré par
PageSize
,Bookmark
,startTime
etendTime
. Il s'agit d'une méthode asynchrone. Cette méthode ne peut être appelée qu'en cas de connexion au réseau Oracle Blockchain Platform distant. Cette méthode peut uniquement être appelée par l'élémentToken Admin
du code chaîne ou par le propriétaire du compte. -
getTransactionById
- Cette méthode renvoie l'historique des transactions pour un ID de transaction spécifié. Il s'agit d'une méthode asynchrone. Cette méthode peut uniquement être appelée par un élément
Token Admin
du code chaîne ou par le propriétaire du compte. -
deleteHistoricalTransactions
- Cette méthode supprime les transactions antérieures à un horodatage spécifié dans la base de données d'état. Il s'agit d'une méthode asynchrone. Cette méthode ne peut être appelée que par un élément
Token Admin
du code chaîne.
Méthodes de gestion du comportement des jetons - Comportement Mintable
-
create<Token Name>Token
- Cette méthode crée un NFT. La ressource et les propriétés associées sont enregistrées dans la base de données d'état. L'appelant de cette transaction doit avoir un compte de jeton. L'appelant de cette transaction devient le propriétaire de la NFT. Si le fichier de spécification de jeton inclut la section
roles
pourbehaviors
et la propriétéminter_role_name
pourroles
, l'appelant de la transaction doit avoir le rôle minter. Sinon, tout appelant peut effectuer des opérations NFT. -
update<Token Name>Token
- Cette méthode met à jour les propriétés de jeton. Cette méthode ne peut être appelée que par l'utilisateur propriétaire ou créateur du jeton. Après la création d'une ressource de jeton, seul le propriétaire du jeton peut mettre à jour les propriétés personnalisées du jeton. Si l'utilisateur est à la fois propriétaire et créateur d'un jeton, il peut également mettre à jour la propriété
TokenDesc
. Les métadonnées de jeton ne peuvent pas être mises à jour. Vous devez transmettre toutes les propriétés de jeton à cette méthode, même si vous souhaitez mettre à jour uniquement certaines propriétés.
Méthodes de gestion du comportement des jetons - Comportement transférable
-
safeTransferFrom
- Il s'agit d'une fonction asynchrone. Cette méthode transfère la propriété de la NFT spécifiée de l'appelant vers un autre compte. Cette méthode inclut les validations suivantes :
- Le jeton existe et n'est pas gravé.
- Le compte expéditeur et le compte destinataire existent et ne sont pas identiques.
- Le compte expéditeur est propriétaire du jeton.
- L'appelant de la fonction est l'expéditeur.
-
transferFrom
- Il s'agit d'une fonction asynchrone. Cette méthode transfère la propriété de la NFT spécifiée d'un compte expéditeur vers un compte destinataire. Il est de la responsabilité de l'appelant de transmettre les paramètres corrects. Cette méthode peut être appelée par n'importe quel utilisateur, pas seulement par le propriétaire du jeton. Cette méthode inclut les validations suivantes :
- Le jeton existe et n'est pas gravé.
- Le compte expéditeur et le compte destinataire existent et ne sont pas identiques.
- Le compte expéditeur est propriétaire du jeton.
Méthodes de gestion du comportement des jetons - Comportement gravable
-
burn
- Cette méthode désactive ou brûle le NFT spécifié à partir du compte de l'appelant. L'appelant de cette méthode doit avoir un compte. Un jeton ne peut pas être gravé sauf si le fichier de spécification de jeton inclut le comportement
burnable
. Si aucune propriétéburner_role_name
n'est indiquée dans la sectionroles
du fichier de spécification, le propriétaire du jeton peut graver le jeton. Si une propriétéburner_role_name
est indiquée dans la sectionroles
, l'utilisateur qui a affecté le rôle de brûleur, qui est également le mineurs (créateur) ou le propriétaire du jeton, peut graver le jeton. -
burnNFT
- Cette méthode désactive ou brûle le NFT spécifié à partir du compte de l'appelant, et renvoie un objet de jeton et un historique de jeton. L'appelant de cette méthode doit avoir un compte. Un jeton ne peut pas être gravé sauf si le fichier de spécification de jeton inclut le comportement
burnable
. Si aucune propriétéburner_role_name
n'est indiquée dans la sectionroles
du fichier de spécification, le propriétaire du jeton peut graver le jeton. Si une propriétéburner_role_name
est indiquée dans la sectionroles
, l'utilisateur qui a affecté le rôle de brûleur, qui est également le mineurs (créateur) ou le propriétaire du jeton, peut graver le jeton.
Méthodes personnalisées
Vous pouvez utiliser les méthodes SDK de jeton pour écrire des méthodes personnalisées pour votre application métier.
L'exemple suivant montre comment utiliser des méthodes SDK de jeton dans des méthodes personnalisées. Lorsque la méthode sell
est appelée, elle envoie un jeton à la vente pour un prix spécifié.
@Validator(yup.string(), yup.number())
public async sell(token_id: string, selling_price: number) {
try {
const token = await this.Ctx.ERC721Token.get(token_id);
const t = new ArtCollection(token)
/** * price is a custom asset
attribute to set the price of a non-fungible token in the
marketplace */
t.price = selling_price;
/** * on_sale_flag is a
custom asset attribute that maintains non-fungible token selling status in the
marketplace */
t.on_sale_flag = true;
await this.Ctx.ERC721Token.updateToken(t);
let msg = `Token ID : '${token_id}' has been posted for selling in the marketplace'`;
return {msg}
} catch(error) {
throw new Error(error.message);
}
}
Méthodes SDK NFT
- Gestion des contrôles d'accès
- Gestion de la configuration des jetons
- Gestion des comptes
- Gestion des rôles
- Gestion de l'historique des transactions
- Gestion du comportement des jetons
Méthodes de gestion du contrôle d'accès
Token Admin
ou Account Owner
du jeton. Vous pouvez utiliser cette fonctionnalité pour vous assurer que les opérations sont effectuées uniquement par les utilisateurs prévus. Tout accès non autorisé entraîne une erreur. Pour utiliser la fonction de contrôle d'accès, importez la classe Authorization
à partir du module ../lib/erc721-auth
.import { ERC721Authorization } from '../lib/erc721-auth';
-
checkAuthorization
- Utilisez cette méthode pour ajouter une vérification de contrôle d'accès à une opération. Il s'agit d'une fonction asynchrone. La plupart des méthodes générées automatiquement incluent le contrôle d'accès. Certaines méthodes de jeton ne peuvent être exécutées que par le paramètre
ERC721Admin
ouAccount Owner
du jeton ou par le paramètreMultipleAccountOwner
pour les utilisateurs ayant plusieurs comptes. La méthodecheckAuthorization
fait partie de la classeAuthorization
, à laquelle vous accédez via l'objetCtx
. Le mapping de contrôle d'accès est décrit dans le fichier../lib/constant.ts
, comme indiqué dans le texte suivant. Vous pouvez modifier le contrôle d'accès en modifiant le fichier../lib/constant.ts
. Pour utiliser votre propre contrôle d'accès ou pour désactiver le contrôle d'accès, supprimez le code de contrôle d'accès des méthodes de contrôleur et des méthodes personnalisées générées automatiquement.export const TOKENACCESS = { ADMIN: { isUserTokenAdmin: ['Admin', 'MultipleAccountOwner'], addAdmin: ['Admin'], removeAdmin: ['Admin'], getAllAdmins: ['Admin'], }, TOKEN: { save: ['Admin'], getAllTokens: ['Admin'], get: ['Admin'], update: ['Admin'], getDecimals: ['Admin'], getTokensByName: ['Admin'], addRoleMember: ['Admin'], removeRoleMember: ['Admin'], isInRole: ['Admin', 'AccountOwner'], getTotalMintedTokens: ['Admin'], getNetTokens: ['Admin'], }, ROLE: { getAccountsByRole: ['Admin'], getUsersByRole: ['Admin'], }, TRANSACTION: { deleteTransactions: ['Admin'], }, ACCOUNT: { createAccount: ['Admin'], getAllAccounts: ['Admin'], getAccountsByUser: ['Admin', 'MultipleAccountOwner'], getAccount: ['Admin', 'AccountOwner'], history: ['Admin', 'AccountOwner'], getAccountTransactionHistory: ['Admin', 'AccountOwner'], getAccountBalance: ['Admin', 'AccountOwner'], getAccountOnHoldBalance: ['Admin', 'AccountOwner'], getOnHoldIds: ['Admin', 'AccountOwner'], }, ERC721ADMIN: { isUserTokenAdmin: ['Admin'], addAdmin: ['Admin'], removeAdmin: ['Admin'], getAllAdmins: ['Admin'], }, ERC721TOKEN: { getAllTokens: ['Admin'], getAllTokensByUser: ['Admin', 'AccountOwner'], get: ['Admin', TOKEN_OWNER], getTokensByName: ['Admin'], addRoleMember: ['Admin'], removeRoleMember: ['Admin'], isInRole: ['Admin', 'AccountOwner'], totalSupply: ['Admin'], totalNetSupply: ['Admin'], history: ['Admin'], }, ERC721ROLE: { getAccountsByRole: ['Admin'], getUsersByRole: ['Admin'], }, ERC721TRANSACTION: { deleteTransactions: ['Admin'], }, ERC721ACCOUNT: { createAccount: ['Admin'], getAllAccounts: ['Admin'], getAccountsByUser: ['Admin', 'MultipleAccountOwner'], history: ['Admin', 'AccountOwner'], getAccountTransactionHistory: ['Admin', 'AccountOwner'], getAccountTransactionHistoryWithFilters: ['Admin', 'AccountOwner'], balanceOf: ['Admin', 'MultipleAccountOwner'], } }
-
isUserTokenAdmin
- Cette méthode renvoie la valeur booléenne
true
si l'appelant de la fonction est unToken Admin
. Sinon, la méthode renvoiefalse
. Il s'agit d'une fonction statique asynchrone. -
addAdmin
- Cette méthode ajoute un utilisateur en tant qu'utilisateur
Token Admin
du code chaîne de jeton. -
removeAdmin
- Cette méthode enlève un utilisateur en tant qu'utilisateur
Token Admin
du code chaîne de jeton. -
getAllAdmins
- Cette méthode renvoie la liste de tous les utilisateurs
Token Admin
.
Méthodes de gestion de la configuration de jeton
Les méthodes de gestion de la configuration des jetons sont basées sur la norme ERC-721. Pour utiliser les méthodes de gestion de la configuration de jeton, importez la classe Token
à partir du module ../lib/erc721-token
.
-
totalSupply
- Cette méthode renvoie le nombre total de NFT extraits. Il s'agit d'une fonction asynchrone.
-
get
- Cette méthode renvoie l'objet de jeton spécifié s'il est présent dans la base de données d'état. Il s'agit d'une fonction statique asynchrone.
-
isTokenType
- Cette méthode indique si une ressource de jeton existe avec l'ID indiqué. Il s'agit d'une fonction statique asynchrone.
-
createToken
- Cette méthode crée un jeton et enregistre ses propriétés dans la base de données d'état. Cette méthode ne peut être appelée que par les utilisateurs dotés du rôle minter. Il s'agit d'une fonction asynchrone.
-
updateToken
- Cette méthode met à jour les propriétés de jeton. Cette méthode ne peut être appelée que par le propriétaire ou le créateur du jeton. Après la création d'une ressource de jeton, seul le propriétaire du jeton peut mettre à jour les propriétés personnalisées du jeton. Si l'utilisateur est à la fois propriétaire et créateur d'un jeton, il peut également mettre à jour la propriété
TokenDesc
. Les métadonnées de jeton ne peuvent pas être mises à jour. Vous devez transmettre toutes les propriétés de jeton à cette méthode, même si vous souhaitez mettre à jour uniquement certaines propriétés. Il s'agit d'une fonction asynchrone. -
getByRange
- Cette méthode appelle la méthode
getStateByRange
de structure en interne. Même si une immobilisation portant l'ID indiqué est renvoyée par le livre, cette méthode convertit l'immobilisation dans le type d'immobilisation appelant. Il s'agit d'une fonction statique asynchrone.@validator(yup.string(), yup.string()) public async getDigiCurrGetByRange(startId: string, endId: string) { return await this.Ctx.ERC721TOken.getByRange(startId, endId, PaintingNft); }
-
history
- Cette méthode renvoie l'historique du jeton spécifié. Il s'agit d'une fonction statique asynchrone.
-
getAllTokens
- Cette méthode renvoie toutes les ressources de jeton enregistrées dans la base de données d'état. Cette méthode utilise des requêtes Berkeley DB SQL riches et ne peut être appelée qu'en cas de connexion au réseau Oracle Blockchain Platform distant. Il s'agit d'une fonction statique asynchrone.
-
getAllTokensByUser
- Cette méthode renvoie tous les jetons appartenant à un ID de compte spécifié. Il s'agit d'une fonction statique asynchrone.
-
ownerOf
- Cette méthode renvoie l'ID de compte du propriétaire d'un jeton spécifié. Il s'agit d'une fonction statique asynchrone.
-
tokenUri
- Cette méthode renvoie l'URI d'un jeton spécifié. Il s'agit d'une fonction statique asynchrone.
-
getTokenUri
- Cette méthode renvoie l'URI d'un jeton spécifié. Il s'agit d'une fonction statique asynchrone.
-
symbol
- Cette méthode renvoie le symbole de la classe de jeton.
Méthodes de gestion des comptes
-
generateAccountId
- Cette méthode renvoie un ID de compte, formé par la concaténation de l'ID de fournisseur de services d'adhésion (
orgId
) et du nom utilisateur ou de l'ID de courriel (userId
), puis par la création d'un hachage SHA-256. -
createAccount
- Cette méthode crée un compte pour un utilisateur et un jeton spécifiés. Un compte doit être créé pour tout utilisateur qui aura des jetons à tout moment. Les comptes suivent le nombre de NFT dont dispose un utilisateur. Les utilisateurs doivent disposer de comptes sur le réseau pour effectuer les opérations liées aux jetons. Vous ne pouvez créer qu'un seul compte NFT par utilisateur.
Un ID de compte est un ensemble alphanumérique de caractères, préfixé par
oaccount~
et suivi d'un hachage SHA-256 de l'ID de fournisseur de services d'appartenance (orgId
) de l'utilisateur dans l'organisation réseau en cours, du nom utilisateur ou de l'ID de courriel (userId
) du propriétaire de l'instance ou de l'utilisateur connecté à l'instance, et de la chaîne constantenft
. Cette méthode ne peut être appelée que parToken Admin
du code chaîne. -
getAllAccounts
- Cette méthode renvoie la liste de tous les comptes. Cette méthode utilise des requêtes Berkeley DB SQL riches et ne peut être appelée qu'en cas de connexion au réseau Oracle Blockchain Platform distant.
-
history
- Cette méthode renvoie un tableau des détails de l'historique des comptes pour un compte spécifié.
-
getUserByAccountId
- Cette méthode renvoie les détails de l'utilisateur pour un compte spécifié.
-
getAccountWithStatusByUser
- Cette méthode renvoie les détails de l'utilisateur pour un compte spécifié, y compris le statut du compte. Cette méthode peut uniquement être appelée par
Token Admin
du code chaîne ou parAccount Owner
du compte. -
getAccountByUser
- Cette méthode renvoie les détails de l'utilisateur pour un compte spécifié. Cette méthode peut uniquement être appelée par
Token Admin
du code chaîne ou parAccount Owner
du compte. -
balanceOf
- Cette méthode renvoie le nombre total de NFT détenus par l'utilisateur spécifié.
Méthodes de gestion des rôles
-
addRoleMember
- Cette méthode ajoute un rôle à un utilisateur et un jeton spécifiés. Un ID de compte est formé par la création d'un hachage SHA-256 de l'ID de fournisseur de services d'adhésion concaténé (
orgId
) et du nom utilisateur ou de l'ID de courriel (userId
). Il s'agit d'une fonction asynchrone. -
removeRoleMember
- Cette méthode supprime un rôle d'un utilisateur et d'un jeton spécifiés. Un ID de compte est formé par la création d'un hachage SHA-256 de l'ID de fournisseur de services d'adhésion concaténé (
orgId
) et du nom utilisateur ou de l'ID de courriel (userId
). Il s'agit d'une fonction asynchrone. -
isInRole
- Cette méthode renvoie une valeur booléenne pour indiquer si un utilisateur et un jeton ont un rôle spécifié. Un ID de compte est formé par la création d'un hachage SHA-256 de l'ID de fournisseur de services d'adhésion concaténé (
orgId
) et du nom utilisateur ou de l'ID de courriel (userId
). Il s'agit d'une fonction asynchrone. -
getAccountsByRole
- Cette méthode renvoie la liste de tous les ID de compte pour un rôle spécifié.
-
getUsersByRole
- Cette méthode renvoie la liste de tous les utilisateurs pour un rôle spécifié.
Méthodes de gestion de l'historique des transactions
-
getAccountTransactionHistory
- Cette méthode renvoie un tableau des détails de l'historique des transactions pour un compte spécifié.
-
getAccountTransactionHistoryWithFilters
- Cette méthode renvoie l'historique des transactions de compte pour un utilisateur spécifié, filtré par
PageSize
,Bookmark
,startTime
etendTime
. Cette méthode ne peut être appelée qu'en cas de connexion au réseau Oracle Blockchain Platform distant. -
getTransactionById
- Cette méthode renvoie l'historique d'une ressource
Transaction
. -
deleteHistoricalTransactions
- Cette méthode supprime les transactions antérieures à une date spécifiée de la base de données d'état.
Gestion du comportement des jetons - Comportement Mintable
-
getMaxMintQuantity
- Cette méthode renvoie la quantité minimale maximale d'un jeton. Si le comportement
max_mint_quantity
n'est pas configuré dans le fichier de spécification, la valeur par défaut est 0 et un nombre infini de jetons peut être extrait. -
getTotalMintedTokens
- Cette méthode renvoie le nombre total de jetons extraits disponibles dans le système pour le jeton spécifié. Le nombre net de jetons disponibles est le nombre total de jetons frappés moins le nombre de jetons brûlés. Il s'agit d'une fonction asynchrone.
Gestion du comportement des jetons - Comportement transférable
-
safeTransferFrom
- Il s'agit d'une fonction asynchrone. Cette méthode transfère la propriété de la NFT spécifiée de l'appelant vers un autre compte. Cette méthode inclut les validations suivantes :
- Le jeton existe et n'est pas gravé.
- Le compte expéditeur et le compte destinataire existent et ne sont pas identiques.
- Le compte expéditeur est propriétaire du jeton.
- L'appelant de la fonction est l'expéditeur.
-
transferFrom
- Il s'agit d'une fonction asynchrone. Cette méthode transfère la propriété de la NFT spécifiée d'un compte expéditeur vers un compte destinataire. Il est de la responsabilité de l'appelant de transmettre les paramètres corrects. Cette méthode peut être appelée par n'importe quel utilisateur, pas seulement par le propriétaire du jeton. Cette méthode inclut les validations suivantes :
- Le jeton existe et n'est pas gravé.
- Le compte expéditeur et le compte destinataire existent et ne sont pas identiques.
- Le compte expéditeur est propriétaire du jeton.
Gestion du comportement des jetons - Comportement gravable
-
burn
- Cette méthode désactive ou brûle le NFT spécifié à partir du compte de l'appelant. L'appelant de cette méthode doit avoir un compte. Un jeton ne peut pas être gravé sauf si le fichier de spécification de jeton inclut le comportement
burnable
. Si aucune propriétéburner_role_name
n'est indiquée dans la sectionroles
du fichier de spécification, le propriétaire du jeton peut graver le jeton. Si une propriétéburner_role_name
est indiquée dans la sectionroles
, l'utilisateur qui a affecté le rôle de brûleur, qui est également le mineurs (créateur) du jeton, peut graver le jeton. Il s'agit d'une fonction asynchrone.