loopring_sdk

@loopring-web/loopring-sdk / Exports / NFTAPI

Class: NFTAPI

Hierarchy

• BaseAPI

  ↳ NFTAPI

Table of contents

Constructors

• constructor

Properties

• baseUrl
• chainId
• KEY_MESSAGE

Methods

• _genContract
• _genContractData
• _genERC1155Data
• _genERC721Data
• approveNFT
• callContractMethod
• callRefreshNFT
• computeNFTAddress
• depositNFT
• genErr
• getAvailableBroker
• getCollectionWholeNFTs
• getContractNFTMeta
• getCounterFactualInfo
• getInfoForNFTTokens
• getNFTBalance
• getPublicCollectionById
• ipfsCid0ToNftID
• ipfsNftIDToCid
• isApprovedForAll
• makeReq
• returnTxHash
• setBaseUrl
• setChainId

Constructors

constructor

• new NFTAPI(param, timeout?, baseUrlMap?)

Parameters

Name	Type	Default value
param	InitParam	undefined
timeout	number	6000
baseUrlMap	Object	undefined
baseUrlMap.1	string	"https://api3.loopring.io"
baseUrlMap.5	string	"https://uat2.loopring.io"

Inherited from

BaseAPI.constructor

Defined in

api/base_api.ts:104

Properties

baseUrl

• Protected baseUrl: string = ""

Inherited from

BaseAPI.baseUrl

Defined in

api/base_api.ts:39

---

chainId

• Protected chainId: ChainId = ChainId.MAINNET

Inherited from

BaseAPI.chainId

Defined in

api/base_api.ts:40

---

KEY_MESSAGE

▪ Static KEY_MESSAGE: string = KEY_MESSAGE

Inherited from

BaseAPI.KEY_MESSAGE

Defined in

api/base_api.ts:38

Methods

_genContract

▸ Private _genContract(web3, contractAddress, type?): any

Parameters

Name	Type	Default value
web3	any	undefined
contractAddress	string	undefined
type	NFTType	NFTType.ERC1155

Returns

any

Defined in

api/nft_api.ts:94

---

_genContractData

▸ Private _genContractData(Contract, method, data): any

Parameters

Name	Type
Contract	any
method	string
data	any

Returns

any

Defined in

api/nft_api.ts:82

---

_genERC1155Data

▸ Private _genERC1155Data(method, data): any

Parameters

Name	Type
method	string
data	any

Returns

any

Defined in

api/nft_api.ts:86

---

_genERC721Data

▸ Private _genERC721Data(method, data): any

Parameters

Name	Type
method	string
data	any

Returns

any

Defined in

api/nft_api.ts:90

---

approveNFT

▸ approveNFT(__namedParameters): Promise<any>

approveNFT

Parameters

Name	Type
__namedParameters	ApproveParam

Returns

Promise<any>

Defined in

api/nft_api.ts:297

---

callContractMethod

▸ Private callContractMethod(web3, method, data, contractAddress, type?): Promise<any>

Parameters

Name	Type	Default value
web3	any	undefined
method	string	undefined
data	any[]	undefined
contractAddress	string	undefined
type	NFTType	NFTType.ERC1155

Returns

Promise<any>

Defined in

api/nft_api.ts:70

---

callRefreshNFT

▸ callRefreshNFT(request): Promise<undefined | { createdAt: number ; status: string ; updatedAt: number }>

Parameters

Name	Type
request	CallRefreshNFT

Returns

Promise<undefined | { createdAt: number ; status: string ; updatedAt: number }>

Defined in

api/nft_api.ts:205

---

computeNFTAddress

▸ computeNFTAddress(__namedParameters): Object

function computeNFTAddress

throws Error

Parameters

Name	Type
__namedParameters	Object
__namedParameters.nftBaseUri?	string
__namedParameters.nftFactory?	string
__namedParameters.nftOwner	string

Returns

Object

tokenAddress

Name	Type
tokenAddress	string

Defined in

api/nft_api.ts:462

---

depositNFT

▸ depositNFT(__namedParameters): Promise<any>

depositparam an NFTAction to the specified account.

Parameters

Name	Type
__namedParameters	DepositNFTParam

Returns

Promise<any>

Defined in

api/nft_api.ts:415

---

genErr

▸ genErr(err): RESULT_INFO

Parameters

Name	Type
err	Error | AxiosResponse<any> & Error

Returns

RESULT_INFO

Inherited from

BaseAPI.genErr

Defined in

api/base_api.ts:41

---

getAvailableBroker

▸ getAvailableBroker(request): Promise<{ broker: string }>

Parameters

Name	Type
request	GetAvailableBrokerRequest

Returns

Promise<{ broker: string }>

Inherited from

BaseAPI.getAvailableBroker

Defined in

api/base_api.ts:123

---

getCollectionWholeNFTs

▸ getCollectionWholeNFTs<R>(request): Promise<any>

Type parameters

Name
R

Parameters

Name	Type
request	GetCollectionWholeNFTsRequest

Returns

Promise<any>

Defined in

api/nft_api.ts:536

---

getContractNFTMeta

▸ getContractNFTMeta(__namedParameters, _IPFS_META_URL?): Promise<any>

getContractNFTMeta

Parameters

Name	Type	Default value
__namedParameters	ContractNFTMetaParam	undefined
_IPFS_META_URL	string	LOOPRING_URLs.IPFS_META_URL

Returns

Promise<any>

Defined in

api/nft_api.ts:250

---

getCounterFactualInfo

▸ getCounterFactualInfo<T>(request): Promise<{ counterFactualInfo: undefined | CounterFactualInfo ; error?: RESULT_INFO ; raw_data: T }>

Type parameters

Name	Type
T	extends unknown

Parameters

Name	Type
request	GetCounterFactualInfoRequest

Returns

Promise<{ counterFactualInfo: undefined | CounterFactualInfo ; error?: RESULT_INFO ; raw_data: T }>

Inherited from

BaseAPI.getCounterFactualInfo

Defined in

api/base_api.ts:136

---

getInfoForNFTTokens

▸ getInfoForNFTTokens(nftDatas): Promise<undefined | { [key: string]: NFTTokenInfo; }>

getInfoForNFTTokens

Parameters

Name	Type	Description
nftDatas	Object	NftData[]
nftDatas.nftDatas	string[]	-

Returns

Promise<undefined | { [key: string]: NFTTokenInfo; }>

Defined in

api/nft_api.ts:167

---

getNFTBalance

▸ getNFTBalance(__namedParameters): Promise<{ count?: string }>

getNFTBalance

Parameters

Name	Type
__namedParameters	UserNFTBalanceParam

Returns

Promise<{ count?: string }>

Defined in

api/nft_api.ts:115

---

getPublicCollectionById

▸ getPublicCollectionById<R>(request): Promise<RESULT_INFO | { raw_data: R } & CollectionExtendsKey & CollectionBasicMeta>

Type parameters

Name	Type
R	extends CollectionMeta

Parameters

Name	Type
request	Object
request.id	string

Returns

Promise<RESULT_INFO | { raw_data: R } & CollectionExtendsKey & CollectionBasicMeta>

Defined in

api/nft_api.ts:507

---

ipfsCid0ToNftID

▸ ipfsCid0ToNftID(cidV0Str): string

Parameters

Name	Type
cidV0Str	string

Returns

string

Defined in

api/nft_api.ts:345

---

ipfsNftIDToCid

▸ ipfsNftIDToCid(nftId): any

Parameters

Name	Type	Description
nftId	string	16

Returns

any

Defined in

api/nft_api.ts:358

---

isApprovedForAll

▸ isApprovedForAll(__namedParameters): Promise<any>

isApprovedForAll

Parameters

Name	Type
__namedParameters	IsApproveParam

Returns

Promise<any>

Defined in

api/nft_api.ts:374

---

makeReq

▸ Protected makeReq(): Request

Returns

Request

Inherited from

BaseAPI.makeReq

Defined in

api/base_api.ts:182

---

returnTxHash

▸ Protected returnTxHash<T>(raw_data): RESULT_INFO | Omit<T, "resultInfo"> & { raw_data: Omit<T, "resultInfo"> }

Type parameters

Name	Type
T	extends TX_HASH_API

Parameters

Name	Type
raw_data	T

Returns

RESULT_INFO | Omit<T, "resultInfo"> & { raw_data: Omit<T, "resultInfo"> }

Inherited from

BaseAPI.returnTxHash

Defined in

api/base_api.ts:82

---

setBaseUrl

▸ setBaseUrl(baseUrl): void

Parameters

Name	Type
baseUrl	string

Returns

void

Inherited from

BaseAPI.setBaseUrl

Defined in

api/base_api.ts:178

---

setChainId

▸ setChainId(chainId): void

Parameters

Name	Type
chainId	ChainId

Returns

void

Inherited from

BaseAPI.setChainId

Defined in

api/base_api.ts:170

This site is open source. Improve this page.