Gerüst TypeScript NFT Projekt für ERC-721

Blockchain App Builder übernimmt die Eingabe aus Ihrer NFT-Spezifikationsdatei und generiert ein voll funktionsfähiges gerüstetes Chaincode-Projekt.

Das Projekt generiert automatisch NFT-Lebenszyklusklassen und -Funktionen, einschließlich CRUD- und Nicht-CRUD-Methoden sowie ein Tokenisierungs-SDK. Validierung von Argumenten, Marshalling/Unmarshalling und transparente Persistenzfunktion werden automatisch unterstützt.

Informationen zu dem gerüsteten Projekt und den Methoden, die nicht direkt mit NFTs verknüpft sind, finden Sie unter Gerüstetes TypeScript Chaincode-Projekt.

Referenz:

Modell

Jede tokenisierte Modellklasse erweitert die Klasse OchainModel. Transparent Persistence Capability (oder vereinfachtes ORM) wird in der Klasse OchainModel erfasst.

import * as yup from 'yup';
import { Id, Mandatory, Validate, Default, Embedded, Derived, ReadOnly } from '../../lib/decorators';
import { OchainModel } from '../../lib/ochain-model';
import { STRATEGY } from '../../lib/utils';
import { EmbeddedModel } from '../../lib/ochain-embedded-model';

export class ArtCollectionMetadata extends EmbeddedModel<ArtCollectionMetadata> {
    @Validate(yup.string())
    public painting_name: string;

    @Validate(yup.string())
    public description: string;

    @Validate(yup.string())
    public image: string;

    @Validate(yup.string())
    public painter_name: string;

}
    
@Id('tokenId')       
export class ArtCollection extends OchainModel<ArtCollection> {

    public readonly assetType = 'otoken';
        
    @Mandatory()
    @Validate(yup.string().required().matches(/^[A-Za-z0-9][A-Za-z0-9_-]*$/).max(16))
    public tokenId: string;

    @ReadOnly('artcollection')
    public tokenName: string;

    @Validate(yup.string().trim().max(256))
    public tokenDesc: string;

    @ReadOnly('ART')
    public symbol: string;

    @ReadOnly('erc721+')
    public tokenStandard: string;

    @ReadOnly('nonfungible')
    public tokenType: string;

    @ReadOnly('whole')
    public tokenUnit: string;

      @ReadOnly(["indivisible","singleton","mintable","transferable","burnable","roles"])
    public behaviors: string[];

    @ReadOnly({minter_role_name: "minter"})
    public roles: object;

    @ReadOnly({max_mint_quantity: 20000})
    public mintable: object;

    @Validate(yup.string())
    public owner: string;

    @Validate(yup.string())
    public createdBy: string;

    @Validate(yup.string())
    public transferredBy: string;

    @Validate(yup.string())
    public creationDate: string;

    @Validate(yup.string())
    public transferredDate: string;

    @Validate(yup.bool())
    public isBurned: boolean;

    @Validate(yup.string())
    public burnedBy: string;

    @Validate(yup.string())
    public burnedDate: string;

    @Validate(yup.string().max(2000))
    public tokenUri: string;
    
    @Embedded(ArtCollectionMetadata)
    public metadata: ArtCollectionMetadata;

    @Validate(yup.number())
    public price: number;

    @Validate(yup.boolean())
    public on_sale_flag: boolean;

}

Verantwortlicher

Die Hauptcontrollerklasse erweitert die Klasse OchainController. Es gibt nur einen Hauptcontroller.

export class DigiCurrCCController extends OchainController{

Sie können eine beliebige Anzahl von Klassen, Funktionen oder Dateien erstellen, aber nur die Methoden, die in der Hauptcontrollerklasse definiert sind, können aufgerufen werden. Die anderen Methoden sind versteckt.

Mit den Token-SDK-Methoden können Sie benutzerdefinierte Methoden für Ihre Geschäftsanwendung schreiben.

Automatisch generierte NFT-Methoden

Blockchain App Builder generiert automatisch Methoden zur Unterstützung von NFTs und NFT-Lebenszyklen. Mit diesen Methoden können Sie NFTs initialisieren, Rollen und Accounts verwalten und andere NFT-Lebenszyklusaufgaben ohne zusätzliche Codierung ausführen. Controller-Methoden müssen einen @Validator(...params)-Dekorator aufweisen, damit sie aufgerufen werden können.

Methoden für die Zugriffskontrollverwaltung

addTokenAdmin

Diese Methode fügt einen Benutzer als Token Admin des Chaincodes hinzu. Diese Methode kann nur von einem Token Admin des Chaincodes aufgerufen werden.

@Validator(yup.string(), yup.string())
public async addTokenAdmin(orgId: string, userId: string) {
    await this.Ctx.ERC721Auth.checkAuthorization('ERC721ADMIN.addAdmin', 'TOKEN');
    return await this.Ctx.ERC721Admin.addAdmin(orgId, userId);
}

Parameter:

orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Rückgabewert:

Bei Erfolg eine Nachricht, die Details des Benutzers enthält, der als Token Admin des Chaincodes hinzugefügt wurde.

Beispiel für Rückgabewert:

{"msg":"Successfully added Admin (orgId: Org1MSP, userId: User1)"}

removeTokenAdmin

Mit dieser Methode wird ein Benutzer als Token Admin des Chaincodes entfernt. Diese Methode kann nur von einem Token Admin des Chaincodes aufgerufen werden.

@Validator(yup.string(), yup.string())
public async removeTokenAdmin(orgId: string, userId: string) {
   await this.Ctx.ERC721Auth.checkAuthorization('ERC721ADMIN.removeAdmin', 'TOKEN');
   return await this.Ctx.ERC721Admin.removeAdmin(orgId, userId);
}

Parameter:

orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Rückgabewert:

Bei Erfolg eine Nachricht, die Details des Benutzers enthält, der als Token Admin des Chaincodes entfernt wurde.

Beispiel für Rückgabewert:

{"msg": "Successfully removed Admin (orgId: Org1MSP, userId: User1)"}

isTokenAdmin

Diese Methode gibt den booleschen Wert true zurück, wenn der Aufrufer der Funktion ein Token Admin ist. Andernfalls gibt sie false zurück. Eine Token Admin kann diese Funktion bei jedem anderen Benutzer im Blockchain-Netzwerk aufrufen. Andere Benutzer können diese Methode nur für ihre eigenen Accounts aufrufen.

@GetMethod()
@Validator(yup.string(), yup.string())
public async isTokenAdmin(orgId: string, userId: string) {
    await this.Ctx.ERC721Auth.checkAuthorization('ERC721ADMIN.isUserTokenAdmin', 'TOKEN');
    return await this.Ctx.ERC721Auth.isUserTokenAdmin(orgId, userId);
}

Parameter:

orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Rückgabewert:

Die Methode gibt true zurück, wenn der Aufrufer ein Token Admin ist. Andernfalls wird false zurückgegeben.

Beispiel für Rückgabewert:

{"result": true}

getAllTokenAdmins

Diese Methode gibt eine Liste aller Benutzer zurück, die ein Token Admin des Chaincodes sind. Diese Methode kann nur von der Token Admin des Chaincodes aufgerufen werden.

@GetMethod()
@Validator()
public async getAllTokenAdmins() {
    await this.Ctx.ERC721Auth.checkAuthorization('ERC721ADMIN.getAllAdmins', 'TOKEN');
    return await this.Ctx.ERC721Admin.getAllAdmins();
}

Parameter:

Kein

Rückgabewert:

Bei Erfolg ein Array admins im JSON-Format, das orgId- und userId-Objekte enthält.

Beispiel für Rückgabewert:

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

Methoden für die Verwaltung der Tokenkonfiguration

init

Diese Methode wird aufgerufen, wenn der Chaincode instanziiert wird. Jede Token Admin wird durch die Informationen userId und orgId im Parameter adminList identifiziert. Die userId ist der Benutzername oder die E-Mail-ID des Instanzeigentümers oder des Benutzers, der bei der Instanz angemeldet ist. Die orgId ist die MSP-ID (Member Service Provider) des Benutzers in der aktuellen Netzwerkorganisation. Der Parameter adminList ist erforderlich, wenn Sie den Chaincode das erste Mal bereitstellen. Wenn Sie das Chaincode-Upgrade durchführen, übergeben Sie eine leere Liste ([]). Alle anderen Informationen im Parameter adminList werden bei Upgrades ignoriert.

@Validator(yup.array().of(yup.object()).nullable())
public async init(adminList: ERC721TokenAdminAsset[]) {
   await this.Ctx.ERC721Admin.initAdmin(adminList);
   await this.Ctx.ERC721Token.saveClassInfo(<NFT_NAME>);
   await this.Ctx.ERC721Token.saveDeleteTransactionInfo();
   return;
}

Parameter:

adminList array: Ein Array mit {orgId, userId}-Informationen, das die Liste der Tokenadministratoren angibt. Das Array adminList ist ein obligatorischer Parameter.

getAllTokens

Diese Methode gibt alle Tokenassets zurück, die in der Statusdatenbank gespeichert sind. Diese Methode kann nur von einem Token Admin des Chaincodes aufgerufen werden. Diese Methode verwendet SQL-reiche Berkeley DB-Abfragen und kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Oracle Blockchain Platform-Netzwerk besteht.

@GetMethod()
@Validator()
public async getAllTokens() {
    await this.Ctx.ERC721Auth.checkAuthorization('ERC721TOKEN.getAllTokens', 'TOKEN');
    return await this.Ctx.ERC721Token.getAllTokens();
}

Parameter:

Kein

Rückgabewert:

Eine Liste aller Tokenassets im JSON-Format.

Beispiel für Rückgabewert:

[
    {
        "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
        }
    }
]

getAllTokensByUser

Diese Methode gibt alle Tokenassets zurück, deren Eigentümer ein angegebener Benutzer ist. Diese Methode verwendet SQL-reiche Berkeley DB-Abfragen und kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Oracle Blockchain Platform-Netzwerk besteht. Diese Methode kann nur von einem Token Admin des Chaincodes oder vom Accounteigentümer aufgerufen werden.

@GetMethod()
@Validator(yup.string(), yup.string())
public async getAllTokensByUser(orgId: string, userId: string) {
    const accountId = await this.Ctx.ERC721Account.generateAccountId(orgId, userId);
    await this.Ctx.ERC721Auth.checkAuthorization('ERC721TOKEN.getAllTokensByUser', 'TOKEN', { accountId });
    return await this.Ctx.ERC721Token.getAllTokensByUser(accountId);
}

Parameter:

orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Rückgabewert:

Eine Liste der Tokenassets im JSON-Format.

Beispiel für Rückgabewert:

[
    {
        "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
        }
    }
]

getTokenById

Diese Methode gibt ein Tokenobjekt zurück, wenn das Token in der Statusdatenbank vorhanden ist. Diese Methode kann nur von einem Token Admin des Chaincodes oder des Tokeneigentümers aufgerufen werden.

@GetMethod()
@Validator(yup.string())
public async getTokenById(tokenId: string) {
   await this.Ctx.ERC721Auth.checkAuthorization('ERC721TOKEN.get', 'TOKEN', { tokenId });
   let token = await this.getTokenObject(tokenId);
   return token;
}

Parameter:

tokenId: string: Die ID des abzurufenden Tokens.

Rückgabewert:

Das Tokenasset im JSON-Format.

Beispiel für Rückgabewert:

{
    "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
}

getTokenHistory

Diese Methode gibt die Historie für eine angegebene Token-ID zurück. Dies ist eine asynchrone Methode. Diese Methode kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Oracle Blockchain Platform-Netzwerk besteht. Jeder kann diese Methode aufrufen.

@GetMethod()
@Validator(yup.string())
public async getTokenHistory(tokenId: string) {
   // await this.Ctx.ERC721Auth.checkAuthorization('ERC721TOKEN.history', 'TOKEN');
   return await this.Ctx.ERC721Token.history(tokenId);
}

Parameter:

tokenId: string: Die ID des Tokens.

Beispiel für Rückgabewert:

[
    {
        "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
        }
    }
]

getTokenObject

Dies ist eine Utilitymethode, die eine Instanz des Tokens für eine angegebene Token-ID zurückgibt. Diese Methode wird von vielen der automatisch generierten Methoden zum Abrufen von Tokenobjekten verwendet. Sie können diese Methode nach Bedarf mit Ihren benutzerdefinierten Methoden aufrufen. Wenn Sie ein tokenisiertes Asset oder eine tokenisierte Klasse erstellen, aktualisieren Sie den Switch-Fall mit der entsprechenden Token-Klasse, um das richtige Tokenobjekt zurückzugeben. Der Befehl ochain sync in Blockchain App Builder erstellt automatisch einen Switch-Fall, wenn ein tokenisiertes Asset in der Spezifikationsdatei erstellt wird. Diese Methode hat keinen @Validator()-Methodendekorator, was bedeutet, dass diese Methode nicht direkt aufgerufen werden kann und nur von anderen Methoden aufgerufen werden kann.

public async getTokenObject<T extends OchainModel<any>>(tokenId: string): Promise<T> {
   if (!tokenId) {
        throw Error('TokenID cannot be null/empty.');
    }
    const token = await this.Ctx.ERC721Token.get(tokenId);
    if (token.tokenName && token.assetType && token.assetType === 'otoken') {
        let tokenAsset;
        switch (token.tokenName) {
           case '<NFT_NAME in lowercase>':
               tokenAsset = new <NFT_NAME>(token, false, true);
               return tokenAsset;
           default:
               throw new Error(`No token exists with ID [${tokenId}]`);
        }
    } else {
        throw new Error(`No token exists with ID [${tokenId}]`);
    }
}

Parameter:

tokenId: string: Die ID des Tokens.

ownerOf

Diese Methode gibt die Account-ID des Eigentümers der angegebenen Token-ID zurück. Jeder kann diese Methode aufrufen.

@GetMethod()
@Validator(yup.string())
public async ownerOf(tokenId: string) {
   return await this.Ctx.ERC721Token.ownerOf(tokenId);
}

Parameter:

tokenId: string: Die ID des Tokens.

Rückgabewert:

Ein JSON-Objekt der Account-ID des Eigentümers.

Beispiel für Rückgabewert:

{"owner": "oaccount~d6d22c3167e3c6ab9ee5653e1a008c37c20cc47ebb0229ca0aedfafe64c675b8"}

name

Diese Methode gibt den Namen der Tokenklasse zurück. Jeder kann diese Methode aufrufen.

@GetMethod()
@Validator()
public async name() {
   return await this.Ctx.ERC721Token.name();
}

Parameter:

Kein

Rückgabewert:

Ein JSON-Objekt des Tokennamens.

Beispiel für Rückgabewert:

{"tokenName": "artcollection"}

symbol

Diese Methode gibt das Symbol der Tokenklasse zurück. Jeder kann diese Methode aufrufen.

@GetMethod()
@Validator()
public async symbol() {
   return await this.Ctx.ERC721Token.symbol();
}

Parameter:

Kein

Rückgabewert:

Ein JSON-Objekt des Tokensymbols.

Beispiel für Rückgabewert:

{"symbol": "PNT"}

tokenURI

Diese Methode gibt die URI eines angegebenen Tokens zurück. Jeder kann diese Methode aufrufen.

@GetMethod()
@Validator(yup.string())
public async tokenURI(tokenId: string) {
   return await this.Ctx.ERC721Token.tokenURI(tokenId);
}

Parameter:

tokenId: string: Die ID des Tokens.

Rückgabewert:

Bei Erfolg ein JSON-Objekt der Token-URI.

Beispiel für Rückgabewert:

{"tokenURI": "https://bafybeid6pmpp62bongoip5iy2skosvyxh3gr7r2e35x3ctvawjco6ddmsq\
.ipfs.infura-ipfs.io/?filename=MonaLisa.jpeg"}

totalSupply

Diese Methode gibt die Gesamtanzahl der abgebauten Token zurück. Diese Methode kann nur von einem Token Admin des Chaincodes aufgerufen werden.

@GetMethod()
@Validator()
public async totalSupply() {
  await this.Ctx.ERC721Auth.checkAuthorization('ERC721TOKEN.totalSupply', 'TOKEN');
  return await this.Ctx.ERC721Token.totalSupply();
}

Parameter:

Kein

Rückgabewert:

Bei Erfolg ein JSON-Objekt der Tokenanzahl.

Beispiel für Rückgabewert:

{"totalSupply": 3}

totalNetSupply

Diese Methode gibt die Gesamtanzahl der abgebrannten Token abzüglich der Anzahl der verbrannten Token zurück. Diese Methode kann nur von einem Token Admin des Chaincodes aufgerufen werden.

@GetMethod()
@Validator()
public async totalNetSupply() {
    await this.Ctx.ERC721Auth.checkAuthorization('ERC721TOKEN.totalNetSupply', 'TOKEN');
    return await this.Ctx.ERC721Token.getTotalMintedTokens();
}

Parameter:

Kein

Rückgabewert:

Bei Erfolg ein JSON-Objekt der Tokenanzahl.

Beispiel für Rückgabewert:

{"totalNetSupply": 1}

Methoden für die Kontenverwaltung

createAccount

Mit dieser Methode wird ein Account für einen angegebenen Benutzer und ein bestimmtes Token erstellt. Ein Konto muss für jeden Benutzer erstellt werden, der zu einem beliebigen Zeitpunkt Token hat. Firmen verfolgen die Anzahl der NFTs, die ein Benutzer hat. Benutzer müssen über Konten im Netzwerk verfügen, um tokenbezogene Vorgänge abzuschließen. Sie können nur ein NFT-Konto pro Benutzer erstellen.

Eine Account-ID ist ein alphanumerisches Zeichensatz mit dem Präfix oaccount~, gefolgt von einem SHA-256-Hash der Mitgliedsdienstanbieter-ID (orgId) des Benutzers in der aktuellen Netzwerkorganisation, dem Benutzernamen oder der E-Mail-ID (userId) des Instanzeigentümers oder des Benutzers, der bei der Instanz angemeldet ist, und der Konstantenzeichenfolge nft. Diese Methode kann nur von der Token Admin des Chaincodes aufgerufen werden.

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

Parameter:

orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
tokenType: string: Der einzige unterstützte Tokentyp ist nonfungible.

Rückgabewert:

Bei Erfolg ein JSON-Objekt des Accounts, der erstellt wurde. Der Parameter bapAccountVersion wird zur internen Verwendung im Accountobjekt definiert.

Beispiel für Rückgabewert:

{
    "assetType": "oaccount",
    "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
    "bapAccountVersion": 0,
    "userId": "admin",
    "orgId": "Org1MSP",
    "tokenType": "nonfungible",
    "noOfNfts": 0
}

balanceOf

Diese Methode gibt die Gesamtanzahl der NFTs zurück, die ein bestimmter Benutzer hält. Diese Methode kann nur von einem Token Admin des Chaincodes oder vom Accounteigentümer aufgerufen werden.

@GetMethod()
@Validator(yup.string(), yup.string())
 public async balanceOf(orgId: string, userId: string) {
     await this.Ctx.ERC721Auth.checkAuthorization('ERC721ACCOUNT.balanceOf', 'TOKEN', { orgId, userId });
     const accountId = await this.Ctx.ERC721Account.generateAccountId(orgId, userId);
     return await this.Ctx.ERC721Account.balanceOf(accountId);
 }

Parameter:

orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Rückgabewert:

Ein JSON-Objekt der aktuellen NFT-Anzahl.

Beispiel für Rückgabewert:

{"totalNfts": 0}

getAllAccounts

Diese Methode gibt eine Liste aller Konten zurück. Diese Methode kann nur von einem Token Admin des Chaincodes aufgerufen werden. Diese Methode verwendet SQL-reiche Berkeley DB-Abfragen und kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Oracle Blockchain Platform-Netzwerk besteht.

@GetMethod()
@Validator()
public async getAllAccounts() {
    await this.Ctx.ERC721Auth.checkAuthorization('ERC721ACCOUNT.getAllAccounts', 'TOKEN');
    return await this.Ctx.ERC721Account.getAllAccounts();
}

Parameter:

Kein

Rückgabewert:

Bei Erfolg ein JSON-Array aller Konten.

Beispiel für Rückgabewert:

[
    {
        "key": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
        "valueJson": {
            "assetType": "oaccount",
            "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
            "userId": "admin",
            "orgId": "Org1MSP",
            "tokenType": "nonfungible",
            "noOfNfts": 1
        }    
    }
]

getAccountByUser

Diese Methode gibt Accountdetails für einen angegebenen Benutzer zurück. Diese Methode kann nur mit einer Token Admin des Chaincodes oder der Account Owner des Accounts aufgerufen werden.

@GetMethod()
@Validator(yup.string(), yup.string())
public async getAccountByUser(orgId: string, userId: string) {
    await this.Ctx.ERC721Auth.checkAuthorization('ERC721ACCOUNT.getAccountByUser', 'TOKEN', { orgId, userId });
    return await this.Ctx.ERC721Account.getAccountWithStatusByUser(orgId, userId);
}

Parameter:

orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Rückgabewert:

Bei Erfolg ein JSON-Accountobjekt, das die folgenden Eigenschaften enthält:
bapAccountVersion: Ein Accountobjektparameter für die interne Verwendung.
status: Der aktuelle Status des Benutzeraccounts.
accountId: Die ID des Benutzerkontos.
userId: Der Benutzername oder die E-Mail-ID des Benutzers.
orgId: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
tokenType: Der Tokentyp, den das Konto enthält.
noOfNfts: Die Gesamtanzahl der vom Konto gehaltenen NFTs.

Beispiel für Rückgabewert:

{
  "bapAccountVersion": 0,
  "assetType": "oaccount",
  "status": "active",
  "accountId": "oaccount~cc301bee057f14236a97d434909ec1084970921b008f6baab09c2a0f5f419a9a",
  "userId": "idcqa",
  "orgId": "appdev",
  "tokenType": "nonfungible",
  "noOfNfts": 0
}

getUserByAccountId

Diese Methode gibt die Benutzerdetails eines angegebenen Accounts zurück. Diese Methode kann von jedem Benutzer aufgerufen werden.

@GetMethod()
@Validator(yup.string())
public async getUserByAccountId(accountId: string) {
    return await this.Ctx.ERC721Account.getUserByAccountId(accountId);
}

Parameter:

accountId: string: Die ID des Kontos.

Rückgabewert:

Bei Erfolg ein JSON-Objekt der Benutzerdetails (orgId und userId).

Beispiel für Rückgabewert:

{
  "userId": "admin",
  "orgId": "Org1MSP"
}

getAccountHistory

Diese Methode gibt die Kontohistorie für einen angegebenen Benutzer zurück. Dies ist eine asynchrone Methode. Diese Methode kann nur von der Token Admin des Chaincodes oder vom Accounteigentümer aufgerufen werden.

@GetMethod()
@Validator(yup.string(), yup.string())
public async getAccountHistory(orgId: string, userId: string) {
    const accountId = await this.Ctx.ERC721Account.generateAccountId(orgId, userId);
    await this.Ctx.ERC721Auth.checkAuthorization('ERC721ACCOUNT.history', 'TOKEN', { accountId });
    return await this.Ctx.ERC721Account.history(accountId);
}

Parameter:

orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Rückgabewert:

Bei Erfolg ein JSON-Objekt der Kontohistorie. Der Parameter bapAccountVersion wird zur internen Verwendung im Accountobjekt definiert.

Beispiel für Rückgabewert:

[
    {
        "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
        }
    }
]

Methoden für die Rollenverwaltung

addRole

Diese Methode fügt einem angegebenen Benutzer eine Rolle hinzu. Diese Methode kann nur von einem Token Admin des Chaincodes aufgerufen werden.

@Validator(yup.string(), yup.string(), yup.string())
public async addRole(role: string, orgId: string, userId: string) {
   const accountId = await this.Ctx.ERC721Account.generateAccountId(orgId, userId);
   await this.Ctx.ERC721Auth.checkAuthorization('ERC721TOKEN.addRoleMember', 'TOKEN');
   return await this.Ctx.ERC721Token.addRoleMember(role, accountId);
}

Parameter:

role: string: Der Name der Rolle, die dem angegebenen Benutzer hinzugefügt werden soll. Das Verhalten von mintable und burnable entspricht den Eigenschaften minter_role_name und burner_role_name der Spezifikationsdatei.
orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Rückgabewert:

Bei Erfolg eine Nachricht mit Accountdetails.

Beispiel für Rückgabewert:

{"msg": "Successfully added role 'minter' to Account Id: oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d (Org-Id: Org1MSP, User-Id: admin)"}

removeRole

Mit dieser Methode wird eine Rolle aus einem angegebenen Benutzer entfernt. Diese Methode kann nur von einem Token Admin des Chaincodes aufgerufen werden.

@Validator(yup.string(), yup.string(), yup.string())
public async removeRole(role: string, orgId: string, userId: string) {
    const accountId = await this.Ctx.ERC721Account.generateAccountId(orgId, userId);
    await this.Ctx.ERC721Auth.checkAuthorization('ERC721TOKEN.removeRoleMember', 'TOKEN');
    return await this.Ctx.ERC721Token.removeRoleMember(role, accountId);
}

Parameter:

role: string: Der Name der Rolle, die aus dem angegebenen Benutzer entfernt werden soll. Das Verhalten von mintable und burnable entspricht den Eigenschaften minter_role_name und burner_role_name der Spezifikationsdatei.
orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Rückgabewert:

Bei Erfolg eine Nachricht mit Accountdetails.

Beispiel für Rückgabewert:

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

getAccountsByRole

Diese Methode gibt eine Liste aller Konto-IDs für eine angegebene Rolle zurück. Diese Methode kann nur von einem Token Admin des Chaincodes aufgerufen werden.

@GetMethod()
@Validator(yup.string())
public async getAccountsByRole(role: string) {
    await this.Ctx.ERC721Auth.checkAuthorization('ERC721ROLE.getAccountsByRole', 'TOKEN');
    return await this.Ctx.ERC721Role.getAccountsByRole(role);
}

Parameter:

role: string: Der Name der Rolle, nach der gesucht werden soll.

Rückgabewert:

Bei Erfolg ein JSON-Array mit Konto-IDs.

Beispiel für Rückgabewert:

{
    "accounts": [
        "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d"
    ]
}

getUsersByRole

Diese Methode gibt eine Liste aller Benutzer für eine angegebene Rolle zurück. Diese Methode kann nur von einem Token Admin des Chaincodes aufgerufen werden.

@GetMethod()
@Validator(yup.string())
public async getUsersByRole(role: string) {
    await this.Ctx.ERC721Auth.checkAuthorization('ERC721ROLE.getUsersByRole', 'TOKEN');
    return await this.Ctx.ERC721Role.getUsersByRole(role);
}

Parameter:

role: string: Der Name der Rolle, nach der gesucht werden soll.

Rückgabewert:

Bei Erfolg ein JSON-Array der Benutzerobjekte (orgId und userId).

Beispiel für Rückgabewert:

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

isInRole

Diese Methode gibt einen booleschen Wert zurück, um anzugeben, ob ein Benutzer eine bestimmte Rolle hat. Diese Methode kann nur mit einer Token Admin des Chaincodes oder der Account Owner des Accounts aufgerufen werden.

@GetMethod()
@Validator(yup.string(), yup.string(), yup.string())
public async isInRole(orgId: string, userId: string, role: string) {
    const accountId = await this.Ctx.ERC721Account.generateAccountId(orgId, userId);
    await this.Ctx.ERC721Auth.checkAuthorization('ERC721TOKEN.isInRole', 'TOKEN',{ accountId });
    return { result: await this.Ctx.ERC721Token.isInRole(role, accountId) };
}

Parameter:

orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
role: string: Der Name der Rolle, nach der gesucht werden soll.

Rückgabewert:

Bei Erfolg eine JSON-Zeichenfolge des booleschen Ergebnisses.

Beispiel für Rückgabewert:

{"result":"true"}

Methoden für Transaktionshistorienmanagement

getAccountTransactionHistory

Diese Methode gibt die Kontotransaktionshistorie für einen angegebenen Benutzer zurück. Dies ist eine asynchrone Methode. Diese Methode kann nur von der Token Admin des Chaincodes oder vom Accounteigentümer aufgerufen werden.

@GetMethod()
@Validator(yup.string(), yup.string())
public async getAccountTransactionHistory(orgId: string, userId: string) {
    const accountId = await this.Ctx.ERC721Account.generateAccountId(orgId, userId);
    await this.Ctx.ERC721Auth.checkAuthorization('ERC721ACCOUNT.getAccountTransactionHistory', 'TOKEN', { accountId });
    return await this.Ctx.ERC721Account.getAccountTransactionHistory(accountId)
}

Parameter:

orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Beispiel für Rückgabewert:

[
    {
        "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"
    }
]

getAccountTransactionHistoryWithFilters

Diese Methode gibt die Kontotransaktionshistorie für einen angegebenen Benutzer zurück, gefiltert nach PageSize, Bookmark, startTime und endTime. Dies ist eine asynchrone Methode. Diese Methode kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Oracle Blockchain Platform-Netzwerk besteht. Diese Methode kann nur von der Token Admin des Chaincodes oder vom Accounteigentümer aufgerufen werden.

@GetMethod()
@Validator(yup.string(), yup.string(), yup.object().nullable())
public async getAccountTransactionHistoryWithFilters(orgId: string, userId: string, filters ?: Filters) {
    const accountId = await this.Ctx.ERC721Account.generateAccountId(orgId, userId);
    await this.Ctx.ERC721Auth.checkAuthorization('ERC721ACCOUNT.getAccountTransactionHistoryWithFilters', 'TOKEN', { accountId });
    return await this.Ctx.ERC721Account.getAccountTransactionHistoryWithFilters(accountId, filters)
}

Parameter:

orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
filters: object: Ein Objekt der Filterklasse, das vier Attribute enthält: pageSize, bookmark, startTime und endTime.

Beispiel für Rückgabewert:

[
    {
        "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"
    }
]

getTransactionById

Diese Methode gibt die Transaktionshistorie für eine angegebene Transaktions-ID zurück. Dies ist eine asynchrone Methode. Diese Methode kann nur von einem Token Admin des Chaincodes oder vom Accounteigentümer aufgerufen werden.

@GetMethod()
@Validator(yup.string())
public async getTransactionById(transactionId: string) {
    return await this.Ctx.ERC721Transaction.getTransactionById(transactionId);
}

Parameter:

transactionId: string: Die ID der Transaktion. Dies ist das Präfix otransaction~ gefolgt vom 64-Bit-Hash im hexadezimalen Format.

Beispiel für Rückgabewert:

{
    "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",
            }
        }
    ]
}

deleteHistoricalTransactions

Mit dieser Methode werden Transaktionen gelöscht, die älter sind als ein angegebener Zeitstempel in der Statusdatenbank. Dies ist eine asynchrone Methode. Diese Methode kann nur von einem Token Admin des Chaincodes aufgerufen werden.

@Validator(yup.date())
public async deleteHistoricalTransactions(timeToExpiration: Date) {
    await this.Ctx.ERC721Auth.checkAuthorization('ERC721TRANSACTION.deleteTransactions', 'TOKEN');
    return await this.Ctx.ERC721Transaction.deleteTransactions(timeToExpiration);
}

Parameter:

timestamp: string: Ein Zeitstempel. Alle Transaktionen vor dem Zeitstempel werden gelöscht.

Beispiel für Rückgabewert:

{
    "msg": "Successfuly deleted transaction older than date: Thu Apr 07 2022 21:18:59 GMT+0000 (Coordinated Universal Time).",
    "transactions": [
        "otransaction~30513757d8b647fffaafac440d743635f5c1b2e41b25ebd6b70b5bbf78a2643f",
        "otransaction~ac0e908c735297941ba58bb208ee61ff4816a1e54c090d68024f82adf743892b"
    ]
}

Methoden für die Verwaltung des Tokenverhaltens - Mintable-Verhalten

create<Token Name>Token

Mit dieser Methode wird ein NFT erstellt (abgemeldet). Das Asset und die zugehörigen Eigenschaften werden in der Statusdatenbank gespeichert. Der Aufrufer dieser Transaktion muss ein Token-Konto haben. Der Aufrufer dieser Transaktion wird der Eigentümer der NFT. Wenn die Tokenspezifikationsdatei den Abschnitt roles für behaviors und die Eigenschaft minter_role_name für roles enthält, muss der Aufrufer der Transaktion die Rolle "Miner" aufweisen. Andernfalls kann jeder Anrufer NFTs prägen.

@Validator(< Token Class >)
public async create< Token Name >Token(tokenAsset: <Token Class>) {
    return await this.Ctx.ERC721Token.createToken(tokenAsset);
}

Parameter:

tokenAsset: <Token Class>: Das Tokenasset für Mint. Weitere Informationen zu den Eigenschaften des Tokenassets finden Sie in der Eingabespezifikationsdatei.

Rückgabewert:

Bei Erfolg ein JSON-Tokenassetobjekt, das die folgenden Eigenschaften enthält:
metadata: JSON-Informationen, die das Token beschreiben.
createdBy: Die Konto-ID des Benutzers, der die Transaktion aufgerufen hat, um das Token zu prägen.
creationDate: Der Zeitstempel der Transaktion.
isBurned: Ein boolescher Wert, der angibt, ob der mit tokenId identifizierte NFT gebrannt wird.
tokenName: Der Name des Tokens.
tokenDesc: Die Beschreibung des Tokens.
symbol: Das Symbol des Tokens.
tokenStandard: Der Standard des Tokens.
tokenType: Der von diesem Account gehaltene Tokentyp.
tokenUnit: Die Einheit des Tokens.
behaviors: Eine Beschreibung aller Tokenverhaltensweisen.
mintable – Eine Beschreibung der Eigenschaften des Verhaltens von mintable. Die Eigenschaft max_mint_quantity gibt die maximale Anzahl von NFTs dieser Tokenklasse an, die erstellt werden können.
owner: Die Account-ID des aktuellen Eigentümers des Tokens. Während des Prägevorgangs wird der Aufrufer dieser Methode zum Eigentümer des Tokens.
tokenUri: Die URI des Tokens.

Beispiel für Rückgabewert:

{
    "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
}

update<Token Name>Token

Diese Methode aktualisiert Tokeneigenschaften. Diese Methode kann nur vom Benutzer aufgerufen werden, der Eigentümer oder Ersteller des Tokens ist. Nachdem ein Tokenasset erstellt wurde, kann nur der Tokeneigentümer die benutzerdefinierten Tokeneigenschaften aktualisieren. Wenn der Benutzer sowohl Tokeneigentümer als auch Ersteller eines Tokens ist, kann er auch die Eigenschaft TokenDesc aktualisieren. Tokenmetadaten können nicht aktualisiert werden. Sie müssen alle Tokeneigenschaften an diese Methode übergeben, auch wenn Sie nur bestimmte Eigenschaften aktualisieren möchten.

@Validator(<Token Class>)
public async update<Token name>Token(tokenAsset: <Token Class>) {
    return await this.Ctx.ERC721Token.updateToken(tokenAsset);
}

Parameter:

tokenAsset: <Token Class>: Das zu aktualisierende Tokenasset. Weitere Informationen zu den Eigenschaften des Tokenassets finden Sie in der Eingabespezifikationsdatei.

Rückgabewert:

Bei Erfolg ein aktualisiertes JSON-Tokenassetobjekt

Beispiel für Rückgabewert:

{
    "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
}

Methoden für Token Behavior Management - Übertragbares Verhalten

safeTransferFrom

Dies ist eine asynchrone Funktion. Diese Methode überträgt die Verantwortung für die angegebene NFT vom Anrufer auf ein anderes Konto. Diese Methode umfasst die folgenden Validierungen:

Das Token existiert und wird nicht verbrannt.
Absenderkonto und Empfängerkonto sind vorhanden und nicht dasselbe Konto.
Das Absenderkonto ist Eigentümer des Tokens.
Der Aufrufer der Funktion ist der Absender.

@Validator(yup.string(), yup.string(), yup.string(), yup.string(), yup.string(), yup.string().max(2000))
public async safeTransferFrom(fromOrgId: string, fromUserId: string, toOrgId: string, toUserId: string, tokenId: string, data?: string) {
    const tokenAsset = await this.getTokenObject(tokenId);
    const fromAccountId = await this.Ctx.ERC721Account.generateAccountId(fromOrgId, fromUserId);
    const toAccountId = await this.Ctx.ERC721Account.generateAccountId(toOrgId, toUserId);
    return await this.Ctx.ERC721Token.safeTransferFrom(fromAccountId, toAccountId, tokenAsset, data);
}

Parameter:

fromOrgId: string: Die MSP-ID (Member Service Provider) des Absenders und Tokeneigentümers in der aktuellen Organisation.
fromUserId: string: Der Benutzername oder die E-Mail-ID des Absenders und Tokeneigentümers.
toOrgId: string: Die MSP-ID (Member Service Provider) des Empfängers in der aktuellen Organisation.
toUserId: string: Der Benutzername oder die E-Mail-ID des Empfängers.
tokenId: string: Die ID des zu übertragenden Tokens.
data: string: Optionale zusätzliche Informationen zum Speichern im Transaktionsdatensatz.

Rückgabewert:

Bei Erfolg eine Nachricht mit den Absender- und Empfängerkontodetails.

Beispiel für Rückgabewert:

{"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)"}

transferFrom

Dies ist eine asynchrone Funktion. Bei dieser Methode wird das Eigentum an der angegebenen NFT von einem Absenderkonto auf ein Empfängerkonto übertragen. Es liegt in der Verantwortung des Aufrufers, die richtigen Parameter zu übergeben. Diese Methode kann von jedem Benutzer aufgerufen werden, nicht nur vom Token-Eigentümer. Diese Methode umfasst die folgenden Validierungen:

Das Token existiert und wird nicht verbrannt.
Absenderkonto und Empfängerkonto sind vorhanden und nicht dasselbe Konto.
Das Absenderkonto ist Eigentümer des Tokens.

@Validator(yup.string(), yup.string(), yup.string(), yup.string(), yup.string())
public async transferFrom(fromOrgId: string, fromUserId: string, toOrgId: string, toUserId: string, tokenId: string) {
    const tokenAsset = await this.getTokenObject(tokenId);
    const fromAccountId = await this.Ctx.ERC721Account.generateAccountId(fromOrgId, fromUserId);
    const toAccountId = await this.Ctx.ERC721Account.generateAccountId(toOrgId, toUserId);
    return await this.Ctx.ERC721Token.transferFrom(fromAccountId, toAccountId, tokenAsset);
}

Parameter:

fromOrgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Absenders in der aktuellen Organisation.
fromUserId: string: Der Benutzername oder die E-Mail-ID des Absenders.
toOrgId: string: Die MSP-ID (Member Service Provider) des Empfängers in der aktuellen Organisation.
toUserId: string: Der Benutzername oder die E-Mail-ID des Empfängers.
tokenId: string: Die ID des zu übertragenden Tokens.

Rückgabewert:

Bei Erfolg eine Nachricht mit den Absender- und Empfängerkontodetails.

Beispiel für Rückgabewert:

{"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)"}

Methoden für Token Behavior Management - Burnable Behavior

burn

Mit dieser Methode wird die angegebene NFT aus dem Konto des Aufrufers deaktiviert oder gebrannt. Der Aufrufer dieser Methode muss ein Konto haben. Ein Token kann nur gebrannt werden, wenn die Tokenspezifikationsdatei das Verhalten burnable enthält. Wenn im Abschnitt roles der Spezifikationsdatei keine Eigenschaft burner_role_name angegeben ist, kann der Eigentümer des Tokens das Token brennen. Wenn eine Eigenschaft burner_role_name im Abschnitt roles angegeben ist, kann der Benutzer die Burner-Rolle zuweisen, die auch der Minter (Ersteller) oder Eigentümer des Tokens ist, das Token brennen.

@Validator(yup.string())
public async burn(tokenId: string) {
    const tokenAsset = await this.getTokenObject(tokenId);
    return await this.Ctx.ERC721Token.burn(tokenAsset);
}

Parameter:

tokenId: string: Die ID des zu brennenden Tokens.

Rückgabewert:

Bei Erfolg eine Meldung mit den Accountdetails.

Beispiel für Rückgabewert:

{"msg": "Successfully burned NFT token: 'monalisa1' from Account-Id: oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d (Org-Id: Org1MSP, User-Id: admin)"}

burnNFT

Mit dieser Methode wird die angegebene NFT aus dem Konto des Aufrufers deaktiviert oder gebrannt und ein Tokenobjekt und eine Tokenhistorie zurückgegeben. Der Aufrufer dieser Methode muss ein Konto haben. Ein Token kann nur gebrannt werden, wenn die Tokenspezifikationsdatei das Verhalten burnable enthält. Wenn im Abschnitt roles der Spezifikationsdatei keine Eigenschaft burner_role_name angegeben ist, kann der Eigentümer des Tokens das Token brennen. Wenn eine Eigenschaft burner_role_name im Abschnitt roles angegeben ist, kann der Benutzer die Burner-Rolle zuweisen, die auch der Minter (Ersteller) oder Eigentümer des Tokens ist, das Token brennen.

@Validator(yup.string())
public async burnNFT(tokenId: string) {
    const token = await this.Ctx.ERC721Token.get(tokenId)
    if (token.isBurned === true) {
      throw new Error(`token with tokenId ${tokenId} is already burned`);
    }
    const tokenHistory = await this.Ctx.ERC721Token.history(tokenId);
    await this.burn(tokenId);
    token.tokenId = parseInt(token.tokenId);
    if(Number.isNaN(token.tokenId)) {
      throw new Error(`tokenId is expected to be integer but found ${tokenId}`)
    }
    token.isBurned = true;
    return {...token, tokenHistory: JSON.stringify(tokenHistory)};
}

Parameter:

tokenId: string: Die ID des zu brennenden Tokens.

Rückgabewert:

Bei Erfolg ein Tokenobjekt, das Tokenhistorieninformationen enthält.

Beispiel für Rückgabewert:

{
    "assetType": "otoken",
    "tokenId": 1,
    "tokenName": "artcollection",
    "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
    },
    "createdBy": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
    "creationDate": "2023-08-22T07:36:50.000Z",
    "owner": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
    "isBurned": true,
    "tokenUri": "example.com",
    "price": 120,
    "on_sale_flag": false,
    "tokenHistory": "[{\"trxId\":\"732438a85b5e8fc76c5254e54602b29d583543b103fafb5a28c0df384428bb50\",\"timeStamp\":\"2023-08-22T07:36:50.000Z\",\"value\":{\"assetType\":\"otoken\",\"tokenId\":\"1\",\"tokenName\":\"artcollection\",\"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},\"createdBy\":\"oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d\",\"creationDate\":\"2023-08-22T07:36:50.000Z\",\"owner\":\"oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d\",\"isBurned\":false,\"tokenUri\":\"example.com\",\"price\":120,\"on_sale_flag\":false}}]"
}

Benutzerdefinierte Methoden

Mit den Token-SDK-Methoden können Sie benutzerdefinierte Methoden für Ihre Geschäftsanwendung schreiben.

Im folgenden Beispiel wird gezeigt, wie Sie Token-SDK-Methoden in benutzerdefinierten Methoden verwenden. Wenn die Methode sell aufgerufen wird, wird ein Token für einen angegebenen Preis zum Verkauf gebucht.

@Validator(yup.string(), yup.number())
public async sell(token_id: string, selling_price: number) {
    try { 
        const token = await this.Ctx.ERC721Token.get(token_id);
        const t = new ArtCollection(token)
 /**  * price is a custom asset
      attribute to set the price of a non-fungible token in the
      marketplace  */
        t.price =  selling_price;
 /**  * on_sale_flag is a
      custom asset attribute that maintains non-fungible token selling status in the
      marketplace  */
        t.on_sale_flag = true;
        await this.Ctx.ERC721Token.updateToken(t);
        let msg = `Token ID : '${token_id}' has been posted for selling in the marketplace'`;
        return {msg}
        } catch(error) {
            throw new Error(error.message);
    }
}

NFT SDK-Methoden

Methoden für die Zugriffskontrollverwaltung

Das NFT-SDK bietet eine Zugriffskontrollfunktion. Einige Methoden können nur mit einer Token Admin oder Account Owner des Tokens aufgerufen werden. Mit dieser Funktion können Sie sicherstellen, dass Vorgänge nur von den beabsichtigten Benutzern ausgeführt werden. Unbefugter Zugriff führt zu einem Fehler. Um die Zugriffskontrollfunktion zu verwenden, importieren Sie die Klasse Authorization aus dem Modul ../lib/erc721-auth.

import { ERC721Authorization } from '../lib/erc721-auth';

addAdmin

Diese Methode fügt einen Benutzer als Token Admin des Token-Chaincodes hinzu.

Ctx.ERC721Admin.addAdmin(orgId: string, userId: string)

Parameter:

orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Rückgabewert:

Bei Erfolg eine Nachricht, die Details für den als Token Admin des Token-Chaincodes hinzugefügten Benutzer auflistet. Bei Fehler ein Nicht-Nil-Fehlerobjekt, das eine Fehlermeldung enthält.

Beispiel:

await this.Ctx.ERC721Admin.addAdmin(orgId, userId)

{"msg": "Successfully added Admin (orgId: Org1MSP, userId: user1)"}

removeAdmin

Mit dieser Methode wird ein Benutzer als Token Admin des Token-Chaincodes entfernt.

Ctx.ERC721Admin.removeAdmin(orgId: string, userId: string)

Parameter:

orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Rückgabewert:

Bei Erfolg eine Nachricht, die Details für den als Token Admin des Token-Chaincodes entfernten Benutzer auflistet. Bei Fehler ein Nicht-Nil-Fehlerobjekt, das eine Fehlermeldung enthält.

Beispiel:

await this.Ctx.ERC721Admin.RemoveAdmin(orgId, userId)

{"msg": "Successfully removed Admin (orgId: Org1MSP, userId: user1)"}

isUserTokenAdmin

Diese Methode gibt den booleschen Wert true zurück, wenn der Aufrufer der Funktion ein Token Admin ist. Andernfalls gibt die Methode false zurück. Dies ist eine asynchrone statische Funktion.

Ctx.ERC721Auth.isUserTokenAdmin(orgId: string, userId: string)

Parameter:

orgId: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Netzwerkorganisation.
userId: Der Benutzername oder die E-Mail-ID des Benutzers.

Rückgabewert:

Eine boolesche Antwort und eine Fehlermeldung, wenn ein Fehler auftritt.

Beispiel:

await this.Ctx.Auth.isUserTokenAdmin('Org1MSP', 'user1');

{"result":false}

getAllAdmins

Diese Methode gibt eine Liste aller Token Admin-Benutzer zurück.

Ctx.ERC721Admin.getAllAdmins()

Parameter:

Kein

Rückgabewert:

Bei Erfolg eine Liste aller Token Admin-Benutzer. Bei Fehler ein Nicht-Nil-Fehlerobjekt, das eine Fehlermeldung enthält.

Beispiel:

await this.Ctx.ERC721Admin.getAllAdmins()

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

checkAuthorization

Mit dieser Methode können Sie einem Vorgang eine Zugriffskontrollprüfung hinzufügen. Dies ist eine asynchrone Funktion. Die meisten automatisch generierten Methoden umfassen die Zugriffskontrolle. Bestimmte Tokenmethoden können nur von ERC721Admin oder Account Owner des Tokens oder von MultipleAccountOwner für Benutzer mit mehreren Accounts ausgeführt werden. Die Methode checkAuthorization ist Teil der Klasse Authorization, auf die Sie über das Objekt Ctx zugreifen. Die Zuordnung der Zugriffskontrolle wird in der Datei ../lib/constant.ts beschrieben, wie im folgenden Text dargestellt. Sie können die Zugriffskontrolle ändern, indem Sie die Datei ../lib/constant.ts bearbeiten. Um Ihre eigene Zugriffskontrolle zu verwenden oder die Zugriffskontrolle zu deaktivieren, entfernen Sie den Zugriffskontrollcode aus den automatisch generierten Controller-Methoden und benutzerdefinierten Methoden.

export const TOKENACCESS = {
  ADMIN: {
    isUserTokenAdmin: ['Admin', 'MultipleAccountOwner'],
    addAdmin: ['Admin'],
    removeAdmin: ['Admin'],
    getAllAdmins: ['Admin'],
  },
  TOKEN: {
    save: ['Admin'],
    getAllTokens: ['Admin'],
    get: ['Admin'],
    update: ['Admin'],
    getDecimals: ['Admin'],
    getTokensByName: ['Admin'],
    addRoleMember: ['Admin'],
    removeRoleMember: ['Admin'],
    isInRole: ['Admin', 'AccountOwner'],
    getTotalMintedTokens: ['Admin'],
    getNetTokens: ['Admin'],
  },
  ROLE: {
    getAccountsByRole: ['Admin'],
    getUsersByRole: ['Admin'],
  },
  TRANSACTION: {
    deleteTransactions: ['Admin'],
  },
  ACCOUNT: {
    createAccount: ['Admin'],
    getAllAccounts: ['Admin'],
    getAccountsByUser: ['Admin', 'MultipleAccountOwner'],
    getAccount: ['Admin', 'AccountOwner'],
    history: ['Admin', 'AccountOwner'],
    getAccountTransactionHistory: ['Admin', 'AccountOwner'],
    getAccountBalance: ['Admin', 'AccountOwner'],
    getAccountOnHoldBalance: ['Admin', 'AccountOwner'],
    getOnHoldIds: ['Admin', 'AccountOwner'],
  },
  ERC721ADMIN: {
    isUserTokenAdmin: ['Admin'],
    addAdmin: ['Admin'],
    removeAdmin: ['Admin'],
    getAllAdmins: ['Admin'],
  }, 
  ERC721TOKEN: {
    getAllTokens: ['Admin'],
    getAllTokensByUser: ['Admin', 'AccountOwner'],
    get: ['Admin', TOKEN_OWNER],
    getTokensByName: ['Admin'],
    addRoleMember: ['Admin'],
    removeRoleMember: ['Admin'],
    isInRole: ['Admin', 'AccountOwner'],
    totalSupply: ['Admin'],
    totalNetSupply: ['Admin'],
    history: ['Admin'],
  },
  ERC721ROLE: {
    getAccountsByRole: ['Admin'],
    getUsersByRole: ['Admin'],
  },
  ERC721TRANSACTION: {
    deleteTransactions: ['Admin'],
  },
  ERC721ACCOUNT: {
    createAccount: ['Admin'],
    getAllAccounts: ['Admin'],
    getAccountsByUser: ['Admin', 'MultipleAccountOwner'],
    history: ['Admin', 'AccountOwner'],
    getAccountTransactionHistory: ['Admin', 'AccountOwner'],
    getAccountTransactionHistoryWithFilters: ['Admin', 'AccountOwner'],
    balanceOf: ['Admin', 'MultipleAccountOwner'],
  }
}

Ctx.ERC721Auth.checkAuthorization(classFuncName: string, ...args)

Parameter:

classFuncName: string: Der Zuordnungswert zwischen der Klasse und den Methoden, wie in der Datei ../lib/constant.ts beschrieben.
...args – Ein Variablenargument, bei dem args[0] die Konstante 'TOKEN' annimmt und args[1] den Parameter accountId verwendet, um eine Zugriffskontrollprüfung für ein AccountOwner hinzuzufügen. Um eine Zugriffskontrollprüfung für eine MultipleAccountOwner hinzuzufügen, verwendet args[1] den Parameter orgId, und args[2] den Parameter userId.

Rückgabewert:

Auf Erfolg, ein Versprechen. Bei Fehler eine Ablehnung mit einer Fehlermeldung.

Beispiele:

Admin-Zugriff

await this.Ctx.ERC721Auth.checkAuthorization('ADMIN.addAdmin', 'TOKEN');

AccountOwner-Zugriff

await this.Ctx.ERC721Auth.checkAuthorization('ACCOUNT.getAccountBalance', 'TOKEN', accountId);

MultipleAccountOwner-Zugriff

await this.Ctx.ERC721Auth.checkAuthorization('ADMIN.isUserTokenAdmin', 'TOKEN', orgId, userId);

Methoden für die Verwaltung der Tokenkonfiguration

Die Methoden zur Verwaltung der Tokenkonfiguration basieren auf dem ERC-721-Standard. Um die Methoden zur Verwaltung der Tokenkonfiguration zu verwenden, importieren Sie die Klasse Token aus dem Modul ../lib/erc721-token.

createToken

Diese Methode erstellt ein Token und speichert seine Eigenschaften in der Statusdatenbank. Diese Methode kann nur von Benutzern mit der Minter-Rolle aufgerufen werden. Dies ist eine asynchrone Funktion.

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

Parameter:

token: <Instance of Token Class>: Das zu erstellende Tokenasset.

Rückgabewert:

Bei Erfolg eine Zusagenachricht mit Tokendetails. Bei Fehler eine Ablehnung mit einer Fehlermeldung.

Beispiel:

await this.Ctx.ERC721Token.createToken(tokenAsset);

{
    "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
}

getAllTokens

Diese Methode gibt alle Tokenassets zurück, die in der Statusdatenbank gespeichert sind. Diese Methode verwendet SQL-reiche Berkeley DB-Abfragen und kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Oracle Blockchain Platform-Netzwerk besteht. Dies ist eine asynchrone statische Funktion.

Ctx.ERC721Token.getAllTokens()

Parameter:

Kein

Rückgabewert:

Bei Erfolg ein Versprechen mit allen Token Assets. Bei Fehler eine Ablehnung mit einer Fehlermeldung.

Beispiel:

await this.Ctx.ERC721Token.getAllTokens();

{
   "returnCode":"Success",
   "error":"",
   "result":{
      "txid":"98e0a0a115803d25b843d630e6b23c435a192a03eb0a301fc9375f05da49a8b2",
      "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"
   }
}

getAllTokensByUser

Diese Methode gibt alle Token zurück, deren Eigentümer eine angegebene Konto-ID ist. Dies ist eine asynchrone statische Funktion.

Ctx.ERC721Token.getAllTokensByUser(accountId: string)

Parameter:

accountId: string: Die ID des Kontos.

Rückgabewert:

Bei Erfolg fragt eine Zusagehistorie den Iterator für die angegebene Firma ab. Bei Fehler eine Ablehnung mit einer Fehlermeldung.

Beispiel für Rückgabewert:

{
   "returnCode":"Success",
   "error":"",
   "result":{
      "txid":"98e0a0a115803d25b843d630e6b23c435a192a03eb0a301fc9375f05da49a8b2",
      "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"
   }

getTokenUri

Diese Methode gibt die URI für ein angegebenes Token zurück. Dies ist eine asynchrone statische Funktion.

Ctx.ERC721Token.getTokenUri(tokenId: string)

Parameter:

tokenId: string: Die ID des Tokens.

Rückgabewert:

Bei Erfolg wird ein Abfrage-Iterator der Zusagehistorie für die angegebene Token-ID zurückgegeben. Bei Fehler lehnt es mit einer Fehlermeldung ab

Beispiel für Rückgabewert:

{"tokenUri": https://bafybeid6pmpp62bongoip5iy2skosvyxh3gr7r2e35x3ctvawjco6ddmsq\\ .ipfs.infura-ipfs.io/?filename=MonaLisa.jpeg"}

history

Diese Methode gibt die Historie für das angegebene Token zurück. Dies ist eine asynchrone statische Funktion.

Ctx.ERC721Token.history(tokenId: string)

Parameter:

tokenId: string: Die ID des Tokens.

Rückgabewert:

Bei Erfolg wird ein Iterator der Zusagehistorie für das angegebene Token abgefragt. Bei Fehler eine Ablehnung mit einer Fehlermeldung.

Beispiel für Rückgabewert:

[
   {
      "trxId":"e17a3154d5271be0492cbc7c12390b3480fec5a792d1cb1083e5335de56ebbd9",
      "timeStamp":1622614032,
      "isDelete":false,
      "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":"dbcc4da410ad4d4a80996f090b313240f3f3d08aa2b5086afa8d0921f7b4c1e5",
      "timeStamp":1622643853,
      "isDelete":false,
      "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
      }
   }
]

get

Diese Methode gibt das angegebene Tokenobjekt zurück, wenn es in der Statusdatenbank vorhanden ist. Dies ist eine asynchrone statische Funktion.

Ctx.ERC721Token.get(tokenId: string)

Parameter:

tokenId: string: Die ID des Tokens.

Rückgabewert:

Bei Erfolg eine Zusage, die ein JSON-Objekt des Tokenassets enthält. Bei Fehler: Ablehnung mit Fehlermeldung

Beispiel:

await this.Ctx.ERC721Token.get(tokenId);

{
    "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
}

ownerOf

Diese Methode gibt die Account-ID des Eigentümers eines angegebenen Tokens zurück. Dies ist eine asynchrone statische Funktion.

Ctx.ERC721Token.ownerOf(tokenId: string)

Parameter:

tokenId: string: Die ID des Tokens.

Rückgabewert:

Bei Erfolg wird ein Abfrage-Iterator der Zusagehistorie für die angegebene Token-ID zurückgegeben. Bei Fehler lehnt es mit einer Fehlermeldung ab

Beispiel für Rückgabewert:

{"owner": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d"}

symbol

Diese Methode gibt das Symbol der Tokenklasse zurück.

Ctx.ERC721Token.symbol()

Parameter:

Kein

Rückgabewert:

Bei Erfolg ein JSON-Objekt mit dem Tokensymbol.

Beispiel für Rückgabewert:

{"symbol": "PNT"}

tokenUri

Diese Methode gibt die URI für ein angegebenes Token zurück. Dies ist eine asynchrone statische Funktion.

Ctx.ERC721Token.tokenUri(tokenId: string)

Parameter:

tokenId: string: Die ID des Tokens.

Rückgabewert:

Bei Erfolg wird ein Abfrage-Iterator der Zusagehistorie für die angegebene Token-ID zurückgegeben. Bei Fehler lehnt es mit einer Fehlermeldung ab

Beispiel für Rückgabewert:

{"uri": "https://bafybeid6pmpp62bongoip5iy2skosvyxh3gr7r2e35x3ctvawjco6ddmsq https://bafybeid6pmpp62bongoip5iy2skosvyxh3gr7r2e35x3ctvawjco6ddmsq\\ .ipfs.infura-ipfs.io/?filename=MonaLisa.jpeg"}

totalSupply

Diese Methode gibt die Gesamtanzahl der ausgeprägten NFTs zurück. Dies ist eine asynchrone Funktion.

Ctx.ERC721Token.totalSupply()

Parameter:

Kein

Rückgabewert:

Bei Erfolg die Summe der Nettotoken im Datentyp "Zahl". Bei Fehler wird eine Fehlermeldung zurückgegeben.

Beispiel:

await this.Ctx.ERC721Token.totalSupply(tokenAsset);

updateToken

Diese Methode aktualisiert Tokeneigenschaften. Diese Methode kann nur vom Eigentümer oder Ersteller des Tokens aufgerufen werden. Nachdem ein Tokenasset erstellt wurde, kann nur der Tokeneigentümer die benutzerdefinierten Tokeneigenschaften aktualisieren. Wenn der Benutzer sowohl Tokeneigentümer als auch Ersteller eines Tokens ist, kann er auch die Eigenschaft TokenDesc aktualisieren. Tokenmetadaten können nicht aktualisiert werden. Sie müssen alle Tokeneigenschaften an diese Methode übergeben, auch wenn Sie nur bestimmte Eigenschaften aktualisieren möchten. Dies ist eine asynchrone Funktion.

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

Parameter:

token: <Instance of Token Class>: Das zu aktualisierende Tokenasset.

Rückgabewert:

Bei Erfolg eine Zusagenachricht mit Tokendetails. Bei Fehler eine Ablehnung mit einer Fehlermeldung.

Beispiel:

await this.Ctx.ERC721Token.updateToken(tokenAsset)

{
    "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
}

getByRange

Diese Methode ruft die getStateByRange-Methode der Struktur intern auf. Auch wenn ein Vermögensgegenstand mit der angegebenen ID vom Buch zurückgegeben wird, wirft diese Methode den Vermögensgegenstand in den aufrufenden Vermögensgegenstandstyp um. Dies ist eine asynchrone statische Funktion.

@validator(yup.string(), yup.string())
public async getDigiCurrGetByRange(startId: string, endId: string) {
   return await this.Ctx.ERC721TOken.getByRange(startId, endId, PaintingNft);
}

Ctx.ERC721Token.getByRange(startId: string, endId: string, tokenClassReference?: <Instance of Token Class> )

Parameter:

startId: string: Der Startschlüssel des Bereichs. Dieser Schlüssel ist im Bereich enthalten.
endId: string: Der Endschlüssel des Bereichs. Dieser Schlüssel ist aus dem Bereich ausgeschlossen.
tokenClassReference: <Instance of Token Class>: Das Tokenasset, das ausgeführt werden soll.

Rückgabewert:

Bei Erfolg ein Versprechen mit einem Array von <Token Class>. Bei Fehler eine Ablehnung mit einer Fehlermeldung.

Beispiel für Rückgabewert:

[
  {
      "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
   }
]

isTokenType

Diese Methode gibt an, ob ein Tokenasset mit der angegebenen ID vorhanden ist. Dies ist eine asynchrone statische Funktion.

Ctx.ERC721Token.isTokenType(tokenId: string)

Parameter:

tokenId: string: Die ID des Tokens.

Rückgabewert:

Bei Erfolg eine Zusage mit true, wenn ein Tokenasset mit der angegebenen ID vorhanden ist. Bei Fehler eine Ablehnung mit einer Fehlermeldung.

Beispiel:

await this.Ctx.ERC721Token.isTokenType(tokenId);

true

Methoden für die Kontenverwaltung

generateAccountId

Diese Methode gibt eine Account-ID zurück, die durch Verketten der Mitgliedsdienstanbieter-ID (orgId) und des Benutzernamens oder der E-Mail-ID (userId) gebildet wird und dann einen SHA-256-Hash erstellt.

Ctx.ERC721Account.generateAccountId(orgId: string, userId: string)

Parameter:

orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.

Rückgabewert:

Bei Erfolg eine Zusage mit der generierten Konto-ID. Bei Fehler eine Ablehnung mit einer Fehlermeldung.

Beispiel:

await this.Ctx.ERC721Account.generateAccountId(orgId, userId)

oaccount~a0a60d54ba9e2ff349737d292ea10ebd9cc8f1991c11443c19d20aea299a9507

createAccount

Ctx.ERC721Account.createAccount(orgId: string, userId: string, tokenType: string)

Parameter:

orgId: string: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
userId: string: Der Benutzername oder die E-Mail-ID des Benutzers.
tokenType: string: Der einzige unterstützte Tokentyp ist nonfungible.

Rückgabewert:

Bei Erfolg ein Versprechen mit dem neuen Accountobjekt. Bei Fehler: Ablehnung mit Fehlermeldung

Beispiel:

await this.Ctx.ERC721Account.CreateAccount(orgId, userId, tokenType)

{
    "assetType": "oaccount",
    "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
    "userId": "admin",
    "orgId": "Org1MSP",
    "tokenType": "nonfungible",
    "noOfNfts": 0
}

balanceOf

Diese Methode gibt die Gesamtanzahl der NFTs zurück, die der angegebene Benutzer hält.

Ctx.ERC721Account.balanceOf(accountId: string)

Parameter:

accountId: string: Die Konto-ID des Benutzers.

Rückgabewert:

Bei Erfolg ein JSON-Objekt der aktuellen NFT-Anzahl. Bei Fehler ein Nicht-Nil-Fehlerobjekt, das eine Fehlermeldung enthält.

Beispiel:

await this.Ctx.ERC721Account.balanceOf(accountId)

{"totalNfts": 0}

getAllAccounts

Diese Methode gibt eine Liste aller Konten zurück. Diese Methode verwendet SQL-reiche Berkeley DB-Abfragen und kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Oracle Blockchain Platform-Netzwerk besteht.

Ctx.ERC721Account.getAllAccounts()

Parameter:

Kein

Rückgabewert:

Bei Erfolg eine Zusage mit einem JSON-Objekt, das alle Konten auflistet. Bei Fehler eine Ablehnung mit einer Fehlermeldung.

Beispiel für Rückgabewert:

[
    {
        "key": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
        "valueJson": {
            "assetType": "oaccount",
            "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
            "userId": "admin",
            "orgId": "Org1MSP",
            "tokenType": "nonfungible",
            "noOfNfts": 1
        }   
    }
]

getAccountByUser

Diese Methode gibt Benutzerdetails für einen angegebenen Account zurück. Diese Methode kann nur mit einer Token Admin des Chaincodes oder der Account Owner des Accounts aufgerufen werden.

Ctx.ERC721Account.getAccountByUser(orgId, userId)

Parameter:

orgId: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
userId: Der Benutzername oder die E-Mail-ID des Benutzers.

Rückgabewert:

Bei Erfolg ein JSON-Accountobjekt, das die folgenden Eigenschaften enthält:
accountId: Die ID des Benutzerkontos.
userId: Der Benutzername oder die E-Mail-ID des Benutzers.
orgId: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
tokenType: Der Tokentyp, den das Konto enthält.
noOfNfts: Die Gesamtanzahl der vom Konto gehaltenen NFTs.
Bei Fehler ein Nicht-Nil-Objekt, das eine Fehlermeldung enthält.

Beispiel:

await this.Ctx.ERC721Account.getUserByAccountById(orgId, userId)

{
    "assetType": "oaccount",
    "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
    "userId": "admin",
    "orgId": "Org1MSP",
    "tokenType": "nonfungible",
    "noOfNfts": 0
}

getUserByAccountId

Diese Methode gibt die Benutzerdetails für einen angegebenen Account zurück.

Ctx.ERC721Account.getUserByAccountId(accountId: string)

Parameter:

accountId: string: Die ID des Kontos.

Rückgabewert:

Bei Erfolg ein JSON-Objekt, das Benutzerdetails in den folgenden Eigenschaften enthält:
- orgId: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Netzwerkorganisation.
- userId: Der Benutzername oder die E-Mail-ID des Benutzers.
Bei Fehler eine Ablehnung mit einer Fehlermeldung.

Beispiel:

await this.Ctx.ERC721Account.getUserByAccountById(accountId)

{
  "userId": "admin",
  "orgId": "Org1MSP"
}

history

Diese Methode gibt ein Array der Kontohistoriendetails für ein angegebenes Konto zurück.

Ctx.ERC721Account.history(accountId: string)

Parameter:

accountId: string: Die ID des Kontos.

Rückgabewert:

Bei Erfolg ein map[string]interface{}-Array, das die Details der Accounthistorie für den angegebenen Account enthält. Die Accountdaten werden unter dem Schlüssel value in der Karte angezeigt. Bei Fehler ein Nicht-Nil-Fehlerobjekt mit einer Fehlermeldung.

Beispiel:

await this.Ctx.ERC721Account.history(accountId)

[
    {
        "trxId": "6ffd0d94f234c12444a5d5aa559563b59dff4d2280b573fea956dc632bdaf5d4",
        "timeStamp": 1649151044,
        "value": {
            "assetType": "oaccount",
            "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
            "userId": "admin",
            "orgId": "Org1MSP",
            "tokenType": "nonfungible",
            "noOfNfts": 1
        }
    },
    {
        "trxId": "a605f1fa62e511c2945fce5437f983a5e70ec814b82520d3ecd2d81e3ecf53a3",
        "timeStamp": 1649151022,
        "value": {
            "assetType": "oaccount",
            "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
            "userId": "admin",
            "orgId": "Org1MSP",
            "tokenType": "nonfungible",
            "noOfNfts": 2
        }
    },
    {
        "trxId": "ca4c07bf04240345de918cbf1f4f3da4b4d0ab044c5b8bea94343e427d9ed4e7",
        "timeStamp": 1649150910,
        "value": {
            "assetType": "oaccount",
            "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
            "userId": "admin",
            "orgId": "Org1MSP",
            "tokenType": "nonfungible",
            "noOfNfts": 1
        }
    },
    {
        "trxId": "cfb52ffc8c34c7fd86210fcf8c5f53d9f92a056c45ed3a33671d638020c1f9cb",
        "timeStamp": 1649149545,
        "value": {
            "assetType": "oaccount",
            "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
            "userId": "admin",
            "orgId": "Org1MSP",
            "tokenType": "nonfungible",
            "noOfNfts": 0
        }
    },
    {
        "trxId": "e7747b3001a170f88688620956320e9402e1dd8edad8afb4818a08a34647337c",
        "timeStamp": 1649147442,
        "value": {
            "assetType": "oaccount",
            "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
            "userId": "admin",
            "orgId": "Org1MSP",
            "tokenType": "nonfungible",
            "noOfNfts": 1
        }
    },
    {
        "trxId": "d2d1f9c898707ae831e9361bc25da6369eac37b10c87dc04d18d6f3808222f08",
        "timeStamp": 1649137534,
        "value": {
            "assetType": "oaccount",
            "accountId": "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d",
            "userId": "admin",
            "orgId": "Org1MSP",
            "tokenType": "nonfungible",
            "noOfNfts": 0
        }
    }
]

getAccountWithStatusByUser

Diese Methode gibt Benutzerdetails für einen angegebenen Account zurück, einschließlich Accountstatus. Diese Methode kann nur mit einer Token Admin des Chaincodes oder der Account Owner des Accounts aufgerufen werden.

Ctx.ERC721Account.getAccountWithStatusByUser(orgId, userId)

Parameter:

orgId: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
userId: Der Benutzername oder die E-Mail-ID des Benutzers.

Rückgabewert:

Bei Erfolg ein JSON-Accountobjekt, das die folgenden Eigenschaften enthält:
accountId: Die ID des Benutzerkontos.
userId: Der Benutzername oder die E-Mail-ID des Benutzers.
orgId: Die Mitgliedsdienstanbieter-(MSP-)ID des Benutzers in der aktuellen Organisation.
tokenType: Der Tokentyp, den das Konto enthält.
noOfNfts: Die Gesamtanzahl der vom Konto gehaltenen NFTs.
bapAccountVersion: Ein Accountobjektparameter für die interne Verwendung.
status: Der aktuelle Status des Benutzeraccounts.
Bei Fehler ein Nicht-Nil-Objekt, das eine Fehlermeldung enthält.

Beispiel:

await this.Ctx.ERC721Account.getAccountWithStatusByUser(orgId, userId)

{
  "bapAccountVersion": 0,
  "assetType": "oaccount",
  "status": "active",
  "accountId": "oaccount~cc301bee057f14236a97d434909ec1084970921b008f6baab09c2a0f5f419a9a",
  "userId": "idcqa",
  "orgId": "appdev",
  "tokenType": "nonfungible",
  "noOfNfts": 0
}

Methoden für die Rollenverwaltung

addRoleMember

Diese Methode fügt einem angegebenen Benutzer und Token eine Rolle hinzu. Eine Account-ID wird gebildet, indem ein SHA-256-Hash der verketteten Serviceprovider-ID der Mitgliedschaft (orgId) und des Benutzernamens oder der E-Mail-ID (userId) erstellt wird. Dies ist eine asynchrone Funktion.

Ctx.ERC721Token.addRoleMember(role: string, accountId: string)

Parameter:

role: string: Der Name der Rolle, die dem angegebenen Benutzer hinzugefügt werden soll. Das Verhalten von mintable und burnable entspricht den Eigenschaften minter_role_name und burner_role_name der Spezifikationsdatei.
accountId: string: Die Konto-ID, die bearbeitet werden soll.

Rückgabewert:

Bei Erfolg eine Zusage mit einer Nachricht, die die hinzugefügte Rolle und Konto-ID enthält. Bei Fehler: Ablehnung mit Fehlermeldung

Beispiel:

await this.Ctx.ERC721Token.addRoleMember(role, accountId);

{"msg": "Successfully added role 'minter' to Account Id: oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d (Org-Id: Org1MSP, User-Id: admin)"}

removeRoleMember

Mit dieser Methode wird eine Rolle aus einem angegebenen Benutzer und Token entfernt. Eine Account-ID wird gebildet, indem ein SHA-256-Hash der verketteten Serviceprovider-ID der Mitgliedschaft (orgId) und des Benutzernamens oder der E-Mail-ID (userId) erstellt wird. Dies ist eine asynchrone Funktion.

Ctx.ERC721Token.removeRoleMember(role: string, accountId: string)

Parameter:

role: string: Der Name der Rolle, die aus dem angegebenen Benutzer entfernt werden soll. Das Verhalten von mintable und burnable entspricht den Eigenschaften minter_role_name und burner_role_name der Spezifikationsdatei.
accountId: string: Die Konto-ID, die bearbeitet werden soll.

Rückgabewert:

Bei Erfolg eine Zusage mit einer Nachricht, die die entfernte Rolle und die Konto-ID enthält. Bei Fehler: Ablehnung mit Fehlermeldung

Beispiel:

await this.Ctx.ERC721Token.removeRoleMember(role, accountId);

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

getAccountsByRole

Diese Methode gibt eine Liste aller Konto-IDs für eine angegebene Rolle zurück.

Ctx.ERC721Role.getAccountsByRole(roleName: string)

Parameter:

roleName: string: Der Name der Rolle, nach der gesucht werden soll.

Rückgabewert:

Bei Erfolg ein JSON-Array mit Konto-IDs. Bei Fehler ein Nicht-Nil-Fehlerobjekt, das eine Fehlermeldung enthält.

Beispiel:

await this.Ctx.ERC721Role.getAccountsByRole(userRole)

{
    "accounts": [
        "oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d"
    ]
}

getUsersByRole

Diese Methode gibt eine Liste aller Benutzer für eine angegebene Rolle zurück.

Ctx.ERC721Role.getUsersByRole(userRole: string)

Parameter:

role: string: Der Name der Rolle, nach der gesucht werden soll.

Rückgabewert:

Bei Erfolg ein JSON-Array von Benutzerobjekten. Jedes Objekt enthält die Benutzer-ID und Organisations-ID. Bei Fehler ein Nicht-Nil-Fehlerobjekt, das eine Fehlermeldung enthält.

Beispiel:

await this.Ctx.ERC721Role.getUsersByRole(userRole)

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

isInRole

Diese Methode gibt einen booleschen Wert zurück, um anzugeben, ob ein Benutzer und ein Token eine bestimmte Rolle haben. Eine Account-ID wird gebildet, indem ein SHA-256-Hash der verketteten Serviceprovider-ID der Mitgliedschaft (orgId) und des Benutzernamens oder der E-Mail-ID (userId) erstellt wird. Dies ist eine asynchrone Funktion.

Ctx.ERC721Token.isInRole(role: string, accountId: string)

Parameter:

role: string: Der Name der Rolle, die auf den angegebenen Benutzer geprüft werden soll. Das Verhalten von mintable und burnable entspricht den Eigenschaften minter_role_name und burner_role_name der Spezifikationsdatei.
accountId: string: Die Konto-ID, die bearbeitet werden soll.

Rückgabewert:

Bei Erfolg eine Zusage, die wahr ist, wenn die Rolle für die angegebene Konto-ID vorhanden ist, andernfalls falsch. Bei Fehler: Ablehnung mit Fehlermeldung

Beispiel:

await this.Ctx.ERC721Token.isInRole(role, accountId, tokenAsset)

{"result": "true"}

Methoden für Transaktionshistorienmanagement

getAccountTransactionHistory

Diese Methode gibt ein Array der Transaktionshistoriendetails für ein angegebenes Konto zurück.

Ctx.ERC721Account.getAccountTransactionHistory(accountId: string)

Parameter:

accountId: string: Die ID des Kontos.

Rückgabewert:

Bei Erfolg ein Array von Kontotransaktionsobjekten im JSON-Format:
- transactionId: Die ID der Transaktion.
- transactedAccount: Das Konto, mit dem die Transaktion stattgefunden hat.
- transactionType: Der Typ der Transaktion.
- timestamp: Der Zeitpunkt der Transaktion.
- noOfNfts: Der Saldo des Anruferkontos.
- Bei Fehler ein Nicht-Nil-Fehlerobjekt, das eine Fehlermeldung enthält.

Beispiel:

await this.Ctx.ERC721Account.GetAccountTransactionHistory(accountId)

[
    {
        "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"
    }
]

getAccountTransactionHistoryWithFilters

Diese Methode gibt die Kontotransaktionshistorie für einen angegebenen Benutzer zurück, gefiltert nach PageSize, Bookmark, startTime und endTime. Diese Methode kann nur aufgerufen werden, wenn eine Verbindung zum Remote-Oracle Blockchain Platform-Netzwerk besteht.

async getAccountTransactionHistoryWithFilters(orgId: string, userId: string, filters?: Filters)

Parameter:

accountId: string: Die ID des Kontos.
filters: object: Ein Objekt der Filterklasse, das vier Attribute enthält: pageSize, bookmark, startTime und endTime. Wenn leer, werden alle Datensätze zurückgegeben. Die Eigenschaft PageSize bestimmt die Anzahl der zurückzugebenden Datensätze. Wenn PageSize 0 ist, ist die Standardseitengröße 20. Die Eigenschaft Bookmark bestimmt den Startindex der zurückzugebenden Datensätze. Weitere Informationen finden Sie in der Dokumentation zu Hyperledger Fabric. Die Eigenschaften StartTime und EndTime müssen im RFC-3339-Format angegeben werden.

Rückgabewert:

Bei Erfolg ein Array von Kontotransaktionsobjekten im JSON-Format:
- transactionId: Die ID der Transaktion.
- transactedAccount: Das Konto, mit dem die Transaktion stattgefunden hat.
- transactionType: Der Typ der Transaktion.
- timestamp: Der Zeitpunkt der Transaktion.
- noOfNfts: Der Saldo des Anruferkontos.
- Bei Fehler ein Nicht-Nil-Fehlerobjekt, das eine Fehlermeldung enthält.

Beispiel:

await this.Ctx.ERC721Account.getAccountTransactionHistoryWithFilters(accountId, filters)

[
    {
        "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"
    }
]

getTransactionById

Diese Methode gibt die Historie eines Transaction-Assets zurück.

Ctx.ERC721Transaction.getTransactionById(transactionId: string)

Parameter:

transactionId: string: Die ID des Transaktionsassets.

Beispiel:

await this.Ctx.ERC721Transaction.getTransactionById(transactionId)

{
    "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",
            }
        }
    ]
}

deleteHistoricalTransactions

Diese Methode löscht Transaktionen, die älter als ein angegebenes Datum sind, aus der Statusdatenbank.

Ctx.ERC721Transaction.deleteTransactions(timeToExpiration: Date)

Parameter:

timeToExpiration: Date: Datum und Uhrzeit. Transaktionen, die älter als die angegebene Zeit sind, werden gelöscht.

Beispiel:

await this.Ctx.ERC721Transaction.deleteTransactions(timeToExpiration)

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "62ad6753cf2bfa54816b4c2f0ea325478b1cb1b84f8e13e6742c00f277310081",
        "payload": {
            "msg": "Successfuly deleted transaction older than date: Fri Apr 08 2022 00:00:00 GMT+0000 (Coordinated Universal Time).",
            "transactions": [
                "otransaction~e687531b71d943da2fb129638784fb93a96e7698013dfc51c8c6bf4f5f797059",
                "otransaction~18446adf59b669e12990a1cf3ea0a7a15764f967fa694cf263aee0cd5a21d952",
                "otransaction~5560d4b5e0b0d0b9a6e97dcd7f81241a5daf56497a7b6819c6a55cebacc106f2",
                "otransaction~f0a0a64ec1a0c92ac732706dd75ffbd3feecd9c48fc79e42c551485edf0542cb"
            ]
        },
        "encode": "JSON"
    }
}

Tokenverhaltensverwaltung - Mintable-Verhalten

getMaxMintQuantity

Diese Methode gibt die maximale mintable-Menge eines Tokens zurück. Wenn das Verhalten max_mint_quantity nicht in der Spezifikationsdatei konfiguriert ist, ist der Standardwert 0, und eine unbegrenzte Anzahl von Token kann geprägt werden.

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

Parameter:

token: <Instance of Token Class>: Das Tokenasset, das ausgeführt werden soll.

Rückgabewert:

Bei Erfolg die maximale mintable-Menge des Tokens im Zahlendatentyp. Bei Fehler wird eine Fehlermeldung zurückgegeben.

Beispiel:

await this.Ctx.ERC721Token.getMaxMintQuantity(tokenAsset);

getTotalMintedTokens

Diese Methode gibt die Gesamtanzahl der ausgeprägten Token zurück, die für das angegebene Token im System verfügbar sind. Die Nettoanzahl der verfügbaren Token ist die Gesamtanzahl der abgebauten Token minus der Anzahl der verbrannten Token. Dies ist eine asynchrone Funktion.

Ctx.ERC721Token.getTotalMintedTokens()

Parameter:

token: <Instance of Token Class>: Das Tokenasset, das ausgeführt werden soll.

Rückgabewert:

Bei Erfolg die Gesamtanzahl der abgebildeten Token im Datentyp "Anzahl". Bei Fehler wird eine Fehlermeldung zurückgegeben.

Beispiel:

await this.Ctx.ERC721Token.getTotalMintedTokens(tokenAsset);

Tokenverhaltensverwaltung - Übertragbares Verhalten

safeTransferFrom

Dies ist eine asynchrone Funktion. Diese Methode überträgt die Verantwortung für die angegebene NFT vom Anrufer auf ein anderes Konto. Diese Methode umfasst die folgenden Validierungen:

Das Token existiert und wird nicht verbrannt.
Absenderkonto und Empfängerkonto sind vorhanden und nicht dasselbe Konto.
Das Absenderkonto ist Eigentümer des Tokens.
Der Aufrufer der Funktion ist der Absender.

Ctx.ERC721Token.safeTransferFrom(fromAccountId: string, toAccountId: string, token: <Instance of Token Class>, data?: string)

Parameter:

fromAccountId: string: Die Konto-ID des Absenders in der aktuellen Organisation.
toAccountId: string: Die Konto-ID des Empfängers in der aktuellen Organisation.
token: <Instance of Token Class>: Das zu transferierende Tokenasset.
data: string: Optionale zusätzliche Informationen zum Speichern in der Transaktion.

Rückgabewert:

Bei Erfolg ein Versprechen mit einer Erfolgsmeldung, die Accountdetails enthält. Account-IDs haben das Präfix oaccount~. Bei Fehler eine Ablehnung mit einer Fehlermeldung.

Beispiel:

await this.Ctx.ERC721Token.safeTransferFrom(fromAccountId, toAccountId, tokenAsset, data);

{"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)"}

transferFrom

Das Token existiert und wird nicht verbrannt.
Absenderkonto und Empfängerkonto sind vorhanden und nicht dasselbe Konto.
Das Absenderkonto ist Eigentümer des Tokens.

Ctx.ERC721Token.transferFrom(fromAccountId: string, toAccountId: string, token: <Instance of Token Class>)

Parameter:

fromAccountId: string: Die Konto-ID des Absenders in der aktuellen Organisation.
toAccountId: string: Die Konto-ID des Empfängers in der aktuellen Organisation.
token: <Instance of Token Class>: Das zu transferierende Tokenasset.

Rückgabewert:

Bei Erfolg ein Versprechen mit einer Erfolgsmeldung, die Accountdetails enthält. Account-IDs haben das Präfix oaccount~. Bei Fehler eine Ablehnung mit einer Fehlermeldung.

\Beispiel:

await this.Ctx.ERC721Token.transferFrom(fromAccountId, toAccountId, tokeAsset, data);

{"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)"}

Tokenverhaltensmanagement - Burnable Behavior

burn

Mit dieser Methode wird die angegebene NFT aus dem Konto des Aufrufers deaktiviert oder gebrannt. Der Aufrufer dieser Methode muss ein Konto haben. Ein Token kann nur gebrannt werden, wenn die Tokenspezifikationsdatei das Verhalten burnable enthält. Wenn im Abschnitt roles der Spezifikationsdatei keine Eigenschaft burner_role_name angegeben ist, kann der Eigentümer des Tokens das Token brennen. Wenn im Abschnitt roles eine Eigenschaft burner_role_name angegeben ist, kann der Benutzer die Burner-Rolle, die auch der Minter (Ersteller) des Tokens ist, brennen. Dies ist eine asynchrone Funktion.

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

Parameter:

token: <Instance of Token Class>: Das zu brennende Tokenasset.

Rückgabewert:

Bei Erfolg ein Versprechen mit einer Erfolgsmeldung, die Accountdetails enthält. Bei Fehler eine Ablehnung mit einer Fehlermeldung.

Beispiel:

await this.Ctx.ERC721Token.burn(tokenAsset);

{msg": "Successfully burned NFT token: 'monalisa1' from Account-Id: oaccount~42e89f4c72dfde9502814876423c6da630d466e87436dd1aae201d347ad1288d (Org-Id: Org1MSP, User-Id: admin)"}