Service | @irisnet/irishub-sdk

todo: docs
since: v0.17

Hierarchy

Service

Methods

bindService

bindService(binding: { deposit: Coin[]; pricing: string; serviceName: string }, baseTx: BaseTx): Promise<TxResult>

- Defined in src/modules/service.ts:259
Bind an existing service definition

since

v0.17

Parameters
- binding: { deposit: Coin[]; pricing: string; serviceName: string }
  
  Service binding
  - deposit: Coin[]
  - pricing: string
  - serviceName: string
- baseTx: BaseTx
Returns Promise<TxResult>

defineService

defineService(definition: { author_description?: undefined | string; description?: undefined | string; name: string; schemas: string; tags?: string[] }, baseTx: BaseTx): Promise<TxResult>

- Defined in src/modules/service.ts:225
Creating a new service definition

since

v0.17

Parameters
- definition: { author_description?: undefined | string; description?: undefined | string; name: string; schemas: string; tags?: string[] }
  
  Service definition
  - Optional author_description?: undefined | string
  - Optional description?: undefined | string
  - name: string
  - schemas: string
  - Optional tags?: string[]
- baseTx: BaseTx
Returns Promise<TxResult>

disableServiceBinding

disableServiceBinding(serviceName: string, baseTx: BaseTx): Promise<TxResult>

- Defined in src/modules/service.ts:319
Disable an available service binding

since

v0.17

Parameters
- serviceName: string
  
  The unique name of the service
- baseTx: BaseTx
Returns Promise<TxResult>

enableServiceBinding

enableServiceBinding(serviceName: string, baseTx: BaseTx): Promise<TxResult>

- Defined in src/modules/service.ts:340
Enable an unavailable service binding

** Not Supported **

since

v0.17

Parameters
- serviceName: string
  
  The unique name of the service
- baseTx: BaseTx
Returns Promise<TxResult>

killRequestContext

killRequestContext(requestContextID: string, baseTx: BaseTx): Promise<TxResult>

- Defined in src/modules/service.ts:483
Kill the specified request context

since

v0.17

Parameters
- requestContextID: string
  
  The context ID of the service invocation which is returned when calling the service
- baseTx: BaseTx
Returns Promise<TxResult>

pauseRequestContext

pauseRequestContext(requestContextID: string, baseTx: BaseTx): Promise<TxResult>

- Defined in src/modules/service.ts:463
Pause the specified request context

since

v0.17

Parameters
- requestContextID: string
  
  The context ID of the service invocation which is returned when calling the service
- baseTx: BaseTx
Returns Promise<TxResult>

queryBinding

queryBinding(serviceName: string, provider: string): Promise<ServiceBinding>

- Defined in src/modules/service.ts:59
Query a service binding

since

v0.17

Parameters
- serviceName: string
  
  The unique service name
- provider: string
  
  Bech32 provider address
Returns Promise<ServiceBinding>

queryBindings

queryBindings(serviceName: string): Promise<ServiceBinding[]>

- Defined in src/modules/service.ts:79
Query service bindings by service name

since

v0.17

Parameters
- serviceName: string
  
  The unique service name
Returns Promise<ServiceBinding[]>

queryDefinition

queryDefinition(serviceName: string): Promise<ServiceDefinition>

- Defined in src/modules/service.ts:42
Query a service definition

since

v0.17

Parameters
- serviceName: string
  
  The unique service name
Returns Promise<ServiceDefinition>

queryFees

queryFees(provider: string): Promise<ServiceFee>

- Defined in src/modules/service.ts:208
Query service fee

since

v0.17

Parameters
- provider: string
  
  Bech32 provider address
Returns Promise<ServiceFee>

queryRequest

queryRequest(requestID: string): Promise<ServiceRequest>

- Defined in src/modules/service.ts:95
Query a service request

since

v0.17

Parameters
- requestID: string
  
  The ID of the request
Returns Promise<ServiceRequest>

queryRequestContext

queryRequestContext(requestContextID: string): Promise<ServiceRequestContext>

- Defined in src/modules/service.ts:153
Query a request context

since

v0.17

Parameters
- requestContextID: string
  
  The context ID of the service invocation which is returned when calling the service
Returns Promise<ServiceRequestContext>

queryRequests

queryRequests(serviceName: string, provider: string): Promise<ServiceRequest>

- Defined in src/modules/service.ts:112
Query all requests of a specified service and provider

since

v0.17

Parameters
- serviceName: string
  
  The unique service name
- provider: string
  
  Bech32 provider address
Returns Promise<ServiceRequest>

queryRequestsByReqCtx

queryRequestsByReqCtx(requestContextID: string, batchCounter: number): Promise<ServiceRequest[]>

- Defined in src/modules/service.ts:133
Query all requests of a specified request context ID and batch counter

since

v0.17

Parameters
- requestContextID: string
  
  The context ID of the service invocation which is returned when calling the service
- batchCounter: number
  
  The sequence number of the request context
Returns Promise<ServiceRequest[]>

queryResponse

queryResponse(requestID: string): Promise<ServiceResponse>

- Defined in src/modules/service.ts:171
Query a service response

since

v0.17

Parameters
- requestID: string
  
  The ID of the request
Returns Promise<ServiceResponse>

queryResponses

queryResponses(requestContextID: string, batchCounter: number): Promise<ServiceResponse>

- Defined in src/modules/service.ts:188
Query service responses

since

v0.17

Parameters
- requestContextID: string
  
  The context ID of the service invocation which is returned when calling the service
- batchCounter: number
  
  The sequence number of the request context
Returns Promise<ServiceResponse>

refundServiceDeposit

refundServiceDeposit(serviceName: string, baseTx: BaseTx): Promise<TxResult>

- Defined in src/modules/service.ts:423
Refund deposits from the specified service binding

since

v0.17

Parameters
- serviceName: string
  
  The unique name of the service
- baseTx: BaseTx
Returns Promise<TxResult>

setWithdrawAddress

setWithdrawAddress(withdrawAddress: string, baseTx: BaseTx): Promise<TxResult>

- Defined in src/modules/service.ts:403
Set a withdrawal address for a provider

since

v0.17

Parameters
- withdrawAddress: string
  
  Bech32 account address
- baseTx: BaseTx
Returns Promise<TxResult>

startRequestContext

startRequestContext(requestContextID: string, baseTx: BaseTx): Promise<TxResult>

- Defined in src/modules/service.ts:443
Start the specified request context

since

v0.17

Parameters
- requestContextID: string
  
  The context ID of the service invocation which is returned when calling the service
- baseTx: BaseTx
Returns Promise<TxResult>

updateRequestContext

updateRequestContext(request: { providers: string[]; repeated_frequency?: undefined | number; repeated_total?: undefined | number; request_context_id: string; service_fee_cap?: Coin[]; timeout?: undefined | number }, baseTx: BaseTx): Promise<TxResult>

- Defined in src/modules/service.ts:503
Update the specified request context

since

v0.17

Parameters
- request: { providers: string[]; repeated_frequency?: undefined | number; repeated_total?: undefined | number; request_context_id: string; service_fee_cap?: Coin[]; timeout?: undefined | number }
  
  Params to be updated
  - providers: string[]
  - Optional repeated_frequency?: undefined | number
  - Optional repeated_total?: undefined | number
  - request_context_id: string
  - Optional service_fee_cap?: Coin[]
  - Optional timeout?: undefined | number
- baseTx: BaseTx
Returns Promise<TxResult>

updateServiceBinding

updateServiceBinding(binding: { deposit: Coin[]; pricing: string; serviceName: string }, baseTx: BaseTx): Promise<TxResult>

- Defined in src/modules/service.ts:289
Update the specified service binding

since

v0.17

Parameters
- binding: { deposit: Coin[]; pricing: string; serviceName: string }
  
  Service binding
  - deposit: Coin[]
  - pricing: string
  - serviceName: string
- baseTx: BaseTx
Returns Promise<TxResult>

withdrawEarnedFees

withdrawEarnedFees(baseTx: BaseTx): Promise<TxResult>

- Defined in src/modules/service.ts:540
Withdraw the earned fees to the specified provider

since

v0.17

Parameters
- baseTx: BaseTx
Returns Promise<TxResult>

withdrawTax

withdrawTax(destAddress: string, amount: Coin[], baseTx: BaseTx): Promise<TxResult>

- Defined in src/modules/service.ts:555
Withdraw the service tax to the speicified destination address by the trustee

since

v0.17

Parameters
- destAddress: string
  
  The speicified destination address to receive the service tax
- amount: Coin[]
- baseTx: BaseTx
Returns Promise<TxResult>

Hierarchy

Index

Methods

Methods

bindService

Parameters

binding: { deposit: Coin[]; pricing: string; serviceName: string }

deposit: Coin[]

pricing: string

serviceName: string

baseTx: BaseTx

Returns Promise<TxResult>

defineService

Parameters

definition: { author_description?: undefined | string; description?: undefined | string; name: string; schemas: string; tags?: string[] }

Optional author_description?: undefined | string

Optional description?: undefined | string

name: string

schemas: string

Optional tags?: string[]

baseTx: BaseTx

Returns Promise<TxResult>

disableServiceBinding

Parameters

serviceName: string

baseTx: BaseTx

Returns Promise<TxResult>

enableServiceBinding

Parameters

serviceName: string

baseTx: BaseTx

Returns Promise<TxResult>

killRequestContext

Parameters

requestContextID: string

baseTx: BaseTx

Returns Promise<TxResult>

pauseRequestContext

Parameters

requestContextID: string

baseTx: BaseTx

Returns Promise<TxResult>

queryBinding

Parameters

serviceName: string

provider: string

Returns Promise<ServiceBinding>

queryBindings

Parameters

serviceName: string

Returns Promise<ServiceBinding[]>

queryDefinition

Parameters

serviceName: string

Returns Promise<ServiceDefinition>

queryFees

Parameters

provider: string

Returns Promise<ServiceFee>

queryRequest

Parameters

requestID: string

Returns Promise<ServiceRequest>

queryRequestContext

Parameters

requestContextID: string

Returns Promise<ServiceRequestContext>

queryRequests

Parameters

serviceName: string

provider: string

Returns Promise<ServiceRequest>

queryRequestsByReqCtx

Parameters

requestContextID: string

batchCounter: number

Returns Promise<ServiceRequest[]>

queryResponse

Parameters

requestID: string