Snip20Querier | Secret.js Docs

Hierarchy

ComputeQuerier
- Snip20Querier

Index

Constructors

constructor

Methods

Constructors

constructor

new Snip20Querier(url: string, encryption?: EncryptionUtils): Snip20Querier

Inherited from ComputeQuerier.constructor
- Defined in src/query/compute.ts:49
Parameters
- url: string
- Optional encryption: EncryptionUtils
Returns Snip20Querier

Methods

GetAllowance

GetAllowance(__namedParameters: { auth: { key?: string; permit?: Permit }; contract: <internal>.SecretContract; owner: string; spender: string }): Promise<GetAllowanceResponse>

- Defined in src/extensions/snip20/query.ts:204
Parameters
- __namedParameters: { auth: { key?: string; permit?: Permit }; contract: <internal>.SecretContract; owner: string; spender: string }
  - auth: { key?: string; permit?: Permit }
    - Optional key?: string
    - Optional permit?: Permit
  - contract: <internal>.SecretContract
  - owner: string
  - spender: string
Returns Promise<GetAllowanceResponse>

codes

codes(req: Empty, headers?: HeadersInit): Promise<QueryCodesResponse>

Inherited from ComputeQuerier.codes
- Defined in src/query/compute.ts:85
Parameters
- req: Empty
- Optional headers: HeadersInit
Returns Promise<QueryCodesResponse>

contractInfo

contractInfo(req: QueryByContractAddressRequest, headers?: HeadersInit): Promise<QueryContractInfoResponse>

Inherited from ComputeQuerier.contractInfo
- Defined in src/query/compute.ts:55
Parameters
- req: QueryByContractAddressRequest
- Optional headers: HeadersInit
Returns Promise<QueryContractInfoResponse>

contractsByCodeId

contractsByCodeId(req: QueryByCodeIdRequest, headers?: HeadersInit): Promise<QueryContractsByCodeIdResponse>

Inherited from ComputeQuerier.contractsByCodeId
- Defined in src/query/compute.ts:65
Parameters
- req: QueryByCodeIdRequest
- Optional headers: HeadersInit
Returns Promise<QueryContractsByCodeIdResponse>

getBalance

getBalance(__namedParameters: { address: string; auth: { key?: string; permit?: Permit }; contract: <internal>.SecretContract }): Promise<GetBalanceResponse>

- Defined in src/extensions/snip20/query.ts:44
Parameters
- __namedParameters: { address: string; auth: { key?: string; permit?: Permit }; contract: <internal>.SecretContract }
  - address: string
  - auth: { key?: string; permit?: Permit }
    - Optional key?: string
    - Optional permit?: Permit
  - contract: <internal>.SecretContract
Returns Promise<GetBalanceResponse>

getSnip20Params

getSnip20Params(__namedParameters: { contract: <internal>.SecretContract }): Promise<GetTokenParamsResponse>

- Defined in src/extensions/snip20/query.ts:27
Parameters
- __namedParameters: { contract: <internal>.SecretContract }
  - contract: <internal>.SecretContract
Returns Promise<GetTokenParamsResponse>

getTransactionHistory

getTransactionHistory(__namedParameters: { address: string; auth: { key?: string; permit?: Permit }; contract: <internal>.SecretContract; page?: number; page_size: number }): Promise<TransactionHistoryResponse>

- Defined in src/extensions/snip20/query.ts:146
Parameters
- __namedParameters: { address: string; auth: { key?: string; permit?: Permit }; contract: <internal>.SecretContract; page?: number; page_size: number }
  - address: string
  - auth: { key?: string; permit?: Permit }
    - Optional key?: string
    - Optional permit?: Permit
  - contract: <internal>.SecretContract
  - Optional page?: number
  - page_size: number
Returns Promise<TransactionHistoryResponse>

getTransferHistory

getTransferHistory(__namedParameters: { address: string; auth: { key?: string; permit?: Permit }; contract: <internal>.SecretContract; page?: number; page_size: number }): Promise<TransferHistoryResponse>

- Defined in src/extensions/snip20/query.ts:88
Parameters
- __namedParameters: { address: string; auth: { key?: string; permit?: Permit }; contract: <internal>.SecretContract; page?: number; page_size: number }
  - address: string
  - auth: { key?: string; permit?: Permit }
    - Optional key?: string
    - Optional permit?: Permit
  - contract: <internal>.SecretContract
  - Optional page?: number
  - page_size: number
Returns Promise<TransferHistoryResponse>

labelByAddress

labelByAddress(req: QueryByContractAddressRequest, headers?: HeadersInit): Promise<QueryContractLabelResponse>

Inherited from ComputeQuerier.labelByAddress
- Defined in src/query/compute.ts:131
Parameters
- req: QueryByContractAddressRequest
- Optional headers: HeadersInit
Returns Promise<QueryContractLabelResponse>

queryContract

queryContract<T, R>(__namedParameters: QueryContractRequest<T>, headers?: HeadersInit): Promise<R>

Inherited from ComputeQuerier.queryContract
- Defined in src/query/compute.ts:155
Query a Secret Contract. May return a string on error.

Type parameters
- T: object
- R: unknown
Parameters
- __namedParameters: QueryContractRequest<T>
- Optional headers: HeadersInit
Returns Promise<R>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

url: string

Optional encryption: EncryptionUtils

Returns Snip20Querier

Methods

GetAllowance

Parameters

__namedParameters: { auth: { key?: string; permit?: Permit }; contract: <internal>.SecretContract; owner: string; spender: string }

auth: { key?: string; permit?: Permit }

Optional key?: string

Optional permit?: Permit

contract: <internal>.SecretContract

owner: string

spender: string

Returns Promise<GetAllowanceResponse>

addressByLabel

Parameters

req: QueryByLabelRequest

Optional headers: HeadersInit

Returns Promise<QueryContractAddressResponse>

code

Parameters

req: QueryByCodeIdRequest

Optional headers: HeadersInit

Returns Promise<QueryCodeResponse>

codeHashByCodeId

Parameters

req: QueryByCodeIdRequest

Optional headers: HeadersInit

Returns Promise<QueryCodeHashResponse>

codeHashByContractAddress

Parameters

req: QueryByContractAddressRequest

Optional headers: HeadersInit

Returns Promise<QueryCodeHashResponse>

codes

Parameters

req: Empty

Optional headers: HeadersInit

Returns Promise<QueryCodesResponse>

contractInfo

Parameters

req: QueryByContractAddressRequest

Optional headers: HeadersInit

Returns Promise<QueryContractInfoResponse>

contractsByCodeId

Parameters

req: QueryByCodeIdRequest

Optional headers: HeadersInit

Returns Promise<QueryContractsByCodeIdResponse>

getBalance

Parameters

__namedParameters: { address: string; auth: { key?: string; permit?: Permit }; contract: <internal>.SecretContract }

address: string

auth: { key?: string; permit?: Permit }

Optional key?: string

Optional permit?: Permit

contract: <internal>.SecretContract

Returns Promise<GetBalanceResponse>

getSnip20Params

Parameters

__namedParameters: { contract: <internal>.SecretContract }

contract: <internal>.SecretContract

Returns Promise<GetTokenParamsResponse>

getTransactionHistory

Parameters

__namedParameters: { address: string; auth: { key?: string; permit?: Permit }; contract: <internal>.SecretContract; page?: number; page_size: number }

address: string

auth: { key?: string; permit?: Permit }

Optional key?: string

Optional permit?: Permit

contract: <internal>.SecretContract

Optional page?: number

page_size: number