Class: TransferParams

Properties overview

address: PublicKey = PublicKey; ↗
context: NFTTransactionContext = NFTTransactionContext; ↗
from: PublicKey = PublicKey; ↗
price: UInt64Option = UInt64Option; ↗
to: PublicKey = PublicKey; ↗

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

Represents the parameters required for transferring an NFT.

Extends

{
address: PublicKey;
context: NFTTransactionContext;
from: PublicKey;
price: UInt64Option;
to: PublicKey;
}

Constructors

new TransferParams()

new TransferParams(value: {
  address: PublicKey;
  context: NFTTransactionContext;
  from: PublicKey;
  price: UInt64Option;
  to: PublicKey;
 }): TransferParams

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

Parameters

value

address

PublicKey = PublicKey

The address of the NFT contract.

context

NFTTransactionContext = NFTTransactionContext

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

from

PublicKey = PublicKey

The sender's public key.

price

UInt64Option = UInt64Option

Optional price for the transfer.

to

PublicKey = PublicKey

The receiver's public key.

Returns

TransferParams

Inherited from

Struct({
  / The address of the NFT contract. /
  address: PublicKey,
  / The sender's public key. /
  from: PublicKey,
  / The receiver's public key. /
  to: PublicKey,
  / Optional price for the transfer. /
  price: UInt64Option,
  / Custom value that can be interpreted by the owner or approved contract. /
  context: NFTTransactionContext,
}).constructor

Properties

address

address: PublicKey = PublicKey;

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

The address of the NFT contract.

Inherited from

Struct({
  / The address of the NFT contract. /
  address: PublicKey,
  / The sender's public key. /
  from: PublicKey,
  / The receiver's public key. /
  to: PublicKey,
  / Optional price for the transfer. /
  price: UInt64Option,
  / Custom value that can be interpreted by the owner or approved contract. /
  context: NFTTransactionContext,
}).address

context

context: NFTTransactionContext = NFTTransactionContext;

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

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

Inherited from

Struct({
  / The address of the NFT contract. /
  address: PublicKey,
  / The sender's public key. /
  from: PublicKey,
  / The receiver's public key. /
  to: PublicKey,
  / Optional price for the transfer. /
  price: UInt64Option,
  / Custom value that can be interpreted by the owner or approved contract. /
  context: NFTTransactionContext,
}).context

from

from: PublicKey = PublicKey;

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

The sender's public key.

Inherited from

Struct({
  / The address of the NFT contract. /
  address: PublicKey,
  / The sender's public key. /
  from: PublicKey,
  / The receiver's public key. /
  to: PublicKey,
  / Optional price for the transfer. /
  price: UInt64Option,
  / Custom value that can be interpreted by the owner or approved contract. /
  context: NFTTransactionContext,
}).from

price

price: UInt64Option = UInt64Option;

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

Optional price for the transfer.

Inherited from

Struct({
  / The address of the NFT contract. /
  address: PublicKey,
  / The sender's public key. /
  from: PublicKey,
  / The receiver's public key. /
  to: PublicKey,
  / Optional price for the transfer. /
  price: UInt64Option,
  / 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:597

The receiver's public key.

Inherited from

Struct({
  / The address of the NFT contract. /
  address: PublicKey,
  / The sender's public key. /
  from: PublicKey,
  / The receiver's public key. /
  to: PublicKey,
  / Optional price for the transfer. /
  price: UInt64Option,
  / Custom value that can be interpreted by the owner or approved contract. /
  context: NFTTransactionContext,
}).to