Reference / Modules / client / VaultClient
Class: VaultClient
client.VaultClient
Table of contents
Constructors
Properties
Methods
- acceptVaultTransferRequest
- cancelVaultTransferRequest
- createVaultTransferRequest
- fetchAll
- filterByStatuses
- getVaultTransferRequests
- rejectVaultTransferRequest
- resubmitVaultTransferRequest
Constructors
constructor
• new VaultClient(params): VaultClient
Parameters
| Name | Type |
|---|---|
params | Object |
params.axiosFactory | AxiosFactory |
params.currentAddress | string |
params.isLegalOfficer | boolean |
params.isRecovery | boolean |
params.networkState | NetworkState<LegalOfficerEndpoint> |
params.token | string |
Returns
Defined in
packages/client/src/VaultClient.ts:54
Properties
axiosFactory
• Private axiosFactory: AxiosFactory
Defined in
packages/client/src/VaultClient.ts:72
currentAddress
• Private currentAddress: string
Defined in
packages/client/src/VaultClient.ts:74
isLegalOfficer
• Private isLegalOfficer: boolean
Defined in
packages/client/src/VaultClient.ts:76
isRecovery
• Private isRecovery: boolean
Defined in
packages/client/src/VaultClient.ts:78
networkState
• Private networkState: NetworkState<LegalOfficerEndpoint>
Defined in
packages/client/src/VaultClient.ts:70
token
• Private token: string
Defined in
packages/client/src/VaultClient.ts:80
Methods
acceptVaultTransferRequest
▸ acceptVaultTransferRequest(legalOfficer, request): Promise<void>
Parameters
| Name | Type |
|---|---|
legalOfficer | LegalOfficer |
request | VaultTransferRequest |
Returns
Promise<void>
Defined in
packages/client/src/VaultClient.ts:185
cancelVaultTransferRequest
▸ cancelVaultTransferRequest(legalOfficer, request): Promise<void>
Parameters
| Name | Type |
|---|---|
legalOfficer | LegalOfficer |
request | VaultTransferRequest |
Returns
Promise<void>
Defined in
packages/client/src/VaultClient.ts:173
createVaultTransferRequest
▸ createVaultTransferRequest(legalOfficer, params): Promise<VaultTransferRequest>
Parameters
| Name | Type |
|---|---|
legalOfficer | LegalOfficer |
params | CreateVaultTransferRequest |
Returns
Promise<VaultTransferRequest>
Defined in
packages/client/src/VaultClient.ts:157
fetchAll
▸ fetchAll(legalOfficers?): Promise<FetchAllResult>
Parameters
| Name | Type |
|---|---|
legalOfficers? | LegalOfficer[] |
Returns
Promise<FetchAllResult>
Defined in
packages/client/src/VaultClient.ts:82
filterByStatuses
▸ filterByStatuses(requests, statuses): VaultTransferRequest[]
Parameters
| Name | Type |
|---|---|
requests | VaultTransferRequest[] |
statuses | VaultTransferRequestStatus[] |
Returns
Defined in
packages/client/src/VaultClient.ts:153
getVaultTransferRequests
▸ getVaultTransferRequests(axios, legalOfficerAddress, fetch): Promise<VaultTransferRequest[]>
Parameters
| Name | Type |
|---|---|
axios | AxiosInstance |
legalOfficerAddress | string |
fetch | FetchVaultTransferRequest |
Returns
Promise<VaultTransferRequest[]>
Defined in
packages/client/src/VaultClient.ts:140
rejectVaultTransferRequest
▸ rejectVaultTransferRequest(legalOfficer, request, rejectReason): Promise<void>
Parameters
| Name | Type |
|---|---|
legalOfficer | LegalOfficer |
request | VaultTransferRequest |
rejectReason | string |
Returns
Promise<void>
Defined in
packages/client/src/VaultClient.ts:197
resubmitVaultTransferRequest
▸ resubmitVaultTransferRequest(legalOfficer, request): Promise<void>
Parameters
| Name | Type |
|---|---|
legalOfficer | LegalOfficer |
request | VaultTransferRequest |
Returns
Promise<void>