TransferExtendedParams

Class: TransferExtendedParams

Properties overview

  • approved: PublicKey = PublicKey;
  • collection: PublicKey = PublicKey;
  • context: NFTTransactionContext = NFTTransactionContext;
  • fee: UInt64Option = UInt64Option;
  • from: PublicKey = PublicKey;
  • nft: PublicKey = PublicKey;
  • price: UInt64Option = UInt64Option;
  • to: PublicKey = PublicKey;
  • transferByOwner: Bool = Bool;

Defined in: packages/nft/src/interfaces/types.ts:604

Extends

Constructors

new TransferExtendedParams()

new TransferExtendedParams(value: {
  approved: PublicKey;
  collection: PublicKey;
  context: NFTTransactionContext;
  fee: UInt64Option;
  from: PublicKey;
  nft: PublicKey;
  price: UInt64Option;
  to: PublicKey;
  transferByOwner: Bool;
 }): TransferExtendedParams

Defined in: node_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103

Parameters

value
approved

PublicKey = PublicKey

The public key of the approved address.

collection

PublicKey = PublicKey

The public key of the collection.

context

NFTTransactionContext = NFTTransactionContext

Custom value that can be interpreted by the owner or approved contract.

fee

UInt64Option = UInt64Option

The fee paid for the transfer.

from

PublicKey = PublicKey

The public key of the sender (current owner) before the transfer.

nft

PublicKey = PublicKey

The public key address of the NFT being transferred.

price

UInt64Option = UInt64Option

The price of the NFT being transferred.

to

PublicKey = PublicKey

The public key of the recipient (new owner) after the transfer.

transferByOwner

Bool = Bool

Indicates whether the transfer is by owner or by approved address.

Returns

TransferExtendedParams

Inherited from

Struct({
  / The public key of the sender (current owner) before the transfer. /
  from: PublicKey,
  / The public key of the recipient (new owner) after the transfer. /
  to: PublicKey,
  / The public key of the collection. /
  collection: PublicKey,
  / The public key address of the NFT being transferred. /
  nft: PublicKey,
  / The fee paid for the transfer. /
  fee: UInt64Option,
  / The price of the NFT being transferred. /
  price: UInt64Option,
  / Indicates whether the transfer is by owner or by approved address. /
  transferByOwner: Bool,
  / The public key of the approved address. /
  approved: PublicKey,
  / Custom value that can be interpreted by the owner or approved contract. /
  context: NFTTransactionContext,
}).constructor

Properties

approved

approved: PublicKey = PublicKey;

Defined in: packages/nft/src/interfaces/types.ts:620

The public key of the approved address.

Inherited from

Struct({
  / The public key of the sender (current owner) before the transfer. /
  from: PublicKey,
  / The public key of the recipient (new owner) after the transfer. /
  to: PublicKey,
  / The public key of the collection. /
  collection: PublicKey,
  / The public key address of the NFT being transferred. /
  nft: PublicKey,
  / The fee paid for the transfer. /
  fee: UInt64Option,
  / The price of the NFT being transferred. /
  price: UInt64Option,
  / Indicates whether the transfer is by owner or by approved address. /
  transferByOwner: Bool,
  / The public key of the approved address. /
  approved: PublicKey,
  / Custom value that can be interpreted by the owner or approved contract. /
  context: NFTTransactionContext,
}).approved

collection

collection: PublicKey = PublicKey;

Defined in: packages/nft/src/interfaces/types.ts:610

The public key of the collection.

Inherited from

Struct({
  / The public key of the sender (current owner) before the transfer. /
  from: PublicKey,
  / The public key of the recipient (new owner) after the transfer. /
  to: PublicKey,
  / The public key of the collection. /
  collection: PublicKey,
  / The public key address of the NFT being transferred. /
  nft: PublicKey,
  / The fee paid for the transfer. /
  fee: UInt64Option,
  / The price of the NFT being transferred. /
  price: UInt64Option,
  / Indicates whether the transfer is by owner or by approved address. /
  transferByOwner: Bool,
  / The public key of the approved address. /
  approved: PublicKey,
  / Custom value that can be interpreted by the owner or approved contract. /
  context: NFTTransactionContext,
}).collection

context

context: NFTTransactionContext = NFTTransactionContext;

Defined in: packages/nft/src/interfaces/types.ts:622

Custom value that can be interpreted by the owner or approved contract.

Inherited from

Struct({
  / The public key of the sender (current owner) before the transfer. /
  from: PublicKey,
  / The public key of the recipient (new owner) after the transfer. /
  to: PublicKey,
  / The public key of the collection. /
  collection: PublicKey,
  / The public key address of the NFT being transferred. /
  nft: PublicKey,
  / The fee paid for the transfer. /
  fee: UInt64Option,
  / The price of the NFT being transferred. /
  price: UInt64Option,
  / Indicates whether the transfer is by owner or by approved address. /
  transferByOwner: Bool,
  / The public key of the approved address. /
  approved: PublicKey,
  / Custom value that can be interpreted by the owner or approved contract. /
  context: NFTTransactionContext,
}).context

fee

fee: UInt64Option = UInt64Option;

Defined in: packages/nft/src/interfaces/types.ts:614

The fee paid for the transfer.

Inherited from

Struct({
  / The public key of the sender (current owner) before the transfer. /
  from: PublicKey,
  / The public key of the recipient (new owner) after the transfer. /
  to: PublicKey,
  / The public key of the collection. /
  collection: PublicKey,
  / The public key address of the NFT being transferred. /
  nft: PublicKey,
  / The fee paid for the transfer. /
  fee: UInt64Option,
  / The price of the NFT being transferred. /
  price: UInt64Option,
  / Indicates whether the transfer is by owner or by approved address. /
  transferByOwner: Bool,
  / The public key of the approved address. /
  approved: PublicKey,
  / Custom value that can be interpreted by the owner or approved contract. /
  context: NFTTransactionContext,
}).fee

from

from: PublicKey = PublicKey;

Defined in: packages/nft/src/interfaces/types.ts:606

The public key of the sender (current owner) before the transfer.

Inherited from

Struct({
  / The public key of the sender (current owner) before the transfer. /
  from: PublicKey,
  / The public key of the recipient (new owner) after the transfer. /
  to: PublicKey,
  / The public key of the collection. /
  collection: PublicKey,
  / The public key address of the NFT being transferred. /
  nft: PublicKey,
  / The fee paid for the transfer. /
  fee: UInt64Option,
  / The price of the NFT being transferred. /
  price: UInt64Option,
  / Indicates whether the transfer is by owner or by approved address. /
  transferByOwner: Bool,
  / The public key of the approved address. /
  approved: PublicKey,
  / Custom value that can be interpreted by the owner or approved contract. /
  context: NFTTransactionContext,
}).from

nft

nft: PublicKey = PublicKey;

Defined in: packages/nft/src/interfaces/types.ts:612

The public key address of the NFT being transferred.

Inherited from

Struct({
  / The public key of the sender (current owner) before the transfer. /
  from: PublicKey,
  / The public key of the recipient (new owner) after the transfer. /
  to: PublicKey,
  / The public key of the collection. /
  collection: PublicKey,
  / The public key address of the NFT being transferred. /
  nft: PublicKey,
  / The fee paid for the transfer. /
  fee: UInt64Option,
  / The price of the NFT being transferred. /
  price: UInt64Option,
  / Indicates whether the transfer is by owner or by approved address. /
  transferByOwner: Bool,
  / The public key of the approved address. /
  approved: PublicKey,
  / Custom value that can be interpreted by the owner or approved contract. /
  context: NFTTransactionContext,
}).nft

price

price: UInt64Option = UInt64Option;

Defined in: packages/nft/src/interfaces/types.ts:616

The price of the NFT being transferred.

Inherited from

Struct({
  / The public key of the sender (current owner) before the transfer. /
  from: PublicKey,
  / The public key of the recipient (new owner) after the transfer. /
  to: PublicKey,
  / The public key of the collection. /
  collection: PublicKey,
  / The public key address of the NFT being transferred. /
  nft: PublicKey,
  / The fee paid for the transfer. /
  fee: UInt64Option,
  / The price of the NFT being transferred. /
  price: UInt64Option,
  / Indicates whether the transfer is by owner or by approved address. /
  transferByOwner: Bool,
  / The public key of the approved address. /
  approved: PublicKey,
  / Custom value that can be interpreted by the owner or approved contract. /
  context: NFTTransactionContext,
}).price

to

to: PublicKey = PublicKey;

Defined in: packages/nft/src/interfaces/types.ts:608

The public key of the recipient (new owner) after the transfer.

Inherited from

Struct({
  / The public key of the sender (current owner) before the transfer. /
  from: PublicKey,
  / The public key of the recipient (new owner) after the transfer. /
  to: PublicKey,
  / The public key of the collection. /
  collection: PublicKey,
  / The public key address of the NFT being transferred. /
  nft: PublicKey,
  / The fee paid for the transfer. /
  fee: UInt64Option,
  / The price of the NFT being transferred. /
  price: UInt64Option,
  / Indicates whether the transfer is by owner or by approved address. /
  transferByOwner: Bool,
  / The public key of the approved address. /
  approved: PublicKey,
  / Custom value that can be interpreted by the owner or approved contract. /
  context: NFTTransactionContext,
}).to

transferByOwner

transferByOwner: Bool = Bool;

Defined in: packages/nft/src/interfaces/types.ts:618

Indicates whether the transfer is by owner or by approved address.

Inherited from

Struct({
  / The public key of the sender (current owner) before the transfer. /
  from: PublicKey,
  / The public key of the recipient (new owner) after the transfer. /
  to: PublicKey,
  / The public key of the collection. /
  collection: PublicKey,
  / The public key address of the NFT being transferred. /
  nft: PublicKey,
  / The fee paid for the transfer. /
  fee: UInt64Option,
  / The price of the NFT being transferred. /
  price: UInt64Option,
  / Indicates whether the transfer is by owner or by approved address. /
  transferByOwner: Bool,
  / The public key of the approved address. /
  approved: PublicKey,
  / Custom value that can be interpreted by the owner or approved contract. /
  context: NFTTransactionContext,
}).transferByOwner