diff --git a/.gitignore b/.gitignore index 76add87..5a19e8a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ node_modules -dist \ No newline at end of file +dist +coverage \ No newline at end of file diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..2c88ae2 --- /dev/null +++ b/.npmignore @@ -0,0 +1,2 @@ +docs +coverage \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..7afb747 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# XOXNO SDK + +XOXNO SDK is a JavaScript library that simplifies the interaction with the XOXNO Protocol for developers. It includes a set of helper functions and modules that make it easy to fetch, filter, and interact with data from the XOXNO Protocol and its NFT marketplace. + +## Table of Contents + +- [Installation](#installation) +- [Usage](#usage) + - [Initialization](#initialization) + - [Fetching Data](#fetching-data) + - [Interacting with the Smart Contract](#interacting-with-the-smart-contract) +- [Testing](#testing) +- [Contributing](#contributing) +- [License](#license) + +## Installation + +To install the XOXNO SDK, simply run the following command in your project's root directory: + +```bash +npm install xoxno-sdk +``` diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index bedcf83..0e740c4 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -1,16 +1,16 @@ :root { - --light-hl-0: #0000FF; - --dark-hl-0: #569CD6; - --light-hl-1: #000000; - --dark-hl-1: #D4D4D4; - --light-hl-2: #0070C1; - --dark-hl-2: #4FC1FF; - --light-hl-3: #795E26; - --dark-hl-3: #DCDCAA; - --light-hl-4: #001080; - --dark-hl-4: #9CDCFE; - --light-hl-5: #A31515; - --dark-hl-5: #CE9178; + --light-hl-0: #000000; + --dark-hl-0: #D4D4D4; + --light-hl-1: #A31515; + --dark-hl-1: #CE9178; + --light-hl-2: #0000FF; + --dark-hl-2: #569CD6; + --light-hl-3: #0070C1; + --dark-hl-3: #4FC1FF; + --light-hl-4: #795E26; + --dark-hl-4: #DCDCAA; + --light-hl-5: #001080; + --dark-hl-5: #9CDCFE; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } diff --git a/docs/classes/collection.CollectionModule.html b/docs/classes/collection.CollectionModule.html index d3b6aa7..eaf6efc 100644 --- a/docs/classes/collection.CollectionModule.html +++ b/docs/classes/collection.CollectionModule.html @@ -1,4 +1,4 @@ -
const xoxno = new XOXNO({ apiURL: 'https://api.xoxno.com', apiKey: 'your-api-key' });
const collectionModule = xoxno.collection;
+Example
const xoxno = new XOXNO({ apiURL: 'https://api.xoxno.com', apiKey: 'your-api-key' });
const collectionModule = xoxno.collection;
Private
apiPrivate
callPrivate
xoA list of accepted payment tokens.
The number of collections listed.
a list of IDs of global offers.
The number of global offers.
The number of listings.
The percentage of each transaction that will be paid to the m
The number of custom offers.
Private
getPrivate
isStatic
createStatic
Private
apiStatic
Private
managerStatic
Private
marketStatic
Private
minterStatic
Private
p2pStatic
Private
stakingStatic
Static
getStatic
Static
getStatic
Static
getStatic
Static
getStatic
Static
getStatic
Private
apiStatic
Private
instanceStatic
getStatic
Static
initPrivate
Readonly
parserPrivate
Readonly
proxyConst
Const
Const
Const
XOXNO SDK is a JavaScript library that simplifies the interaction with the XOXNO Protocol for developers. It includes a set of helper functions and modules that make it easy to fetch, filter, and interact with data from the XOXNO Protocol and its NFT marketplace.
+ + +To install the XOXNO SDK, simply run the following command in your project's root directory:
+npm install xoxno-sdk
+
+Optional
auctionOptional
levelOptional
max
Optional
min?: numberOptional
marketplaceOptional
onOptional
rangeOptional
rankOptional
max
Optional
min?: numberOptional
tokensOptional
ownerOptional
ownerOptional
nameOptional
orderOptional
selectOptional
If set, will return only NFTs with the specified attributes
Optional
cantinaThe collection to search in
Optional
listedIf set, will return only NFTs listed in the specified tokens
Optional
listedIf set, will return only NFTs listed in the specified marketplaces
Optional
onlyIf true, will return only NFTs that are on auction
Optional
onlyIf true, will return only NFTs that are on sale
Optional
onlyIf set, will return only the specified fields
Optional
orderThe order of the results based on a field
Optional
priceOptional
rankOptional
searchIf set, will return only NFTs with a name that contains the specified string
Optional
skipThe order by to use
Optional
topThe number of results to return
The total count of the results for the specific query
If the results are empty
The payload to use to get the next page
If there are more results to fetch
The results for the current page
The results count for the current page
Optional
OnOptional
descriptionOptional
creatorOptional
hasOptional
nftOptional
ownerOptional
ownerOptional
ownerOptional
The actions to fetch the trading activity from
Optional
attributesThe attributes to fetch the trading activity from
Optional
collectionsThe collections to fetch the trading activity from
Optional
identifiersThe identifier of the NFTs to fetch the trading activity from
Optional
marketplacesThe marketplaces to fetch the trading activity from
Optional
orderThe fields to order the trading activity by
Optional
ownersThe owners of the NFTs to fetch the trading activity from
Optional
placedThe tokens to fetch the trading activity from
Optional
priceOptional
rankOptional
selectThe fields to select from the trading activity
Optional
skipThe number of results to skip
Optional
timestampOptional
topThe number of results to return
Optional
tokens?: string[]Optional
orderOptional
selectConst
Const
Const
Const
Const
Const
Const
Const
Const
Const
Const
Const
Const
NFTModule provides a set of methods to interact with single NFTs. It includes methods for getting single NFT information, and searching NFTs by collection and nonce.
-Example