Class DataContractsController

Collection of methods necessary to work with Data Contracts in the network, such as data contract creation or retrieval

Index

Methods

create createStateTransition getDataContractByIdentifier

Methods

create

create(
    ownerId: IdentifierLike,
    identityNonce: bigint,
    schema: object,
    fullValidation?: boolean,
    tokenConfiguration?: TokenConfigurationWASM,
    config?: DataContractConfig,
    platformVersion?: PlatformVersionWASM,
): DataContractWASM
Creates an instance of {DataContractWASM} that can be used to register a data contract in the network.
Parameters
- ownerId: IdentifierLike
  {IdentifierLike} Identifier of the Data Contract's owner
- identityNonce: bigint
  {bigint} Identity nonce
- schema: object
  {object} Data Contract schema in json
- OptionalfullValidation: boolean
  {true=} Full validation (omit it)
- OptionaltokenConfiguration: TokenConfigurationWASM
  {object=} Token configuration
- Optionalconfig: DataContractConfig
  {DataContractConfig=} Data Contract config
- OptionalplatformVersion: PlatformVersionWASM
  {PlatformVersionWASM=} version of the platform
Returns DataContractWASM
- Defined in src/dataContracts/index.ts:36

createStateTransition

createStateTransition(
    dataContract: DataContractWASM,
    type: DataContractTransitionType,
    identityNonce: bigint,
): StateTransitionWASM
Helper function to create a state transition from a {DataContractWASM} instance Pass {DataContractTransitionType} in type param to specify which type of operation you want to make: create or update.
Parameters
- dataContract: DataContractWASM
  {DataContractWASM} An instance of DataContractWASM to create or update
- type: DataContractTransitionType
  {DataContractTransitionType} type of state transition to create
- identityNonce: bigint
  {bigint} identity contract nonce
Returns StateTransitionWASM
- Defined in src/dataContracts/index.ts:62

getDataContractByIdentifier

getDataContractByIdentifier(
identifier: IdentifierLike,
): Promise<DataContractWASM>
Retrieves a Data Contract by an identifier from the network
Parameters
- identifier: IdentifierLike
  {IdentifierLike} Identifier of the Data Contract
Returns Promise<DataContractWASM>
- Defined in src/dataContracts/index.ts:47