Ensemble d'API d'encapsuleur de cadre de jeton non fongible

Oracle Blockchain Platform Digital Assets Edition comprend un ensemble d'API wrapper qui étend l'API REST afin de prendre en charge des opérations propres à un marché NFT de collection.

L'ensemble d'API wrapper utilise le service de passerelle d'API et le service des fonctions pour OCI pour déployer des routes d'API spécialement conçues pour l'application Marketplace de collection. L'ensemble d'API d'encapsulation de cadre de jeton non fongible peut être téléchargé à partir de la console Oracle Blockchain Platform et comprend les composants suivants.

• NFTCollectiblesWithERC721WrapperAPI.zip, un fichier d'archives contenant l'ensemble d'API d'encapsuleur, y compris les scripts Terraform requis pour le déploiement. Vous déployez ce fichier dans une pile du gestionnaire de ressources sur Oracle Cloud Infrastructure (OCI) pour créer les ressources Oracle nécessaires pour les API Wrapper.
• NFTCollectiblesWithERC721_WrapperAPI.postman_collection.json, une collection Postman qui vous permet de tester les API d'encapsuleur déployées. La collection comprend des demandes préconfigurées avec des points d'extrémité et des données utiles qui correspondent aux API définies dans l'ensemble d'API wrapper.

API d'encapsulation

activateAccount

Nom de la méthode initiale : activateAccount

Cette méthode POST active un compte de jeton. Cette méthode ne peut être appelée que par un administrateur. Pour tous les comptes créés avant la fonctionnalité de statut de compte, vous devez appeler cette méthode pour voir le statut du compte à Actif.

Données utiles :

{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}

Paramètres :

• 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.
• endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.

Retourne :

• En cas de succès, une représentation JSON de l'objet de statut de compte pour le compte de jeton spécifié.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "db0738d4a44f6d9c80b24fce7c518c07023f7be19edaa69b272eaf7886b4b925",
        "payload": {
            "assetType": "oaccountStatus",
            "status_id": "oaccountStatus~d5814d96d8517ac31727d60aace0519c58a425892ab0d378fcfb0a35771f65ae",
            "account_id": "oaccount~802bf8da5579c6103b2dddaa6c4385df8e722d639a18029e0e93d7a5d6f826d6",
            "status": "active"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 194
    }
}

addTokenAdmin

Nom de la méthode initiale : addTokenAdmin

Cette méthode POST 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.

Données utiles :

{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}

Paramètres :

• 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.
• sameOrgEndorser: boolean - Valeur booléenne indiquant si les endossements de transaction doivent provenir de la même organisation que le demandeur.

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 :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bd7416689b1acdace3c557faebbc0ad9a51671c10278ba6909350a6fe4b08eed",
        "payload": {
            "msg":"Successfully added Admin (orgId: Org1MSP, userId: User1)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 190
    }
}

addRole

Nom de la méthode initiale : addRole

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

Données utiles :

{
    "role": "role value (for example minter / burner)",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}

Paramètres :

• role: string - Nom du rôle à ajouter à l'utilisateur spécifié.
• 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.
• endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bd7416689b1acdace3c557faebbc0ad9a51671c10278ba6909350a6fe4b08eed",
        "payload": {
            "msg": "Successfully added role 'minter' to Account Id: oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d (Org-Id: Org1MSP, User-Id: admin)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 193
    }
}

addTokenSysRole

Nom de la méthode initiale : addTokenSysRole

Cette méthode ajoute Org Admins au code de chaîne du jeton.

Données utiles :

{
    "role": "role value (for example vault)",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}

Paramètres :

• role: string - Nom du rôle à ajouter à l'utilisateur spécifié.
• 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.
• endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "96a84dffcb9156f7271dfb414e8c43b540595044cf9145f5fd56e9873797fc4a",
        "payload": {
            "msg": "Successfully added Org Admin (Org_Id: CB, User_Id: cb)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 197
    }
}

balanceOf

Nom de la méthode initiale : balanceOf

Cette méthode GET retourne le nombre total de transactions NFT détenues par un utilisateur spécifié. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne ou par le responsable du compte.

Interrogation :

/balanceOf?orgId={{bc-org-id}}&userId={{bc-user-id}}

Paramètres :

• 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.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload":  {
            "totalNfts": 0
        },
        "encode": "JSON"
    }
}

buy

Nom de la méthode initiale : buy

Cette méthode POST achète un jeton qui est en vente.

Données utiles :

{
    "fromOrgId": "from_org_id value",
    "fromUserId": "from_user_id value",
    "toOrgId": "to_org_id value",
    "toUserId": "to_user_id value",
    "nonfungibleTokenId": "nonfungible_token_id value",
    "amountPaid": 1,
    "endorsers": {{endorsers}}
}

Paramètres :

• fromOrgId: string - ID fournisseur de services d'adhésion (MSP) de l'expéditeur (propriétaire) dans l'organisation courante.
• fromUserId: string - Nom d'utilisateur ou ID courriel de l'expéditeur (responsable).
• toOrgId: string - ID fournisseur de services d'adhésion (MSP) du destinataire dans l'organisation courante.
• toUserId: string - Nom d'utilisateur ou ID courriel du destinataire.
• nonfungibleTokenId: string - ID du jeton à acheter.
• amountPaid: number - Prix du jeton.
• endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bd7416689b1acdace3c557faebbc0ad9a51671c10278ba6909350a6fe4b08eed",
        "payload": {
            "msg": "Token ID: 'monalisa' has been successfully transferred to UserID :oaccount~ec32cff8635a056f3dda3da70b1d6090d61f66c6a170c4a95fd008181f729dba"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 193
    }
}

createAccount

Nom de la méthode initiale : createAccount

Cette méthode crée un compte pour un utilisateur et un jeton spécifiés. Un compte doit être créé pour tout utilisateur qui aura des jetons à tout moment. Les comptes suivent le nombre de transactions NFT détenues par un utilisateur. Un ID compte est un jeu de caractères alphanumériques, précédé de oaccount~ et suivi d'un hachage SHA-256 de l'ID fournisseur de services d'adhésion (orgId) de l'utilisateur dans l'organisation de réseau courante, du nom d'utilisateur ou de l'ID courriel (userId) du responsable de l'instance ou de l'utilisateur connecté à l'instance, et de la chaîne constante nft. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.

Données utiles :

{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "tokenType": "nonfungible",
    "endorsers": {{endorsers}}
}

Paramètres :

• orgId - ID fournisseur de services d'adhésion (MSP) de l'utilisateur pour lequel créer le compte. L'ID doit commencer par un caractère alphanumérique et peut inclure des lettres, des chiffres et des caractères spéciaux tels que les traits de soulignement (_), les points (.), les signes (@) et les tirets (-).
• userId - Nom d'utilisateur ou ID courriel de l'utilisateur. L'ID doit commencer par un caractère alphanumérique et peut inclure des lettres, des chiffres et des caractères spéciaux tels que les traits de soulignement (_), les points (.), les signes (@) et les tirets (-).
• tokenType: TokenType - Type de jeton, qui doit être fungible.
• endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bd7416689b1acdace3c557faebbc0ad9a51671c10278ba6909350a6fe4b08eed",
        "payload": {
            "assetType": "oaccount",
            "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
            "bapAccountVersion": 0,
            "userId": "admin",
            "orgId": "Org1MSP",
            "tokenType": "nonfungible",
            "noOfNfts": 0
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 193
    }
}

createArtCollectionToken

Nom de la méthode initiale : createArtCollectionToken

Cette méthode POST crée (mints) un NFT. La ressource et les propriétés associées sont enregistrées dans la base de données d'état. L'appelant de cette transaction doit avoir un compte de jeton. L'appelant de cette transaction devient le propriétaire de la NFT. Si le fichier de spécification de jeton inclut la section roles pour behaviors et la propriété minter_role_name pour roles, l'appelant de la transaction doit avoir le rôle de filtre. Sinon, n'importe quel appelant peut extraire des NFT.

Données utiles :

{
    "tokenAsset": "{\"tokenId\":\"{{bc-token-id}}\",\"tokenDesc\":\"tokenDesc value\",\"tokenUri\":\"tokenUri value\",\"metadata\":{\"Painting_Name\":\"Painting_Name value\",\"Description\":\"Description value\",\"Painter_Name\":\"Painter_Name value\"},\"Price\":999,\"On_Sale_Flag\":true}",
    "sameOrgEndorser": true
}

Paramètres :

• tokenAsset: <Token Class> - Ressource de jeton à extraire. Pour plus d'informations sur les propriétés de la ressource de jeton, voir le fichier de spécification d'entrée.
• sameOrgEndorser: boolean - Valeur booléenne indiquant si les endossements de transaction doivent provenir de la même organisation que le demandeur.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bd7416689b1acdace3c557faebbc0ad9a51671c10278ba6909350a6fe4b08eed",
        "payload": {
            "metadata": {
                "painting_name": "Mona_Lisa",
                "description": "Mona Lisa Painting",
                "image": "monalisa.jpeg",
                "painter_name": "Leonardo_da_Vinci"
            },
            "assetType": "otoken",
            "tokenId": "monalisa",
            "tokenName": "artcollection",
            "tokenDesc": "token description",
            "symbol": "ART",
            "tokenStandard": "erc721+",
            "tokenType": "nonfungible",
            "tokenUnit": "whole",
            "behaviors": [
                "indivisible",
                "singleton",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter"
            },
            "mintable": {
                "max_mint_quantity": 20000
            },
            "owner": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
            "createdBy": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
            "creationDate": "2022-04-05T08:30:42.000Z",
            "isBurned": false,
            "tokenUri": "\"https://bafybeid6pmpp62bongoip5iy2skosvyxh3gr7r2e35x3ctvawjco6ddmsq\\ .ipfs.infura-ipfs.io/?filename=MonaLisa.jpeg\"",
            "price": 100,
            "on_sale_flag": false
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 193
    }
}

deleteAccount

Nom de la méthode initiale : deleteAccount

Cette méthode POST supprime un compte de jeton. Après la suppression d'un compte, celui-ci est à l'état final et ne peut pas être mis à jour ni modifié à un autre état. Pour supprimer un compte, le solde doit être égal à zéro. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.

Données utiles :

{
 "orgId": "{{bc-org-id}}",
 "userId": "{{bc-user-id}}",
 "endorsers": {{endorsers}}
}

Paramètres :

• 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 représentation JSON du statut du compte de jeton.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bd7416689b1acdace3c557faebbc0ad9a51671c10278ba6909350a6fe4b08eed",
        "payload": {
          "assetType": "oaccountStatus",
          "statusId": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
          "accountId": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
          "status": "deleted"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 193
    }
}

getAccountByUser

Nom de la méthode initiale : getAccountByUser

Cette méthode retourne les détails du compte pour un utilisateur spécifié. Cette méthode ne peut être appelée que par Token Admin du code de chaîne ou par Account Owner du compte.

Interrogation :

/getAccountByUser?orgId={{bc-org-id}}&userId={{bc-user-id}}

Paramètres :

• 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.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
          "bapAccountVersion": 0,
          "assetType": "oaccount",
          "status": "active",
          "accountId": "oaccount~cc301bee057f14236a97d434909ec1084970921b008f6baab09c2a0f5f419a9a",
          "userId": "idcqa",
          "orgId": "appdev",
          "tokenType": "nonfungible",
          "noOfNfts": 0
        },
        "encode": "JSON"
    }
}

getAccountHistory

Nom de la méthode initiale : getAccountHistory

Cette méthode retourne l'historique du compte pour un utilisateur spécifié. Il s'agit d'une méthode asynchrone. Cette méthode ne peut être appelée que par la chaîne Token Admin du code de chaîne ou par le responsable du compte.

Interrogation :

/getAccountHistory?orgId={{bc-org-id}}&userId={{bc-user-id}}

Paramètres :

• 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.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bd7416689b1acdace3c557faebbc0ad9a51671c10278ba6909350a6fe4b08eed",
        "payload": [
            {
                "trxId": "6ffd0d94f234c12444a5d5aa559563b59dff4d2280b573fea956dc632bdaf5d4",
                "timeStamp": 1649151044,
                "value": {
                    "assetType": "oaccount",
                    "bapAccountVersion" : 5,
                    "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                    "userId": "admin",
                    "orgId": "Org1MSP",
                    "tokenType": "nonfungible",
                    "noOfNfts": 1
                }
            },
            {
                "trxId": "a605f1fa62e511c2945fce5437f983a5e70ec814b82520d3ecd2d81e3ecf53a3",
                "timeStamp": 1649151022,
                "value": {
                    "assetType": "oaccount",
                    "bapAccountVersion" : 4,
                    "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                    "userId": "admin",
                    "orgId": "Org1MSP",
                    "tokenType": "nonfungible",
                    "noOfNfts": 2
                }
            },
            {
                "trxId": "ca4c07bf04240345de918cbf1f4f3da4b4d0ab044c5b8bea94343e427d9ed4e7",
                "timeStamp": 1649150910,
                "value": {
                    "assetType": "oaccount",
                    "bapAccountVersion" : 3,
                    "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                    "userId": "admin",
                    "orgId": "Org1MSP",
                    "tokenType": "nonfungible",
                    "noOfNfts": 1
                }
            },
            {
                "trxId": "cfb52ffc8c34c7fd86210fcf8c5f53d9f92a056c45ed3a33671d638020c1f9cb",
                "timeStamp": 1649149545,
                "value": {
                    "assetType": "oaccount",
                    "bapAccountVersion" : 2,
                    "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                    "userId": "admin",
                    "orgId": "Org1MSP",
                    "tokenType": "nonfungible",
                    "noOfNfts": 0
                }
            },
            {
                "trxId": "e7747b3001a170f88688620956320e9402e1dd8edad8afb4818a08a34647337c",
                "timeStamp": 1649147442,
                "value": {
                    "assetType": "oaccount",
                    "bapAccountVersion" : 1,
                    "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                    "userId": "admin",
                    "orgId": "Org1MSP",
                    "tokenType": "nonfungible",
                    "noOfNfts": 1
                }
            },
            {
                "trxId": "d2d1f9c898707ae831e9361bc25da6369eac37b10c87dc04d18d6f3808222f08",
                "timeStamp": 1649137534,
                "value": {
                    "assetType": "oaccount",
                    "bapAccountVersion" : 0,
                    "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                    "userId": "admin",
                    "orgId": "Org1MSP",
                    "tokenType": "nonfungible",
                    "noOfNfts": 0
                }
            }
        ],
        "encode": "JSON"
    }
}

getAccountsByRole

Nom de la méthode initiale : getAccountsByRole

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

Interrogation :

/getAccountsByRole?role=role value (for example minter / burner)

Paramètres :

• role: string - Nom du rôle à rechercher.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bd7416689b1acdace3c557faebbc0ad9a51671c10278ba6909350a6fe4b08eed",
        "payload": {
            "accounts": [
                "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d"
            ]
        },
        "encode": "JSON"
    }
}

getAccountsByTokenSysRole

Nom de la méthode initiale : getAccountsByTokenSysRole

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

Interrogation :

/getAccountsByTokenSysRole?role=role value (for example vault)

Paramètres :

• role: string - Nom du rôle TokenSys à rechercher.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "accountIds": [
                "oaccount~bf07f584a94be44781e49d9101bfaf58c6fbbe77a4dfebdb83c874c2caf03eba"
            ]
        },
        "encode": "JSON"
    }
}

getAccountStatus

Nom de la méthode initiale : getAccountStatus

Cette méthode GET extrait le statut courant du compte de jeton. Cette méthode peut être appelée par la chaîne Token Admin du code de chaîne ou par le responsable du compte de jeton.

Interrogation :

/getAccountStatus?orgId={{bc-org-id}}&userId={{bc-user-id}}

Paramètres :

• 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 représentation JSON du statut du compte de jeton.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "assetType": "oaccountStatus",
            "statusId": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
            "accountId": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
            "status": "active"
        },
        "encode": "JSON"
    }
}

getAccountStatusHistory

Nom de la méthode initiale : getAccountStatusHistory

Cette méthode GET extrait l'historique du statut du compte. Cette méthode peut être appelée par la chaîne Token Admin du code de chaîne ou par le responsable du compte de jeton.

Interrogation :

/getAccountStatusHistory?orgId={{bc-org-id}}&userId={{bc-user-id}}

Paramètres :

• 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, l'historique des statuts de compte au format JSON.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
          {
            "trxId": "d5c6d6f601257ba9b6edaf5b7660f00adc13c37d5321b8f7d3a35afab2e93e63",
            "timeStamp": "2022-12-02T10:39:14.000Z",
            "value": {
              "assetType": "oaccountStatus",
              "statusId": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
              "accountId": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
              "status": "suspended"
            }
          },
          {
            "trxId": "e6c850cfa084dc20ad95fb2bb8165eef3a3bd62a0ac867cccee57c2003125183",
            "timeStamp": "2022-12-02T10:37:50.000Z",
            "value": {
              "assetType": "oaccountStatus",
              "statusId": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
              "accountId": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
              "status": "active"
            }
          }
        ],
        "encode": "JSON"
    }
}

getAccountTransactionHistory

Nom de la méthode initiale : getAccountTransactionHistory

Cette méthode GET retourne l'historique des transactions de compte. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne ou par le responsable du compte.

/getAccountTransactionHistory?orgId={{bc-org-id}}&userId={{bc-user-id}}

Paramètres :

• 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.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "transactionId": "otransaction~6ffd0d94f234c12444a5d5aa559563b59dff4d2280b573fea956dc632bdaf5d4",
                "timestamp": "2022-04-05T09:30:44.000Z",
                "tokenId": "monalisa1",
                "noOfNfts": 1,
                "transactedAccount": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                "transactionType": "BURN"
            },
            {
                "transactionId": "otransaction~a605f1fa62e511c2945fce5437f983a5e70ec814b82520d3ecd2d81e3ecf53a3",
                "timestamp": "2022-04-05T09:30:22.000Z",
                "tokenId": "monalisa1",
                "transactedAccount": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                "transactionType": "MINT"
            },
            {
                "transactionId": "otransaction~ca4c07bf04240345de918cbf1f4f3da4b4d0ab044c5b8bea94343e427d9ed4e7",
                "timestamp": "2022-04-05T09:28:30.000Z",
                "tokenId": "monalisa",
                "transactedAccount": "oaccount~ec32cff8635a056f3dda3da70b1d6090d61f66c6a170c4a95fd008181f729dba",
                "transactionType": "CREDIT"
            },
            {
                "transactionId": "otransaction~cfb52ffc8c34c7fd86210fcf8c5f53d9f92a056c45ed3a33671d638020c1f9cb",
                "timestamp": "2022-04-05T09:05:45.000Z",
                "tokenId": "monalisa",
                "transactedAccount": "oaccount~ec32cff8635a056f3dda3da70b1d6090d61f66c6a170c4a95fd008181f729dba",
                "transactionType": "DEBIT"
            },
            {
                "transactionId": "otransaction~e7747b3001a170f88688620956320e9402e1dd8edad8afb4818a08a34647337c",
                "timestamp": "2022-04-05T08:30:42.000Z",
                "tokenId": "monalisa",
                "transactedAccount": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                "transactionType": "MINT"
            }
        ],
        "encode": "JSON"
    }
}

getAccountTransactionHistoryWithFilters

Nom de la méthode initiale : getAccountTransactionHistoryWithFilters

Cette méthode GET retourne l'historique des transactions de compte pour un utilisateur spécifié, filtré par PageSize, Bookmark, startTime et endTime. Il s'agit d'une méthode asynchrone. Cette méthode ne peut être appelée que lorsqu'elle est connectée au réseau distant Oracle Blockchain Platform. Cette méthode ne peut être appelée que par la chaîne Token Admin du code de chaîne ou par le responsable du compte.

/getAccountTransactionHistoryWithFilters?orgId={{bc-org-id}}&userId={{bc-user-id}}&filters={"pageSize":20,"bookmark":"","startTime":"2022-01-16T15:16:36+00:00","endTime":"2022-01-17T15:16:36+00:00"}

Paramètres :

• 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.
• filters: object - Objet de la classe Filter qui contient quatre attributs : pageSize, bookmark, startTime et endTime.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "transactionId": "otransaction~6ffd0d94f234c12444a5d5aa559563b59dff4d2280b573fea956dc632bdaf5d4",
                "timestamp": "2022-04-05T09:30:44.000Z",
                "tokenId": "monalisa1",
                "transactedAccount": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                "transactionType": "BURN"
            },
            {
                "transactionId": "otransaction~a605f1fa62e511c2945fce5437f983a5e70ec814b82520d3ecd2d81e3ecf53a3",
                "timestamp": "2022-04-05T09:30:22.000Z",
                "tokenId": "monalisa1",
                "transactedAccount": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                "transactionType": "MINT"
            },
            {
                "transactionId": "otransaction~ca4c07bf04240345de918cbf1f4f3da4b4d0ab044c5b8bea94343e427d9ed4e7",
                "timestamp": "2022-04-05T09:28:30.000Z",
                "tokenId": "monalisa",
                "transactedAccount": "oaccount~ec32cff8635a056f3dda3da70b1d6090d61f66c6a170c4a95fd008181f729dba",
                "transactionType": "CREDIT"
            },
            {
                "transactionId": "otransaction~cfb52ffc8c34c7fd86210fcf8c5f53d9f92a056c45ed3a33671d638020c1f9cb",
                "timestamp": "2022-04-05T09:05:45.000Z",
                "tokenId": "monalisa",
                "transactedAccount": "oaccount~ec32cff8635a056f3dda3da70b1d6090d61f66c6a170c4a95fd008181f729dba",
                "transactionType": "DEBIT"
            },
            {
                "transactionId": "otransaction~e7747b3001a170f88688620956320e9402e1dd8edad8afb4818a08a34647337c",
                "timestamp": "2022-04-05T08:30:42.000Z",
                "tokenId": "monalisa",
                "transactedAccount": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                "transactionType": "MINT"
            }
        ],
        "encode": "JSON"
    }
}

getAllAccounts

Nom de la méthode initiale : getAllAccounts

Cette méthode GET retourne les détails de tous les comptes d'utilisateur. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.

Interrogation :

/getAllAccounts

Paramètres :

• aucune

Retourne :

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

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "key": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                "valueJson": {
                    "assetType": "oaccount",
                    "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                    "userId": "admin",
                    "orgId": "Org1MSP",
                    "tokenType": "nonfungible",
                    "noOfNfts": 1
                }   
            }
        ],
        "encode": "JSON"
    }
}

getAllLockedNFTs

Nom de la méthode initiale : getAllLockedNFTs

Cette méthode GET retourne une liste de tous les NFT verrouillés. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne ou par le gestionnaire de chambres fortes (utilisateur doté du rôle TokenSys vault).

Interrogation :

/getAllLockedNFTs

Paramètres :

• aucune

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
           {
              "key":"token1",
              "valueJson":{
                 "assetType":"otoken",
                 "tokenId":"token1",
                 "tokenName":"artcollection",
                 "symbol":"ART",
                 "tokenStandard":"erc721+",
                 "tokenType":"nonfungible",
                 "tokenUnit":"whole",
                 "behaviors":[
                    "indivisible",
                    "singleton",
                    "mintable",
                    "transferable",
                    "lockable",
                    "burnable",
                    "roles"
                 ],
                 "roles":{
                    "minter_role_name":"minter"
                 },
                 "mintable":{
                    "max_mint_quantity":20000
                 },
                 "createdBy":"oaccount~208e3345ac84b4849f0d2648b2f2f018019886a1230f99304ebff1b6a7733463",
                 "creationDate":"2023-10-20T10:26:29.000Z",
                 "owner":"oaccount~208e3345ac84b4849f0d2648b2f2f018019886a1230f99304ebff1b6a7733463",
                 "isBurned":false,
                 "isLocked":true,
                 "tokenUri":"token1.example.com",
                 "price":120,
                 "on_sale_flag":false
              }
           }
        ],
        "encode": "JSON"
    }
}

getAllTokenAdmins

Nom de la méthode initiale : 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 la chaîne Token Admin du code de chaîne.

Interrogation :

/getAllTokenAdmins

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 :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "admins":[
                {
                    "orgId":"Org1MSP",
                    "userId":"admin"
                }
            ]
        },
        "encode": "JSON"
    }
}

getAllTokens

Nom de la méthode initiale : getAllTokens

Cette méthode retourne toutes les ressources de jeton enregistrées dans la base de données d'état. Cette méthode ne peut être appelée que par un élément Token Admin du code 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.

Interrogation :

/getAllTokens

Paramètres :

• aucune

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "key": "monalisa",
                "valueJson": {
                    "metadata": {
                        "PaintingName": "Mona_Lisa",
                        "Description": "Mona Lisa Painting",
                        "Image": "monalisa.jpeg",
                        "PainterName": "Leonardo_da_Vinci"
                    },
                    "assetType": "otoken",
                    "tokenId": "monalisa",
                    "tokenName": "ravinft",
                    "tokenDesc": "token Description",
                    "symbol": "PNT",
                    "tokenStandard": "erc721+",
                    "tokenType": "nonfungible",
                    "tokenUnit": "whole",
                    "behaviors": [
                        "indivisible",
                        "singleton",
                        "mintable",
                        "transferable",
                        "burnable",
                        "roles"
                    ],
                    "roles": {
                        "minter_role_name": "minter",
                        "burner_role_name": "burner"
                    },
                    "mintable": {
                        "max_mint_quantity": 20000
                    },
                    "owner": "oaccount~543c2258e351c3e7a40ea59b81e62154d38fbfc9d1b5b79f30ac5e08e7d0dfd1",
                    "createdBy": "oaccount~543c2258e351c3e7a40ea59b81e62154d38fbfc9d1b5b79f30ac5e08e7d0dfd1",
                    "creationDate": "2022-04-07T21:17:48.000Z",
                    "isBurned": false,
                    "tokenUri": "https://bafybeid6pmpp62bongoip5iy2skosvyxh3gr7r2e35x3ctvawjco6ddmsq\\\\ .ipfs.infura-ipfs.io/?filename=MonaLisa.jpeg",
                    "NftBasePrice": 100
                }
            },
            {
                "key": "monalisa1",
                "valueJson": {
                    "metadata": {
                        "PaintingName": "Mona_Lisa",
                        "Description": "Mona Lisa Painting",
                        "Image": "monalisa.jpeg",
                        "PainterName": "Leonardo_da_Vinci"
                    },
                    "assetType": "otoken",
                    "tokenId": "monalisa1",
                    "tokenName": "ravinft",
                    "tokenDesc": "token Description",
                    "symbol": "PNT",
                    "tokenStandard": "erc721+",
                    "tokenType": "nonfungible",
                    "tokenUnit": "whole",
                    "behaviors": [
                        "indivisible",
                        "singleton",
                        "mintable",
                        "transferable",
                        "burnable",
                        "roles"
                    ],
                    "roles": {
                        "minter_role_name": "minter",
                        "burner_role_name": "burner"
                    },
                    "mintable": {
                        "max_mint_quantity": 20000
                    },
                    "owner": "oaccount~543c2258e351c3e7a40ea59b81e62154d38fbfc9d1b5b79f30ac5e08e7d0dfd1",
                    "createdBy": "oaccount~543c2258e351c3e7a40ea59b81e62154d38fbfc9d1b5b79f30ac5e08e7d0dfd1",
                    "creationDate": "2022-04-07T21:17:59.000Z",
                    "isBurned": false,
                    "tokenUri": "https://bafybeid6pmpp62bongoip5iy2skosvyxh3gr7r2e35x3ctvawjco6ddmsq\\\\ .ipfs.infura-ipfs.io/?filename=MonaLisa.jpeg",
                    "NftBasePrice": 100
                }
            }
        ],
        "encode": "JSON"
    }
}

getAllTokensByUser

Nom de la méthode initiale : getAllTokensByUser

Cette méthode GET retourne toutes les ressources de jeton appartenant à un utilisateur 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. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne ou par le responsable du compte.

Interrogation :

/getAllTokensByUser?orgId={{bc-org-id}}&userId={{bc-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.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "key": "monalisa",
                "valueJson": {
                    "metadata": {
                        "PaintingName": "Mona_Lisa",
                        "Description": "Mona Lisa Painting",
                        "Image": "monalisa.jpeg",
                        "PainterName": "Leonardo_da_Vinci"
                    },
                    "assetType": "otoken",
                    "tokenId": "monalisa",
                    "tokenName": "ravinft",
                    "tokenDesc": "token Description",
                    "symbol": "PNT",
                    "tokenStandard": "erc721+",
                    "tokenType": "nonfungible",
                    "tokenUnit": "whole",
                    "behaviors": [
                        "indivisible",
                        "singleton",
                        "mintable",
                        "transferable",
                        "burnable",
                        "roles"
                    ],
                    "roles": {
                        "minter_role_name": "minter",
                        "burner_role_name": "burner"
                    },
                    "mintable": {
                        "max_mint_quantity": 20000
                    },
                    "owner": "oaccount~543c2258e351c3e7a40ea59b81e62154d38fbfc9d1b5b79f30ac5e08e7d0dfd1",
                    "createdBy": "oaccount~543c2258e351c3e7a40ea59b81e62154d38fbfc9d1b5b79f30ac5e08e7d0dfd1",
                    "creationDate": "2022-04-07T21:17:48.000Z",
                    "isBurned": false,
                    "tokenUri": "https://bafybeid6pmpp62bongoip5iy2skosvyxh3gr7r2e35x3ctvawjco6ddmsq\\\\ .ipfs.infura-ipfs.io/?filename=MonaLisa.jpeg",
                    "NftBasePrice": 100
                }
            },
            {
                "key": "monalisa1",
                "valueJson": {
                    "metadata": {
                        "PaintingName": "Mona_Lisa",
                        "Description": "Mona Lisa Painting",
                        "Image": "monalisa.jpeg",
                        "PainterName": "Leonardo_da_Vinci"
                    },
                    "assetType": "otoken",
                    "tokenId": "monalisa1",
                    "tokenName": "ravinft",
                    "tokenDesc": "token Description",
                    "symbol": "PNT",
                    "tokenStandard": "erc721+",
                    "tokenType": "nonfungible",
                    "tokenUnit": "whole",
                    "behaviors": [
                        "indivisible",
                        "singleton",
                        "mintable",
                        "transferable",
                        "burnable",
                        "roles"
                    ],
                    "roles": {
                        "minter_role_name": "minter",
                        "burner_role_name": "burner"
                    },
                    "mintable": {
                        "max_mint_quantity": 20000
                    },
                    "owner": "oaccount~543c2258e351c3e7a40ea59b81e62154d38fbfc9d1b5b79f30ac5e08e7d0dfd1",
                    "createdBy": "oaccount~543c2258e351c3e7a40ea59b81e62154d38fbfc9d1b5b79f30ac5e08e7d0dfd1",
                    "creationDate": "2022-04-07T21:17:59.000Z",
                    "isBurned": false,
                    "tokenUri": "https://bafybeid6pmpp62bongoip5iy2skosvyxh3gr7r2e35x3ctvawjco6ddmsq\\\\ .ipfs.infura-ipfs.io/?filename=MonaLisa.jpeg",
                    "NftBasePrice": 100
                }
            }
        ],
        "encode": "JSON"
    }
}

getLockedNFTsByOrg

Nom de la méthode initiale : getLockedNFTsByOrg

Cette méthode retourne une liste de tous les jetons non fongibles verrouillés pour une organisation spécifiée et facultativement un utilisateur spécifié. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne ou par le gestionnaire de chambres fortes (utilisateur doté du rôle TokenSys vault).

Interrogation :

/getLockedNFTsByOrg?orgId={{bc-org-id}}&userId={{bc-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.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
           {
              "key":"token1",
              "valueJson":{
                 "assetType":"otoken",
                 "tokenId":"token1",
                 "tokenName":"artcollection",
                 "symbol":"ART",
                 "tokenStandard":"erc721+",
                 "tokenType":"nonfungible",
                 "tokenUnit":"whole",
                 "behaviors":[
                    "indivisible",
                    "singleton",
                    "mintable",
                    "transferable",
                    "lockable",
                    "burnable",
                    "roles"
                 ],
                 "roles":{
                    "minter_role_name":"minter"
                 },
                 "mintable":{
                    "max_mint_quantity":20000
                 },
                 "createdBy":"oaccount~208e3345ac84b4849f0d2648b2f2f018019886a1230f99304ebff1b6a7733463",
                 "creationDate":"2023-10-20T10:26:29.000Z",
                 "owner":"oaccount~208e3345ac84b4849f0d2648b2f2f018019886a1230f99304ebff1b6a7733463",
                 "isBurned":false,
                 "isLocked":true,
                 "tokenUri":"token1.examplecom",
                 "price":120,
                 "on_sale_flag":false
              }
           }
        ],
        "encode": "JSON"
    }
}

getTokenById

Nom de la méthode initiale : getTokenById

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

Interrogation :

/getTokenById?tokenId={{bc-token-id}}

Paramètres :

• tokenId: string - ID du jeton à obtenir.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "metadata": {
                "painting_name": "Mona_Lisa",
                "description": "Mona Lisa Painting",
                "image": "monalisa.jpeg",
                "painter_name": "Leonardo_da_Vinci"
            },
            "assetType": "otoken",
            "tokenId": "monalisa",
            "tokenName": "artcollection",
            "tokenDesc": "token description",
            "symbol": "ART",
            "tokenStandard": "erc721+",
            "tokenType": "nonfungible",
            "tokenUnit": "whole",
            "behaviors": [
                "indivisible",
                "singleton",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter"
            },
            "mintable": {
                "max_mint_quantity": 20000
            },
            "owner": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
            "createdBy": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
            "transferredBy": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
            "creationDate": "2022-04-05T08:30:42.000Z",
            "transferredDate": "2022-04-05T09:28:30.000Z",
            "isBurned": false,
            "tokenUri": "https://bafybeid6pmpp62bongoip5iy2skosvyxh3gr7r2e35x3ctvawjco6ddmsq\\ .ipfs.infura-ipfs.io/?filename=MonaLisa.jpeg",
            "price": 100,
            "on_sale_flag": true
        },
        "encode": "JSON"
    }
}

getTokenHistory

Nom de la méthode initiale : getTokenHistory

Cette méthode retourne l'historique pour un ID jeton spécifié. Il s'agit d'une méthode asynchrone. Cette méthode ne peut être appelée que lorsqu'elle est connectée au réseau distant Oracle Blockchain Platform. Tout le monde peut appeler cette méthode.

/getTokenHistory?tokenId={{bc-token-id}}

Paramètres :

• tokenId: string - ID du jeton.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": [
            {
                "trxId": "ca4c07bf04240345de918cbf1f4f3da4b4d0ab044c5b8bea94343e427d9ed4e7",
                "timeStamp": 1649150910,
                "value": {
                    "metadata": {
                        "painting_name": "Mona_Lisa",
                        "description": "Mona Lisa Painting",
                        "image": "monalisa.jpeg",
                        "painter_name": "Leonardo_da_Vinci"
                    },
                    "assetType": "otoken",
                    "tokenId": "monalisa",
                    "tokenName": "artcollection",
                    "tokenDesc": "token description",
                    "symbol": "ART",
                    "tokenStandard": "erc721+",
                    "tokenType": "nonfungible",
                    "tokenUnit": "whole",
                    "behaviors": [
                        "indivisible",
                        "singleton",
                        "mintable",
                        "transferable",
                        "burnable",
                        "roles"
                    ],
                    "roles": {
                        "minter_role_name": "minter"
                    },
                    "mintable": {
                        "max_mint_quantity": 20000
                    },
                    "owner": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                    "createdBy": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                    "transferredBy": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                    "creationDate": "2022-04-05T08:30:42.000Z",
                    "transferredDate": "2022-04-05T09:28:30.000Z",
                    "isBurned": false,
                    "tokenUri": "https://bafybeid6pmpp62bongoip5iy2skosvyxh3gr7r2e35x3ctvawjco6ddmsq\\ .ipfs.infura-ipfs.io/?filename=MonaLisa.jpeg",
                    "price": 100,
                    "on_sale_flag": true
                }
            },
            {
                "trxId": "cfb52ffc8c34c7fd86210fcf8c5f53d9f92a056c45ed3a33671d638020c1f9cb",
                "timeStamp": 1649149545,
                "value": {
                    "metadata": {
                        "painting_name": "Mona_Lisa",
                        "description": "Mona Lisa Painting",
                        "image": "monalisa.jpeg",
                        "painter_name": "Leonardo_da_Vinci"
                    },
                    "assetType": "otoken",
                    "tokenId": "monalisa",
                    "tokenName": "artcollection",
                    "tokenDesc": "token description",
                    "symbol": "ART",
                    "tokenStandard": "erc721+",
                    "tokenType": "nonfungible",
                    "tokenUnit": "whole",
                    "behaviors": [
                        "indivisible",
                        "singleton",
                        "mintable",
                        "transferable",
                        "burnable",
                        "roles"
                    ],
                    "roles": {
                        "minter_role_name": "minter"
                    },
                    "mintable": {
                        "max_mint_quantity": 20000
                    },
                    "owner": "oaccount~ec32cff8635a056f3dda3da70b1d6090d61f66c6a170c4a95fd008181f729dba",
                    "createdBy": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                    "transferredBy": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                    "creationDate": "2022-04-05T08:30:42.000Z",
                    "transferredDate": "2022-04-05T09:05:45.000Z",
                    "isBurned": false,
                    "tokenUri": "https://bafybeid6pmpp62bongoip5iy2skosvyxh3gr7r2e35x3ctvawjco6ddmsq\\ .ipfs.infura-ipfs.io/?filename=MonaLisa.jpeg",
                    "price": 100,
                    "on_sale_flag": true
                }
            },
            {
                "trxId": "702e61cc8d6d2982521023d0d5f3195900f35e146d6a90ef66daae551e6075d2",
                "timeStamp": 1649147729,
                "value": {
                    "metadata": {
                        "painting_name": "Mona_Lisa",
                        "description": "Mona Lisa Painting",
                        "image": "monalisa.jpeg",
                        "painter_name": "Leonardo_da_Vinci"
                    },
                    "assetType": "otoken",
                    "tokenId": "monalisa",
                    "tokenName": "artcollection",
                    "tokenDesc": "token description",
                    "symbol": "ART",
                    "tokenStandard": "erc721+",
                    "tokenType": "nonfungible",
                    "tokenUnit": "whole",
                    "behaviors": [
                        "indivisible",
                        "singleton",
                        "mintable",
                        "transferable",
                        "burnable",
                        "roles"
                    ],
                    "roles": {
                        "minter_role_name": "minter"
                    },
                    "mintable": {
                        "max_mint_quantity": 20000
                    },
                    "owner": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                    "createdBy": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                    "creationDate": "2022-04-05T08:30:42.000Z",
                    "isBurned": false,
                    "tokenUri": "https://bafybeid6pmpp62bongoip5iy2skosvyxh3gr7r2e35x3ctvawjco6ddmsq\\ .ipfs.infura-ipfs.io/?filename=MonaLisa.jpeg",
                    "price": 100,
                    "on_sale_flag": true
                }
            },
            {
                "trxId": "e7747b3001a170f88688620956320e9402e1dd8edad8afb4818a08a34647337c",
                "timeStamp": 1649147442,
                "value": {
                    "metadata": {
                        "painting_name": "Mona_Lisa",
                        "description": "Mona Lisa Painting",
                        "image": "monalisa.jpeg",
                        "painter_name": "Leonardo_da_Vinci"
                    },
                    "assetType": "otoken",
                    "tokenId": "monalisa",
                    "tokenName": "artcollection",
                    "tokenDesc": "token description",
                    "symbol": "ART",
                    "tokenStandard": "erc721+",
                    "tokenType": "nonfungible",
                    "tokenUnit": "whole",
                    "behaviors": [
                        "indivisible",
                        "singleton",
                        "mintable",
                        "transferable",
                        "burnable",
                        "roles"
                    ],
                    "roles": {
                        "minter_role_name": "minter"
                    },
                    "mintable": {
                        "max_mint_quantity": 20000
                    },
                    "owner": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                    "createdBy": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                    "creationDate": "2022-04-05T08:30:42.000Z",
                    "isBurned": false,
                    "tokenUri": "\"https://bafybeid6pmpp62bongoip5iy2skosvyxh3gr7r2e35x3ctvawjco6ddmsq\\ .ipfs.infura-ipfs.io/?filename=MonaLisa.jpeg\"",
                    "price": 100,
                    "on_sale_flag": false
                }
            }
        ]
        "encode": "JSON"
    }
}

getTransactionById

Nom de la méthode initiale : getTransactionById

Cette méthode retourne l'historique des transactions pour un ID transaction spécifié. Il s'agit d'une méthode asynchrone. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.

Interrogation :

/getTransactionById?transactionId=transactionId value

Paramètres :

• transactionId: string - ID de la transaction, qui est le préfixe otransaction~ suivi du code de hachage à 64 bits au format hexadécimal.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "transactionId": "otransaction~6ffd0d94f234c12444a5d5aa559563b59dff4d2280b573fea956dc632bdaf5d4",
            "history": [
                {
                    "trxId": "6ffd0d94f234c12444a5d5aa559563b59dff4d2280b573fea956dc632bdaf5d4",
                    "timeStamp": 1649151044,
                    "value": {
                        "assetType": "otransaction",
                        "transactionId": "otransaction~6ffd0d94f234c12444a5d5aa559563b59dff4d2280b573fea956dc632bdaf5d4",
                        "tokenId": "monalisa1",
                        "fromAccountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                        "toAccountId": "",
                        "triggeredByAccountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
                        "transactionType": "BURN",
                        "timestamp": "2022-04-05T09:30:44.000Z",
                    }
                }
            ]
        },
        "encode": "JSON"
    }
}

getUserByAccountId

Nom de la méthode initiale : getUserByAccountId

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

Interrogation :

/getUserByAccountId?accountId=accountId value

Paramètres :

• accountId: string - ID du compte.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
          "userId": "admin",
          "orgId": "Org1MSP"
        },
        "encode": "JSON"
    }
}

getUsersByRole

Nom de la méthode initiale : getUsersByRole

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

/getUsersByRole?role=role value (for example minter / burner)

Paramètres :

• role: string - Nom du rôle à rechercher.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "users": [
                {
                    "userId": "admin",
                    "orgId": "Org1MSP"
                }
            ]
        },
        "encode": "JSON"
    }
}

init

Nom de la méthode initiale : init

Cette méthode est appelée lorsque le code de chaîne est déployé. Les informations sur l'utilisateur sont enregistrées en tant que Token Admin du code de chaîne.

Données utiles :

{
    "adminList": "[{\"orgId\":\"{{bc-org-id}}\",\"userId\":\"{{bc-admin-user}}\"}]"
}

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 valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "fdb7dc89832c8045a333823b77fa24ae628178148dc93b3550040e070d7cd807",
        "payload": "",
        "encode": "UTF-8",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 263
    }
}

isInRole

Nom de la méthode initiale : isInRole

Cette méthode GET retourne une valeur booléenne pour indiquer si un utilisateur a un rôle spécifié. Cette méthode ne peut être appelée que par Token Admin du code de chaîne ou par Account Owner du compte.

Interrogation :

/isInRole?orgId={{bc-org-id}}&userId={{bc-user-id}}&role=role value (for example minter / burner)

Paramètres :

• 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.
• role: string - Nom du rôle à rechercher.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "result":"true"
        },
        "encode": "JSON"
    }
}

isInTokenSysRole

Nom de la méthode initiale : isInTokenSysRole

Cette méthode GET retourne une valeur booléenne pour indiquer si un utilisateur a un rôle TokenSys spécifié. Cette méthode ne peut être appelée que par Token Admin du code de chaîne ou par Account Owner du compte.

Interrogation :

/isInTokenSysRole?orgId={{bc-org-id}}&userId={{bc-user-id}}&role=role value (for example vault)

Paramètres :

• role: string - Nom du rôle TokenSys à rechercher.
• 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.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "result": true,
            "msg": "Account Id oaccount~bf07f584a94be44781e49d9101bfaf58c6fbbe77a4dfebdb83c874c2caf03eba (Org-Id: Org1MSP, User-Id: user1) has vault role"
        },
        "encode": "JSON"
    }
}

isNFTLocked

Nom de la méthode initiale : isNFTLocked

Cette méthode GET retourne une valeur booléenne pour indiquer si un jeton spécifié est verrouillé. Cette méthode ne peut être appelée que par Token Admin du code de chaîne, du responsable du jeton ou du gestionnaire de chambres fortes (utilisateur doté du rôle TokenSys vault).

Interrogation :

/isNFTLocked?tokenId={{bc-token-id}}

Paramètres :

• tokenId: string - ID du jeton.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
           "isNFTLocked":true
        },
        "encode": "JSON"
    }
}

lockNFT

Nom de la méthode initiale : lockNFT

Cette méthode POST verrouille un jeton non fongible spécifié. Pour verrouiller un jeton, un utilisateur doté du rôle TokenSys vault doit agir en tant que gestionnaire de chambres fortes.

Données utiles :

{
    "tokenId": "{{bc-token-id}}",
    "sameOrgEndorser": true
}

Paramètres :

• tokenId: string - ID du jeton à verrouiller.
• sameOrgEndorser: boolean - Valeur booléenne indiquant si les endossements de transaction doivent provenir de la même organisation que le demandeur.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bd7416689b1acdace3c557faebbc0ad9a51671c10278ba6909350a6fe4b08eed",
        "payload": {
           "assetType":"otoken",
           "tokenId":"token1",
           "tokenName":"artcollection",
           "symbol":"ART",
           "tokenStandard":"erc721+",
           "tokenType":"nonfungible",
           "tokenUnit":"whole",
           "behaviors":[
              "indivisible",
              "singleton",
              "mintable",
              "transferable",
              "lockable",
              "burnable",
              "roles"
           ],
           "roles":{
              "minter_role_name":"minter"
           },
           "mintable":{
              "max_mint_quantity":20000
           },
           "createdBy":"oaccount~208e3345ac84b4849f0d2648b2f2f018019886a1230f99304ebff1b6a7733463",
           "creationDate":"2023-10-20T10:26:29.000Z",
           "owner":"oaccount~208e3345ac84b4849f0d2648b2f2f018019886a1230f99304ebff1b6a7733463",
           "isBurned":false,
           "isLocked":true,
           "tokenUri":"token1.example.com",
           "price":120,
           "on_sale_flag":false
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 193
    }
}

name

Nom de la méthode d'origine : name

Cette méthode GET retourne le nom de la classe de jeton. Tout le monde peut appeler cette méthode.

Interrogation :

/name

Paramètres : Aucun

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {"tokenName": "artcollection"},
        "encode": "JSON"
    }
}

ownerOf

Nom de la méthode initiale : ownerOf

Cette méthode GET retourne l'ID compte du responsable de l'ID jeton spécifié. Tout le monde peut appeler cette méthode.

Interrogation :

/ownerOf?tokenId={{bc-token-id}}

Paramètres :

• tokenId: string - ID du jeton.

Retourne :

• Objet JSON de l'ID compte du responsable.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "owner": "oaccount~d6d22c3167e3c6ab9ee5653e1a008c37c20cc47ebb0229ca0aedfafe64c675b8"
        },
        "encode": "JSON"
    }
}

post

Nom de la méthode initiale : post

Cette méthode POST publie un jeton à vendre pour un prix spécifié.

Données utiles :

{
    "tokenId": "{{bc-token-id}}",
    "sellingPrice": 1,
    "endorsers": {{endorsers}}
}

Paramètres :

• tokenId: string - ID du jeton.
• sellingPrice: number - Prix du jeton.
• endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bd7416689b1acdace3c557faebbc0ad9a51671c10278ba6909350a6fe4b08eed",
        "payload": {
            "msg": "Token ID: 'monalisa'  has been posted for selling in the marketplace"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 193
    }
}

removeRole

Nom de la méthode initiale : removeRole

Cette méthode supprime un rôle d'un utilisateur spécifié. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.

Données utiles :

{
    "role": "role value (for example minter / burner)",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}

Paramètres :

• 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.
• 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.
• endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bd7416689b1acdace3c557faebbc0ad9a51671c10278ba6909350a6fe4b08eed",
        "payload": {
            "msg": "Successfully removed role 'minter' from Account Id: oaccount~ec32cff8635a056f3dda3da70b1d6090d61f66c6a170c4a95fd008181f729dba (Org-Id: Org1MSP, User-Id: user1)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 193
    }
}

removeTokenAdmin

Nom de la méthode initiale : removeTokenAdmin

Cette méthode POST 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. Un administrateur ne peut pas se supprimer lui-même.

Données utiles :

{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "sameOrgEndorser": true
}

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.
• sameOrgEndorser: boolean - Valeur booléenne indiquant si les endossements de transaction doivent provenir de la même organisation que le demandeur.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bd7416689b1acdace3c557faebbc0ad9a51671c10278ba6909350a6fe4b08eed",
        "payload": {
            "msg": "Successfully removed Admin (orgId: Org1MSP, userId: User1)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 193
    }
}

removeTokenSysRole

Nom de la méthode initiale : removeTokenSysRole

Cette méthode supprime un rôle TokenSys 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.

Données utiles :

{
    "role": "role value (for example vault)",
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}

Paramètres :

• role: string - Nom du rôle TokenSys à supprimer de l'utilisateur spécifié.
• 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.
• endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bd7416689b1acdace3c557faebbc0ad9a51671c10278ba6909350a6fe4b08eed",
        "payload": {
            "msg": "Successfully removed role 'vault' from Account Id: oaccount~bf07f584a94be44781e49d9101bfaf58c6fbbe77a4dfebdb83c874c2caf03eba (Org-Id: Org1MSP, User-Id: user1)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 193
    }
}

safeTransferFrom

Nom de la méthode initiale : safeTransferFrom

Il s'agit d'une fonction asynchrone. Cette méthode POST transfère la propriété du NFT spécifié de l'appelant à un autre compte. Cette méthode comprend les validations suivantes :

• Le jeton existe et n'est pas brûlé.
• Le compte expéditeur et le compte destinataire existent et ne sont pas le même compte.
• Le compte de l'expéditeur est responsable du jeton.
• L'appelant de la fonction est l'expéditeur.

Données utiles :

{
    "fromOrgId": "fromOrgId value",
    "fromUserId": "fromUserId value",
    "toOrgId": "toOrgId value",
    "toUserId": "toUserId value",
    "tokenId": "{{bc-token-id}}",
    "data": "data value",
    "endorsers": {{endorsers}}
}

Paramètres :

• fromOrgId: string - ID fournisseur de services d'adhésion (MSP) de l'expéditeur et du responsable du jeton dans l'organisation courante.
• fromUserId: string - Nom d'utilisateur ou ID courriel de l'expéditeur et du responsable du jeton.
• toOrgId: string - ID fournisseur de services d'adhésion (MSP) du destinataire dans l'organisation courante.
• toUserId: string - Nom d'utilisateur ou ID courriel du destinataire.
• tokenId: string - ID du jeton à transférer.
• data: string - Informations supplémentaires facultatives à stocker dans l'enregistrement de transaction.
• endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bd7416689b1acdace3c557faebbc0ad9a51671c10278ba6909350a6fe4b08eed",
        "payload": {
            "msg": "Successfully transferred NFT token: 'monalisa' from Account-Id:     oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d (Org-Id: Org1MSP, User-Id: admin) to Account-Id: oaccount~ec32cff8635a056f3dda3da70b1d6090d61f66c6a170c4a95fd008181f729dba (Org-Id: Org1MSP, User-Id: user1)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 193
    }
}

suspendAccount

Nom de la méthode initiale : suspendAccount

Cette méthode suspend un compte de jeton fongible. Une erreur est générée si aucune valeur accountStatus n'est trouvée dans le livre. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.

Données utiles :

{
    "orgId": "{{bc-org-id}}",
    "userId": "{{bc-user-id}}",
    "endorsers": {{endorsers}}
}

Paramètres :

• 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.
• endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bd7416689b1acdace3c557faebbc0ad9a51671c10278ba6909350a6fe4b08eed",
        "payload": {
            "assetType": "oaccountStatus",
            "statusId": "oaccountStatus~5a0b0d8b1c6433af9fedfe0d9e6580e7cf6b6bb62a0de6267aaf79f79d5e96d7",
            "accountId": "oaccount~1c568151c4acbcd1bd265c766c677145760a61c47fc8a3ba681a4cfbe287f9c1",
            "status": "suspended"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 193
    }
}

symbol

Nom de la méthode initiale : symbol

Cette méthode retourne le symbole de la classe de jeton. Tout le monde peut appeler cette méthode.

Interrogation :

/symbol

Paramètres :

• aucune

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "symbol": "PNT"
        },
        "encode": "JSON"
    }
}

tokenURI

Nom de la méthode initiale : tokenURI

Cette méthode retourne l'URI d'un jeton spécifié. Tout le monde peut appeler cette méthode.

Interrogation :

/tokenURI?tokenId={{bc-token-id}}

Paramètres :

• tokenId: string - ID du jeton.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {   
            "tokenURI": "https://bafybeid6pmpp62bongoip5iy2skosvyxh3gr7r2e35x3ctvawjco6ddmsq\.ipfs.infura-ipfs.io/?filename=MonaLisa.jpeg"
        },
        "encode": "JSON"
    }
}

totalNetSupply

Nom de la méthode initiale : totalNetSupply

Cette méthode GET retourne le nombre total de jetons frappés moins le nombre de jetons brûlés. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.

/totalNetSupply

Paramètres :

• aucune

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "totalNetSupply": 1
        },
        "encode": "JSON"
    }
}

totalSupply

Nom de la méthode initiale : totalSupply

Cette méthode GET retourne le nombre total de jetons frappés. Cette méthode ne peut être appelée que par un élément Token Admin du code de chaîne.

Interrogation :

/totalSupply

Paramètres :

• aucune

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "payload": {
            "totalSupply": 3
        },
        "encode": "JSON"
    }
}

transferFrom

Nom de la méthode initiale : transferFrom

Il s'agit d'une fonction asynchrone. Cette méthode transfère la propriété de la transaction de transfert de fonds nationale spécifiée d'un compte d'expéditeur à un compte de destinataire. Il est de la responsabilité de l'appelant de transmettre les paramètres corrects. Cette méthode peut être appelée par n'importe quel utilisateur, pas seulement par le propriétaire du jeton. Cette méthode comprend les validations suivantes :

• Le jeton existe et n'est pas brûlé.
• Le compte expéditeur et le compte destinataire existent et ne sont pas le même compte.
• Le compte de l'expéditeur est responsable du jeton.

Données utiles :

{
    "fromOrgId": "fromOrgId value",
    "fromUserId": "fromUserId value",
    "toOrgId": "toOrgId value",
    "toUserId": "toUserId value",
    "tokenId": "{{bc-token-id}}",
    "endorsers": {{endorsers}}
}

Paramètres :

• fromOrgId: string - ID fournisseur de services d'adhésion (MSP) de l'expéditeur dans l'organisation courante.
• fromUserId: string - Nom d'utilisateur ou ID courriel de l'expéditeur.
• toOrgId: string - ID fournisseur de services d'adhésion (MSP) du destinataire dans l'organisation courante.
• toUserId: string - Nom d'utilisateur ou ID courriel du destinataire.
• tokenId: string - ID du jeton à transférer.
• endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bd7416689b1acdace3c557faebbc0ad9a51671c10278ba6909350a6fe4b08eed",
        "payload": {
            "msg": "Successfully transferred NFT token: 'monalisa' from Account-Id: oaccount~ec32cff8635a056f3dda3da70b1d6090d61f66c6a170c4a95fd008181f729dba (Org-Id: Org1MSP, User-Id: user1) to Account-Id: oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d (Org-Id: Org1MSP, User-Id: admin)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 193
    }
}

transferTokenSysRole

Nom de la méthode initiale : transferTokenSysRole

Cette méthode transfère un rôle TokenSys d'un utilisateur à un autre utilisateur.

Données utiles :

{
    "role": "role value (for example vault)",
    "fromOrgId": "fromOrgId value",
    "fromUserId": "fromUserId value",
    "toOrgId": "toOrgId value",
    "toUserId": "toUserId value",
    "endorsers": {{endorsers}}
}

Paramètres :

• role: string - Nom du rôle TokenSys à transférer.
• fromOrgId: string - ID fournisseur de services d'adhésion (MSP) de l'expéditeur dans l'organisation courante.
• fromUserId: string - Nom d'utilisateur ou ID courriel de l'expéditeur.
• toOrgId: string - ID fournisseur de services d'adhésion (MSP) du destinataire dans l'organisation courante.
• toUserId: string - Nom d'utilisateur ou ID courriel du destinataire.
• endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bd7416689b1acdace3c557faebbc0ad9a51671c10278ba6909350a6fe4b08eed",
        "payload": {
            "msg": "Successfully transfered role 'vault' from Account Id: ouaccount~f4e311528f03fffa7810753d643f66289ff6c9080fcf839902f28a1d3aff1789 (Org-Id: Org1MSP, User-Id: user1) to Account Id: ouaccount~ae5be2ae8f98d6d32f5d02b43877d987114e7937c7bacbc30390dcce09996a19 (Org-Id: Org1MSP, User-Id: user2)"
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 193
    }
}

updateArtCollectionToken

Nom de la méthode initiale : updateArtCollectionToken

Cette méthode met à jour les propriétés du jeton. Après la création d'une ressource de jeton, seul le responsable du jeton peut mettre à jour les propriétés personnalisées du jeton. Si l'utilisateur est à la fois le responsable et le créateur d'un jeton, il peut également mettre à jour la propriété TokenDesc. Les métadonnées de jeton ne peuvent pas être mises à jour. Vous devez transmettre toutes les propriétés de jeton à cette méthode, même si vous souhaitez mettre à jour uniquement certaines propriétés.

Données utiles :

{
    "tokenAsset": "{\"tokenId\":\"{{bc-token-id}}\",\"tokenDesc\":\"tokenDesc value\",\"tokenUri\":\"tokenUri value\",\"Price\":999,\"On_Sale_Flag\":true}",
    "sameOrgEndorser": true
}

Paramètres :

• tokenAsset: <Token Class> - Ressource de jeton à mettre à jour. Pour plus d'informations sur les propriétés de la ressource de jeton, voir le fichier de spécification d'entrée.
• endorsers: string[] - Tableau des pairs (par exemple, peer1, peer2) qui doivent approuver la transaction.

Exemple de valeur renvoyée :

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bd7416689b1acdace3c557faebbc0ad9a51671c10278ba6909350a6fe4b08eed",
        "payload": {
            "metadata": {
                "painting_name": "Mona_Lisa",
                "description": "Mona Lisa Painting",
                "image": "monalisa.jpeg",
                "painter_name": "Leonardo_da_Vinci"
            },
            "assetType": "otoken",
            "tokenId": "monalisa",
            "tokenName": "artcollection",
            "tokenDesc": "token description",
            "symbol": "ART",
            "tokenStandard": "erc721+",
            "tokenType": "nonfungible",
            "tokenUnit": "whole",
            "behaviors": [
                "indivisible",
                "singleton",
                "mintable",
                "transferable",
                "burnable",
                "roles"
            ],
            "roles": {
                "minter_role_name": "minter"
            },
            "mintable": {
                "max_mint_quantity": 20000
            },
            "owner": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
            "createdBy": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
            "creationDate": "2022-04-05T08:30:42.000Z",
            "isBurned": false,
            "tokenUri": "https://bafybeid6pmpp62bongoip5iy2skosvyxh3gr7r2e35x3ctvawjco6ddmsq\\.ipfs.infura-ipfs.io/?filename=MonaLisa.jpeg",
            "price": 100,
            "on_sale_flag": true
        },
        "encode": "JSON",
        "sourceURL": "cb-oabcs1-bom.blockchain.ocp.example.com:20009",
        "blockNumber": 193
    }
}