Andaime TypeScript Projeto NFT para ERC-721
O Blockchain App Builder pega a entrada do seu arquivo de especificação NFT e gera um projeto de chaincode totalmente funcional.
O projeto gera automaticamente classes e funções de ciclo de vida NFT, incluindo métodos CRUD e não CRUD, bem como um SDK de tokenização. Validação de argumentos, marshalling/unmarshalling e capacidade de persistência transparente são suportados automaticamente.
Para obter informações sobre o projeto e os métodos do andaime que não estão diretamente relacionados aos NFTs, consulte Projeto Chaincode TypeScript do andaime.
Modelo
Cada classe de modelo tokenizada estende a classe OchainModel
. O Recurso de Persistência Transparente, ou ORM simplificado, é capturado na classe OchainModel
.
import * as yup from 'yup';
import { Id, Mandatory, Validate, Default, Embedded, Derived, ReadOnly } from '../../lib/decorators';
import { OchainModel } from '../../lib/ochain-model';
import { STRATEGY } from '../../lib/utils';
import { EmbeddedModel } from '../../lib/ochain-embedded-model';
export class ArtCollectionMetadata extends EmbeddedModel<ArtCollectionMetadata> {
@Validate(yup.string())
public painting_name: string;
@Validate(yup.string())
public description: string;
@Validate(yup.string())
public image: string;
@Validate(yup.string())
public painter_name: string;
}
@Id('tokenId')
export class ArtCollection extends OchainModel<ArtCollection> {
public readonly assetType = 'otoken';
@Mandatory()
@Validate(yup.string().required().matches(/^[A-Za-z0-9][A-Za-z0-9_-]*$/).max(16))
public tokenId: string;
@ReadOnly('artcollection')
public tokenName: string;
@Validate(yup.string().trim().max(256))
public tokenDesc: string;
@ReadOnly('ART')
public symbol: string;
@ReadOnly('erc721+')
public tokenStandard: string;
@ReadOnly('nonfungible')
public tokenType: string;
@ReadOnly('whole')
public tokenUnit: string;
@ReadOnly(["indivisible","singleton","mintable","transferable","burnable","roles"])
public behaviors: string[];
@ReadOnly({minter_role_name: "minter"})
public roles: object;
@ReadOnly({max_mint_quantity: 20000})
public mintable: object;
@Validate(yup.string())
public owner: string;
@Validate(yup.string())
public createdBy: string;
@Validate(yup.string())
public transferredBy: string;
@Validate(yup.string())
public creationDate: string;
@Validate(yup.string())
public transferredDate: string;
@Validate(yup.bool())
public isBurned: boolean;
@Validate(yup.string())
public burnedBy: string;
@Validate(yup.string())
public burnedDate: string;
@Validate(yup.string().max(2000))
public tokenUri: string;
@Embedded(ArtCollectionMetadata)
public metadata: ArtCollectionMetadata;
@Validate(yup.number())
public price: number;
@Validate(yup.boolean())
public on_sale_flag: boolean;
}
Controlador
A classe de controlador principal estende a classe OchainController
. Há apenas um controlador principal.
export class DigiCurrCCController extends OchainController{
Você pode criar qualquer número de classes, funções ou arquivos, mas apenas os métodos que são definidos dentro da classe de controlador principal são invocáveis. Os outros métodos estão ocultos.
Você pode usar os métodos SDK de token para criar métodos personalizados para seu aplicativo de negócios.
Métodos NFT Gerados Automaticamente
O Blockchain App Builder gera automaticamente métodos para suportar ciclos de vida de NFTs e NFTs. Você pode usar esses métodos para inicializar NFTs, gerenciar funções e contas e concluir outras tarefas do ciclo de vida de NFT sem qualquer codificação adicional. Os métodos da Controladora devem ter um decorador @Validator(...params)
para serem invocáveis.
- Gerenciamento de Controle de Acesso
- Gerenciamento de Configuração de Token
- Gerenciamento de Contas
- Gerenciamento de Atribuições
- Gerenciamento do Histórico de Transações
- Gerenciamento de Comportamento de Token
Métodos para Gerenciamento de Controle de Acesso
-
addTokenAdmin
- Este método adiciona um usuário como um
Token Admin
do chaincode. Este método pode ser chamado somente por umToken Admin
do chaincode. -
removeTokenAdmin
- Este método remove um usuário como um
Token Admin
do chaincode. Este método pode ser chamado somente por umToken Admin
do chaincode. -
isTokenAdmin
- Esse método retornará o valor booliano
true
se o chamador da função forToken Admin
; caso contrário, ele retornaráfalse
. UmToken Admin
pode chamar essa função em qualquer outro usuário na rede blockchain. Outros usuários só podem chamar esse método em suas próprias contas. -
getAllTokenAdmins
- Esse método retorna uma lista de todos os usuários que são um
Token Admin
do chaincode. Este método pode ser chamado somente peloToken Admin
do chaincode.
Métodos para Gerenciamento de Configuração de Token
-
init
- Esse método é chamado quando o chaincode é instanciado. Cada
Token Admin
é identificado pelas informaçõesuserId
eorgId
no parâmetroadminList
. OuserId
é o nome do usuário ou o ID do e-mail do proprietário da instância ou do usuário que está conectado à instância. OorgId
é o ID do provedor de serviços de associação (MSP) do usuário na organização de rede atual. O parâmetroadminList
é obrigatório na primeira vez que você implanta o chaincode. Se você estiver atualizando o chaincode, passe uma lista vazia ([]
). Qualquer outra informação no parâmetroadminList
é ignorada durante os upgrades. -
getAllTokens
- Esse método retorna todos os ativos de token salvos no banco de dados de estado. Este método pode ser chamado somente por um
Token Admin
do chaincode. Esse método usa consultas ricas em SQL de BD Berkeley e só pode ser chamado quando conectado à rede remota do Oracle Blockchain Platform. -
getAllTokensByUser
- Esse método retorna todos os ativos de token pertencentes a um usuário especificado. Esse método usa consultas ricas em SQL de BD Berkeley e só pode ser chamado quando conectado à rede remota do Oracle Blockchain Platform. Esse método só pode ser chamado por um
Token Admin
do chaincode ou pelo proprietário da conta. -
getTokenById
- Esse método retornará um objeto de token se o token estiver presente no banco de dados de estado. Esse método só pode ser chamado por um
Token Admin
do chaincode ou do proprietário do token. -
getTokenHistory
- Este método retorna o histórico de um ID de token especificado. Este é um método assíncrono. Esse método só pode ser chamado quando conectado à rede remota do Oracle Blockchain Platform. Qualquer um pode chamar esse método.
-
getTokenObject
- Este é um método de utilitário que retorna uma instância do token para um ID de token especificado. Esse método é usado por muitos dos métodos gerados automaticamente para extrair objetos de token. Você pode chamar esse método conforme necessário nos métodos personalizados. Quando você criar um ativo ou uma classe tokenizada, atualize o caso de alternância com a classe
Token
correspondente para retornar o objeto de token correto. O comandoochain sync
no Blockchain App Builder cria automaticamente um caso de alternância quando um ativo tokenizado é criado no arquivo de especificação. Este método não tem decorador de método@Validator()
, o que significa que este método não é diretamente invocável e só pode ser chamado de outros métodos. -
ownerOf
- Este método retorna o ID da conta do proprietário do ID do token especificado. Qualquer um pode chamar esse método.
-
name
- Esse método retorna o nome da classe do token. Qualquer um pode chamar esse método.
-
symbol
- Esse método retorna o símbolo da classe do token. Qualquer um pode chamar esse método.
-
tokenURI
- Esse método retorna o URI de um token especificado. Qualquer um pode chamar esse método.
-
totalSupply
- Este método retorna o número total de tokens cunhados. Este método pode ser chamado somente por um
Token Admin
do chaincode. -
totalNetSupply
- Este método retorna o número total de tokens cunhados menos o número de tokens gravados. Este método pode ser chamado somente por um
Token Admin
do chaincode.
Métodos para Gerenciamento de Contas
-
createAccount
- Esse método cria uma conta para um usuário e token especificados. Uma conta deve ser criada para qualquer usuário que terá tokens a qualquer momento. As contas rastreiam o número de NFTs que um usuário tem. Os usuários devem ter contas na rede para concluir operações relacionadas a token. Você pode criar apenas uma conta NFT por usuário.
Um ID de conta é um conjunto alfanumérico de caracteres, prefixado com
oaccount~
e seguido por um hash SHA-256 do ID do provedor de serviços de associação (orgId
) do usuário na organização de rede atual, o nome de usuário ou o ID de e-mail (userId
) do proprietário da instância ou do usuário que está conectado à instância e a string constantenft
. Este método pode ser chamado somente peloToken Admin
do chaincode. -
balanceOf
- Este método retorna o número total de NFTs que um usuário especificado mantém. Esse método só pode ser chamado por um
Token Admin
do chaincode ou pelo proprietário da conta. -
getAllAccounts
- Esse método retorna uma lista de todas as contas. Este método pode ser chamado somente por um
Token Admin
do chaincode. Esse método usa consultas ricas em SQL de BD Berkeley e só pode ser chamado quando conectado à rede remota do Oracle Blockchain Platform. -
getAccountByUser
- Este método retorna detalhes da conta de um usuário especificado. Esse método só pode ser chamado por um
Token Admin
do chaincode ou peloAccount Owner
da conta. -
getUserByAccountId
- Este método retorna os detalhes do usuário de uma conta especificada. Esse método pode ser chamado por qualquer usuário.
-
getAccountHistory
- Este método retorna o histórico da conta de um usuário especificado. Este é um método assíncrono. Esse método só pode ser chamado pelo
Token Admin
do chaincode ou pelo proprietário da conta.
Métodos para Gerenciamento de Atribuições
-
addRole
- Este método adiciona uma atribuição a um usuário especificado. Este método pode ser chamado somente por um
Token Admin
do chaincode. -
removeRole
- Este método remove uma atribuição de um usuário especificado. Este método pode ser chamado somente por um
Token Admin
do chaincode. -
getAccountsByRole
- Esse método retorna uma lista de todos os IDs de contas para uma função especificada. Este método pode ser chamado somente por um
Token Admin
do chaincode. -
getUsersByRole
- Esse método retorna uma lista de todos os usuários de uma atribuição especificada. Este método pode ser chamado somente por um
Token Admin
do chaincode. -
isInRole
- Esse método retorna um valor Booliano para indicar se um usuário tem uma atribuição especificada. Esse método só pode ser chamado por um
Token Admin
do chaincode ou peloAccount Owner
da conta.
Métodos para Gerenciamento do Histórico de Transações
-
getAccountTransactionHistory
- Este método retorna o histórico de transações da conta para um usuário especificado. Este é um método assíncrono. Esse método só pode ser chamado pelo
Token Admin
do chaincode ou pelo proprietário da conta. -
getAccountTransactionHistoryWithFilters
- Esse método retorna o histórico de transações da conta de um usuário especificado, filtrado por
PageSize
,Bookmark
,startTime
eendTime
. Este é um método assíncrono. Esse método só pode ser chamado quando conectado à rede remota do Oracle Blockchain Platform. Esse método só pode ser chamado peloToken Admin
do chaincode ou pelo proprietário da conta. -
getTransactionById
- Este método retorna o histórico de transações de um ID de transação especificado. Este é um método assíncrono. Esse método só pode ser chamado por um
Token Admin
do chaincode ou pelo proprietário da conta. -
deleteHistoricalTransactions
- Este método exclui transações anteriores a um timestamp especificado no banco de dados de estado. Este é um método assíncrono. Este método pode ser chamado somente por um
Token Admin
do chaincode.
Métodos para Gerenciamento do Comportamento de Token - Comportamento Mínimo
-
create<Token Name>Token
- Este método cria (mints) um NFT. O ativo e as propriedades associadas são salvos no banco de dados de estado. O chamador desta transação deve ter uma conta de token. O chamador desta transação se torna o proprietário do NFT. Se o arquivo de especificação de token incluir a seção
roles
parabehaviors
e a propriedademinter_role_name
pararoles
, o chamador da transação deverá ter a atribuição de minter. Caso contrário, qualquer chamador pode cunhar NFTs. -
update<Token Name>Token
- Este método atualiza as propriedades do token. Esse método só pode ser chamado pelo usuário que é o proprietário ou criador do token. Após a criação de um ativo de token, somente o proprietário do token poderá atualizar as propriedades personalizadas do token. Se o usuário for proprietário do token e criador de um token, ele também poderá atualizar a propriedade
TokenDesc
. Os metadados do token não podem ser atualizados. Você deve passar todas as propriedades de token para esse método, mesmo que queira atualizar apenas determinadas propriedades.
Métodos para Gerenciamento do Comportamento de Token - Comportamento Transferível
-
safeTransferFrom
- Esta é uma função assíncrona. Este método transfere a propriedade do NFT especificado do chamador para outra conta. Este método inclui as seguintes validações:
- O token existe e não é queimado.
- A conta do remetente e a conta do recebedor existem e não são a mesma conta.
- A conta do remetente possui o token.
- O chamador da função é o remetente.
-
transferFrom
- Esta é uma função assíncrona. Este método transfere a propriedade do NFT especificado de uma conta de remetente para uma conta de destinatário. É responsabilidade do chamador passar os parâmetros corretos. Esse método pode ser chamado por qualquer usuário, não apenas pelo proprietário do token. Este método inclui as seguintes validações:
- O token existe e não é queimado.
- A conta do remetente e a conta do recebedor existem e não são a mesma conta.
- A conta do remetente possui o token.
Métodos para Gerenciamento do Comportamento de Token - Comportamento Queimável
-
burn
- Este método desativa ou queima o NFT especificado da conta do chamador. O chamador desse método deve ter uma conta. Um token não pode ser gravado, a menos que o arquivo de especificação do token inclua o comportamento
burnable
. Se nenhuma propriedadeburner_role_name
for especificada na seçãoroles
do arquivo de especificação, o proprietário do token poderá gravar o token. Se uma propriedadeburner_role_name
for especificada na seçãoroles
, o usuário designado à atribuição de gravador que também é o mineiro (criador) ou proprietário do token poderá gravar o token. -
burnNFT
- Esse método desativa ou queima o NFT especificado da conta do chamador e retorna um objeto de token e um histórico de token. O chamador desse método deve ter uma conta. Um token não pode ser gravado, a menos que o arquivo de especificação do token inclua o comportamento
burnable
. Se nenhuma propriedadeburner_role_name
for especificada na seçãoroles
do arquivo de especificação, o proprietário do token poderá gravar o token. Se uma propriedadeburner_role_name
for especificada na seçãoroles
, o usuário designado à atribuição de gravador que também é o mineiro (criador) ou proprietário do token poderá gravar o token.
Métodos Personalizados
Você pode usar os métodos SDK de token para criar métodos personalizados para seu aplicativo de negócios.
O exemplo a seguir mostra como usar métodos SDK de token em métodos personalizados. Quando o método sell
é chamado, ele publica um token à venda por um preço especificado.
@Validator(yup.string(), yup.number())
public async sell(token_id: string, selling_price: number) {
try {
const token = await this.Ctx.ERC721Token.get(token_id);
const t = new ArtCollection(token)
/** * price is a custom asset
attribute to set the price of a non-fungible token in the
marketplace */
t.price = selling_price;
/** * on_sale_flag is a
custom asset attribute that maintains non-fungible token selling status in the
marketplace */
t.on_sale_flag = true;
await this.Ctx.ERC721Token.updateToken(t);
let msg = `Token ID : '${token_id}' has been posted for selling in the marketplace'`;
return {msg}
} catch(error) {
throw new Error(error.message);
}
}
Métodos do NFT SDK
- Gerenciamento de Controle de Acesso
- Gerenciamento de Configuração de Token
- Gerenciamento de Contas
- Gerenciamento de Atribuições
- Gerenciamento do Histórico de Transações
- Gerenciamento de Comportamento de Token
Métodos para Gerenciamento de Controle de Acesso
Token Admin
ou Account Owner
do token. Você pode usar esse recurso para garantir que as operações sejam executadas apenas pelos usuários desejados. Qualquer acesso não autorizado resulta em erro. Para usar a função de controle de acesso, importe a classe Authorization
do módulo ../lib/erc721-auth
.import { ERC721Authorization } from '../lib/erc721-auth';
-
checkAuthorization
- Use esse método para adicionar uma verificação de controle de acesso a uma operação. Esta é uma função assíncrona. A maioria dos métodos gerados automaticamente inclui o controle de acesso. Determinados métodos de token só podem ser executados pelo
ERC721Admin
ouAccount Owner
do token ou peloMultipleAccountOwner
para usuários com várias contas. O métodocheckAuthorization
faz parte da classeAuthorization
, que você acessa por meio do objetoCtx
. O mapeamento do controle de acesso é descrito no arquivo../lib/constant.ts
, conforme mostrado no texto a seguir. Você pode modificar o controle de acesso editando o arquivo../lib/constant.ts
. Para usar seu próprio controle de acesso ou desativar o controle de acesso, remova o código de controle de acesso dos métodos de controlador gerados automaticamente e métodos personalizados.export const TOKENACCESS = { ADMIN: { isUserTokenAdmin: ['Admin', 'MultipleAccountOwner'], addAdmin: ['Admin'], removeAdmin: ['Admin'], getAllAdmins: ['Admin'], }, TOKEN: { save: ['Admin'], getAllTokens: ['Admin'], get: ['Admin'], update: ['Admin'], getDecimals: ['Admin'], getTokensByName: ['Admin'], addRoleMember: ['Admin'], removeRoleMember: ['Admin'], isInRole: ['Admin', 'AccountOwner'], getTotalMintedTokens: ['Admin'], getNetTokens: ['Admin'], }, ROLE: { getAccountsByRole: ['Admin'], getUsersByRole: ['Admin'], }, TRANSACTION: { deleteTransactions: ['Admin'], }, ACCOUNT: { createAccount: ['Admin'], getAllAccounts: ['Admin'], getAccountsByUser: ['Admin', 'MultipleAccountOwner'], getAccount: ['Admin', 'AccountOwner'], history: ['Admin', 'AccountOwner'], getAccountTransactionHistory: ['Admin', 'AccountOwner'], getAccountBalance: ['Admin', 'AccountOwner'], getAccountOnHoldBalance: ['Admin', 'AccountOwner'], getOnHoldIds: ['Admin', 'AccountOwner'], }, ERC721ADMIN: { isUserTokenAdmin: ['Admin'], addAdmin: ['Admin'], removeAdmin: ['Admin'], getAllAdmins: ['Admin'], }, ERC721TOKEN: { getAllTokens: ['Admin'], getAllTokensByUser: ['Admin', 'AccountOwner'], get: ['Admin', TOKEN_OWNER], getTokensByName: ['Admin'], addRoleMember: ['Admin'], removeRoleMember: ['Admin'], isInRole: ['Admin', 'AccountOwner'], totalSupply: ['Admin'], totalNetSupply: ['Admin'], history: ['Admin'], }, ERC721ROLE: { getAccountsByRole: ['Admin'], getUsersByRole: ['Admin'], }, ERC721TRANSACTION: { deleteTransactions: ['Admin'], }, ERC721ACCOUNT: { createAccount: ['Admin'], getAllAccounts: ['Admin'], getAccountsByUser: ['Admin', 'MultipleAccountOwner'], history: ['Admin', 'AccountOwner'], getAccountTransactionHistory: ['Admin', 'AccountOwner'], getAccountTransactionHistoryWithFilters: ['Admin', 'AccountOwner'], balanceOf: ['Admin', 'MultipleAccountOwner'], } }
-
isUserTokenAdmin
- Esse método retornará o valor booliano
true
se o chamador da função forToken Admin
. Caso contrário, o método retornaráfalse
. Esta é uma função estática assíncrona. -
addAdmin
- Esse método adiciona um usuário como
Token Admin
do chaincode do token. -
removeAdmin
- Esse método remove um usuário como
Token Admin
do chaincode do token. -
getAllAdmins
- Esse método retorna uma lista de todos os usuários
Token Admin
.
Métodos para Gerenciamento de Configuração de Token
Os métodos de gerenciamento de configuração de token são baseados no padrão ERC-721. Para usar os métodos de gerenciamento de configuração de token, importe a classe Token
do módulo ../lib/erc721-token
.
-
totalSupply
- Este método retorna o número total de NFTs cunhados. Esta é uma função assíncrona.
-
get
- Esse método retornará o objeto de token especificado se ele estiver presente no banco de dados de estado. Esta é uma função estática assíncrona.
-
isTokenType
- Este método indica se existe um ativo de token com o ID especificado. Esta é uma função estática assíncrona.
-
createToken
- Este método cria um token e salva suas propriedades no banco de dados de estado. Esse método só pode ser chamado por usuários com a atribuição de minter. Esta é uma função assíncrona.
-
updateToken
- Este método atualiza as propriedades do token. Esse método só pode ser chamado pelo proprietário ou criador do token. Após a criação de um ativo de token, somente o proprietário do token poderá atualizar as propriedades personalizadas do token. Se o usuário for proprietário do token e criador de um token, ele também poderá atualizar a propriedade
TokenDesc
. Os metadados do token não podem ser atualizados. Você deve passar todas as propriedades de token para esse método, mesmo que queira atualizar apenas determinadas propriedades. Esta é uma função assíncrona. -
getByRange
- Esse método chama o método
getStateByRange
da malha internamente. Mesmo que qualquer ativo com o ID fornecido seja retornado do razão, esse método converte o ativo no tipo de Ativo chamador. Esta é uma função estática assíncrona.@validator(yup.string(), yup.string()) public async getDigiCurrGetByRange(startId: string, endId: string) { return await this.Ctx.ERC721TOken.getByRange(startId, endId, PaintingNft); }
-
history
- Este método retorna o histórico do token especificado. Esta é uma função estática assíncrona.
-
getAllTokens
- Esse método retorna todos os ativos de token salvos no banco de dados de estado. Esse método usa consultas ricas em SQL de BD Berkeley e só pode ser chamado quando conectado à rede remota do Oracle Blockchain Platform. Esta é uma função estática assíncrona.
-
getAllTokensByUser
- Este método retorna todos os tokens pertencentes a um ID de conta especificado. Esta é uma função estática assíncrona.
-
ownerOf
- Este método retorna o ID da conta do proprietário de um token especificado. Esta é uma função estática assíncrona.
-
tokenUri
- Esse método retorna o URI de um token especificado. Esta é uma função estática assíncrona.
-
getTokenUri
- Esse método retorna o URI de um token especificado. Esta é uma função estática assíncrona.
-
symbol
- Esse método retorna o símbolo da classe do token.
Métodos para Gerenciamento de Contas
-
generateAccountId
- Esse método retorna um ID de conta, que é formado pela concatenação do ID do provedor de serviços de associação (
orgId
) e do nome de usuário ou ID de e-mail (userId
) e, em seguida, pela criação de um hash SHA-256. -
createAccount
- Esse método cria uma conta para um usuário e token especificados. Uma conta deve ser criada para qualquer usuário que terá tokens a qualquer momento. As contas rastreiam o número de NFTs que um usuário tem. Os usuários devem ter contas na rede para concluir operações relacionadas a token. Você pode criar apenas uma conta NFT por usuário.
Um ID de conta é um conjunto alfanumérico de caracteres, prefixado com
oaccount~
e seguido por um hash SHA-256 do ID do provedor de serviços de associação (orgId
) do usuário na organização de rede atual, o nome de usuário ou o ID de e-mail (userId
) do proprietário da instância ou do usuário que está conectado à instância e a string constantenft
. Este método pode ser chamado somente peloToken Admin
do chaincode. -
getAllAccounts
- Esse método retorna uma lista de todas as contas. Esse método usa consultas ricas em SQL de BD Berkeley e só pode ser chamado quando conectado à rede remota do Oracle Blockchain Platform.
-
history
- Esse método retorna uma matriz dos detalhes do histórico da conta de uma conta especificada.
-
getUserByAccountId
- Este método retorna os detalhes do usuário de uma conta especificada.
-
getAccountWithStatusByUser
- Este método retorna detalhes do usuário para uma conta especificada, incluindo o status da conta. Esse método só pode ser chamado por um
Token Admin
do chaincode ou peloAccount Owner
da conta. -
getAccountByUser
- Este método retorna detalhes do usuário para uma conta especificada. Esse método só pode ser chamado por um
Token Admin
do chaincode ou peloAccount Owner
da conta. -
balanceOf
- Este método retorna o número total de NFTs que o usuário especificado mantém.
Métodos para Gerenciamento de Atribuições
-
addRoleMember
- Esse método adiciona uma atribuição a um usuário e token especificados. Um ID de conta é formado pela criação de um hash SHA-256 do ID do provedor de serviços de associação concatenado (
orgId
) e do nome de usuário ou ID de e-mail (userId
). Esta é uma função assíncrona. -
removeRoleMember
- Esse método remove uma atribuição de um usuário e token especificados. Um ID de conta é formado pela criação de um hash SHA-256 do ID do provedor de serviços de associação concatenado (
orgId
) e do nome de usuário ou ID de e-mail (userId
). Esta é uma função assíncrona. -
isInRole
- Esse método retorna um valor Booliano para indicar se um usuário e token têm uma atribuição especificada. Um ID de conta é formado pela criação de um hash SHA-256 do ID do provedor de serviços de associação concatenado (
orgId
) e do nome de usuário ou ID de e-mail (userId
). Esta é uma função assíncrona. -
getAccountsByRole
- Esse método retorna uma lista de todos os IDs de contas para uma função especificada.
-
getUsersByRole
- Esse método retorna uma lista de todos os usuários de uma atribuição especificada.
Métodos para Gerenciamento do Histórico de Transações
-
getAccountTransactionHistory
- Esse método retorna uma matriz dos detalhes do histórico de transações de uma conta especificada.
-
getAccountTransactionHistoryWithFilters
- Esse método retorna o histórico de transações da conta de um usuário especificado, filtrado por
PageSize
,Bookmark
,startTime
eendTime
. Esse método só pode ser chamado quando conectado à rede remota do Oracle Blockchain Platform. -
getTransactionById
- Esse método retorna o histórico de um ativo
Transaction
. -
deleteHistoricalTransactions
- Este método exclui transações anteriores a uma data especificada do banco de dados de estado.
Gerenciamento do Comportamento do Token - Comportamento Mínimo
-
getMaxMintQuantity
- Este método retorna a quantidade mínima máxima de um token. Se o comportamento
max_mint_quantity
não estiver configurado no arquivo de especificação, o valor padrão será 0 e um número infinito de tokens poderá ser cunhado. -
getTotalMintedTokens
- Este método retorna o número total de tokens cunhados disponíveis no sistema para o token especificado. O número líquido de tokens disponíveis é o número total de tokens cunhados menos o número de tokens queimados. Esta é uma função assíncrona.
Gerenciamento de Comportamento de Token - Comportamento Transferível
-
safeTransferFrom
- Esta é uma função assíncrona. Este método transfere a propriedade do NFT especificado do chamador para outra conta. Este método inclui as seguintes validações:
- O token existe e não é queimado.
- A conta do remetente e a conta do recebedor existem e não são a mesma conta.
- A conta do remetente possui o token.
- O chamador da função é o remetente.
-
transferFrom
- Esta é uma função assíncrona. Este método transfere a propriedade do NFT especificado de uma conta de remetente para uma conta de destinatário. É responsabilidade do chamador passar os parâmetros corretos. Esse método pode ser chamado por qualquer usuário, não apenas pelo proprietário do token. Este método inclui as seguintes validações:
- O token existe e não é queimado.
- A conta do remetente e a conta do recebedor existem e não são a mesma conta.
- A conta do remetente possui o token.
Gerenciamento de comportamento de token - Comportamento gravável
-
burn
- Este método desativa ou queima o NFT especificado da conta do chamador. O chamador desse método deve ter uma conta. Um token não pode ser gravado, a menos que o arquivo de especificação do token inclua o comportamento
burnable
. Se nenhuma propriedadeburner_role_name
for especificada na seçãoroles
do arquivo de especificação, o proprietário do token poderá gravar o token. Se uma propriedadeburner_role_name
for especificada na seçãoroles
, o usuário designado à atribuição de gravador que também é o mineiro (criador) do token poderá gravar o token. Esta é uma função assíncrona.