@twin.org/nft-models 0.0.1-next.16 → 0.0.1-next.17

package/dist/types/models/INftComponent.d.ts

@@ -5,7 +5,6 @@ import type { IComponent } from "@twin.org/core";
 export interface INftComponent extends IComponent {
     /**
      * Mint an NFT.
-     * @param issuer The issuer for the NFT, will also be the initial owner.
      * @param tag The tag for the NFT.
      * @param immutableMetadata The immutable metadata for the NFT.
      * @param metadata The metadata for the NFT.
@@ -13,14 +12,14 @@ export interface INftComponent extends IComponent {
      * @param identity The identity to perform the nft operation on.
      * @returns The id of the created NFT in urn format.
      */
-    mint<T = unknown, U = unknown>(issuer: string, tag: string, immutableMetadata?: T, metadata?: U, namespace?: string, identity?: string): Promise<string>;
+    mint<T = unknown, U = unknown>(tag: string, immutableMetadata?: T, metadata?: U, namespace?: string, identity?: string): Promise<string>;
     /**
      * Resolve an NFT.
      * @param id The id of the NFT to resolve.
-     * @param identity The identity to perform the nft operation on.
+     * @param controllerIdentity The identity to perform the nft operation on.
      * @returns The data for the NFT.
      */
-    resolve<T = unknown, U = unknown>(id: string, identity?: string): Promise<{
+    resolve<T = unknown, U = unknown>(id: string, controllerIdentity?: string): Promise<{
         issuer: string;
         owner: string;
         tag: string;
@@ -30,25 +29,26 @@ export interface INftComponent extends IComponent {
     /**
      * Burn an NFT.
      * @param id The id of the NFT to burn in urn format.
-     * @param identity The identity to perform the nft operation on.
+     * @param controllerIdentity The identity to perform the nft operation on.
      * @returns Nothing.
      */
-    burn(id: string, identity?: string): Promise<void>;
+    burn(id: string, controllerIdentity?: string): Promise<void>;
     /**
      * Transfer an NFT.
      * @param id The id of the NFT to transfer in urn format.
-     * @param recipient The recipient of the NFT.
+     * @param recipientIdentity The recipient identity for the NFT.
+     * @param recipientAddress The recipient address for the NFT.
      * @param metadata Optional mutable data to include during the transfer.
-     * @param identity The identity to perform the nft operation on.
+     * @param controllerIdentity The identity to perform the nft operation on.
      * @returns Nothing.
      */
-    transfer<T = unknown>(id: string, recipient: string, metadata?: T, identity?: string): Promise<void>;
+    transfer<U = unknown>(id: string, recipientIdentity: string, recipientAddress: string, metadata?: U, controllerIdentity?: string): Promise<void>;
     /**
      * Update the mutable data of the NFT.
      * @param id The id of the NFT to update in urn format.
      * @param metadata The mutable data to update.
-     * @param identity The identity to perform the nft operation on.
+     * @param controllerIdentity The identity to perform the nft operation on.
      * @returns Nothing.
      */
-    update<T = unknown>(id: string, metadata: T, identity?: string): Promise<void>;
+    update<U = unknown>(id: string, metadata: U, controllerIdentity?: string): Promise<void>;
 }

package/dist/types/models/INftConnector.d.ts

@@ -5,14 +5,13 @@ import type { IComponent } from "@twin.org/core";
 export interface INftConnector extends IComponent {
     /**
      * Mint an NFT.
-     * @param controller The identity of the user to access the vault keys.
-     * @param issuerAddress The issuer for the NFT, will also be the initial owner.
+     * @param controllerIdentity The identity of the user to access the vault keys.
      * @param tag The tag for the NFT.
      * @param immutableMetadata The immutable metadata for the NFT.
      * @param metadata The metadata for the NFT.
      * @returns The id of the created NFT in urn format.
      */
-    mint<T = unknown, U = unknown>(controller: string, issuerAddress: string, tag: string, immutableMetadata?: T, metadata?: U): Promise<string>;
+    mint<T = unknown, U = unknown>(controllerIdentity: string, tag: string, immutableMetadata?: T, metadata?: U): Promise<string>;
     /**
      * Resolve an NFT.
      * @param id The id of the NFT to resolve.
@@ -34,19 +33,20 @@ export interface INftConnector extends IComponent {
     burn(controller: string, id: string): Promise<void>;
     /**
      * Transfer an NFT.
-     * @param controller The controller of the NFT who can make changes.
+     * @param controllerIdentity The controller of the NFT who can make changes.
      * @param id The id of the NFT to transfer in urn format.
-     * @param recipient The recipient of the NFT.
+     * @param recipientIdentity The recipient identity for the NFT.
+     * @param recipientAddress The recipient address for the NFT.
      * @param metadata Optional mutable data to include during the transfer.
      * @returns Nothing.
      */
-    transfer<T = unknown>(controller: string, id: string, recipient: string, metadata?: T): Promise<void>;
+    transfer<U = unknown>(controllerIdentity: string, id: string, recipientIdentity: string, recipientAddress: string, metadata?: U): Promise<void>;
     /**
      * Update the mutable data of the NFT.
-     * @param controller The controller of the NFT who can make changes.
+     * @param controllerIdentity The controller of the NFT who can make changes.
      * @param id The id of the NFT to update in urn format.
      * @param metadata The mutable data to update.
      * @returns Nothing.
      */
-    update<T = unknown>(controller: string, id: string, metadata: T): Promise<void>;
+    update<U = unknown>(controllerIdentity: string, id: string, metadata: U): Promise<void>;
 }

package/dist/types/models/api/INftMintRequest.d.ts

@@ -6,10 +6,6 @@ export interface INftMintRequest {
      * The data to be used in the minting.
      */
     body: {
-        /**
-         * The issuer for the NFT, will also be the initial owner.
-         */
-        issuer: string;
         /**
          * The tag for the NFT.
          */

package/dist/types/models/api/INftTransferRequest.d.ts

@@ -16,9 +16,13 @@ export interface INftTransferRequest {
      */
     body: {
         /**
-         * The recipient for the NFT.
+         * The recipient identity for the NFT.
          */
-        recipient: string;
+        recipientIdentity: string;
+        /**
+         * The recipient address for the NFT.
+         */
+        recipientAddress: string;
         /**
          * The metadata for the NFT.
          */

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/nft-models - Changelog
 
-## v0.0.1-next.16
+## v0.0.1-next.17
 
 - Initial Release

package/docs/reference/interfaces/INftComponent.md

@@ -10,7 +10,7 @@ Interface describing an NFT component.
 
 ### mint()
 
-> **mint**\<`T`, `U`\>(`issuer`, `tag`, `immutableMetadata`?, `metadata`?, `namespace`?, `identity`?): `Promise`\<`string`\>
+> **mint**\<`T`, `U`\>(`tag`, `immutableMetadata`?, `metadata`?, `namespace`?, `identity`?): `Promise`\<`string`\>
 
 Mint an NFT.
 
@@ -22,12 +22,6 @@ Mint an NFT.
 
 #### Parameters
 
-##### issuer
-
-`string`
-
-The issuer for the NFT, will also be the initial owner.
-
 ##### tag
 
 `string`
@@ -68,7 +62,7 @@ The id of the created NFT in urn format.
 
 ### resolve()
 
-> **resolve**\<`T`, `U`\>(`id`, `identity`?): `Promise`\<\{ `issuer`: `string`; `owner`: `string`; `tag`: `string`; `immutableMetadata`: `T`; `metadata`: `U`; \}\>
+> **resolve**\<`T`, `U`\>(`id`, `controllerIdentity`?): `Promise`\<\{ `issuer`: `string`; `owner`: `string`; `tag`: `string`; `immutableMetadata`: `T`; `metadata`: `U`; \}\>
 
 Resolve an NFT.
 
@@ -86,7 +80,7 @@ Resolve an NFT.
 
 The id of the NFT to resolve.
 
-##### identity?
+##### controllerIdentity?
 
 `string`
 
@@ -102,7 +96,7 @@ The data for the NFT.
 
 ### burn()
 
-> **burn**(`id`, `identity`?): `Promise`\<`void`\>
+> **burn**(`id`, `controllerIdentity`?): `Promise`\<`void`\>
 
 Burn an NFT.
 
@@ -114,7 +108,7 @@ Burn an NFT.
 
 The id of the NFT to burn in urn format.
 
-##### identity?
+##### controllerIdentity?
 
 `string`
 
@@ -130,13 +124,13 @@ Nothing.
 
 ### transfer()
 
-> **transfer**\<`T`\>(`id`, `recipient`, `metadata`?, `identity`?): `Promise`\<`void`\>
+> **transfer**\<`U`\>(`id`, `recipientIdentity`, `recipientAddress`, `metadata`?, `controllerIdentity`?): `Promise`\<`void`\>
 
 Transfer an NFT.
 
 #### Type Parameters
 
-• **T** = `unknown`
+• **U** = `unknown`
 
 #### Parameters
 
@@ -146,19 +140,25 @@ Transfer an NFT.
 
 The id of the NFT to transfer in urn format.
 
-##### recipient
+##### recipientIdentity
+
+`string`
+
+The recipient identity for the NFT.
+
+##### recipientAddress
 
 `string`
 
-The recipient of the NFT.
+The recipient address for the NFT.
 
 ##### metadata?
 
-`T`
+`U`
 
 Optional mutable data to include during the transfer.
 
-##### identity?
+##### controllerIdentity?
 
 `string`
 
@@ -174,13 +174,13 @@ Nothing.
 
 ### update()
 
-> **update**\<`T`\>(`id`, `metadata`, `identity`?): `Promise`\<`void`\>
+> **update**\<`U`\>(`id`, `metadata`, `controllerIdentity`?): `Promise`\<`void`\>
 
 Update the mutable data of the NFT.
 
 #### Type Parameters
 
-• **T** = `unknown`
+• **U** = `unknown`
 
 #### Parameters
 
@@ -192,11 +192,11 @@ The id of the NFT to update in urn format.
 
 ##### metadata
 
-`T`
+`U`
 
 The mutable data to update.
 
-##### identity?
+##### controllerIdentity?
 
 `string`
 

package/docs/reference/interfaces/INftConnector.md

@@ -10,7 +10,7 @@ Interface describing an NFT connector.
 
 ### mint()
 
-> **mint**\<`T`, `U`\>(`controller`, `issuerAddress`, `tag`, `immutableMetadata`?, `metadata`?): `Promise`\<`string`\>
+> **mint**\<`T`, `U`\>(`controllerIdentity`, `tag`, `immutableMetadata`?, `metadata`?): `Promise`\<`string`\>
 
 Mint an NFT.
 
@@ -22,18 +22,12 @@ Mint an NFT.
 
 #### Parameters
 
-##### controller
+##### controllerIdentity
 
 `string`
 
 The identity of the user to access the vault keys.
 
-##### issuerAddress
-
-`string`
-
-The issuer for the NFT, will also be the initial owner.
-
 ##### tag
 
 `string`
@@ -118,17 +112,17 @@ Nothing.
 
 ### transfer()
 
-> **transfer**\<`T`\>(`controller`, `id`, `recipient`, `metadata`?): `Promise`\<`void`\>
+> **transfer**\<`U`\>(`controllerIdentity`, `id`, `recipientIdentity`, `recipientAddress`, `metadata`?): `Promise`\<`void`\>
 
 Transfer an NFT.
 
 #### Type Parameters
 
-• **T** = `unknown`
+• **U** = `unknown`
 
 #### Parameters
 
-##### controller
+##### controllerIdentity
 
 `string`
 
@@ -140,15 +134,21 @@ The controller of the NFT who can make changes.
 
 The id of the NFT to transfer in urn format.
 
-##### recipient
+##### recipientIdentity
 
 `string`
 
-The recipient of the NFT.
+The recipient identity for the NFT.
+
+##### recipientAddress
+
+`string`
+
+The recipient address for the NFT.
 
 ##### metadata?
 
-`T`
+`U`
 
 Optional mutable data to include during the transfer.
 
@@ -162,17 +162,17 @@ Nothing.
 
 ### update()
 
-> **update**\<`T`\>(`controller`, `id`, `metadata`): `Promise`\<`void`\>
+> **update**\<`U`\>(`controllerIdentity`, `id`, `metadata`): `Promise`\<`void`\>
 
 Update the mutable data of the NFT.
 
 #### Type Parameters
 
-• **T** = `unknown`
+• **U** = `unknown`
 
 #### Parameters
 
-##### controller
+##### controllerIdentity
 
 `string`
 
@@ -186,7 +186,7 @@ The id of the NFT to update in urn format.
 
 ##### metadata
 
-`T`
+`U`
 
 The mutable data to update.
 

package/docs/reference/interfaces/INftMintRequest.md

@@ -10,12 +10,6 @@ Mint the data and return the NFT id.
 
 The data to be used in the minting.
 
-#### issuer
-
-> **issuer**: `string`
-
-The issuer for the NFT, will also be the initial owner.
-
 #### tag
 
 > **tag**: `string`

package/docs/reference/interfaces/INftTransferRequest.md

@@ -24,11 +24,17 @@ The id of the NFT to transfer in urn format.
 
 The data to be used in the transfer.
 
-#### recipient
+#### recipientIdentity
 
-> **recipient**: `string`
+> **recipientIdentity**: `string`
 
-The recipient for the NFT.
+The recipient identity for the NFT.
+
+#### recipientAddress
+
+> **recipientAddress**: `string`
+
+The recipient address for the NFT.
 
 #### metadata?
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/nft-models",
-	"version": "0.0.1-next.16",
+	"version": "0.0.1-next.17",
 	"description": "Contains models and classes for use with NFTs",
 	"repository": {
 		"type": "git",