-
Notifications
You must be signed in to change notification settings - Fork 71
/
Transactions.ts
167 lines (139 loc) · 4.5 KB
/
Transactions.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
import { ChainType, IEquatableError, PromiseResult } from '@lens-protocol/shared-kernel';
import { Signature } from './Signature';
export type Nonce = number;
export enum TransactionKind {
APPROVE_MODULE = 'APPROVE_MODULE',
ACT_ON_PUBLICATION = 'ACT_ON_PUBLICATION',
BLOCK_PROFILE = 'BLOCK_PROFILE',
CREATE_COMMENT = 'CREATE_COMMENT',
CREATE_POST = 'CREATE_POST',
CREATE_PROFILE = 'CREATE_PROFILE',
CLAIM_HANDLE = 'CLAIM_HANDLE',
CREATE_QUOTE = 'CREATE_QUOTE',
FOLLOW_PROFILE = 'FOLLOW_PROFILE',
LINK_HANDLE = 'LINK_HANDLE',
MIRROR_PUBLICATION = 'MIRROR_PUBLICATION',
UNBLOCK_PROFILE = 'UNBLOCK_PROFILE',
UNFOLLOW_PROFILE = 'UNFOLLOW_PROFILE',
UNLINK_HANDLE = 'UNLINK_HANDLE',
UPDATE_FOLLOW_POLICY = 'UPDATE_FOLLOW_POLICY',
UPDATE_PROFILE_DETAILS = 'UPDATE_PROFILE_DETAILS',
UPDATE_PROFILE_MANAGERS = 'UPDATE_PROFILE_MANAGERS',
}
export const ProtocolTransactionKinds = [
TransactionKind.ACT_ON_PUBLICATION,
TransactionKind.BLOCK_PROFILE,
TransactionKind.UNFOLLOW_PROFILE,
TransactionKind.CLAIM_HANDLE,
TransactionKind.CREATE_COMMENT,
TransactionKind.CREATE_POST,
TransactionKind.CREATE_PROFILE,
TransactionKind.CREATE_QUOTE,
TransactionKind.FOLLOW_PROFILE,
TransactionKind.LINK_HANDLE,
TransactionKind.MIRROR_PUBLICATION,
TransactionKind.UNBLOCK_PROFILE,
TransactionKind.UNFOLLOW_PROFILE,
TransactionKind.UNLINK_HANDLE,
TransactionKind.UPDATE_FOLLOW_POLICY,
TransactionKind.UPDATE_PROFILE_DETAILS,
TransactionKind.UPDATE_PROFILE_MANAGERS,
] as const;
export type ProtocolTransactionKind = (typeof ProtocolTransactionKinds)[number];
export type ProtocolTransactionRequestModel = {
kind: ProtocolTransactionKind;
};
export type AnyTransactionRequestModel = {
kind: TransactionKind;
};
/**
* @internal
*/
export type PickByKind<T extends AnyTransactionRequestModel, K> = T extends {
kind: K;
}
? T
: never;
/**
* @internal
*/
export type JustProtocolRequest<T extends AnyTransactionRequestModel> = PickByKind<
T,
ProtocolTransactionKind
>;
export class UnsignedTransaction<T extends AnyTransactionRequestModel> {
constructor(readonly id: string, readonly chainType: ChainType, readonly request: T) {}
}
// TODO rename to UnsignedOperation
export interface IUnsignedProtocolCall<T extends ProtocolTransactionRequestModel> {
readonly id: string;
readonly request: T;
readonly nonce: Nonce;
}
// TODO rename to SignedOperation
export interface ISignedProtocolCall<T extends ProtocolTransactionRequestModel> {
readonly id: string;
readonly signature: Signature;
readonly request: T;
readonly nonce: Nonce;
}
export enum TransactionEvent {
BROADCASTED = 'BROADCASTED',
UPGRADED = 'UPGRADED',
SETTLED = 'SETTLED',
}
export abstract class MetaTransaction<T extends ProtocolTransactionRequestModel> {
abstract get chainType(): ChainType;
abstract get id(): string;
abstract get request(): T;
abstract get nonce(): Nonce;
abstract get hash(): string | null;
abstract waitNextEvent(): PromiseResult<TransactionEvent, TransactionError>;
}
export abstract class NativeTransaction<T extends AnyTransactionRequestModel> {
abstract get chainType(): ChainType;
abstract get id(): string;
abstract get request(): T;
abstract get hash(): string | null;
abstract waitNextEvent(): PromiseResult<TransactionEvent, TransactionError>;
}
export abstract class DataTransaction<T extends ProtocolTransactionRequestModel> {
abstract get id(): string;
abstract get request(): T;
abstract waitNextEvent(): PromiseResult<TransactionEvent, TransactionError>;
}
// TODO: move, this type might be a convenience type but not an entity per se
export type Transaction<T extends AnyTransactionRequestModel> =
| DataTransaction<JustProtocolRequest<T>>
| MetaTransaction<JustProtocolRequest<T>>
| NativeTransaction<T>;
/**
* The reason why a transaction failed.
*/
export enum TransactionErrorReason {
/**
* The tx was broadcasted but it was not indexed within the expected timeout
*/
INDEXING_TIMEOUT = 'INDEXING_TIMEOUT',
/**
* The tx was broadcasted but it was not mined within the expected timeout
*/
MINING_TIMEOUT = 'MINING_TIMEOUT',
/**
* The tx was reverted
*/
REVERTED = 'REVERTED',
/**
* A not recognized failure
*/
UNKNOWN = 'UNKNOWN',
}
/**
* An error that occurs when a transaction fails.
*/
export class TransactionError extends Error implements IEquatableError {
name = 'TransactionError' as const;
constructor(readonly reason: TransactionErrorReason) {
super(`Transaction failed due to: ${reason}`);
}
}