Class Api<SecurityDataType>

Title

cosmos/nft/v1beta1/event.proto

Version

version not set

Type Parameters

SecurityDataType extends unknown

Hierarchy

HttpClient<SecurityDataType>
- Api

Index

Constructors

constructor

new Api<SecurityDataType>(__namedParameters?: ApiConfig<SecurityDataType>): Api<SecurityDataType>
Type Parameters
- SecurityDataType extends unknown
Parameters
- __namedParameters: ApiConfig<SecurityDataType> = {}
Returns Api<SecurityDataType>
Inherited from HttpClient.constructor
- Defined in cosmos.nft.v1beta1/rest.ts:468

Properties

instance

instance: AxiosInstance

Methods

queryBalance

queryBalance(owner: string, classId: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryBalanceResponse>>
No description

Tags
Query

Name
QueryBalance

Summary
Balance queries the number of NFTs of a given class owned by the owner, same as balanceOf in ERC721

Request
GET:/cosmos/nft/v1beta1/balance/{owner}/{class_id}
Parameters
- owner: string
- classId: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryBalanceResponse>>
- Defined in cosmos.nft.v1beta1/rest.ts:559

queryClass

queryClass(classId: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryClassResponse>>
No description

Tags
Query

Name
QueryClass

Summary
Class queries an NFT class based on its id

Request
GET:/cosmos/nft/v1beta1/classes/{class_id}
Parameters
- classId: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryClassResponse>>
- Defined in cosmos.nft.v1beta1/rest.ts:601

queryClasses

queryClasses(query?: {
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryClassesResponse>>
No description

Tags
Query

Name
QueryClasses

Summary
Classes queries all NFT classes

Request
GET:/cosmos/nft/v1beta1/classes
Parameters
- Optional query: {
      pagination.count_total?: boolean;
      pagination.key?: string;
      pagination.limit?: string;
      pagination.offset?: string;
      pagination.reverse?: boolean;
  }
  - Optional pagination.count_total?: boolean
  - Optional pagination.key?: string
  - Optional pagination.limit?: string
  - Optional pagination.offset?: string
  - Optional pagination.reverse?: boolean
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryClassesResponse>>
- Defined in cosmos.nft.v1beta1/rest.ts:575

queryNFT

queryNFT(classId: string, id: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryNFTResponse>>
No description

Tags
Query

Name
QueryNft

Summary
NFT queries an NFT based on its class and id.

Request
GET:/cosmos/nft/v1beta1/nfts/{class_id}/{id}
Parameters
- classId: string
- id: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryNFTResponse>>
- Defined in cosmos.nft.v1beta1/rest.ts:646

queryNFTs

queryNFTs(query?: {
    class_id?: string;
    owner?: string;
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryNFTsResponse>>
No description

Tags
Query

Name
QueryNfTs

Summary
NFTs queries all NFTs of a given class or owner,choose at least one of the two, similar to tokenByIndex in ERC721Enumerable

Request
GET:/cosmos/nft/v1beta1/nfts
Parameters
- Optional query: {
      class_id?: string;
      owner?: string;
      pagination.count_total?: boolean;
      pagination.key?: string;
      pagination.limit?: string;
      pagination.offset?: string;
      pagination.reverse?: boolean;
  }
  - Optional class_id?: string
  - Optional owner?: string
  - Optional pagination.count_total?: boolean
  - Optional pagination.key?: string
  - Optional pagination.limit?: string
  - Optional pagination.offset?: string
  - Optional pagination.reverse?: boolean
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryNFTsResponse>>
- Defined in cosmos.nft.v1beta1/rest.ts:618

queryOwner

queryOwner(classId: string, id: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryOwnerResponse>>
No description

Tags
Query

Name
QueryOwner

Summary
Owner queries the owner of the NFT based on its class and id, same as ownerOf in ERC721

Request
GET:/cosmos/nft/v1beta1/owner/{class_id}/{id}
Parameters
- classId: string
- id: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryOwnerResponse>>
- Defined in cosmos.nft.v1beta1/rest.ts:662

querySupply

querySupply(classId: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1QuerySupplyResponse>>
No description

Tags
Query

Name
QuerySupply

Summary
Supply queries the number of NFTs from the given class, same as totalSupply of ERC721.

Request
GET:/cosmos/nft/v1beta1/supply/{class_id}
Parameters
- classId: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QuerySupplyResponse>>
- Defined in cosmos.nft.v1beta1/rest.ts:678

request

request<T, _E>(__namedParameters: FullRequestParams): Promise<AxiosResponse<T>>
Type Parameters
- T = any
- _E = any
Parameters
- __namedParameters: FullRequestParams
Returns Promise<AxiosResponse<T>>
Inherited from HttpClient.request
- Defined in cosmos.nft.v1beta1/rest.ts:507

setSecurityData

setSecurityData(data: null | SecurityDataType): void
Parameters
- data: null | SecurityDataType
Returns void
Inherited from HttpClient.setSecurityData
- Defined in cosmos.nft.v1beta1/rest.ts:475

Class Api<SecurityDataType>

Title

Version

Type Parameters

SecurityDataType extends unknown

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

SecurityDataType extends unknown

Parameters

__namedParameters: ApiConfig<SecurityDataType> = {}

Returns Api<SecurityDataType>

Properties

instance

Methods

queryBalance

Tags

Name

Summary

Request

Parameters

owner: string

classId: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1QueryBalanceResponse>>

queryClass

Tags

Name

Summary

Request

Parameters

classId: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1QueryClassResponse>>

queryClasses

Tags

Name

Summary

Request

Parameters

Optional query: { pagination.count_total?: boolean; pagination.key?: string; pagination.limit?: string; pagination.offset?: string; pagination.reverse?: boolean; }

Optional pagination.count_total?: boolean

Optional pagination.key?: string

Optional pagination.limit?: string

Optional pagination.offset?: string

Optional pagination.reverse?: boolean

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1QueryClassesResponse>>

queryNFT

Tags

Name

Summary

Request

Parameters

classId: string

id: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1QueryNFTResponse>>

queryNFTs

Tags

Name

Summary

Request

Parameters

Optional query: { class_id?: string; owner?: string; pagination.count_total?: boolean; pagination.key?: string; pagination.limit?: string; pagination.offset?: string; pagination.reverse?: boolean; }

Optional class_id?: string

Optional owner?: string

Optional pagination.count_total?: boolean

Optional pagination.key?: string

Optional pagination.limit?: string

Optional pagination.offset?: string

Optional pagination.reverse?: boolean

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1QueryNFTsResponse>>

queryOwner

`Optional` query: {
pagination.count_total?: boolean;
pagination.key?: string;
pagination.limit?: string;
pagination.offset?: string;
pagination.reverse?: boolean;
}

`Optional` pagination.count_total?: boolean

`Optional` pagination.key?: string

`Optional` pagination.limit?: string

`Optional` pagination.offset?: string

`Optional` pagination.reverse?: boolean

`Optional` query: {
class_id?: string;
owner?: string;
pagination.count_total?: boolean;
pagination.key?: string;
pagination.limit?: string;
pagination.offset?: string;
pagination.reverse?: boolean;
}

`Optional` class_id?: string

`Optional` owner?: string

`Optional` pagination.count_total?: boolean

`Optional` pagination.key?: string

`Optional` pagination.limit?: string

`Optional` pagination.offset?: string

`Optional` pagination.reverse?: boolean