Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Commit

Permalink
Update links
Browse files Browse the repository at this point in the history
  • Loading branch information
Tschakki committed Dec 7, 2023
1 parent 39d1d32 commit e6eaff6
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion framework/src/modules/interoperability/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export { BaseInteroperableModule } from './base_interoperable_module';
export { BaseInteroperabilityModule } from './base_interoperability_module';
export { BaseInteroperabilityMethod } from './base_interoperability_method';
export { BaseCCMethod } from './base_cc_method';
export { getMainchainID } from './utils';
export { getMainchainID, validateFormat } from './utils';

// Mainchain
export { MainchainInteroperabilityModule } from './mainchain/module';
Expand Down
4 changes: 2 additions & 2 deletions framework/src/modules/nft/method.ts
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export class NFTMethod extends BaseMethod {
* Adds dependencies from other module methods.
*
* @param internalMethod
* @param feeMethod {@link FeeMethod}
* @param feeMethod {@link Modules.Fee.FeeMethod}
*/
public addDependencies(internalMethod: InternalMethod, feeMethod: FeeMethod) {
this._internalMethod = internalMethod;
Expand Down Expand Up @@ -929,7 +929,7 @@ export class NFTMethod extends BaseMethod {

/**
* This function recovers an NFT escrowed to a terminated chain.
* It should only be called by the {@link BaseInteroperabilityModule | Interoperability module} to trigger the recovery of NFTs escrowed to terminated chains.
* It should only be called by the {@link Modules.Interoperability.BaseInteroperabilityModule | Interoperability module} to trigger the recovery of NFTs escrowed to terminated chains.
*
* @example
* ```ts
Expand Down
8 changes: 4 additions & 4 deletions framework/src/modules/nft/module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,10 @@ import {
* Each NFT is stored with an array of attributes specified by various modules, with each attribute property being a byte sequence that is not deserialized by the NFT module.
* Each custom module using NFTs should define schemas to serialize and deserialize their attributes property of NFTs.
*
* Note that the attributes properties are not limited in size by default, which can potentially cause the CCM {@link validateFormat} failure during the cross-chain NFT transfer.
* Note that the attributes properties are not limited in size by default, which can potentially cause the CCM {@link Modules.Interoperability.validateFormat} failure during the cross-chain NFT transfer.
*
* When an NFT is sent to another chain, the attributes properties of the NFT can be modified according to specifications set on the receiving chain.
* When the NFT is received back on its native chain, the returned modified attributes are disregarded and the original attributes are restored, as currently defined by {@link getNewAttributes} function.
* When the NFT is received back on its native chain, the returned modified attributes are disregarded and the original attributes are restored, as currently defined by {@link https://github.com/LiskHQ/lips/blob/main/proposals/lip-0052.md#getnewattributes | getNewAttributes} function.
* If needed, custom modules can implement a more fine-grained approach towards the attributes that are modified cross-chain.
*
* @see [LIP 0052 - Introduce NFT module](https://github.com/LiskHQ/lips/blob/main/proposals/lip-0052.md)
Expand Down Expand Up @@ -165,8 +165,8 @@ export class NFTModule extends BaseInteroperableModule {
* This method should be called where the module is registered to the app (generally in the `app.ts` or `modules.ts` file).
*
* @param interoperabilityMethod {@link InteroperabilityMethod}
* @param feeMethod {@link FeeMethod}
* @param tokenMethod {@link TokenMethod}
* @param feeMethod {@link Modules.Fee.FeeMethod}
* @param tokenMethod {@link Modules.Token.TokenMethod}
*/
public addDependencies(
interoperabilityMethod: InteroperabilityMethod,
Expand Down

0 comments on commit e6eaff6

Please sign in to comment.