-
Notifications
You must be signed in to change notification settings - Fork 118
/
interface.ts
274 lines (253 loc) · 9.48 KB
/
interface.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
import { BigMapKeyType, MichelsonMap, MichelsonMapKey, Schema } from '@taquito/michelson-encoder';
import { SaplingDiffResponse } from '@taquito/rpc';
import { OperationBatch } from '../batch/rpc-batch-provider';
import { Context } from '../context';
import { DelegateOperation } from '../operations/delegate-operation';
import { OriginationOperation } from '../operations/origination-operation';
import { RegisterGlobalConstantOperation } from '../operations/register-global-constant-operation';
import { RevealOperation } from '../operations/reveal-operation';
import { TransactionOperation } from '../operations/transaction-operation';
import {
DelegateParams,
OriginateParams,
TransferParams,
RegisterDelegateParams,
ParamsWithKind,
RevealParams,
RegisterGlobalConstantParams,
IncreasePaidStorageParams,
TransferTicketParams,
DrainDelegateParams,
BallotParams,
ProposalsParams,
UpdateConsensusKeyParams,
SmartRollupAddMessagesParams,
SmartRollupOriginateParams,
} from '../operations/types';
import { ContractAbstraction, ContractStorageType, DefaultContractType } from './contract';
import { IncreasePaidStorageOperation } from '../operations/increase-paid-storage-operation';
import { TransferTicketOperation } from '../operations/transfer-ticket-operation';
import { DrainDelegateOperation } from '../operations';
import { BallotOperation } from '../operations';
import { ProposalsOperation } from '../operations/proposals-operation';
import { UpdateConsensusKeyOperation } from '../operations/update-consensus-key-operation';
import { SmartRollupAddMessagesOperation } from '../operations/smart-rollup-add-messages-operation';
import { SmartRollupOriginateOperation } from '../operations/smart-rollup-originate-operation';
export type ContractSchema = Schema | unknown;
export interface StorageProvider {
/**
*
* @description Return a well formatted json object of the contract storage
*
* @param contract contract address you want to get the storage from
* @param schema optional schema can either be the contract script rpc response or a michelson-encoder schema
*
* @see https://tezos.gitlab.io/api/rpc.html#get-block-id-context-contracts-contract-id-script
*/
getStorage<T>(contract: string, schema?: ContractSchema): Promise<T>;
/**
*
* @description Return a well formatted json object of the contract big map storage
*
* @param contract contract address you want to get the storage from
* @param key contract big map key to fetch value from
* @param schema optional schema can either be the contract script rpc response or a michelson-encoder schema
*
* @deprecated Deprecated in favor of getBigMapKeyByID
*
* @see https://tezos.gitlab.io/api/rpc.html#post-block-id-context-contracts-contract-id-big-map-get
*/
getBigMapKey<T>(contract: string, key: string, schema?: ContractSchema): Promise<T>;
/**
*
* @description Return a well formatted json object of a big map value
*
* @param id Big Map ID
* @param keyToEncode key to query (will be encoded properly according to the schema)
* @param schema Big Map schema (can be determined using your contract type)
* @param block optional block level to fetch the value from
*
* @see https://tezos.gitlab.io/api/rpc.html#get-block-id-context-big-maps-big-map-id-script-expr
*/
getBigMapKeyByID<T>(
id: string,
keyToEncode: BigMapKeyType,
schema: Schema,
block?: number
): Promise<T>;
/**
*
* @description Fetch multiple values in a big map
*
* @param id Big Map ID
* @param keysToEncode Array of keys to query (will be encoded properly according to the schema)
* @param schema Big Map schema (can be determined using your contract type)
* @param block optional block level to fetch the values from
* @param batchSize optional batch size representing the number of requests to execute in parallel
* @returns An object containing the keys queried in the big map and their value in a well-formatted JSON object format
*
*/
getBigMapKeysByID<T>(
id: string,
keysToEncode: Array<BigMapKeyType>,
schema: Schema,
block?: number,
batchSize?: number
): Promise<MichelsonMap<MichelsonMapKey, T | undefined>>;
/**
*
* @description Return a well formatted json object of a sapling state
*
* @param id Sapling state ID
* @param block optional block level to fetch the value from
*
*/
getSaplingDiffByID(id: string, block?: number): Promise<SaplingDiffResponse>;
}
export interface ContractProvider extends StorageProvider {
/**
*
* @description Originate a new contract according to the script in parameters. Will sign and inject an operation using the current context
*
* @returns An operation handle with the result from the rpc node
*
* @param OriginationOperation Originate operation parameter
*/
originate<TContract extends DefaultContractType = DefaultContractType>(
contract: OriginateParams<ContractStorageType<TContract>>
): Promise<OriginationOperation<TContract>>;
/**
*
* @description Set the delegate for a contract. Will sign and inject an operation using the current context
*
* @returns An operation handle with the result from the rpc node
*
* @param SetDelegate operation parameter
*/
setDelegate(params: DelegateParams): Promise<DelegateOperation>;
/**
*
* @description Register the current address as delegate. Will sign and inject an operation using the current context
*
* @returns An operation handle with the result from the rpc node
*
* @param RegisterDelegate operation parameter
*/
registerDelegate(params: RegisterDelegateParams): Promise<DelegateOperation>;
/**
*
* @description Transfer tz from current address to a specific address. Will sign and inject an operation using the current context
*
* @returns An operation handle with the result from the rpc node
*
* @param Transfer operation parameter
*/
transfer(params: TransferParams): Promise<TransactionOperation>;
/**
*
* @description Transfer tickets from an implicit account to a contract or another implicit account.
*
* @returns An operation handle with the result from the rpc node
*
* @param TransferTicket operation parameter
*/
transferTicket(params: TransferTicketParams): Promise<TransferTicketOperation>;
/**
*
* @description Reveal the current address. Will throw an error if the address is already revealed.
*
* @returns An operation handle with the result from the rpc node
*
* @param Reveal operation parameter
*/
reveal(params: RevealParams): Promise<RevealOperation>;
at<T extends ContractAbstraction<ContractProvider>>(
address: string,
contractAbstractionComposer?: (
abs: ContractAbstraction<ContractProvider>,
context: Context
) => T
): Promise<T>;
/**
*
* @description Batch a group of operation together. Operations will be applied in the order in which they are added to the batch
*
* @param params List of operation to batch together
*/
batch(params?: ParamsWithKind[]): OperationBatch;
/**
*
* @description Register a Micheline expression in a global table of constants. Will sign and inject an operation using the current context
*
* @returns An operation handle with the result from the rpc node
*
* @param params registerGlobalConstant operation parameter
*/
registerGlobalConstant(
params: RegisterGlobalConstantParams
): Promise<RegisterGlobalConstantOperation>;
/**
*
* @description Increase the amount of bytes in a smart contract storage by paying a fee
*
* @returns An operation handle with the result from the rpc node
*
* @param params IncreasePaidStorage operation parameter
*/
increasePaidStorage(params: IncreasePaidStorageParams): Promise<IncreasePaidStorageOperation>;
/**
*
* @description Submit a drain delegate operation
*
* @returns An operation handle with the result from the RPC node
*
* @param DrainDelegateParams DrainDelegate operation parameter
*/
drainDelegate(params: DrainDelegateParams): Promise<DrainDelegateOperation>;
/**
*
* @description Submit ballot for an ongoing proposal
*
* @returns An operation handle with the result from the RPC node
*
* @param BallotParams Ballot operation parameter
*/
ballot(params: BallotParams): Promise<BallotOperation>;
/**
*
* @description Submit proposal
*
* @returns An operation handle with the result from the RPC node
*
* @param ProposalsParams Proposals operation parameter
*/
proposals(params: ProposalsParams): Promise<ProposalsOperation>;
/**
*
* @description Update consensus key
*
* @returns An operation handle with the result from the RPC node
*
* @param UpdateConsensusKeyParams UpdateConsensusKey operation parameter
*/
updateConsensusKey(params: UpdateConsensusKeyParams): Promise<UpdateConsensusKeyOperation>;
/**
*
* @description Smart Rollup Add Messages
*
* @returns An operation handle with the result from the RPC node
*
* @param SmartRollupAddMessagesParams smartRollupAddMessages operation parameter
*/
smartRollupAddMessages(
params: SmartRollupAddMessagesParams
): Promise<SmartRollupAddMessagesOperation>;
/**
* @description Smart rollup originate
*
* @returns An operation handle with the result from the RPC node
*
* @param SmartRollupOriginateParams smartRollupOriginate operation parameter
*/
smartRollupOriginate(params: SmartRollupOriginateParams): Promise<SmartRollupOriginateOperation>;
}