Projet TypeScript échafaudé pour le cadre de taxonomie de jetons

Blockchain App Builder prend l'entrée de votre fichier de spécification de jeton et génère un projet de chaîne de blocs entièrement fonctionnel.

Le projet génère automatiquement des classes et des fonctions de cycle de vie de jeton, y compris des méthodes CRUD et non CRUD. La validation des arguments, la conversion de paramètres/déconversion des paramètres 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 à des jetons, voir Projet de code de chaîne TypeScript échafaudé.

Informations de référence :

Modèle

Chaque classe de modèle segmentée en unités étend la classe Token, qui à son tour étend la classe OchainModel. La classe Token est importée à partir de ../lib/token. La capacité de persistance transparente, ou ORM simplifié, est saisie dans la classe OchainModel.

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;
 
}

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 n'importe quel nombre de classes, de fonctions ou de fichiers, 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 de la trousse SDK de jeton pour écrire des méthodes personnalisées pour votre application d'affaires.

Méthodes de jeton générées automatiquement

Blockchain App Builder génère automatiquement des méthodes pour prendre en charge les jetons et les cycles de vie des jetons. Vous pouvez utiliser ces méthodes pour initialiser des jetons, gérer des rôles et des comptes et effectuer d'autres tâches de cycle de vie des jetons sans codage supplémentaire. Les méthodes de contrôleur doivent avoir un décorateur @Validator(...params) pour pouvoir être appelées.

Gestion du contrôle d'accès
Gestion de la configuration de jeton
Gestion du compte
Gestion des rôles
Gestion de l'historique des transactions
Gestion du comportement des jetons

Méthodes pour la gestion du contrôle d'accès

addTokenAdmin

Cette méthode ajoute un utilisateur en tant que Token Admin du code de chaîne. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.

@Validator(yup.string(), yup.string())
public async addTokenAdmin(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization('ADMIN.addAdmin', 'TOKEN');
    return await this.Ctx.Admin.addAdmin(org_id, user_id);
}

Paramètres :

org_id: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
user_id: string - Nom d'utilisateur ou ID courriel de l'utilisateur.

Retourne :

Au succès, un message comprend les détails de l'utilisateur qui a été ajouté comme Token Admin du code de chaîne.

Exemple de valeur renvoyée :

{"msg":"Successfully added Admin (Org_Id: Org1MSP, User_Id: User1)"}

removeTokenAdmin

Cette méthode supprime un utilisateur en tant que Token Admin du code de chaîne. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.

@Validator(yup.string(), yup.string())
public async removeTokenAdmin(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization('ADMIN.removeAdmin', 'TOKEN');
    return await this.Ctx.Admin.removeAdmin(org_id, user_id);
}

Paramètres :

org_id: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
user_id: string - Nom d'utilisateur ou ID courriel de l'utilisateur.

Retourne :

En cas de réussite, un message contenant les détails de l'utilisateur qui a été supprimé comme Token Admin du code de chaîne.

Exemple de valeur renvoyée :

{"msg": "Successfully removed Admin (Org_Id: Org1MSP, User_Id: User1)"}

isTokenAdmin

Cette méthode retourne la valeur booléenne true si l'appelant de la fonction est Token Admin, sinon elle retourne false. Un Token Admin ou un Org Admin peut appeler cette fonction sur tout autre utilisateur du réseau de chaîne de blocs. Les autres utilisateurs ne peuvent appeler cette méthode que sur leur propre compte.

@Validator(yup.string(), yup.string())
  public async isTokenAdmin(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.isUserTokenAdmin", "TOKEN");
    return await this.Ctx.Auth.isUserTokenAdmin(org_id, user_id);
  }

Paramètres :

org_id: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
user_id: string - Nom d'utilisateur ou ID courriel de l'utilisateur.

Retourne :

La méthode retourne true si l'appelant est un Token Admin, sinon elle retourne false.

getAllTokenAdmins

Cette méthode retourne une liste de tous les utilisateurs qui sont des Token Admin du code de chaîne. Cette méthode ne peut être appelée que par Token Admin ou par n'importe quel Org Admin du code de chaîne.

@Validator()
public async getAllTokenAdmins() {
    await this.Ctx.Auth.checkAuthorization('ADMIN.getAllAdmins', 'TOKEN');
    return await this.Ctx.Admin.getAllAdmins();
}

Paramètres :

aucune

Retourne :

En cas de succès, un tableau admins au format JSON contenant les objets orgId et userId.

Exemple de valeur renvoyée :

{"admins":[{"org_id":"Org1MSP","user_id":"admin"}]}

addOrgAdmin

Cette méthode ajoute un utilisateur en tant que Org Admin de l'organisation. Cette méthode ne peut être appelée que par Token Admin du code de chaîne ou par Org Admin de l'organisation spécifiée.

@Validator(yup.string(), yup.string())
  public async addOrgAdmin(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.addOrgAdmin", "TOKEN", { org_id });
    return await this.Ctx.Admin.addOrgAdmin(org_id, user_id);
  }

Paramètres :

org_id: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
user_id: string - Nom d'utilisateur ou ID courriel de l'utilisateur.

Retourne :

En cas de réussite, un message contenant les détails de l'utilisateur qui a été ajouté en tant que Org Admin de l'organisation.

Exemple de valeur renvoyée :

{
    "msg": "Successfully added Org Admin (Org_Id: Org1MSP, User_Id: orgAdmin)"
}

removeOrgAdmin

Cette méthode supprime un utilisateur en tant que Org Admin de l'organisation. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne ou par un élément Org Admin de l'organisation spécifiée.

@Validator(yup.string(), yup.string())
  public async removeOrgAdmin(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ADMIN.removeOrgAdmin", "TOKEN", { org_id });
    return await this.Ctx.Admin.removeOrgAdmin(org_id, user_id);
  }

Paramètres :

org_id: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
user_id: string - Nom d'utilisateur ou ID courriel de l'utilisateur.

Retourne :

En cas de réussite, un message contenant les détails de l'utilisateur qui a été supprimé en tant que Org Admin de l'organisation.

Exemple de valeur renvoyée :

{
  "msg": "Successfully removed Org Admin (Org_Id Org1MSP User_Id orgAdmin)"
}

getOrgAdmins

Cette méthode retourne une liste de tous les utilisateurs qui sont des Org Admin d'une organisation. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne ou par un élément Org Admin de toute organisation.

  @Validator()
  public async getOrgAdmins() {
    await this.Ctx.Auth.checkAuthorization("ADMIN.getOrgAdmins", "TOKEN");
    return await this.Ctx.Admin.getAllOrgAdmins();
  }

Paramètres :

aucune

Retourne :

En cas de succès, tableau au format JSON qui contient les objets orgId et userId.

Exemple de valeur renvoyée :

{
    "admins": [
        {
            "org_id": "Org1MSP",
            "user_id": "orgadmin"
        },
        {
            "org_id": "Org1MSP",
            "user_id": "orgadmin1"
        },
        {
            "org_id": "Org1MSP",
            "user_id": "orgadmin2"
        }
    ]
}

Méthodes de gestion de la configuration de jeton

init

Cette méthode est appelée lorsque le code de chaîne est déployé ou mis à niveau. Chaque valeur Token Admin est identifiée par les informations user_id et org_id dans le paramètre obligatoire adminList. user_id est le nom d'utilisateur ou l'ID courriel du responsable de l'instance ou de l'utilisateur qui est connecté à l'instance. org_id est l'ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation de réseau courante.

Tout utilisateur Token Admin peut ajouter et supprimer d'autres utilisateurs Token Admin en appelant les méthodes addAdmin et removeAdmin.

public async init(adminList: TokenAdminAsset[]) {
    await this.Ctx.Admin.initAdmin(adminList);
    return;
}

Paramètres :

adminList array - Tableau d'informations {user_id, org_id} qui spécifie la liste des administrateurs de jetons. Le tableau adminList est un paramètre obligatoire.

Exemple de paramètre, interface de ligne de commande Mac OSX et Linux :

'[{"user_id":"userid", "org_id":"OrgMSPId"}]'

Exemple de paramètre, interface de ligne de commande Microsoft Windows :

"[{\"user_id\":\"userid\", \"org_id\":\"OrgMSPId\"}]"

Exemple de paramètre, console Oracle Blockchain Platform :

["[{\"user_id\":\"userid\", \"org_id\":\"OrgMSPId\"}]"]

initialize<Token Name>Token

Cette méthode crée un jeton et initialise les propriétés du jeton. La ressource et ses propriétés sont 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 de chaîne.

@Validator(Digicur)
    public async initializeDigicurToken(token_asset: Digicur) {
        await this.Ctx.Auth.checkAuthorization('TOKEN.save', 'TOKEN');
        return await this.Ctx.Token.save(token_asset)
    }

Paramètres :

asset: <Token Class> - La ressource de jeton est transmise en tant que paramètre à cette méthode. Les propriétés de la ressource de jeton sont décrites dans le fichier de modèle.

Retourne :

En cas de réussite, une représentation JSON de la ressource de jeton créée.

Exemple de valeur renvoyée :

{
    "assetType": "otoken",
    "token_id": "digiCurr101",
    "token_name": "digicur",
    "token_type": "fungible",
    "behaviors": [
        "divisible",
        "mintable",
        "transferable",
        "burnable",
        "roles"
    ],
    "roles": {
        "minter_role_name": "minter"
    },
    "mintable": {
        "max_mint_quantity": 1000
    },
    "divisible": {
        "decimal": 2
    },
    "currency_name": "DOLLAR",
    "token_to_currency_ratio": 1
}

update<Token Name>Token

Cette méthode met à jour les propriétés du jeton. Après la création d'une ressource de jeton, seules la propriété token_desc et les propriétés personnalisées peuvent être mises à jour. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.

@Validator(Digicur)
public async updateDigicurToken(token_asset: Digicur) {
    await this.Ctx.Auth.checkAuthorization('TOKEN.update', 'TOKEN');
    return await this.Ctx.Token.update(token_asset);
}

Paramètres :

asset: <Token Class> - La ressource de jeton est transmise en tant que paramètre à cette méthode. Les propriétés de la ressource de jeton sont décrites dans le fichier de modèle.

Retourne :

En cas de réussite, une représentation JSON mise à jour de la ressource de jeton.

Exemple de valeur renvoyée :

{
    "assetType": "otoken",
    "token_id": "digiCurr101",
    "token_name": "digicur",
    "token_desc": "Digital Currency equiv of dollar",
    "token_type": "fungible",
    "behaviors": [
        "divisible",
        "mintable",
        "transferable",
        "burnable",
        "roles"
    ],
    "roles": {
        "minter_role_name": "minter"
    },
    "mintable": {
        "max_mint_quantity": 1000
    },
    "divisible": {
        "decimal": 2
    },
    "currency_name": "DOLLAR",
    "token_to_currency_ratio": 1
}

getTokenDecimals

Cette méthode retourne le nombre de décimales qui ont été configurées pour un jeton fractionnaire. Si le comportement divisible n'a pas été spécifié pour le jeton, la valeur par défaut est 0. Cette méthode ne peut être appelée que par Token Admin ou Org Admin du code de chaîne.

@Validator(yup.string())
public async getTokenDecimals(token_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    await this.Ctx.Auth.checkAuthorization('TOKEN.getDecimals', 'TOKEN');
    return {
        msg: `Token Id: ${token_id} has ${this.Ctx.Token.getDecimals(token_asset)} decimal places.`
    };
}

Paramètres :

token_id: string - ID du jeton.

Retourne :

En cas de succès, une chaîne JSON indiquant le nombre de décimales du jeton.

Exemple de valeur renvoyée :

{"msg":"Token Id: digiCurr101 has 1 decimal places."}

getTokenById

Cette méthode retourne un objet de jeton s'il est présent dans la base de données d'état. Cette méthode ne peut être appelée que par Token Admin ou Org Admin du code de chaîne.

@Validator(yup.string())
public async getTokenById(token_id: string) {
    await this.Ctx.Auth.checkAuthorization('TOKEN.get', 'TOKEN');
    const token = await this.getTokenObject(token_id);
    return token;
}

Paramètres :

token_id: string - ID du jeton.

Retourne :

En cas de réussite, un objet JSON qui représente la ressource de jeton.

Exemple de valeur renvoyée :

{
    "assetType": "otoken",
    "token_id": "digiCurr101",
    "token_name": "digicur",
    "token_desc": "Digital Currency equiv of dollar",
    "token_type": "fungible",
    "behaviors": [
        "divisible",
        "mintable",
        "transferable",
        "burnable",
        "roles"
    ],
    "roles": {
        "minter_role_name": "minter"
        "burner_role_name": "burner",
        "notary_role_name": "notary"
    },
    "mintable": {
        "max_mint_quantity": 2000
    },
    "divisible": {
        "decimal": 1
    },
    "currency_name": "DOLLAR",
    "token_to_currency_ratio": 1
}

getTokenHistory

Cette méthode retourne l'historique des jetons pour un ID jeton spécifié. Tout utilisateur peut appeler cette méthode.

  @Validator(yup.string())
  public async getTokenHistory(tokenId: string) {
    await this.Ctx.Auth.checkAuthorization("TOKEN.getTokenHistory", "TOKEN");
    return await this.Ctx.Token.history(tokenId);
  }

Paramètres :

tokenId: string - ID du jeton.

Retourne :

En cas de succès, un objet JSON qui représente l'historique du jeton.

Exemple de valeur renvoyée :


[
    {
        "trxId": "0d75f09446a60088afb948c6aca046e261fddcd43df416076201cdc5565f1a35",
        "timeStamp": "2023-09-01T16:48:41.000Z",
        "value": {
            "assetType": "otoken",
            "token_id": "token",
            "token_name": "fiatmoneytok",
            "token_desc": "updatedDesc",
            "token_standard": "ttf+",
            "token_type": "fungible",
            "token_unit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter"
            },
            "mintable": {
                "max_mint_quantity": 1000
            },
            "divisible": {
                "decimal": 2
            }
        }
    },
    {
        "trxId": "3666344878b043b65d5b821cc79c042ba52aec467618800df5cf14eac69f72fa",
        "timeStamp": "2023-08-31T20:24:55.000Z",
        "value": {
            "assetType": "otoken",
            "token_id": "token",
            "token_name": "fiatmoneytok",
            "token_standard": "ttf+",
            "token_type": "fungible",
            "token_unit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter"
            },
            "mintable": {
                "max_mint_quantity": 1000
            },
            "divisible": {
                "decimal": 2
            }
        }
    }
]

getAllTokens

Cette méthode retourne tous les jetons stockés dans la base de données d'état. Cette méthode ne peut être appelée que par Token Admin ou Org Admin du code de chaîne. Cette méthode utilise des interrogations SQL enrichies Berkeley DB et ne peut être appelée que lorsqu'elle est connectée au réseau Oracle Blockchain Platform distant.

@Validator()
public async getAllTokens() {
    await this.Ctx.Auth.checkAuthorization('TOKEN.getAllTokens', 'TOKEN');
    return await this.Ctx.Token.getAllTokens();
}

Paramètres :

aucune

Retourne :

En cas de réussite, un objet JSON qui représente toutes les ressources de jeton.

getTokensByName

Cette méthode retourne tous les objets de jeton portant un nom spécifié. Cette méthode ne peut être appelée que par Token Admin ou Org Admin du code de chaîne. Cette méthode utilise des interrogations SQL enrichies Berkeley DB et ne peut être appelée que lorsqu'elle est connectée au réseau Oracle Blockchain Platform distant.

@Validator(yup.string())
public async getTokensByName(token_name: string) {
    await this.Ctx.Auth.checkAuthorization('TOKEN.getTokensByName', 'TOKEN');
    return await this.Ctx.Token.getTokensByName(token_name);
}

Paramètres :

token_name: string - Nom des jetons à extraire. Le nom correspond à la propriété token_name dans le fichier de spécification. La valeur est le nom de classe du jeton.

Retourne :

En cas de succès, un objet JSON de toutes les ressources de jeton correspondant au nom.

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 font le suivi des soldes, des soldes bloqués et de l'historique des transactions. Un ID compte est un jeu de caractères alphanumériques, précédé de oaccount~<token asset name>~ et suivi d'un hachage du nom d'utilisateur ou de l'ID courriel (user_id) du responsable de l'instance ou de l'utilisateur connecté à l'instance, de l'ID fournisseur de services d'appartenance (org_id) de l'utilisateur dans l'organisation de réseau courante. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne ou par un élément Org Admin de l'organisation spécifiée.

  @Validator(yup.string(), yup.string(), yup.string())
  public async createAccount(org_id: string, user_id: string, token_type: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.createAccount", "TOKEN", { org_id });
    return await this.Ctx.Account.createAccount(org_id, user_id, token_type);
  }

Paramètres :

org_id: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
user_id: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
token_type: string - Type du jeton, qui doit être fungible.

Retourne :

En cas de réussite, un objet JSON du compte qui a été créé. Le paramètre bapAccountVersion est défini dans l'objet de compte pour une utilisation interne.

Exemple de valeur renvoyée :

{
  "assetType": "oaccount",
  "account_id": "oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb",
  "bapAccountVersion": 0,
  "user_id": "admin",
  "org_id": "Org1MSP",
  "token_type": "fungible",
  "token_id": "",
  "token_name": "",
  "balance": 0,
  "onhold_balance": 0
}

associateTokenToAccount

Cette méthode associe un jeton fongible à un compte. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne ou par un élément Org Admin de l'organisation concernée.

  @Validator(yup.string(), yup.string())
  public async associateTokenToAccount(account_id: string, token_id: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.associateToken", "TOKEN", { account_id });
    return await this.Ctx.Account.associateToken(account_id, token_id);
  }

Paramètres :

account_id: string - ID du compte.
token_id: string - ID du jeton.

Retourne :

En cas de succès, un objet JSON du compte mis à jour. Le paramètre bapAccountVersion est défini dans l'objet de compte pour une utilisation interne.

Exemple de valeur renvoyée :

{
    "assetType": "oaccount",
    "account_id": "oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb",
    "bapAccountVersion": 0,
    "user_id": "admin",
    "org_id": "Org1MSP",
    "token_type": "fungible",
    "token_id": "fungible",
    "token_name": "fiatmoneytok",
    "balance": 0,
    "onhold_balance": 0
}

getAccount

Cette méthode retourne les détails du compte pour un utilisateur et un jeton spécifiés. Cette méthode ne peut être appelée que par Token Admin du code de chaîne, par Org Admin de l'organisation spécifiée ou par AccountOwner du compte.

@Validator(yup.string(), yup.string(), yup.string())
public async getAccount(token_id: string, org_id: string, user_id: string) {
  const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
  await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccount", "TOKEN", { account_id });
  return await this.Ctx.Account.getAccountWithStatus(account_id);
}

Paramètres :

token_id: string - ID du jeton.
org_id: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
user_id: string - Nom d'utilisateur ou ID courriel de l'utilisateur.

Retourne :

En cas de réussite, un objet de compte JSON qui inclut les propriétés suivantes :
account_id - ID du compte d'utilisateur.
user_id - Nom d'utilisateur ou ID courriel de l'utilisateur.
org_id - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
token_id - ID du jeton.
token_name - Nom du jeton.
balance - Solde courant du compte.
onhold_balance - Solde bloqué courant du compte.
bapAccountVersion - Paramètre d'objet de compte à usage interne.
status - Statut courant du compte d'utilisateur.

Exemple de valeur renvoyée :

{
  "bapAccountVersion": 0,
  "assetType": "oaccount",
  "status": "active",
  "account_id": "oaccount~2de8db6b91964f8c9009136831126d3cfa94e1d00c4285c1ea3e6d1f36479ed4",
  "user_id": "idcqa",
  "org_id": "appdev",
  "token_type": "fungible",
  "token_id": "t1",
  "token_name": "obptok",
  "balance": 0,
  "onhold_balance": 0
}

getAccountHistory

Cette méthode retourne les détails de l'historique du compte pour un utilisateur et un jeton spécifiés. Cette méthode ne peut être appelée que par Token Admin du code de chaîne ou par AccountOwner du compte.

  @Validator(yup.string(), yup.string(), yup.string())
  public async getAccountHistory(token_id: string, org_id: string, user_id: string) {
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.history", "TOKEN", { account_id });
    return await this.Ctx.Account.history(account_id);
  }

Paramètres :

token_id: string - ID du jeton.
org_id: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
user_id: string - Nom d'utilisateur ou ID courriel de l'utilisateur.

Retourne :

En cas de succès, un tableau d'objets de compte JSON comprenant les propriétés suivantes :
trxId - ID transaction tel que retourné par le livre.
timeStamp - Heure de la transaction.
value - Chaîne JSON de l'objet de compte.

Exemple de valeur renvoyée :

[
    {
      "trxId":"2gsdh17fff222467e5667be042e33ce18e804b3e065cca15de306f837e416d7c3e",
      "timeStamp":1629718288,
      "value":{
         "assetType":"oaccount",
         "account_id":"oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
         "user_id":"user1",
         "org_id":"Org1MSP",
         "token_id":"digiCurr101",
         "token_name":"digicur",
         "balance":100,
         "onhold_balance":0,
         "bapAccountVersion": 1
   },
   {
      "trxId":"9fd07fff222467e5667be042e33ce18e804b3e065cca15de306f837e416d7c3e",
      "timeStamp":1629718288,
      "value":{
         "assetType":"oaccount",
         "account_id":"oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
         "user_id":"user1",
         "org_id":"Org1MSP",
         "token_id":"digiCurr101",
         "token_name":"digicur",
         "balance":0,
         "onhold_balance":0,
         "bapAccountVersion": 0
      }
   }
]

getAccountOnHoldBalance

Cette méthode retourne le solde de blocage courant pour un compte et un jeton spécifiés. Cette méthode ne peut être appelée que par Token Admin du code de chaîne, par Org Admin de l'organisation spécifiée ou par AccountOwner du compte.

  @Validator(yup.string(), yup.string(), yup.string())
  public async getAccountOnHoldBalance(token_id: string, org_id: string, user_id: string) {
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountOnHoldBalance", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountOnHoldBalance(account_id);
  }

Paramètres :

token_id: string - ID du jeton.
org_id: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
user_id: string - Nom d'utilisateur ou ID courriel de l'utilisateur.

Retourne :

En cas de succès, une représentation JSON du solde de blocage courant.

Exemple de valeur renvoyée :

{"msg":"Total Holding Balance is: 0","holding_balance":0}

getAllAccounts

Cette méthode retourne une liste de tous les comptes. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne. Cette méthode utilise des interrogations SQL enrichies Berkeley DB et ne peut être appelée que lorsqu'elle est connectée au réseau Oracle Blockchain Platform distant.

@Validator()
public async getAllAccounts() {
    await this.Ctx.Auth.checkAuthorization('ACCOUNT.getAllAccounts', 'TOKEN');
    return await this.Ctx.Account.getAllAccounts();
}

Paramètres :

aucune

Retourne :

En cas de succès, un tableau JSON de tous les comptes.

getUserByAccountId

Cette méthode retourne les détails de l'utilisateur (org_id et user_id) pour un compte spécifié. Cette méthode peut être appelée par n'importe quel utilisateur du code de chaîne.

@Validator(yup.string())
public async getUserByAccountId(account_id: string) {
    return await this.Ctx.Account.getUserByAccountId(account_id);
}

Paramètres :

account_id: string - ID du compte.

Retourne :

En cas de réussite, un objet JSON contenant les détails de l'utilisateur (org_id, token_id et user_id).

Exemple de valeur renvoyée :

{
    "token_id": "digiCurr101",
    "user_id": "user1",
    "org_id": "Org1MSP"
}

getAccountBalance

Cette méthode retourne le solde courant pour un compte et un jeton spécifiés. Cette méthode ne peut être appelée que par Token Admin du code de chaîne, par Org Admin de l'organisation spécifiée ou par AccountOwner du compte.

  @Validator(yup.string(), yup.string(), yup.string())
  public async getAccountBalance(token_id: string, org_id: string, user_id: string) {
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountBalance", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountBalance(account_id);
  }

Paramètres :

token_id: string - ID du jeton.
org_id: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
user_id: string - Nom d'utilisateur ou ID courriel de l'utilisateur.

Retourne :

En cas de succès, une représentation JSON du solde du compte courant.

Exemple de valeur renvoyée :

{"msg":"Current Balance is: 0","user_balance":0}

getAllOrgAccounts

Cette méthode retourne une liste de tous les comptes de jeton appartenant à une organisation spécifiée. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne ou par un élément Org Admin de l'organisation spécifiée.

  @Validator(yup.string())
  public async getAllOrgAccounts(org_id: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAllOrgAccounts", "TOKEN", { org_id });
    return await this.Ctx.Account.getAllOrgAccounts(org_id);
  }

Paramètres :

org_id: string - ID fournisseur de services d'adhésion (MSP) de l'organisation.

Retourne :

En cas de succès, une liste de tous les comptes pour l'organisation spécifiée.

Exemple de valeur renvoyée :

[
    {
        "key": "oaccount~2de8db6b91964f8c9009136831126d3cfa94e1d00c4285c1ea3e6d1f36479ed4",
        "valueJson": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~2de8db6b91964f8c9009136831126d3cfa94e1d00c4285c1ea3e6d1f36479ed4",
            "user_id": "idcqa",
            "org_id": "appdev",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "fiatmoneytok",
            "balance": 0,
            "onhold_balance": 0
        }
    },
    {
        "key": "oaccount~620fcf5deb5fd5a65c0b5b10fda129de0f629ccd232c5891c130e24a574df50a",
        "valueJson": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~620fcf5deb5fd5a65c0b5b10fda129de0f629ccd232c5891c130e24a574df50a",
            "user_id": "example_minter",
            "org_id": "appdev",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "fiatmoneytok",
            "balance": 0,
            "onhold_balance": 0
        }
    }
]

Méthodes pour la gestion des rôles

addRole

Cette méthode ajoute un rôle à un utilisateur et à un jeton spécifiés. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne ou par un élément Org Admin de l'organisation spécifiée qui détient également le rôle spécifié.

  @Validator(yup.string(), yup.string(), yup.string(), yup.string())
  public async addRole(token_id: string, role: string, org_id: string, user_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("TOKEN.addRoleMember", "TOKEN", { token_id, org_id, role });
    return await this.Ctx.Token.addRoleMember(role, account_id, token_asset);
  }

Paramètres :

token_id: string - ID du jeton.
role: string - Nom du rôle à ajouter à l'utilisateur spécifié. Les comportements mintable et burnable correspondent aux propriétés minter_role_name et burner_role_name du fichier de spécification. De même, le rôle notary correspond à la propriété notary_role_name du fichier de spécification.
org_id: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
user_id: string - Nom d'utilisateur ou ID courriel de l'utilisateur.

Retourne :

En cas de réussite, un message avec les détails du compte.

Exemple de valeur renvoyée :

{"msg":"Successfully added role 'minter' to Account Id: oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f (Org-Id: Org1MSP, User-Id: user1)"}

removeRole

Cette méthode supprime un rôle d'un utilisateur et d'un jeton spécifiés. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne ou par un élément Org Admin de l'organisation spécifiée qui détient également le rôle spécifié.

  @Validator(yup.string(), yup.string(), yup.string(), yup.string())
  public async removeRole(token_id: string, role: string, org_id: string, user_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("TOKEN.removeRoleMember", "TOKEN", { token_id, org_id, role });
    return await this.Ctx.Token.removeRoleMember(role, account_id, token_asset);
  }

Paramètres :

token_id: string - ID du jeton.
role: string - Nom du rôle à supprimer de l'utilisateur spécifié. Les comportements mintable et burnable correspondent aux propriétés minter_role_name et burner_role_name du fichier de spécification. De même, le rôle notary correspond à la propriété notary_role_name du fichier de spécification.
org_id: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
user_id: string - Nom d'utilisateur ou ID courriel de l'utilisateur.

Retourne :

En cas de réussite, un message avec les détails du compte.

Exemple de valeur renvoyée :

{"msg":"Successfully removed role 'minter' from Account Id: oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f (Org-Id: Org1MSP, User-Id: user1)"}

getAccountsByRole

Cette méthode retourne une liste de tous les ID compte pour un rôle et un jeton spécifiés. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.

@Validator(yup.string(), yup.string())
public async getAccountsByRole(token_id: string, role: string) {
   await this.Ctx.Auth.checkAuthorization('ROLE.getAccountsByRole', 'TOKEN');
   return await this.Ctx.Role.getAccountsByRole(token_id, role);
}

Paramètres :

token_id: string - ID du jeton.
role: string - Nom du rôle à rechercher.

Retourne :

En cas de succès, un tableau JSON d'ID compte.

Exemple de valeur renvoyée :

{"accounts":["oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f"]}

getAccountsByUser

Cette méthode retourne une liste de tous les ID compte pour un ID organisation et un ID utilisateur spécifiés. Cette méthode ne peut être appelée que par Token Admin du code de chaîne, par Org Admin de l'organisation spécifiée ou par Account Owner spécifié dans les paramètres.

  @Validator(yup.string(), yup.string())
  public async getAccountsByUser(org_id: string, user_id: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountsByUser", "TOKEN", { org_id, user_id });
    return await this.Ctx.Account.getAccountsByUser(org_id, user_id);
  }

Paramètres :

org_id string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
user_id string - Nom d'utilisateur ou ID courriel de l'utilisateur.

Retourne :

En cas de succès, un tableau JSON d'ID compte.

Exemple de valeur renvoyée :

{"accounts":["oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f"]}

getUsersByRole

Cette méthode retourne une liste de tous les utilisateurs pour un rôle et un jeton spécifiés. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.

@Validator(yup.string(), yup.string())
public async getUsersByRole(token_id: string, role: string) {
    await this.Ctx.Auth.checkAuthorization('ROLE.getUsersByRole', 'TOKEN');
    return await this.Ctx.Role.getUsersByRole(token_id, role);
}

Paramètres :

token_id: string - ID du jeton.
role: string - Nom du rôle à rechercher.

Retourne :

En cas de réussite, un tableau JSON des objets utilisateur (org_id, token_id et user_id).

Exemple de valeur renvoyée :

{"users":[{"token_id":"digiCurr101","user_id":"user1","org_id":"Org1MSP"}]}

isInRole

Cette méthode retourne une valeur booléenne pour indiquer si un utilisateur et un jeton ont un rôle spécifié. Cette méthode ne peut être appelée que par Token Admin du code de chaîne, par AccountOwner du compte ou par Org Admin de l'organisation spécifiée.

  @Validator(yup.string(), yup.string(), yup.string(), yup.string())
  public async isInRole(token_id: string, org_id: string, user_id: string, role: string) {
    const token_asset = await this.getTokenObject(token_id);
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("TOKEN.isInRole", "TOKEN", { account_id });
    return { result: await this.Ctx.Token.isInRole(role, account_id, token_asset) };
  }

Paramètres :

token_id: string - ID du jeton.
org_id: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
user_id: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
role: string - Nom du rôle à rechercher.

Retourne :

En cas de succès, une chaîne JSON du résultat booléen.

Exemple de valeur renvoyée :

{"result":"false"}

getOrgAccountsByRole

Cette méthode retourne des informations sur tous les comptes qui ont un rôle spécifié dans une organisation spécifiée. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne ou par un élément Org Admin de l'organisation spécifiée.

   @Validator(yup.string(), yup.string(), yup.string())
  public async getOrgAccountsByRole(token_id: string, role: string, org_id: string) {
    await this.Ctx.Auth.checkAuthorization("ROLE.getOrgAccountsByRole", "TOKEN", { org_id });
    return await this.Ctx.Role.getOrgAccountsByRole(token_id, role, org_id);
  }

Paramètres :

token_id: string - ID du jeton.
role: string - Nom du rôle à vérifier.
org_id: string - ID fournisseur de services d'adhésion (MSP) de l'organisation.

Retourne :

En cas de succès, une liste de tous les comptes ayant le rôle spécifié dans l'organisation spécifiée.

Exemple de valeur renvoyée :

{
    "accounts": [
        "oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb",
        "oaccount~9c650574af9025a6106c8d12a801b079eda9ae2e3399fc2fbd5bd683d738a850"
    ]
}

getOrgUsersByRole

Cette méthode retourne des informations sur tous les utilisateurs qui ont un rôle spécifié dans une organisation spécifiée. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne ou par un élément Org Admin de l'organisation spécifiée.

  @Validator(yup.string(), yup.string(), yup.string())
  public async getOrgUsersByRole(token_id: string, role: string, org_id: string) {
    await this.Ctx.Auth.checkAuthorization("ROLE.getOrgUsersByRole", "TOKEN", { org_id });
    return await this.Ctx.Role.getOrgUsersByRole(token_id, role, org_id);
  }

Paramètres :

token_id: string - ID du jeton.
role: string - Nom du rôle à vérifier.
org_id: string - ID fournisseur de services d'adhésion (MSP) de l'organisation.

Retourne :

Au succès, une liste de tous les utilisateurs ayant le rôle spécifié dans l'organisation spécifiée.

Exemple de valeur renvoyée :

{
    "users": [
        {
            "token_id": "token",
            "user_id": "admin",
            "org_id": "Org1MSP"
        },
        {
            "token_id": "token",
            "user_id": "orgAdmin",
            "org_id": "Org1MSP"
        }
    ]
}

Méthodes de gestion de l'historique des transactions

getAccountTransactionHistory

Cette méthode retourne un tableau des détails de l'historique des transactions de compte pour un utilisateur et un jeton spécifiés. Cette méthode ne peut être appelée que par Token Admin du code de chaîne, par Org Admin de l'organisation spécifiée ou par AccountOwner du compte.

 @Validator(yup.string(), yup.string(), yup.string())
  public async getAccountTransactionHistory(token_id: string, org_id: string, user_id: string) {
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountTransactionHistory", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountTransactionHistory(account_id, org_id, user_id.toLowerCase());
  }

Paramètres :

token_id: string - ID du jeton.
org_id: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
user_id: string - Nom d'utilisateur ou ID courriel de l'utilisateur.

Retourne :

En cas de succès, un tableau d'objets de transaction de compte JSON comprenant les propriétés suivantes :
transaction_id - ID de la transaction.
transacted_account - Compte avec lequel la transaction a eu lieu.
transaction_type - Type de transaction.
transacted_amount - Montant de la transaction.
timestamp - Heure de la transaction.
balance - Solde du compte au moment de la transaction.
onhold_balance - Solde bloqué au moment de la transaction.
token_id - ID du jeton.
holding_id - Identificateur unique retourné par la méthode holdTokens.

Exemple de valeur renvoyée :

[
    {
        "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
        "transacted_amount": 20,
        "timestamp": "2021-08-17T06:04:24.000Z",
        "balance": 930,
        "onhold_balance": 0,
        "token_id": "digiCurr101",
        "transaction_type": "BULKTRANSFER",
        "sub_transactions": [
            {
                "transacted_account": "oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
                "transaction_type": "DEBIT",
                "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c4ca4238a0b923820dcc509a6f75849b",
                "transacted_amount": 10
            },
            {
                "transacted_account": "oaccount~digicur~38848e87296d67c8a90918f78cf55f9c9baab2cdc8c928535471aaa1210c706e",
                "transaction_type": "DEBIT",
                "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c81e728d9d4c2f636f067f89cc14862c",
                "transacted_amount": 10
            }
        ]
    },
    {
        "transaction_id": "otransaction~757864d5369bd0539d044caeb3bb4898db310fd7aa740f45a9938771903d43da",
        "transacted_amount": 50,
        "timestamp": "2021-08-17T06:02:44.000Z",
        "balance": 950,
        "onhold_balance": 0,
        "token_id": "digiCurr101",
        "transacted_account": "oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
        "transaction_type": "DEBIT"
    }
]

getAccountTransactionHistoryWithFilters

  @Validator(yup.string(), yup.string(), yup.string(), yup.object().nullable())
  public async getAccountTransactionHistoryWithFilters(token_id: string, org_id: string, user_id: string, filters?: Filters) {
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getAccountTransactionHistoryWithFilters", "TOKEN", { account_id });
    return await this.Ctx.Account.getAccountTransactionHistoryWithFilters(account_id, org_id, user_id.toLowerCase(), filters);
  }

Paramètres :

token_id: string - ID du jeton.
org_id: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
user_id: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
filters: string - Paramètre facultatif. Si vide, tous les enregistrements sont retournés. La propriété PageSize détermine le nombre d'enregistrements à retourner. Si PageSize a la valeur 0, la taille de page par défaut est 20. La propriété Bookmark détermine l'index de départ des enregistrements à retourner. Pour plus d'informations, voir la documentation relative à Hyperledger Fabric. Les propriétés StartTime et EndTime doivent être spécifiées au format RFC-3339.

Exemple :

ochain invoke GetAccountTransactionHistoryWithFilters 'token1' 'appbuilder12' 'user_minter' '{"PageSize":10,"Bookmark":"1","StartTime":"2022-01-25T17:41:42Z","EndTime":"2022-01-25T17:59:10Z"}'

[
  {
    "transaction_id": "otransaction~672897b5a4fa78b421c000e4d6d4f71f3d46529bfbb5b4be10bf5471dc35ce89",
    "transacted_amount": 5,
    "timestamp": "2022-04-20T15:46:04.000Z",
    "token_id": "tokenId",
    "transacted_account": "oaccount~16c38d804413ebabf416360d374f76c973d4e71c74adfde73cc40c7c274883b8",
    "transaction_type": "DEBIT",
    "balance": 90,
    "onhold_balance": 0
  },
  {
    "transaction_id": "otransaction~467bb67a33aaffca4487f33dcd46c9844efdb5421a2e7b6aa2d53152eb2c6d85",
    "transacted_amount": 5,
    "timestamp": "2022-04-20T15:45:47.000Z",
    "token_id": "tokenId",
    "transacted_account": "oaccount~fbf95683b21bbc91a22205819ac1e2e9c90355d536821ed3fe22b7d23915c248",
    "transaction_type": "DEBIT",
    "balance": 95,
    "onhold_balance": 0
  },
  {
    "transaction_id": "otransaction~c6d56ce54a9bbe24597d1d10448e39316dc6f16328bf3c5b0c8ef10e1dfeb397",
    "transacted_amount": 100,
    "timestamp": "2022-04-20T15:44:26.000Z",
    "token_id": "tokenId",
    "transacted_account": "oaccount~deb5fb0906c40506f6c2d00c573b774e01a53dd91499e651d92ac4778b6add6a",
    "transaction_type": "MINT",
    "balance": 100,
    "onhold_balance": 0
  }
]

getSubTransactionById

Cette méthode retourne un tableau des détails de l'historique des transactions de compte pour un utilisateur et un jeton spécifiés. Cette méthode ne peut être appelée que par la chaîne Token Admin du code de chaîne ou par la chaîne AccountOwner du compte.

  @Validator(yup.string())
  public async getSubTransactionsById(transaction_id: string) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getSubTransactionsById", "TOKEN", { transaction_id });
    return await this.Ctx.Account.getSubTransactionsById(transaction_id);
  }

Paramètres :

transaction_id: string - ID de la transaction de transfert en masse.

Retourne :

Tableau d'objets de sous-transaction de compte au format JSON pour un ID transaction de transfert en masse spécifié.

Exemple :

ochain invoke GetAccountSubTransactionHistory 'otransaction~21972b4d206bd52ea77924efb259c67217edb23b4386580d1bee696f6f864b9b'

[
    {
        "transacted_account": "oaccount~16c38d804413ebabf416360d374f76c973d4e71c74adfde73cc40c7c274883b8",
        "transaction_type": "DEBIT",
        "transaction_id": "otransaction~6e0f8fe4a6430322170b9c619b04b6c9f1c8d257923f611b866bdf69d7fe6cb8~c81e728d9d4c2f636f067f89cc14862c",
        "transacted_amount": 5,
        "timestamp": "2022-04-20T15:52:21.000Z",
        "token_id": "token1",
        "balance": 80,
        "onhold_balance": 0
    },
    {
        "transacted_account": "oaccount~fbf95683b21bbc91a22205819ac1e2e9c90355d536821ed3fe22b7d23915c248",
        "transaction_type": "DEBIT",
        "transaction_id": "otransaction~6e0f8fe4a6430322170b9c619b04b6c9f1c8d257923f611b866bdf69d7fe6cb8~c4ca4238a0b923820dcc509a6f75849b",
        "transacted_amount": 5,
        "timestamp": "2022-04-20T15:52:21.000Z",
        "token_id": "token1",
        "balance": 85,
        "onhold_balance": 0
    }
]

getSubTransactionsByIdWithFilters

Cette méthode retourne un tableau des détails de l'historique des sous-transactions de compte pour une transaction spécifiée.

  @Validator(yup.string(), yup.object().nullable())
  public async getSubTransactionsByIdWithFilters(transaction_id: string, filters?: SubTransactionFilters) {
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getSubTransactionsByIdWithFilters", "TOKEN", { transaction_id });
    return await this.Ctx.Account.getSubTransactionsByIdWithFilters(transaction_id, filters);
  }

Paramètres :

transaction_id: string - ID de la transaction.
filters: string - Paramètre facultatif. Si vide, tous les enregistrements sont retournés. La propriété PageSize détermine le nombre d'enregistrements à retourner. Si PageSize a la valeur 0, la taille de page par défaut est 20. La propriété Bookmark détermine l'index de départ des enregistrements à retourner. Pour plus d'informations, voir la documentation relative à Hyperledger Fabric. Les propriétés StartTime et EndTime doivent être spécifiées au format RFC-3339.

Retourne :

Tableau d'objets de sous-transaction de compte au format JSON pour un ID transaction de transfert en masse spécifié.

Exemple :

ochain invoke GetAccountSubTransactionHistoryWithFilters 'otransaction~21972b4d206bd52ea77924efb259c67217edb23b4386580d1bee696f6f864b9b' '{"PageSize":10,"Bookmark":"1"}'

[
  {
    "transaction_id": "otransaction~6e0f8fe4a6430322170b9c619b04b6c9f1c8d257923f611b866bdf69d7fe6cb8~c81e728d9d4c2f636f067f89cc14862c",
    "transacted_amount": 5,
    "timestamp": "2022-04-20T15:52:21.000Z",
    "token_id": "tokenId",
    "transacted_account": "oaccount~16c38d804413ebabf416360d374f76c973d4e71c74adfde73cc40c7c274883b8",
    "transaction_type": "DEBIT",
    "balance": 80,
    "onhold_balance": 0
  },
  {
    "transaction_id": "otransaction~6e0f8fe4a6430322170b9c619b04b6c9f1c8d257923f611b866bdf69d7fe6cb8~c4ca4238a0b923820dcc509a6f75849b",
    "transacted_amount": 5,
    "timestamp": "2022-04-20T15:52:21.000Z",
    "token_id": "tokenId",
    "transacted_account": "oaccount~fbf95683b21bbc91a22205819ac1e2e9c90355d536821ed3fe22b7d23915c248",
    "transaction_type": "DEBIT",
    "balance": 85,
    "onhold_balance": 0
  }
]

getTransactionById

Cette méthode retourne l'historique d'une ressource Transaction.

@Validator(yup.string())
    public async getTransactionById(transaction_id: string) {
        return await this.Ctx.Transaction.getTransactionById(transaction_id);
    }

Paramètres :

transaction_id string - ID de l'immobilisation de transaction.

Retourne :

En cas de succès, un tableau JSON de l'historique de la transaction.

Exemple de valeur renvoyée :

{
    "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
    "history": [
        {
            "trxId": "68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
            "timeStamp": 1629180264,
            "value": {
                "assetType": "otransaction",
                "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
                "token_id": "digiCurr101",
                "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
                "to_account_id": "",
                "transaction_type": "BULKTRANSFER",
                "amount": 20,
                "timestamp": "2021-08-17T06:04:24.000Z",
                "number_of_sub_transactions": 2,
                "holding_id": ""
            }
        }
    ],
    "sub_transactions": [
        {
            "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c4ca4238a0b923820dcc509a6f75849b",
            "history": [
                {
                    "trxId": "68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
                    "timeStamp": 1629180264,
                    "value": {
                        "assetType": "otransaction",
                        "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c4ca4238a0b923820dcc509a6f75849b",
                        "token_id": "digiCurr101",
                        "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
                        "to_account_id": "oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
                        "transaction_type": "TRANSFER",
                        "amount": 10,
                        "timestamp": "2021-08-17T06:04:24.000Z",
                        "number_of_sub_transactions": 0,
                        "holding_id": ""
                    }
                }
            ]
        },
        {
            "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c81e728d9d4c2f636f067f89cc14862c",
            "history": [
                {
                    "trxId": "68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
                    "timeStamp": 1629180264,
                    "value": {
                        "assetType": "otransaction",
                        "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c81e728d9d4c2f636f067f89cc14862c",
                        "token_id": "digiCurr101",
                        "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
                        "to_account_id": "oaccount~digicur~38848e87296d67c8a90918f78cf55f9c9baab2cdc8c928535471aaa1210c706e",
                        "transaction_type": "TRANSFER",
                        "amount": 10,
                        "timestamp": "2021-08-17T06:04:24.000Z",
                        "number_of_sub_transactions": 0,
                        "holding_id": ""
                    }
                }
            ]
        }
    ]
}

deleteHistoricalTransactions

Cette méthode supprime les anciennes transactions de la base de données d'état.

@Validator(yup.date())
    public async deleteHistoricalTransactions(time_to_expiration: Date) {
        await this.Ctx.Auth.checkAuthorization('TRANSACTION.deleteTransactions', 'TOKEN');
        return await this.Ctx.Transaction.deleteTransactions(time_to_expiration);
    }

Paramètres :

time_to_expiration Date - Horodatage qui indique quand supprimer des transactions. Les immobilisations de transaction antérieures à l'heure spécifiée seront supprimées.

Exemple de valeur renvoyée :

"payload": {
    "msg": "Successfuly deleted transaction older than date: Thu Aug 19 2021 11:19:36 GMT+0000 (Coordinated Universal Time).",
    "transactions": [
        "otransaction~ec3366dd48b4ce2838f820f2f138648e6e55a07226713e59b411ff31b0d21058"
    ]
}

Méthodes de gestion du comportement des jetons - Comportement mintable

issueTokens

Cette méthode émet des jetons, qui sont alors détenus par l'appelant de la méthode. L'appelant doit avoir un compte et le rôle de mineur. Le nombre de jetons pouvant être frappés est limité par la propriété max_mint_quantity du comportement mintable dans le fichier de spécification. Si la propriété max_mint_quantity n'est pas spécifiée, un nombre illimité de jetons peut être pointé. La quantité doit être comprise dans les valeurs décimales spécifiées par le paramètre decimal du comportement divisible dans le fichier de spécification. Cette méthode ne peut être appelée que par AccountOwner du compte doté du rôle de créateur.

@Validator(yup.string(), yup.number().positive())
public async issueTokens(token_id: string, quantity: number) {
    const token_asset = await this.getTokenObject(token_id);
    return await this.Ctx.Token.mint(quantity, token_asset);
}

Paramètres :

token_id: string - ID du jeton.
quantity - Nombre de jetons à menthe.

Retourne :

En cas de réussite, un message avec les détails du compte.

Exemple de valeur renvoyée :

{
    "msg": "Successfully minted 1000 tokens to Account Id: \
oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (Org-Id: Org1MSP, User-Id: user1)  ",
}

getTotalMintedTokens

Cette méthode retourne le nombre total de jetons frappés pour un jeton spécifié. Cette méthode ne peut être appelée que par un élément Token Admin ou tout élément Org Admin du code de chaîne.

@Validator(yup.string())
 public async getTotalMintedTokens(token_id: string) {
     const token_asset = await this.getTokenObject(token_id);
     await this.Ctx.Auth.checkAuthorization('TOKEN.getTotalMintedTokens', 'TOKEN');
     const totalMintedTokens = await this.Ctx.Token.getTotalMintedTokens(token_asset);
     return {
         msg: `Total minted token for Token Id: ${token_id} is ${totalMintedTokens} tokens.`,
         quantity: totalMintedTokens
     };
 }

Paramètres :

token_id: string - ID du jeton.

Retourne :

En cas de succès, une chaîne JSON indiquant le nombre total de jetons.

Exemple de valeur renvoyée :

{"msg":"Total minted token for Token Id: digiCurr101 is 100 tokens.","quantity":100}

getNetTokens

Cette méthode retourne le nombre net total de jetons disponibles dans le système pour un jeton spécifié. Le total net des jetons est la quantité de jetons restants après la combustion des jetons. Sous forme d'équation : jetons nets = jetons totaux frappés - jetons totaux brûlés. Si aucun jeton n'est brûlé, le nombre de jetons nets est égal au nombre total de jetons frappés. Cette méthode ne peut être appelée que par un élément Token Admin ou tout élément Org Admin du code de chaîne.

@Validator(yup.string())
public async getNetTokens(token_id: string) {
	const token_asset = await this.getTokenObject(token_id);
	await this.Ctx.Auth.checkAuthorization('TOKEN.getNetTokens', 'TOKEN');
	const netTokens = await this.Ctx.Token.getNetTokens(token_asset);
	return {
		msg: `Net supply of token for Token Id: ${token_id} is ${netTokens} tokens.`,
		quantity: netTokens
	};
}

Paramètres :

token_id: string - ID du jeton.

Retourne :

En cas de succès, une chaîne JSON indiquant le nombre net de jetons.

Exemple de valeur renvoyée :

{"msg":"Net supply of token for Token Id: digiCurr101 is 0 tokens.","quantity":0}

Méthodes de gestion du comportement des jetons - Comportement transférable

transferTokens

Cette méthode transfère les jetons de l'appelant vers un compte spécifié. L'appelant de la méthode doit avoir un compte. La quantité doit être comprise dans les valeurs décimales spécifiées par le paramètre decimal du comportement divisible dans le fichier de spécification. Cette méthode ne peut être appelée que par AccountOwner du compte.

@Validator(yup.string(), yup.string(), yup.string(), yup.number().positive())
public async transferTokens(token_id: string, to_org_id: string, to_user_id: string, quantity: number) {
   const token_asset = await this.getTokenObject(token_id);
   const to_account_id = await this.Ctx.Account.generateAccountId(token_id, to_org_id, to_user_id);
   return await this.Ctx.Token.transfer(to_account_id, quantity, token_asset);
}

Paramètres :

token_id: string - ID du jeton.
to_org_id: string - ID fournisseur de services d'adhésion (MSP) du destinataire (bénéficiaire) dans l'organisation courante.
to_user_id: string - Nom d'utilisateur ou ID courriel du destinataire.
quantity: number - Nombre de jetons à transférer.

Retourne :

En cas de succès, un message contenant les détails des comptes payeur et bénéficiaire.

Exemple de valeur renvoyée :

{
    "msg": "Successfully transferred 400 tokens from account id: oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (Org-Id: Org1MSP, User-Id: user1) to account id: oaccount~digicur~682bb71de419602af74e3f226345ef308445ca51010737900c112435f676152df (Org-Id: Org1MSP, User-Id: user2) ",
}

bulkTransferTokens

Cette méthode est utilisée pour effectuer un transfert en masse de jetons du compte de l'appelant vers les comptes spécifiés dans l'objet flow. Les quantités doivent être comprises dans les valeurs décimales spécifiées par le paramètre decimal du comportement divisible dans l'appelant de spécification file.The de cette méthode doit avoir un compte déjà créé. Cette méthode ne peut être appelée que par AccountOwner du compte.

@Validator(yup.string(), yup.array().of(yup.object()))
public async bulkTransferTokens(token_id: string, flow: object[]) {
     const token_asset = await this.getTokenObject(token_id);
     return await this.Ctx.Token.bulkTransfer(flow, token_asset);
}

Paramètres :

token_id: string - ID du jeton.
flow : object[] - Tableau d'objets JSON qui spécifient les récepteurs et les quantités.
```
[{
	"to_org_id": "Org1MSP",
	"to_user_id": "user1",
	"quantity": 10
}, {
	"to_org_id": "Org1MSP",
	"to_user_id": "user2",
	"quantity": 10
}]
```
- to_orgId: string - ID fournisseur de services d'adhésion (MSP) du destinataire dans l'organisation courante.
- userId: string - Nom d'utilisateur ou ID courriel du destinataire.
- quantity: number - Nombre de jetons à transférer.

Retourne :

Message indiquant le succès.

Exemple de valeur renvoyée :

{
    "msg": "Successfully transferred 20 tokens from Account Id           'oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df' (Org-Id: Org1MSP, User-Id: admin).",
    "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
    "sub_transactions": [
        {
            "to_account_id": "oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
            "amount": 10
        },
        {
            "to_account_id": "oaccount~digicur~38848e87296d67c8a90918f78cf55f9c9baab2cdc8c928535471aaa1210c706e",
            "amount": 10
        }
    ]
}

Méthodes de gestion du comportement des jetons - Comportement bloquable

holdTokens

Cette méthode crée un blocage pour le compte du responsable des jetons avec le compte to_account_id. Un compte de notaire est spécifié, qui est responsable de terminer ou de débloquer le blocage. Lorsque le blocage est créé, le solde de jeton spécifié du payeur est bloqué. Un solde bloqué ne peut pas être transféré tant que le blocage n'est pas terminé ou annulé. Un compte doit déjà être créé pour l'appelant de cette méthode. Cette méthode ne peut être appelée que par AccountOwner du compte.

@Validator(yup.string(), yup.string(), yup.string(), yup.string(), yup.string(), yup.string(), yup.number().positive(), yup.date())
public async holdTokens(
    token_id: string,
    operation_id: string,
    to_org_id: string,
    to_user_id: string,
    notary_org_id: string,
    notary_user_id: string,
    quantity: number,
    time_to_expiration: Date
) {
    const token_asset = await this.getTokenObject(token_id);
    const to_account_id = await this.Ctx.Account.generateAccountId(token_id, to_org_id, to_user_id);
    const notary_account_id = await this.Ctx.Account.generateAccountId(token_id, notary_org_id, notary_user_id);
    return await this.Ctx.Token.hold(operation_id, to_account_id, notary_account_id, quantity, time_to_expiration, token_asset);
}

Paramètres :

token_id: string - ID du jeton.
operation_id: string - ID unique identifiant l'opération de blocage. En général, cet ID est transmis par l'application client.
to_org_id: string - ID fournisseur de services d'adhésion (MSP) du destinataire dans l'organisation courante.
to_user_id: string - Nom d'utilisateur ou ID courriel du destinataire.
notary_org_id: string - ID fournisseur de services d'adhésion (MSP) du notaire dans l'organisation courante.
notary_user_id: string - Nom d'utilisateur ou ID courriel du notaire.
quantity: number - Nombre de jetons à mettre en attente.
time_to_expiration - Heure à laquelle le blocage expire. Spécifiez 0 pour un blocage permanent. Sinon, utilisez le format RFC-3339. Par exemple, 2021-06-02T12 :46:06Z.

Retourne :

En cas de succès, un message contenant le compte de l'appelant et contenant les détails.

Exemple de valeur renvoyée :

{
  "msg":"AccountId oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (Org-Id: Org1MSP , User-Id: admin) is   successfully holding 10 tokens"
}

executeHoldTokens

Cette méthode met fin à un blocage sur un jeton. Une quantité de jetons précédemment détenus par un propriétaire de jeton est transférée à un destinataire. Si la valeur quantity est inférieure à la valeur de blocage réelle, le montant restant est de nouveau disponible pour le responsable initial des jetons. Cette méthode ne peut être appelée que par l'ID AccountOwner doté du rôle notary pour l'ID opération spécifié. Le blocage ne peut être effectué que par le notaire.

@Validator(yup.string(), yup.string(), yup.number().positive())
public async executeHoldTokens(token_id: string, operation_id: string, quantity: number) {
    const token_asset = await this.getTokenObject(token_id);
    return await this.Ctx.Token.executeHold(operation_id, quantity, token_asset);
}

Paramètres :

token_id: string - ID du jeton.
operation_id: string - ID unique identifiant l'opération de blocage. En général, cet ID est transmis par l'application client.
quantity: number - Nombre de jetons bloqués à transférer.

Retourne :

En cas de succès, un message avec l'ID compte de l'appelant et la quantité de la transaction.

Exemple de valeur renvoyée :

{
 "msg":"Account Id: oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (Org-Id: Org1MSP, User-Id: admin) is successfully executed '10' tokens from Operation Id 'opr_121'."
}

releaseHoldTokens

Cette méthode libère un blocage sur les jetons. Le transfert n'est pas terminé et tous les jetons détenus sont à nouveau disponibles pour le propriétaire d'origine. Cette méthode peut être appelée par l'ID AccountOwner avec le rôle notary dans la limite de temps spécifiée ou par le payeur, le bénéficiaire ou le notaire après la limite de temps spécifiée.

@Validator(yup.string(), yup.string())
public async releaseHoldTokens(token_id: string, operation_id: string) {
    const token_asset = await this.getTokenObject(token_id);
    return await this.Ctx.Token.releaseHold(operation_id, token_asset);
}

Paramètres :

token_id: string - ID du jeton.
operation_id: string - ID unique identifiant l'opération de blocage. En général, cet ID est transmis par l'application client.

Retourne :

En cas de succès, un message indiquant que le blocage a été annulé.

Exemple de valeur renvoyée :

{
 "msg":"Successfully released '10' tokens from Operation Id 'opr_121' to Account Id: oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (Org-Id: Org1MSP, User-Id: user1)."
}

getOnHoldIds

Cette méthode retourne une liste de tous les ID blocage pour un compte spécifié. Cette méthode peut être appelée par Token Admin du code de chaîne, par Org Admin de l'organisation spécifiée ou par AccountOwner du compte.

  @Validator(yup.string(), yup.string(), yup.string())
  public async getOnHoldIds(token_id: string, org_id: string, user_id: string) {
    const account_id = await this.Ctx.Account.generateAccountId(token_id, org_id, user_id);
    await this.Ctx.Auth.checkAuthorization("ACCOUNT.getOnHoldIds", "TOKEN", { account_id });
    return await this.Ctx.Account.getOnHoldIds(account_id);
  }

Paramètres :

token_id: string - ID du jeton.
org_id: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
user_id: string - Nom d'utilisateur ou ID courriel de l'utilisateur.

Retourne :

En cas de succès, liste JSON des ID de maintien.

Exemple de valeur renvoyée :

{"msg":"Holding Ids are: ohold~digicur~digiCurr101~opr_121","holding_ids":["ohold~digicur~digiCurr101~opr_121"]}

getOnHoldDetailsWithOperationId

Cette méthode retourne les détails de la transaction bloquée pour un ID opération et un jeton spécifiés. Cette méthode peut être appelée par n'importe qui.

@Validator(yup.string(), yup.string())
public async getOnHoldDetailsWithOperationId(token_id: string, operation_id: string) {
    return await this.Ctx.Hold.getOnHoldDetailsWithOperationId(token_id, operation_id);
}

Paramètres :

token_id: string - ID du jeton.
operation_id: string - ID unique identifiant l'opération de blocage. En général, cet ID est transmis par l'application client.

Retourne :

En cas de succès, un objet de blocage JSON comprenant les propriétés suivantes :
holding_id - ID détention de la transaction.
operation_id: string - ID unique identifiant l'opération de blocage. En général, cet ID est transmis par l'application client.
from_account_id - ID compte du responsable courant des jetons bloqués.
to_account_id - ID compte du destinataire.
notary_account_id - ID compte du notaire.
token_id: string - ID du jeton enregistré.
quantity - Nombre de jetons bloqués pour l'ID blocage.
time_to_expiration - Durée jusqu'à l'expiration du blocage.

Exemple de valeur renvoyée :

{
    "assetType": "ohold",
    "holding_id": "ohold~digicur~digiCurr101~opr_121",
    "operation_id": "opr_121",
    "token_name": "digicur",
    "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
    "to_account_id": "oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
    "notary_account_id": "oaccount~digicur~38848e87296d67c8a90918f78cf55f9c9baab2cdc8c928535471aaa1210c706e",
    "token_id": "digiCurr101",
    "quantity": 10,
    "time_to_expiration": "2022-08-01T18:30:00.000Z"
}

getOnHoldBalanceWithOperationId

Cette méthode retourne le solde de blocage pour un ID opération et un jeton spécifiés. Cette méthode peut être appelée par n'importe qui.

@Validator(yup.string(), yup.string())
public async getOnHoldBalanceWithOperationId(token_id: string, operation_id: string) {
    return await this.Ctx.Hold.getOnHoldBalanceWithOperationId(token_id, operation_id);
}

Paramètres :

token_id: string - ID du jeton.
operation_id: string - ID unique identifiant l'opération de blocage. En général, cet ID est transmis par l'application client.

Retourne :

En cas de succès, une chaîne JSON indiquant le solde de blocage.

Exemple de valeur renvoyée :

{
	"msg": "Current Holding Balance of Operation 'opr_121' for token 'digiCurr101' is: 10",
	"holding_balance": 10
}

Méthodes de gestion du comportement des jetons - Comportement brûlable

burnTokens

Cette méthode désactive ou grave les jetons du compte de l'appelant de la transaction. L'appelant de cette méthode doit avoir un compte et le rôle de brûleur. La quantité doit être comprise dans les valeurs décimales spécifiées par le paramètre decimal du comportement divisible dans le fichier de spécification. Cette méthode peut être appelée par AccountOwner du compte avec le rôle de brûleur.

@Validator(yup.string(), yup.number().positive())
public async burnTokens(token_id: string, quantity: number) {
    const token_asset = await this.getTokenObject(token_id);
    return await this.Ctx.Token.burn(quantity, token_asset);
}

Paramètres :

token_id: string - ID du jeton.
quantity - Nombre de jetons à brûler.

Retourne :

En cas de succès, un message de réussite avec la quantité de jetons brûlés et l'ID compte.

Exemple de valeur renvoyée :

{
    "msg": "Successfully burned 10 tokens from account id: oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (Org-Id: Org1MSP, User-Id: admin)"
}

Méthodes personnalisées

Vous pouvez utiliser les méthodes de la trousse SDK de jeton pour écrire des méthodes personnalisées pour votre application d'affaires.

Pour éviter les doubles dépenses, ne combinez pas plusieurs fonctions asynchrones qui fonctionnent sur les mêmes paires clé-valeur dans la base de données d'état. Utilisez plutôt la méthode bulkTransferTokens pour effectuer plusieurs transferts dans une méthode.

L'exemple suivant montre comment utiliser des méthodes de trousse SDK de jeton dans des méthodes personnalisées. Lorsque la méthode buyTicket est appelée, elle transfère 20 jetons du compte de l'appelant au compte du vendeur et retourne le message de transaction du transfert.

@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;
}

Si vous utilisez plusieurs méthodes de trousse SDK de jeton dans une méthode personnalisée, n'utilisez pas de méthodes qui affecteront les mêmes paires clé-valeur dans la base de données d'état. L'exemple suivant montre comment effectuer plusieurs transferts de manière incorrecte :

@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);
}

Utilisez plutôt la méthode bulkTransferTokens pour transférer vers plusieurs comptes à partir du compte de l'appelant, comme indiqué dans l'extrait de code suivant.

bulkTransferTokens(token_id: string, flow: object[])

Note :

Si vous utilisez plus d'une méthode de trousse SDK de jeton dans une méthode personnalisée qui pourrait affecter les mêmes paires clé-valeur dans la base de données d'état, activez l'optimisation MVCC pour les codes de chaîne de jeton. Pour plus d'informations, voir Optimisation MVCC.

Méthodes de la trousse SDK de jeton

Méthodes pour la gestion du contrôle d'accès

La trousse SDK de jeton fournit une fonction de contrôle d'accès. Certaines méthodes ne peuvent être appelées que par Token Admin, Org Admin ou AccountOwner du jeton. Vous pouvez utiliser cette fonction 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/auth.

import { Authorization } from '../lib/auth';

addAdmin

Cette méthode ajoute un utilisateur en tant que Token Admin du code de chaîne du jeton.

Ctx.Admin.addAdmin(org_id: string, user_id: string)

Paramètres :

user_id - Nom d'utilisateur ou ID courriel de l'utilisateur.
org_id - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation de réseau courante.

Retourne :

En cas de réussite, un message de promesse avec un objet JSON qui répertorie les détails de l'utilisateur ajouté en tant que Token Admin du code de chaîne du jeton. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
    "msg": "Successfully added Admin (Org_Id: Org1MSP, User_Id: user1)"
}

removeAdmin

Cette méthode supprime un utilisateur en tant que Token Admin du code de chaîne du jeton.

Ctx.Admin.removeAdmin(org_id: string, user_id: string)

Paramètres :

user_id - Nom d'utilisateur ou ID courriel de l'utilisateur.
org_id - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation de réseau courante.

Retourne :

En cas de réussite, un message de promesse avec un objet JSON qui répertorie les détails pour l'utilisateur qui n'est plus Token Admin du code de chaîne du jeton. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
    "msg": "Successfully removed Admin (Org_Id: Org1MSP, User_Id: user1)"
}

getAllAdmins

Cette méthode retourne une liste de tous les utilisateurs qui sont Token Admin du code de chaîne du jeton.

Ctx.Admin.getAllAdmins()

Paramètres :

aucune

Retourne :

En cas de réussite, promesse avec un objet JSON qui répertorie les détails pour tous les utilisateurs qui sont des Token Admin du code de chaîne du jeton. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
    "admins": [
        {
            "orgId": "Org1MSP",
            "userId": "admin"
        }
    ]
}

checkAuthorization

Utilisez cette méthode pour ajouter une vérification de contrôle d'accès à une opération. Certaines méthodes de jeton ne peuvent être exécutées que par Token Admin ou AccountOwner du jeton ou par MultipleAccountOwner pour les utilisateurs ayant plusieurs comptes. Le mappage du contrôle d'accès est décrit dans le fichier ../lib/constant.ts. 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", "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"],
  },
}

await this.Ctx.Auth.checkAuthorization(<parameters>);

Paramètres :

classFuncName: string - Valeur de mappage entre la classe et les méthodes, comme décrit dans le fichier ../lib/constant.ts.
...args - Argument de variable où args[0] prend la constante 'TOKEN' et args[1] prend account_id pour ajouter une vérification de contrôle d'accès pour AccountOwner. Pour ajouter une vérification de contrôle d'accès pour MultipleAccountOwner, args[1] prend org_id et args[2] prend user_id.

Retourne :

Sur le succès, une promesse. En cas d'erreur, un rejet avec un message d'erreur.

isUserTokenAdmin

Cette méthode retourne la valeur booléenne true si l'appelant de la fonction est Token Admin. Sinon, la méthode retourne false.

Ctx.Auth.isUserTokenAdmin()

Paramètres :

user_id - Nom d'utilisateur ou ID courriel de l'utilisateur.
org_id - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation de réseau courante.

Retourne :

Une réponse booléenne et un message d'erreur en cas d'erreur.

addOrgAdmin

Cette méthode ajoute un utilisateur en tant que Org Admin de l'organisation.

Ctx.Admin.addOrgAdmin(org_id, user_id)

Paramètres :

org_id: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
user_id: string - Nom d'utilisateur ou ID courriel de l'utilisateur.

Retourne :

En cas de réussite, un message contenant les détails de l'utilisateur qui a été ajouté en tant que Org Admin de l'organisation.

Exemple de valeur renvoyée :

{
    "msg": "Successfully added Org Admin (Org_Id: Org1MSP, User_Id: orgAdmin)"
}

removeOrgAdmin

Cette méthode supprime un utilisateur en tant que Org Admin de l'organisation.

Ctx.Admin.removeOrgAdmin(org_id, user_id)

Paramètres :

org_id: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
user_id: string - Nom d'utilisateur ou ID courriel de l'utilisateur.

Retourne :

En cas de réussite, un message contenant les détails de l'utilisateur qui a été supprimé en tant que Org Admin de l'organisation.

Exemple de valeur renvoyée :

{
  "msg": "Successfully removed Org Admin (Org_Id Org1MSP User_Id orgAdmin)"
}

getOrgAdmins

Cette méthode retourne une liste de tous les utilisateurs qui sont des Org Admin d'une organisation.

Ctx.Admin.getAllOrgAdmins()

Paramètres :

aucune

Retourne :

En cas de succès, tableau au format JSON qui contient les objets orgId et userId.

Exemple de valeur renvoyée :

{
    "admins": [
        {
            "org_id": "Org1MSP",
            "user_id": "orgadmin"
        },
        {
            "org_id": "Org1MSP",
            "user_id": "orgadmin1"
        },
        {
            "org_id": "Org1MSP",
            "user_id": "orgadmin2"
        }
    ]
}

Méthodes de gestion de la configuration de jeton

getTokenDecimals

Cette méthode retourne le nombre de décimales disponibles pour un jeton fractionnaire. Si le comportement divisible n'est pas spécifié, la valeur par défaut est 0.

Ctx.Token.getTokenDecimals(token_id: string)

Paramètres :

token_id: string - ID du jeton.

Retourne :

En cas de succès, les décimales du jeton, dans le type de données numérique. En cas d'erreur, un message d'erreur s'affiche.

Exemple de valeur renvoyée :

getAllTokens

Cette méthode retourne toutes les ressources de jeton enregistrées dans la base de données d'état. Cette méthode utilise des interrogations SQL enrichies Berkeley DB et ne peut être appelée que lorsqu'elle est connectée au réseau Oracle Blockchain Platform distant.

Ctx.Token.getAllTokens()

Paramètres :

aucune

Retourne :

En cas de succès, il retourne une promesse avec toutes les ressources de jeton. En cas d'erreur, un message d'erreur s'affiche.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "98e0a0a115803d25b843d630e6b23c435a192a03eb0a301fc9375f05da49a8b2",
        "payload": [
            {
                "key": "token1",
                "valueJson": {
                    "assetType": "otoken",
                    "token_id": "token1",
                    "token_name": "vtok",
                    "token_type": "fungible",
                    "behaviours": [
                        "divisible",
                        "mintable",
                        "transferable",
                        "burnable",
                        "holdable",
                        "roles"
                    ],
                    "roles": {
                        "burner_role_name": "burner",
                        "notary_role_name": "notary"
                    },
                    "mintable": {
                        "max_mint_quantity": 0
                    },
                    "divisible": {
                        "decimal": 1
                    }
                }
            }
        ],
        "encode": "JSON"
    }
}

getTokensByName

Cette méthode retourne toutes les ressources de jeton portant le nom spécifié. Cette méthode utilise des interrogations SQL enrichies Berkeley DB et ne peut être appelée que lorsqu'elle est connectée au réseau Oracle Blockchain Platform distant.

Ctx.Token.getTokensByName(token_name: string)

Paramètres :

token_name: string - Nom du jeton, qui correspond à la propriété Token_name du modèle. La valeur est le nom de classe du jeton.

Retourne :

Elle retourne un tableau de toutes les ressources de jeton du nom spécifié, au format JSON.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "98e0a0a115803d25b843d630e6b23c435a192a03eb0a301fc9375f05da49a8b2",
        "payload": [
            {
                "key": "token1",
                "valueJson": {
                    "assetType": "otoken",
                    "token_id": "token1",
                    "token_name": "vtok",
                    "token_type": "fungible",
                    "behaviours": [
                        "divisible",
                        "mintable",
                        "transferable",
                        "burnable",
                        "holdable",
                        "roles"
                    ],
                    "roles": {
                        "burner_role_name": "burner",
                        "notary_role_name": "notary"
                    },
                    "mintable": {
                        "max_mint_quantity": 0
                    },
                    "divisible": {
                        "decimal": 1
                    }
                }
            }
        ],
        "encode": "JSON"
    }
}

get

Cette méthode retourne un objet de jeton s'il est présent dans la base de données d'état.

Ctx.Token.get(token_id: string)

Paramètres :

token_id: string - ID du jeton à retourner.

Retourne :

En cas de succès, une promesse avec la représentation JSON du jeton. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
    "assetType": "otoken",
    "token_id": "token1",
    "token_name": "account",
    "token_desc": "Token 1",
    "token_type": "fungible",
    "behaviors": [
        "divisible",
        "mintable",
        "transferable",
        "burnable",
        "holdable",
        "roles"
    ],
    "roles": {
        "minter_role_name": "minter",
        "burner_role_name": "burner",
        "notary_role_name": "notary"
    },
    "mintable": {
        "max_mint_quantity": 20000
    },
    "divisible": {
        "decimal": 1
    },
    "token_to_currency_ratio": 2,
    "currency_representation": "EURO"
}

isTokenType

Cette méthode indique si une ressource de jeton existe avec l'ID spécifié.

Ctx.Token.isTokenType(token_id: string)

Paramètres :

token_id: string - ID du jeton à vérifier.

Retourne :

En cas de succès, une promesse avec la valeur Vrai s'il existe une ressource de jeton avec l'ID spécifié. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

true

save

Cette méthode crée un jeton et enregistre ses propriétés dans la base de données d'état.

Ctx.Token.save(token: <Instance of Token Class>,extraMetadata?:any)

Paramètres :

token: <Instance of Token Class> - Ressource de jeton à utiliser.

Retourne :

En cas de succès, un message de promesse contenant les détails du jeton. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
   "assetType":"otoken",
   "token_id":"digiCurr101",
   "token_name":"digicur",
   "token_type":"fungible",
   "behaviors":[
      "divisible",
      "mintable",
      "transferable",
      "burnable",
      "roles"
   ],
   "roles":{
      "minter_role_name":"minter"
   },
   "mintable":{
      "max_mint_quantity":1000
   },
   "divisible":{
      "decimal":2
   },
   "currency_name":"DOLLAR",
   "token_to_currency_ratio":1
}

update

Cette méthode met à jour les propriétés du jeton. Après la création d'une ressource de jeton, vous mettez à jour uniquement la valeur token_desc et ses propriétés personnalisées.

Ctx.Token.update(token: <Instance of Token Class>)

Paramètres :

token: <Instance of Token Class> - Ressource de jeton à utiliser.

Retourne :

En cas de succès, un message de promesse contenant les détails du jeton. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
   "assetType":"otoken",
   "token_id":"digiCurr101",
   "token_name":"digicur",
   "token_desc":"Digital Currency equiv of dollar",
   "token_type":"fungible",
   "behaviors":[
      "divisible",
      "mintable",
      "transferable",
      "burnable",
      "roles"
   ],
   "roles":{
      "minter_role_name":"minter"
   },
   "mintable":{
      "max_mint_quantity":1000
   },
   "divisible":{
      "decimal":2
   },
   "currency_name":"DOLLAR",
   "token_to_currency_ratio":1
}

getByRange

Cette méthode appelle la méthode getStateByRange de structure en interne. Même si une immobilisation avec le code donné est retournée du grand livre, cette méthode convertit l'immobilisation dans le type d'immobilisation de l'appelant.

<Token ClassCtx.Token.getByRange(start_token_id: string, end_token_id: string, token_class_reference?: <Instance of Token Class> )

Paramètres :

startId: string - Clé de début de l'intervalle. Cette clé est incluse dans l'intervalle.
endId: string - Clé de fin de l'intervalle. Cette clé est exclue de l'intervalle.
token: <Instance of Token Class> - Ressource de jeton à utiliser.

Retourne :

Sur le succès, une promesse avec un tableau de <Token Class>. En cas d'erreur, un rejet avec un message d'erreur.

Exemple :

@validator(yup.string(), yup.string())
public async getDigiCurrGetByRange(start_token_id: string, end_token_id: string) {
   return await this.Ctx.Token.getByRange(start_token_id, end_token_id, DigiCurr);
}

Exemple de valeur renvoyée :

[
    {
        "assetType": "otoken",
        "token_id": "token1",
        "token_name": "digicur",
        "token_desc": "Token 1",
        "token_type": "fungible",
        "behaviors": [
            "divisible",
            "mintable",
            "transferable",
            "burnable",
            "holdable",
            "roles"
        ],
        "roles": {
            "minter_role_name": "minter",
            "burner_role_name": "burner",
            "notary_role_name": "notary"
        },
        "mintable": {
            "max_mint_quantity": 20000
        },
        "divisible": {
            "decimal": 0
        },
        "token_to_currency_ratio": 1.5,
        "currency_representation": "USD"
    },
    {
        "assetType": "otoken",
        "token_id": "token2",
        "token_name": "digicur",
        "token_desc": "Token2",
        "token_type": "fungible",
        "behaviors": [
            "divisible",
            "mintable",
            "transferable",
            "burnable",
            "holdable",
            "roles"
        ],
        "roles": {
            "minter_role_name": "minter",
            "burner_role_name": "burner",
            "notary_role_name": "notary"
        },
        "mintable": {
            "max_mint_quantity": 20000
        },
        "divisible": {
            "decimal": 0
        },
        "token_to_currency_ratio": 1,
        "currency_representation": "EURO"
    }
]

history

Cette méthode retourne l'historique pour le jeton spécifié.

Ctx.Token.history(tokenId)

Paramètres :

tokenId: string - ID du jeton.

Retourne :

En cas de succès, une promesse comportant un tableau des détails de l'historique du compte pour le jeton spécifié. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

[
    {
        "trxId": "0d75f09446a60088afb948c6aca046e261fddcd43df416076201cdc5565f1a35",
        "timeStamp": "2023-09-01T16:48:41.000Z",
        "value": {
            "assetType": "otoken",
            "token_id": "token",
            "token_name": "fiatmoneytok",
            "token_desc": "updatedDesc",
            "token_standard": "ttf+",
            "token_type": "fungible",
            "token_unit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter"
            },
            "mintable": {
                "max_mint_quantity": 1000
            },
            "divisible": {
                "decimal": 2
            }
        }
    },
    {
        "trxId": "3666344878b043b65d5b821cc79c042ba52aec467618800df5cf14eac69f72fa",
        "timeStamp": "2023-08-31T20:24:55.000Z",
        "value": {
            "assetType": "otoken",
            "token_id": "token",
            "token_name": "fiatmoneytok",
            "token_standard": "ttf+",
            "token_type": "fungible",
            "token_unit": "fractional",
            "behaviors": [
                "divisible",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter"
            },
            "mintable": {
                "max_mint_quantity": 1000
            },
            "divisible": {
                "decimal": 2
            }
        }
    }
]

Méthodes de gestion des comptes

getCallerAccountId

Cette méthode retourne l'ID compte de l'appelant.

Ctx.Account.getCallerAccountId(token_id: string)

Paramètres :

tokenId: string - ID du jeton.

Retourne :

En cas de succès, une promesse avec l'ID compte de l'appelant. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f

generateAccountId

Cette méthode retourne un ID compte, qui est un jeu de caractères alphanumériques, précédé de oaccount~<token asset name>~ et suivi d'un hachage du nom d'utilisateur ou de l'ID courriel (user_id) du responsable de l'instance ou de l'utilisateur connecté à l'instance, de l'ID fournisseur de services d'appartenance (org_id) de l'utilisateur dans l'organisation de réseau courante et de l'ID jeton unique (token_id).

Ctx.Account.generateAccountId(token_id: string, org_id: string, user_id: string)

Paramètres :

tokenId: string - ID du jeton.
orgId: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
userId: string - Nom d'utilisateur ou ID courriel de l'utilisateur.

Retourne :

En cas de succès, une promesse avec l'ID compte généré. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f

createAccount

Cette méthode crée un compte pour un utilisateur et un jeton spécifiés. Chaque utilisateur qui a des jetons à tout moment doit avoir un compte. Les comptes font le suivi du solde d'un utilisateur, du solde bloqué et de l'historique des transactions. Un ID compte est un jeu de caractères alphanumériques, précédé de oaccount~<token asset name>~ et suivi d'un hachage du nom d'utilisateur ou de l'ID courriel (user_id) du responsable de l'instance ou de l'utilisateur connecté à l'instance, de l'ID fournisseur de services d'appartenance (org_id) de l'utilisateur dans l'organisation de réseau courante. Cette méthode ne peut être appelée que par Token Admin du code de chaîne ou par Org Admin de l'organisation spécifiée.

this.Ctx.Account.createAccount(org_id: string, user_id: string, token_type: string)

Paramètres :

org_id: string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
user_id: string - Nom d'utilisateur ou ID courriel de l'utilisateur.
token_type: string - Type du jeton, qui doit être fungible.

Retourne :

En cas de succès, le nouvel objet de compte au format JSON.

Exemple de valeur renvoyée :

{
  "assetType": "oaccount",
  "bapAccountVersion": 0,
  "account_id": "oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb",
  "user_id": "admin",
  "org_id": "Org1MSP",
  "token_type": "fungible",
  "token_id": "",
  "token_name": "",
  "balance": 0,
  "onhold_balance": 0
}

associateTokenToAccount

async associateTokenToAccount(account_id: string, token_id: string)

Paramètres :

account_id: string - ID du compte.
token_id: string - ID du jeton.

Retourne :

En cas de succès, un objet JSON du compte mis à jour.

Exemple de valeur renvoyée :

{
    "assetType": "oaccount",
    "bapAccountVersion": 0,
    "account_id": "oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb",
    "user_id": "admin",
    "org_id": "Org1MSP",
    "token_type": "fungible",
    "token_id": "fungible",
    "token_name": "fiatmoneytok",
    "balance": 0,
    "onhold_balance": 0
}

getAccountWithStatus

Cette méthode retourne les détails du compte pour un compte spécifié, notamment le statut du compte.

Ctx.Account.getAccountWithStatus(account_id: string)

Paramètres :

account_id: string - ID du compte.

Retourne :

En cas de succès, une promesse avec les détails du compte. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
  "bapAccountVersion": 0,
  "assetType": "oaccount",
  "status": "active",
  "account_id": "oaccount~2de8db6b91964f8c9009136831126d3cfa94e1d00c4285c1ea3e6d1f36479ed4",
  "user_id": "idcqa",
  "org_id": "appdev",
  "token_type": "fungible",
  "token_id": "t1",
  "token_name": "obptok",
  "balance": 0,
  "onhold_balance": 0
}

getAccount

Cette méthode retourne les détails du compte pour un compte spécifié.

Ctx.Account.getAccount(account_id: string)

Paramètres :

account_id: string - ID du compte.

Retourne :

En cas de succès, une promesse avec les détails du compte. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
   "assetType":"oaccount",
   "bapAccountVersion": 0,
   "account_id":"oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
   "user_id":"user1",
   "org_id":"Org1MSP",
   "token_id":"digiCurr101",
   "token_name":"digicur",
   "balance":0,
   "onhold_balance":0
}

history

Cette méthode retourne un tableau des détails de l'historique du compte pour un compte spécifié.

Ctx.Account.history(account_id: string)

Paramètres :

account_id: string - ID du compte.

Retourne :

Sur le succès, une promesse avec le tableau des détails de l'historique du compte. En cas d'erreur, un rejet avec un message d'erreur. La valeur retournée est identique à la méthode "getAccountHistory".

Exemple de valeur renvoyée :

[
    {
      "trxId":"2gsdh17fff222467e5667be042e33ce18e804b3e065cca15de306f837e416d7c3e",
      "timeStamp":1629718288,
      "value":{
         "assetType":"oaccount",
         "account_id":"oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
         "user_id":"user1",
         "org_id":"Org1MSP",
         "token_id":"digiCurr101",
         "token_name":"digicur",
         "balance":100,
         "onhold_balance":0,
         "bapAccountVersion": 1
   },
   {
      "trxId":"9fd07fff222467e5667be042e33ce18e804b3e065cca15de306f837e416d7c3e",
      "timeStamp":1629718288,
      "value":{
         "assetType":"oaccount",
         "account_id":"oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
         "user_id":"user1",
         "org_id":"Org1MSP",
         "token_id":"digiCurr101",
         "token_name":"digicur",
         "balance":0,
         "onhold_balance":0,
         "bapAccountVersion": 0
      }
   }
]

getAccountOnHoldBalance

Cette méthode retourne le solde bloqué pour un compte spécifié.

Ctx.Account.getAccountOnHoldBalance(account_id: string)

Paramètres :

account_id: string - ID du compte.

Retourne :

En cas de succès, promesse avec un objet JSON qui affiche le solde de blocage pour le compte spécifié. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
   "holding_balance":0,
   "msg":"Total Holding Balance of Account Id oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f (org_id: Org1MSP, user_id: user1) is 0"
}

getAllAccounts

Cette méthode retourne une liste de tous les comptes. Cette méthode utilise des interrogations SQL enrichies Berkeley DB et ne peut être appelée que lorsqu'elle est connectée au réseau Oracle Blockchain Platform distant.

Ctx.Account.getAllAccounts()

Paramètres :

aucune

Retourne :

En cas de succès, une promesse avec un objet JSON qui répertorie tous les comptes. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

[
           {
               "key": "oaccount~digicur~2e2ef3375ae347cbd7b4d3d7be5cece803f9c36a184aaf2b8d332c5d2dcead52",
               "valueJson": {
                   "assetType": "oaccount",
                   "account_id": "oaccount~digicur~2e2ef3375ae347cbd7b4d3d7be5cece803f9c36a184aaf2b8d332c5d2dcead52",
                   "user_id": "admin",
                   "org_id": "Org1MSP",
                   "token_id": "digiCurr101",
                   "token_name": "digicur",
                   "bapAccountVersion": 0,
                   "balance": 0,
                   "onhold_balance": 0
               }
           },
           {
               "key": "oaccount~digicur~30080c7e5ba94035af57fbbccbbb495e92515e4b2b3dbcd476eb1c0343e4da65",
               "valueJson": {
                   "assetType": "oaccount",
                   "account_id": "oaccount~digicur~30080c7e5ba94035af57fbbccbbb495e92515e4b2b3dbcd476eb1c0343e4da65",
                   "bapAccountVersion": 0,
                   "user_id": "user1",
                   "org_id": "Org1MSP",
                   "token_id": "digiCurr101",
                   "token_name": "digicur",
                   "balance": 0,
                   "onhold_balance": 0
               }
           },
           {
               "key": "oaccount~digicur~cbde438258cb01a82f71a9a9f8029243c40c6d836a505432120529c2b3c2ff0c",
               "valueJson": {
                   "assetType": "oaccount",
                   "account_id": "oaccount~digicur~cbde438258cb01a82f71a9a9f8029243c40c6d836a505432120529c2b3c2ff0c",
                   "bapAccountVersion": 0,
                   "user_id": "user2",
                   "org_id": "Org1MSP",
                   "token_id": "digiCurr101",
                   "token_name": "digicur",
                   "balance": 0,
                   "onhold_balance": 0
               }
           },
           {
               "key": "oaccount~digicur~ecbc3aefcc562d3049c988717940195b30297e95012b7824bbd33a57ca50a626",
               "valueJson": {
                   "assetType": "oaccount",
                   "account_id": "oaccount~digicur~ecbc3aefcc562d3049c988717940195b30297e95012b7824bbd33a57ca50a626",
                   "bapAccountVersion": 0,
                   "user_id": "user3",
                   "org_id": "Org1MSP",
                   "token_id": "digiCurr101",
                   "token_name": "digicur",
                   "balance": 500,
                   "onhold_balance": 0
               }
           }
       ]

getUserByAccountId

Cette méthode retourne les détails de l'utilisateur pour un compte spécifié.

Ctx.Account.getUserByAccountId(account_id: string)

Paramètres :

account_id: string - ID du compte.

Retourne :

En cas de succès, une promesse avec un objet JSON comprenant trois propriétés :
- user_id - Nom d'utilisateur ou ID courriel de l'utilisateur.
- org_id - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation de réseau courante.
- token_id - ID du jeton.
En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
   "token_id": "digiCurr101",
   "user_id": "user1",
   "org_id": "Org1MSP"
}

getAccountBalance

Cette méthode retourne le solde du compte pour un compte spécifié.

Ctx.Account.getAccountBalance(account_id: string)

Paramètres :

account_id: string - ID du compte.

Retourne :

En cas de succès, un message de promesse avec un objet JSON comprenant deux propriétés :
- msg - Message affichant le solde courant.
- user_balance - Valeur numérique du solde courant.
En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
    "msg": "Current Balance is: 200",
    "user_balance": 200
}

getAllOrgAccounts

Cette méthode retourne une liste de tous les comptes de jeton appartenant à une organisation spécifiée.

Ctx.Account.getAllOrgAccounts(org_id: string)

Paramètres :

org_id: string - ID fournisseur de services d'adhésion (MSP) de l'organisation.

Retourne :

En cas de succès, une liste de tous les comptes pour l'organisation spécifiée.

Exemple de valeur renvoyée :

[
    {
        "key": "oaccount~2de8db6b91964f8c9009136831126d3cfa94e1d00c4285c1ea3e6d1f36479ed4",
        "valueJson": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~2de8db6b91964f8c9009136831126d3cfa94e1d00c4285c1ea3e6d1f36479ed4",
            "user_id": "idcqa",
            "org_id": "appdev",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "fiatmoneytok",
            "balance": 0,
            "onhold_balance": 0
        }
    },
    {
        "key": "oaccount~620fcf5deb5fd5a65c0b5b10fda129de0f629ccd232c5891c130e24a574df50a",
        "valueJson": {
            "bapAccountVersion": 0,
            "assetType": "oaccount",
            "account_id": "oaccount~620fcf5deb5fd5a65c0b5b10fda129de0f629ccd232c5891c130e24a574df50a",
            "user_id": "example_minter",
            "org_id": "appdev",
            "token_type": "fungible",
            "token_id": "token",
            "token_name": "fiatmoneytok",
            "balance": 0,
            "onhold_balance": 0
        }
    }
]

Méthodes pour la gestion des rôles

addRoleMember

Cette méthode ajoute un rôle à un utilisateur et à un jeton spécifiés.

Ctx.Token.addRoleMember(role: string, account_id: string, token: <Instance of Token Class>)

Paramètres :

role: string - Nom du rôle à ajouter à l'utilisateur spécifié. Les comportements mintable et burnable correspondent aux propriétés minter_role_name et burner_role_name du fichier de spécification. De même, le rôle notary correspond à la propriété notary_role_name du fichier de spécification.
account_id: number - ID compte auquel ajouter le rôle.
token: <Instance of Token Class> - Ressource de jeton à utiliser.

Retourne :

Sur la réussite, une promesse avec un message de réussite. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
    "msg":"Successfully added role minter to oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f (org_id :          Org1MSP, user_id : user1)"
}

removeRoleMember

Cette méthode supprime un rôle d'un utilisateur et d'un jeton spécifiés.

Ctx.Token.removeRoleMember(role: string, account_id: string, token: <Instance of Token Class>)

Paramètres :

role: string - Nom du rôle à supprimer pour l'utilisateur spécifié. Les comportements mintable et burnable correspondent aux propriétés minter_role_name et burner_role_name du fichier de spécification. De même, le rôle notary correspond à la propriété notary_role_name du fichier de spécification.
account_id: number - ID compte duquel supprimer le rôle.
token: <Instance of Token Class> - Ressource de jeton à utiliser.

Retourne :

Sur la réussite, une promesse avec un message de réussite. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
  "msg":"successfully removed member_id oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f (org_id : Org1MSP, user_id : user1) from role minter"
}

getAccountsByRole

Cette méthode retourne une liste de tous les comptes pour un rôle et un jeton spécifiés.

Ctx.Role.getAccountsByRole(token_id: string, role: string)

Paramètres :

token_id: string - ID du jeton.
role: string - Nom du rôle à rechercher.

Retourne :

En cas de succès, promesse avec un objet JSON qui répertorie tous les comptes pour le rôle et le jeton spécifiés. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
    "accounts": [
        "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
        "oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f"
    ]
}

getAccountsByUser

Cette méthode retourne une liste de tous les ID compte pour un utilisateur spécifié.

async getAccountsByUser(org_id: string, user_id: string)

Paramètres :

org_id string - ID fournisseur de services d'adhésion (MSP) de l'utilisateur dans l'organisation courante.
user_id string - Nom d'utilisateur ou ID courriel de l'utilisateur.

Retourne :

En cas de succès, un tableau JSON d'ID compte.

Exemple de valeur renvoyée :

{"accounts":["oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f"]}

getUsersByRole

Cette méthode retourne une liste de tous les utilisateurs pour un rôle et un jeton spécifiés.

Ctx.Role.getUsersByRole(token_id: string, role: string)

Paramètres :

token_id: string - ID du jeton.
role: string - Nom du rôle à rechercher.

Retourne :

En cas de succès, promesse avec un objet JSON qui répertorie tous les utilisateurs pour le rôle et le jeton spécifiés. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
   "users":[
      {
         "token_id":"digiCurr101",
         "user_id":"user1",
         "org_id":"Org1MSP"
      }
   ]
}

isInRole

Cette méthode indique si un utilisateur et un jeton ont un rôle spécifié.

Ctx.Token.isInRole(role: string, account_id: string, token: <Instance of Token Class>)

Paramètres :

role: string - Nom du rôle à vérifier.
account_id: number - ID compte à vérifier.
token: <Instance of Token Class> - Ressource de jeton à utiliser.

Retourne :

En cas de succès, une promesse avec la valeur Vrai si l'utilisateur a le rôle, et la valeur Faux si l'utilisateur n'a pas le rôle. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{"result":"true"}

roleCheck

Cette méthode vérifie si l'ID compte fourni est membre d'un rôle.

Ctx.Token.roleCheck(account_id: string, token: <Instance of Token Class>)

Paramètres :

account_id: string - ID compte à vérifier.
token: <Instance of Token Class> - Ressource de jeton à utiliser.

Retourne :

Si l'ID compte fait partie d'un rôle, il retourne true. Sinon, la valeur false est retournée.

Exemple de valeur renvoyée :

{ result: true }

getOrgUsersByRole

Cette méthode retourne des informations sur tous les utilisateurs qui ont un rôle spécifié dans une organisation spécifiée.

Ctx.Role.getOrgUsersByRole(token_id: string, role: string, org_id: string)

Paramètres :

token_id: string - ID du jeton.
role: string - Nom du rôle à vérifier.
org_id: string - ID fournisseur de services d'adhésion (MSP) de l'organisation.

Retourne :

Au succès, une liste de tous les utilisateurs ayant le rôle spécifié dans l'organisation spécifiée.

Exemple de valeur renvoyée :

{
    "users": [
        {
            "token_id": "token",
            "user_id": "admin",
            "org_id": "Org1MSP"
        },
        {
            "token_id": "token",
            "user_id": "orgAdmin",
            "org_id": "Org1MSP"
        }
    ]
}

getOrgAccountsByRole

Cette méthode retourne des informations sur tous les comptes qui ont un rôle spécifié dans une organisation spécifiée.

Ctx.Role.getOrgAccountsByRole(token_id: string, role: string, org_id: string)

Paramètres :

token_id: string - ID du jeton.
role: string - Nom du rôle à vérifier.
org_id: string - ID fournisseur de services d'adhésion (MSP) de l'organisation.

Retourne :

En cas de succès, une liste de tous les comptes ayant le rôle spécifié dans l'organisation spécifiée.

Exemple de valeur renvoyée :

{
    "accounts": [
        "oaccount~abc74791148b761352b98df58035601b6f5480448ac2b4a3a7eb54bdbebf48eb",
        "oaccount~9c650574af9025a6106c8d12a801b079eda9ae2e3399fc2fbd5bd683d738a850"
    ]
}

Méthodes de gestion de l'historique des transactions

getTransactionById

Cette méthode retourne l'historique d'une ressource Transaction.

async getTransactionById(transaction_id: string)

Paramètres :

transaction_id: string - ID de l'immobilisation de transaction.

Retourne :

En cas de succès, l'historique des immobilisations de transaction.

Exemple de valeur renvoyée :

{
    "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
    "history": [
        {
            "trxId": "68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
            "timeStamp": 1629180264,
            "value": {
                "assetType": "otransaction",
                "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
                "token_id": "digiCurr101",
                "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
                "to_account_id": "",
                "transaction_type": "BULKTRANSFER",
                "amount": 20,
                "timestamp": "2021-08-17T06:04:24.000Z",
                "number_of_sub_transactions": 2,
                "holding_id": ""
            }
        }
    ],
    "sub_transactions": [
        {
            "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c4ca4238a0b923820dcc509a6f75849b",
            "history": [
                {
                    "trxId": "68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
                    "timeStamp": 1629180264,
                    "value": {
                        "assetType": "otransaction",
                        "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c4ca4238a0b923820dcc509a6f75849b",
                        "token_id": "digiCurr101",
                        "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
                        "to_account_id": "oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
                        "transaction_type": "TRANSFER",
                        "amount": 10,
                        "timestamp": "2021-08-17T06:04:24.000Z",
                        "number_of_sub_transactions": 0,
                        "holding_id": ""
                    }
                }
            ]
        },
        {
            "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c81e728d9d4c2f636f067f89cc14862c",
            "history": [
                {
                    "trxId": "68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
                    "timeStamp": 1629180264,
                    "value": {
                        "assetType": "otransaction",
                        "transaction_id": "otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c81e728d9d4c2f636f067f89cc14862c",
                        "token_id": "digiCurr101",
                        "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
                        "to_account_id": "oaccount~digicur~38848e87296d67c8a90918f78cf55f9c9baab2cdc8c928535471aaa1210c706e",
                        "transaction_type": "TRANSFER",
                        "amount": 10,
                        "timestamp": "2021-08-17T06:04:24.000Z",
                        "number_of_sub_transactions": 0,
                        "holding_id": ""
                    }
                }
            ]
        }
    ]
}

deleteHistoricalTransactions

Cette méthode retourne un tableau des détails de l'historique des transactions pour un compte spécifié.

async deleteHistoricalTransactions(time_to_expiration: Date)

Paramètres :

time_to_expiration: Date - Horodatage qui indique quand supprimer des transactions. Les immobilisations de transaction antérieures à l'heure spécifiée seront supprimées.

Retourne :

La valeur retournée est identique à la méthode "getAccountTransactionHistory".
En cas de succès, une promesse avec le tableau des objets de transaction de compte :
- transaction_id - ID de la transaction.
- transacted_account - Compte avec lequel la transaction a eu lieu.
- transaction_type - Type de transaction.
- transacted_amount - Montant de la transaction.
- timestamp - Heure de la transaction.
- balance - Solde du compte au moment de la transaction.
- onhold_balance - Solde bloqué au moment de la transaction.
- sub_transactions - Pour les transferts en masse uniquement, liste des transactions qui font partie d'un transfert en masse.
- holding_id - Identificateur unique retourné par la méthode holdTokens.
- token_id - ID du jeton.
En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

"payload": {
            "msg": "Successfuly deleted transaction older than date: Thu Aug 19 2021 11:19:36 GMT+0000 (Coordinated Universal Time).",
            "transactions": [
                "otransaction~ec3366dd48b4ce2838f820f2f138648e6e55a07226713e59b411ff31b0d21058"
            ]
        }

getAccountTransactionHistory

Cette méthode retourne un tableau des détails de l'historique des transactions pour un compte spécifié.

Ctx.Account.getAccountTransactionHistory(account_id: string)

Paramètres :

account_id: string - ID du compte.

Retourne :

La valeur retournée est identique à la méthode "getAccountTransactionHistory".
En cas de succès, une promesse avec le tableau des objets de transaction de compte :
- transaction_id - ID de la transaction.
- transacted_account - Compte avec lequel la transaction a eu lieu.
- transaction_type - Type de transaction.
- transacted_amount - Montant de la transaction.
- timestamp - Heure de la transaction.
- balance - Solde du compte au moment de la transaction.
- onhold_balance - Solde bloqué au moment de la transaction.
- sub_transactions - Pour les transferts en masse uniquement, liste des transactions qui font partie d'un transfert en masse.
- holding_id - Identificateur unique retourné par la méthode holdTokens.
- token_id - ID du jeton.
En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

[
   {
      "transaction_id":"otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775",
      "transacted_amount":20,
      "timestamp":"2021-08-17T06:04:24.000Z",
      "balance":60,
      "onhold_balance":0,
      "token_id":"digiCurr101",
      "transaction_type":"BULKTRANSFER",
      "sub_transactions":[
         {
            "transacted_account":"oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
            "transaction_type":"CREDIT",
            "transaction_id":"otransaction~68f46c90d0d8d6b93d827e6b9e0152b4845e6e42a61965e63a9bbf1d8e0fc775~c4ca4238a0b923820dcc509a6f75849b",
            "transacted_amount":10
         }
      ]
   },
   {
      "transaction_id":"otransaction~757864d5369bd0539d044caeb3bb4898db310fd7aa740f45a9938771903d43da",
      "transacted_amount":50,
      "timestamp":"2021-08-17T06:02:44.000Z",
      "balance":50,
      "onhold_balance":0,
      "token_id":"digiCurr101",
      "transacted_account":"oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
      "transaction_type":"CREDIT"
   }
]

getAccountTransactionHistoryWithFilters

Cette méthode retourne un tableau des détails de l'historique des transactions pour un compte spécifié. Cette méthode ne peut être appelée que lorsqu'elle est connectée au réseau distant Oracle Blockchain Platform.

await this.Ctx.Account.getAccountTransactionHistoryWithFilters(account_id: string, filters?: Filters)

Paramètres :

account_id: string - ID du compte.
filters: string - Paramètre facultatif. Si vide, tous les enregistrements sont retournés. La propriété PageSize détermine le nombre d'enregistrements à retourner. Si PageSize a la valeur 0, la taille de page par défaut est 20. La propriété Bookmark détermine l'index de départ des enregistrements à retourner. Pour plus d'informations, voir la documentation relative à Hyperledger Fabric. Les propriétés StartTime et EndTime doivent être spécifiées au format RFC-3339.

Exemple :

ochain invoke getAccountTransactionHistoryWithFilters 'token1' 'appbuilder12' 'user_minter' '{"PageSize":10,"Bookmark":"1","StartTime":"2022-01-25T17:41:42Z","EndTime":"2022-01-25T17:59:10Z"}'

[
    {
        "transaction_id": "otransaction~672897b5a4fa78b421c000e4d6d4f71f3d46529bfbb5b4be10bf5471dc35ce89",
        "transacted_amount": 5,
        "timestamp": "2022-04-20T15:46:04.000Z",
        "token_id": "token1",
        "transacted_account": "oaccount~16c38d804413ebabf416360d374f76c973d4e71c74adfde73cc40c7c274883b8",
        "transaction_type": "DEBIT",
        "balance": 90,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~467bb67a33aaffca4487f33dcd46c9844efdb5421a2e7b6aa2d53152eb2c6d85",
        "transacted_amount": 5,
        "timestamp": "2022-04-20T15:45:47.000Z",
        "token_id": "token1",
        "transacted_account": "oaccount~fbf95683b21bbc91a22205819ac1e2e9c90355d536821ed3fe22b7d23915c248",
        "transaction_type": "DEBIT",
        "balance": 95,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~c6d56ce54a9bbe24597d1d10448e39316dc6f16328bf3c5b0c8ef10e1dfeb397",
        "transacted_amount": 100,
        "timestamp": "2022-04-20T15:44:26.000Z",
        "token_id": "token1",
        "transacted_account": "oaccount~deb5fb0906c40506f6c2d00c573b774e01a53dd91499e651d92ac4778b6add6a",
        "transaction_type": "MINT",
        "balance": 100,
        "onhold_balance": 0
    }
]

getSubTransactionHistory

Cette méthode retourne un tableau des détails de l'historique des transactions pour une transaction spécifiée.

await this.Ctx.Account.getSubTransactionHistory(transaction_id)

Paramètres :

transaction_id: string - ID de la transaction de transfert en masse.

Exemple :

ochain invoke GetAccountSubTransactionHistory 'otransaction~21972b4d206bd52ea77924efb259c67217edb23b4386580d1bee696f6f864b9b'

[
    {
        "transacted_account": "oaccount~16c38d804413ebabf416360d374f76c973d4e71c74adfde73cc40c7c274883b8",
        "transaction_type": "DEBIT",
        "transaction_id": "otransaction~6e0f8fe4a6430322170b9c619b04b6c9f1c8d257923f611b866bdf69d7fe6cb8~c81e728d9d4c2f636f067f89cc14862c",
        "transacted_amount": 5,
        "timestamp": "2022-04-20T15:52:21.000Z",
        "token_id": "token1",
        "balance": 80,
        "onhold_balance": 0
    },
    {
        "transacted_account": "oaccount~fbf95683b21bbc91a22205819ac1e2e9c90355d536821ed3fe22b7d23915c248",
        "transaction_type": "DEBIT",
        "transaction_id": "otransaction~6e0f8fe4a6430322170b9c619b04b6c9f1c8d257923f611b866bdf69d7fe6cb8~c4ca4238a0b923820dcc509a6f75849b",
        "transacted_amount": 5,
        "timestamp": "2022-04-20T15:52:21.000Z",
        "token_id": "token1",
        "balance": 85,
        "onhold_balance": 0
    }
]

getSubTransactionHistoryWithFilters

Cette méthode retourne un tableau des détails de l'historique des sous-transactions pour une transaction spécifiée.

await this.Ctx.Account.getSubTransactionHistoryWithFilters(transaction_id: string, filters?: SubTransactionFilters)

Paramètres :

transaction_id: string - ID de la transaction de transfert en masse.
filters: string - Paramètre facultatif. Si vide, tous les enregistrements sont retournés. La propriété PageSize détermine le nombre d'enregistrements à retourner. Si PageSize a la valeur 0, la taille de page par défaut est 20. La propriété Bookmark détermine l'index de départ des enregistrements à retourner. Pour plus d'informations, voir la documentation relative à Hyperledger Fabric. Les propriétés StartTime et EndTime doivent être spécifiées au format RFC-3339.

Exemple :

ochain invoke GetAccountSubTransactionHistoryWithFilters 'otransaction~21972b4d206bd52ea77924efb259c67217edb23b4386580d1bee696f6f864b9b' '{"PageSize":10,"Bookmark":"1"}'

[
    {
        "transaction_id": "otransaction~6e0f8fe4a6430322170b9c619b04b6c9f1c8d257923f611b866bdf69d7fe6cb8~c81e728d9d4c2f636f067f89cc14862c",
        "transacted_amount": 5,
        "timestamp": "2022-04-20T15:52:21.000Z",
        "token_id": "token1",
        "transacted_account": "oaccount~16c38d804413ebabf416360d374f76c973d4e71c74adfde73cc40c7c274883b8",
        "transaction_type": "DEBIT",
        "balance": 80,
        "onhold_balance": 0
    },
    {
        "transaction_id": "otransaction~6e0f8fe4a6430322170b9c619b04b6c9f1c8d257923f611b866bdf69d7fe6cb8~c4ca4238a0b923820dcc509a6f75849b",
        "transacted_amount": 5,
        "timestamp": "2022-04-20T15:52:21.000Z",
        "token_id": "token1",
        "transacted_account": "oaccount~fbf95683b21bbc91a22205819ac1e2e9c90355d536821ed3fe22b7d23915c248",
        "transaction_type": "DEBIT",
        "balance": 85,
        "onhold_balance": 0
    }
]

Gestion du comportement des jetons

Les méthodes de gestion du cycle de vie des jetons sont basées sur les normes du cadre de taxonomie des jetons. Pour utiliser les méthodes de cycle de vie des jetons, importez la classe Token à partir du module ../lib/token.

import { Token } from '../lib/token';

Méthodes de gestion du comportement des jetons - Comportement mintable

mint

Cette méthode émet une quantité de jetons, qui sont alors détenus par l'appelant de la méthode. L'appelant doit avoir un compte et le rôle de mineur. La quantité doit être comprise dans les valeurs décimales spécifiées par le paramètre decimal du comportement divisible dans le fichier de spécification.

Ctx.Token.mint(quantity: number, token: <Instance of Token Class>)

Paramètres :

quantity: number - Nombre total de jetons à menthe.
token: <Instance of Token Class> - Ressource de jeton à extraire.

Retourne :

Sur le succès, une promesse avec un message de réussite et des détails toAccount. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
  "msg":"Successfully minted 1000 tokens to Account Id: oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (Org-Id: Org1MSP, User-Id: admin)"
}

getTotalMintedTokens

Cette méthode retourne le nombre total de jetons frappés.

Ctx.Token.getTotalMintedTokens(token: <Instance of Token Class>)

Paramètres :

token: <Instance of Token Class> - Ressource de jeton à utiliser.

Retourne :

En cas de succès, la quantité de jetons frappés, dans le type de données Nombre. En cas d'erreur, un message d'erreur s'affiche.

Exemple de valeur renvoyée :

getNetTokens

Cette méthode retourne la quantité nette de jetons disponibles dans le système. Les jetons nets sont la quantité de jetons restants après la combustion des jetons. Sous forme d'équation : jetons nets = jetons totaux frappés - jetons totaux brûlés. Si aucun jeton n'est brûlé, le nombre de jetons nets est égal au nombre total de jetons frappés.

Ctx.Token.getNetTokens(token: <Instance of Token Class>)

Paramètres :

token: <Instance of Token Class> - Ressource de jeton à utiliser.

Retourne :

Au succès, la quantité de jetons nets, dans le type de données Nombre. En cas d'erreur, un message d'erreur s'affiche.

Exemple de valeur renvoyée :

getMaxMintQuantity

Cette méthode retourne la quantité minimale maximale pour un jeton. Si le comportement max_mint_quantity n'est pas spécifié, la valeur par défaut est 0, ce qui permet de frapper un nombre quelconque de jetons.

Ctx.Token.getMaxMintQuantity(token: <Instance of Token Class>)

Paramètres :

token: <Instance of Token Class> - Ressource de jeton à utiliser.

Retourne :

En cas de succès, quantité minimale maximale du jeton, dans le type de données numérique. En cas d'erreur, un message d'erreur s'affiche.

Exemple de valeur renvoyée :

Méthodes de gestion du comportement des jetons - Comportement transférable

transfer

Cette méthode transfère les jetons de l'appelant de transaction vers le compte to_account_id. L'appelant de cette méthode doit avoir un compte et la quantité doit être comprise dans les valeurs décimales spécifiées par le paramètre decimal du comportement divisible dans le fichier de spécification.

Ctx.Token.transfer(to_account_id: string, quantity: number, token: <Instance of Token Class>)

Paramètres :

to_account_id: string - ID compte pour la réception des jetons.
quantity: number - Nombre total de jetons à transférer.

Retourne :

Sur la réussite, une promesse avec un message de réussite. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
 "msg":"Successfully transferred 50 tokens from account id: oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (Org-Id: Org1MSP, User-Id: admin) to account id: oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f (Org-Id: Org1MSP, User-Id: user1)"
}

bulkTransfer

Cette méthode est utilisée pour effectuer un transfert en masse de jetons du compte de l'appelant vers les comptes spécifiés dans l'objet flow. Un compte doit déjà être créé pour l'appelant de cette méthode.

Ctx.Token.bulkTransfer(flow: object[], token: <Instance of Token Class>)

Paramètres :

flow: object[] - Tableau d'objets JSON spécifiant les détails et la quantité du destinataire. La quantité de transfert doit être comprise dans les valeurs décimales spécifiées par le paramètre decimal du comportement divisible dans le fichier de spécification. Par exemple :
```
[{
	"to_org_id": "Org1MSP",
	"to_user_id": "user1",
	"quantity": 10
}, {
	"to_org_id": "Org1MSP",
	"to_user_id": "user2",
	"quantity": 10
}]
```
token: <Instance of Token Class> - Ressource de jeton à utiliser.

Retourne :

En cas de succès, une promesse avec un message de réussite et des informations sur le compte. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
    "from_account_id": "oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
    "msg": "Successfully transferred 2 tokens from Account Id oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f (Org-Id: Org1MSP, User-Id: user1)",
    "sub_transactions": [
        {
            "amount": 1,
            "to_account_id": "oaccount~digicur~38848e87296d67c8a90918f78cf55f9c9baab2cdc8c928535471aaa1210c706e"
        },
        {
            "amount": 1,
            "to_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df"
        }
    ]
}

Méthodes de gestion du comportement des jetons - Comportement bloquable

hold

Ctx.Token.hold(operation_id: string, to_account_id: string, notary_account_id: string, quantity: number, time_to_expiration: Date, token: <Instance of Token Class>)

Paramètres :

operation_id: string - ID unique identifiant l'opération de blocage. En général, cet ID est transmis par l'application client.
to_account_id: string - ID du compte pour la réception des jetons.
notary__account_id: string - ID du compte de notaire.
quantity: number - Nombre total de jetons à mettre en attente.
time_to_expiration: Date - Durée jusqu'à l'expiration du blocage. Spécifiez 0 pour un blocage permanent. Sinon, utilisez le format RFC-3339. Par exemple, 2021-06-02T12.
token: <Instance of Token Class> - Ressource de jeton à bloquer.

Retourne :

Sur la réussite, une promesse avec un message de réussite. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
 "msg": "account id: oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (org_id : Org1MSP, user_id : user1) is successfully holding 10 tokens",
}

executeHold

Cette méthode effectue un blocage sur les jetons, en transférant la quantité spécifiée de jetons précédemment bloqués au destinataire. Si la valeur quantity est inférieure à la valeur de blocage réelle, le montant restant est de nouveau disponible pour le responsable initial des jetons. Cette méthode ne peut être appelée que par l'ID AccountOwner doté du rôle notary pour l'ID opération spécifié. Le blocage ne peut être effectué que par le notaire.

Ctx.Token.executeHold(operation_id: string, quantity: number, token: <Instance of Token Class>)

Paramètres :

operation_id: string - ID unique identifiant l'opération de blocage. En général, cet ID est transmis par l'application client.
quantity: number - Nombre total de jetons sur lesquels effectuer un blocage.
token: <Instance of Token Class> - Ressource de jeton sur laquelle effectuer un blocage.

Retourne :

Sur la réussite, une promesse avec un message de réussite. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
 "msg": "user with accountId: oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (org_id : Org1MSP, user_id : user1) has successfully executed 5  tokens(digiCurr101) from the hold with Operation Id opr_121",
}

releaseHold

Ctx.Token.releaseHold(operation_id: string, token: <Instance of Token Class>)

Paramètres :

operation_id: string - ID unique identifiant l'opération de blocage. En général, cet ID est transmis par l'application client.
token: <Instance of Token Class> - Ressource de jeton sur laquelle débloquer un blocage.

Retourne :

Sur la réussite, une promesse avec un message de réussite. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
  "msg": "Successfully released 5 tokens from Operation Id opr_121 to Account Id: oaccount~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (org_id : Org1MSP, user_id : user1)",
}

getOnHoldIds

Cette méthode retourne une liste de tous les ID blocage pour un compte spécifié.

Ctx.Account.getOnHoldIds(account_id: string)

Paramètres :

account_id: string - ID du compte.

Retourne :

En cas de succès, promesse avec un objet JSON qui répertorie tous les ID de détention pour le compte spécifié. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
   "msg":"Holding Ids are: ohold~digicur~digiCurr101~opr_121",
   "holding_ids":[
      "ohold~digicur~digiCurr101~opr_121"
   ]
}

getOnHoldDetailsWithOperationId

Cette méthode retourne les détails de la transaction bloquée pour un ID opération et un jeton spécifiés.

Ctx.Hold.getOnHoldDetailsWithOperationId(token_id: string, operation_id: string)

Paramètres :

token_id: string - ID du jeton.
operation_id: string - ID unique identifiant l'opération de blocage. En général, cet ID est transmis par l'application client.

Retourne :

En cas de succès, un objet de blocage comprenant les propriétés suivantes :
- holding_id - ID détention de la transaction.
- operation_id: string - ID unique identifiant l'opération de blocage. En général, cet ID est transmis par l'application client.
- from_account_id - ID compte du responsable courant des jetons bloqués.
- to_account_id - ID compte du destinataire.
- notary_account_id - ID compte du notaire.
- token_id: string - ID du jeton enregistré.
- quantity - Nombre de jetons bloqués pour l'ID blocage.
- time_to_expiration - Durée jusqu'à l'expiration du blocage.
En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
    "assetType": "ohold",
    "holding_id": "ohold~digicur~digiCurr101~opr_121",
    "operation_id": "opr_121",
    "token_name": "digicur",
    "from_account_id": "oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df",
    "to_account_id": "oaccount~digicur~b4f45440aa2a7942db64443d047027e9d714d62cba5c3d546d64f368642f622f",
    "notary_account_id": "oaccount~digicur~38848e87296d67c8a90918f78cf55f9c9baab2cdc8c928535471aaa1210c706e",
    "token_id": "digiCurr101",
    "quantity": 10,
    "time_to_expiration": "2022-08-01T18:30:00.000Z"
}

getOnHoldBalanceWithOperationId

Cette méthode retourne le solde de blocage pour un ID opération et un jeton spécifiés. Cette méthode peut être appelée par n'importe qui.

Ctx.Hold.getOnHoldBalanceWithOperationId(token_id: string, operation_id: string)

Paramètres :

token_id: string - ID du jeton.
operation_id: string - ID unique identifiant l'opération de blocage. En général, cet ID est transmis par l'application client.

Retourne :

En cas de succès, un objet de promesse avec le solde de blocage pour l'ID opération et le jeton spécifiés. En cas d'erreur, un rejet avec un message d'erreur

Exemple de valeur renvoyée :

{
    "msg": "Current Holding Balance of Operation 'op1' for token 'token1' is: 10",
    "holding_balance": 10
}

Méthodes de gestion du comportement des jetons - Comportement brûlable

burn

Ctx.Token.burn(quantity: number, token: <Instance of Token Class>)

Paramètres :

quantity: number - Nombre total de jetons à brûler.
token: <Instance of Token Class> - Ressource de jeton à brûler.

Retourne :

Sur la réussite, une promesse avec un message de réussite. En cas d'erreur, un rejet avec un message d'erreur.

Exemple de valeur renvoyée :

{
 "msg":"Successfully burned 10 tokens from account id: oaccount~digicur~682bb71de419602af74e3f226345ae308445ca51010737900c1d85f0376152df (Org-Id: Org1MSP, User-Id: admin)"
}