Class L1XTokenNFTService

Represents a service for working with non-fungible tokens (NFTs).

Hierarchy

L1XTokenNFTService

Constructors

constructor

new L1XTokenNFTService(_client, _core, _vm, _options): L1XTokenNFTService
Create an instance of L1XTokenNFTService.
Parameters
- _client: JSONRPCLib
  
  JSONRPC client.
- _core: L1XCoreStubService
  
  L1XCoreStubService instance.
- _vm: L1XVMService
- _options: ProviderAttrib
Returns L1XTokenNFTService
- Defined in src/services/tokens/L1XTokenNFTService.ts:93

Properties

`Private` #client

#client: JSONRPCLib

The JSON-RPC client used for communication with the L1X core.

`Private` #core

#core: L1XCoreStubService

Represents an instance of the L1XCoreStubService, which provides access to core L1X functionality.

`Private` #defaultBaseContractAddress

#defaultBaseContractAddress: string = ""

Represents a default base contract address for non fungible tokens (NFT).

`Private` #options

#options: ProviderAttrib

Represents the options for cluster provider information associated with the L1XProvider.

Memberof

L1XProvider

Instance

See

ProviderAttrib

`Private` #vm

#vm: L1XVMService

Represents an instance of the L1XVMService, which provides access to core L1X functionality.

Methods

`Private` #handleFallbackValue

#handleFallbackValue(data, fallbackValue?): any
Handles fallback value.
Parameters
- data: any
  
  Data to handle.
- Optional fallbackValue: any
  
  Fallback value if data is falsy.
Returns any
Handled value.
- Defined in src/services/tokens/L1XTokenNFTService.ts:110

`Private` #makeReadOnlyCall

#makeReadOnlyCall(payload): Promise<string>
Makes a read-only call to a smart contract.
Parameters
- payload: RawTokenReadOnlyArg
  
  Payload for the read-only call.
Returns Promise<string>
Result of the call.
- Defined in src/services/tokens/L1XTokenNFTService.ts:125

`Private` #makeStateChangingFunctionCall

#makeStateChangingFunctionCall(functionName, attrib): Promise<StateChangingFunctionCallResponse>
Makes a state-changing function call to the smart contract.
Parameters
- functionName: NFTStateChangingFunction
  
  Name of the function to call.
- attrib: any
  
  Function call attributes.
Returns Promise<StateChangingFunctionCallResponse>
State-changing function call response.
- Defined in src/services/tokens/L1XTokenNFTService.ts:164

`Private` #prepareQueryPayload

#prepareQueryPayload(attrib): RawTokenReadOnlyArg
Prepares the payload for a query.
Parameters
- attrib: NFTTokenPrepareQueryPayloadArg
  
  Query attributes.
Returns RawTokenReadOnlyArg
Prepared query payload.
- Defined in src/services/tokens/L1XTokenNFTService.ts:146

approve

approve(attrib): Promise<StateChangingFunctionCallResponse>
Approves an address to spend an NFT.
Parameters
- attrib: NFTApproveArg
  
  Attributes for approving NFT.
Returns Promise<StateChangingFunctionCallResponse>
State-changing function call response.
- Defined in src/services/tokens/L1XTokenNFTService.ts:475

burn

burn(attrib): Promise<StateChangingFunctionCallResponse>
Burns an NFT.
Parameters
- attrib: NFTTokenBurnArg
  
  Attributes for burning NFT.
Returns Promise<StateChangingFunctionCallResponse>
State-changing function call response.
- Defined in src/services/tokens/L1XTokenNFTService.ts:452

create

create(attrib): Promise<NFTTokenCreateResponse>
Creates an NFT.
Parameters
- attrib: NFTTokenCreateArg
  
  Attributes for creating NFT.
Returns Promise<NFTTokenCreateResponse>
NFT creation response.
- Defined in src/services/tokens/L1XTokenNFTService.ts:523

getAttribute

getAttribute(attrib): Promise<NFTTokenGetAttributeResponse>
Gets attributes of an NFT.
Parameters
- attrib: NFTTokenGetAttributeArg
  
  Attributes for getting NFT attributes.
Returns Promise<NFTTokenGetAttributeResponse>
NFT attributes.
- Defined in src/services/tokens/L1XTokenNFTService.ts:229

getBalance

getBalance(attrib): Promise<NFTTokenGetBalanceResponse>
Gets the balance of an NFT for a specific owner.
Parameters
- attrib: NFTTokenGetBalanceArg
  
  Attributes for getting NFT balance.
Returns Promise<NFTTokenGetBalanceResponse>
NFT balance response.
- Defined in src/services/tokens/L1XTokenNFTService.ts:290

getOwnedTokens

getOwnedTokens(attrib): Promise<NFTTokenOwnedTokensResponse>
Gets the owned token ids of an NFT for a specific owner.
Parameters
- attrib: NFTTokenOwnedByAddressArg
  
  Attributes for getting NFT balance.
Returns Promise<NFTTokenOwnedTokensResponse>
NFT owned token ids response.
- Defined in src/services/tokens/L1XTokenNFTService.ts:317

getOwnerOfTokenId

getOwnerOfTokenId(attrib): Promise<NFTTokenOwnerOfResponse>
Gets the owner of a specific NFT token ID.
Parameters
- attrib: NFTTokenOwnerOfArg
  
  Attributes for getting owner of an NFT.
Returns Promise<NFTTokenOwnerOfResponse>
Owner of the NFT token ID.
- Defined in src/services/tokens/L1XTokenNFTService.ts:348

getTokenUri

getTokenUri(attrib): Promise<NFTTokenUriOfResponse>
Gets the owner of a specific NFT token ID.
Parameters
- attrib: NFTTokenUriOfArg
  
  Attributes for getting owner of an NFT.
Returns Promise<NFTTokenUriOfResponse>
Owner of the NFT token ID.
- Defined in src/services/tokens/L1XTokenNFTService.ts:375

mintTo

mintTo(attrib): Promise<StateChangingFunctionCallResponse>
Mints an NFT and assigns it to an address.
Parameters
- attrib: NFTTokenMintToArg
  
  Attributes for minting NFT.
Returns Promise<StateChangingFunctionCallResponse>
State-changing function call response.
- Defined in src/services/tokens/L1XTokenNFTService.ts:427

setApprovalForAll

setApprovalForAll(attrib): Promise<StateChangingFunctionCallResponse>
Sets approval for all addresses to spend an NFT.
Parameters
- attrib: NFTSetApprovalForAllArg
  
  Attributes for setting approval for all.
Returns Promise<StateChangingFunctionCallResponse>
State-changing function call response.
- Defined in src/services/tokens/L1XTokenNFTService.ts:499

transferFrom

transferFrom(attrib): Promise<StateChangingFunctionCallResponse>
Transfers an NFT from one address to another.
Parameters
- attrib: NFTTokenTransferArg
  
  Attributes for transferring NFT.
Returns Promise<StateChangingFunctionCallResponse>
State-changing function call response.
- Defined in src/services/tokens/L1XTokenNFTService.ts:402

Class L1XTokenNFTService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

_client: JSONRPCLib

_core: L1XCoreStubService

_vm: L1XVMService

_options: ProviderAttrib

Returns L1XTokenNFTService

Properties

Private #client

Private #core

Private #defaultBaseContractAddress

Private #options

Memberof

Instance

See

Private #vm

Methods

Private #handleFallbackValue

Parameters

data: any

Optional fallbackValue: any

Returns any

Private #makeReadOnlyCall

Parameters

payload: RawTokenReadOnlyArg

Returns Promise<string>

Private #makeStateChangingFunctionCall

Parameters

functionName: NFTStateChangingFunction

attrib: any

Returns Promise<StateChangingFunctionCallResponse>

Private #prepareQueryPayload

Parameters

attrib: NFTTokenPrepareQueryPayloadArg

Returns RawTokenReadOnlyArg

approve

Parameters

attrib: NFTApproveArg

Returns Promise<StateChangingFunctionCallResponse>

burn

Parameters

attrib: NFTTokenBurnArg

Returns Promise<StateChangingFunctionCallResponse>

create

Parameters

attrib: NFTTokenCreateArg

Returns Promise<NFTTokenCreateResponse>

getAttribute

Parameters

attrib: NFTTokenGetAttributeArg

Returns Promise<NFTTokenGetAttributeResponse>

getBalance

Parameters

attrib: NFTTokenGetBalanceArg

Returns Promise<NFTTokenGetBalanceResponse>

getOwnedTokens

Parameters

attrib: NFTTokenOwnedByAddressArg

Returns Promise<NFTTokenOwnedTokensResponse>

getOwnerOfTokenId

Parameters

attrib: NFTTokenOwnerOfArg

Returns Promise<NFTTokenOwnerOfResponse>

getTokenUri

Parameters

attrib: NFTTokenUriOfArg

Returns Promise<NFTTokenUriOfResponse>

mintTo

Parameters

attrib: NFTTokenMintToArg

Returns Promise<StateChangingFunctionCallResponse>

setApprovalForAll

Parameters

`Private` #client

`Private` #core

`Private` #defaultBaseContractAddress

`Private` #options

`Private` #vm

`Private` #handleFallbackValue

`Optional` fallbackValue: any

`Private` #makeReadOnlyCall

`Private` #makeStateChangingFunctionCall

`Private` #prepareQueryPayload