Skip to content

Commit 04d96f2

Browse files
SyedAsadKazmiaelmanaa
SyedAsadKazmi
and
aelmanaa
authored
Add Events API Reference (smartcontractkit#3163)
* Add Events API Reference * Added Internal and FeeQuoter API References * Fix Events API Reference --------- Co-authored-by: Amine E. <[email protected]>
1 parent d62e233 commit 04d96f2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+6805
-7
lines changed

‎src/config/data/ccip/data.ts‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import {
55
Environment,
66
Version,
77
CCIPSendErrorEntry,
8+
CCIPEventEntry,
89
SupportedTokenConfig,
910
TokenMechanism,
1011
NetworkFees,
@@ -54,6 +55,18 @@ import * as errors_v1_6_1 from "./errors/v1_6_1/index.ts"
5455
import * as errors_v1_6_2 from "./errors/v1_6_2/index.ts"
5556
// eslint-disable-next-line camelcase
5657
import * as errors_v1_6_3 from "./errors/v1_6_3/index.ts"
58+
// eslint-disable-next-line camelcase
59+
import * as events_v1_5_0 from "./events/v1_5_0/index.ts"
60+
// eslint-disable-next-line camelcase
61+
import * as events_v1_5_1 from "./events/v1_5_1/index.ts"
62+
// eslint-disable-next-line camelcase
63+
import * as events_v1_6_0 from "./events/v1_6_0/index.ts"
64+
// eslint-disable-next-line camelcase
65+
import * as events_v1_6_1 from "./events/v1_6_1/index.ts"
66+
// eslint-disable-next-line camelcase
67+
import * as events_v1_6_2 from "./events/v1_6_2/index.ts"
68+
// eslint-disable-next-line camelcase
69+
import * as events_v1_6_3 from "./events/v1_6_3/index.ts"
5770

5871
export const getAllEnvironments = () => [Environment.Mainnet, Environment.Testnet]
5972
export const getAllVersions = () => [Version.V1_2_0]
@@ -106,6 +119,55 @@ export const errors: VersionedErrors = {
106119
v1_6_3: errors_v1_6_3 as ErrorTypesV163,
107120
}
108121

122+
// Type for v1.5.0 events
123+
type EventTypesV150 = {
124+
onrampCCIPSendEvents: CCIPEventEntry[]
125+
offrampCCIPReceiveEvents: CCIPEventEntry[]
126+
routerCCIPReceiveEvents: CCIPEventEntry[]
127+
poolCCIPSendEvents: CCIPEventEntry[]
128+
poolCCIPReceiveEvents: CCIPEventEntry[]
129+
}
130+
131+
// Type for v1.5.1 events
132+
type EventTypesV151 = EventTypesV150
133+
134+
// Type for v1.6.0 events
135+
type EventTypesV160 = EventTypesV151
136+
137+
// Type for v1.6.1 events
138+
type EventTypesV161 = EventTypesV160
139+
140+
// Type for v1.6.2 events
141+
type EventTypesV162 = EventTypesV161
142+
143+
// Type for v1.6.3 events
144+
type EventTypesV163 = EventTypesV162
145+
146+
type VersionedEvents = {
147+
v1_5_0: EventTypesV150
148+
v1_5_1: EventTypesV151
149+
v1_6_0: EventTypesV160
150+
v1_6_1: EventTypesV161
151+
v1_6_2: EventTypesV162
152+
v1_6_3: EventTypesV163
153+
}
154+
155+
// Export events by version with type safety
156+
export const events: VersionedEvents = {
157+
// eslint-disable-next-line camelcase
158+
v1_5_0: events_v1_5_0 as EventTypesV150,
159+
// eslint-disable-next-line camelcase
160+
v1_5_1: events_v1_5_1 as EventTypesV151,
161+
// eslint-disable-next-line camelcase
162+
v1_6_0: events_v1_6_0 as EventTypesV160,
163+
// eslint-disable-next-line camelcase
164+
v1_6_1: events_v1_6_1 as EventTypesV161,
165+
// eslint-disable-next-line camelcase
166+
v1_6_2: events_v1_6_2 as EventTypesV162,
167+
// eslint-disable-next-line camelcase
168+
v1_6_3: events_v1_6_3 as EventTypesV163,
169+
}
170+
109171
export const networkFees: NetworkFees = {
110172
tokenTransfers: {
111173
[TokenMechanism.LockAndUnlock]: {

‎src/config/data/ccip/events/v1_5_0/index.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
export { default as onrampCCIPSendEvents } from "./onramp-send.json"
2+
export { default as poolCCIPSendEvents } from "./pool-send.json"
3+
export { default as offrampCCIPReceiveEvents } from "./offramp-receive.json"
4+
export { default as routerCCIPReceiveEvents } from "./router-receive.json"
5+
export { default as poolCCIPReceiveEvents } from "./pool-receive.json"

‎src/config/data/ccip/events/v1_5_0/offramp-receive.json‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
[
2+
{
3+
"event": "ExecutionStateChanged",
4+
"parameters": [
5+
{
6+
"type": "uint64",
7+
"name": "sequenceNumber",
8+
"indexed": true
9+
},
10+
{
11+
"type": "bytes32",
12+
"name": "messageId",
13+
"indexed": true
14+
},
15+
{
16+
"type": "Internal.MessageExecutionState",
17+
"name": "state",
18+
"indexed": false,
19+
"typeLink": "/ccip/api-reference/evm/v1.5.0/internal#messageexecutionstate"
20+
},
21+
{
22+
"type": "bytes",
23+
"name": "returnData",
24+
"indexed": false
25+
}
26+
],
27+
"description": "Emitted when a message execution state changes to SUCCESS or FAILURE."
28+
}
29+
]

‎src/config/data/ccip/events/v1_5_0/onramp-send.json‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[
2+
{
3+
"event": "CCIPSendRequested",
4+
"parameters": [
5+
{
6+
"type": "Internal.EVM2EVMMessage",
7+
"name": "message",
8+
"indexed": false,
9+
"typeLink": "/ccip/api-reference/evm/v1.5.0/internal#evm2evmmessage"
10+
}
11+
],
12+
"description": "Emitted when a CCIP message is successfully sent."
13+
}
14+
]

‎src/config/data/ccip/events/v1_5_0/pool-receive.json‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
[
2+
{
3+
"event": "Released",
4+
"parameters": [
5+
{
6+
"type": "address",
7+
"name": "sender",
8+
"indexed": true
9+
},
10+
{
11+
"type": "address",
12+
"name": "recipient",
13+
"indexed": true
14+
},
15+
{
16+
"type": "uint256",
17+
"name": "amount",
18+
"indexed": false
19+
}
20+
],
21+
"description": "Emitted when tokens are released to the receiver on the destination chain."
22+
},
23+
{
24+
"event": "Minted",
25+
"parameters": [
26+
{
27+
"type": "address",
28+
"name": "sender",
29+
"indexed": true
30+
},
31+
{
32+
"type": "address",
33+
"name": "recipient",
34+
"indexed": true
35+
},
36+
{
37+
"type": "uint256",
38+
"name": "amount",
39+
"indexed": false
40+
}
41+
],
42+
"description": "Emitted when tokens are minted to the receiver on the destination chain."
43+
}
44+
]

‎src/config/data/ccip/events/v1_5_0/pool-send.json‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
[
2+
{
3+
"event": "Locked",
4+
"parameters": [
5+
{
6+
"type": "address",
7+
"name": "sender",
8+
"indexed": true
9+
},
10+
{
11+
"type": "uint256",
12+
"name": "amount",
13+
"indexed": false
14+
}
15+
],
16+
"description": "Emitted when tokens are locked during a cross-chain transfer."
17+
},
18+
{
19+
"event": "Burned",
20+
"parameters": [
21+
{
22+
"type": "address",
23+
"name": "sender",
24+
"indexed": true
25+
},
26+
{
27+
"type": "uint256",
28+
"name": "amount",
29+
"indexed": false
30+
}
31+
],
32+
"description": "Emitted when tokens are burned during a cross-chain transfer."
33+
}
34+
]

‎src/config/data/ccip/events/v1_5_0/router-receive.json‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
[
2+
{
3+
"event": "MessageExecuted",
4+
"parameters": [
5+
{
6+
"type": "bytes32",
7+
"name": "messageId",
8+
"indexed": false
9+
},
10+
{
11+
"type": "uint64",
12+
"name": "sourceChainSelector",
13+
"indexed": false
14+
},
15+
{
16+
"type": "address",
17+
"name": "offRamp",
18+
"indexed": false
19+
},
20+
{
21+
"type": "bytes32",
22+
"name": "calldataHash",
23+
"indexed": false
24+
}
25+
],
26+
"description": "Emitted when the Router successfully routes a message to the receiver."
27+
}
28+
]

‎src/config/data/ccip/events/v1_5_1/index.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
export { default as onrampCCIPSendEvents } from "./onramp-send.json"
2+
export { default as poolCCIPSendEvents } from "./pool-send.json"
3+
export { default as offrampCCIPReceiveEvents } from "./offramp-receive.json"
4+
export { default as routerCCIPReceiveEvents } from "./router-receive.json"
5+
export { default as poolCCIPReceiveEvents } from "./pool-receive.json"

‎src/config/data/ccip/events/v1_5_1/offramp-receive.json‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
[
2+
{
3+
"event": "ExecutionStateChanged",
4+
"parameters": [
5+
{
6+
"type": "uint64",
7+
"name": "sequenceNumber",
8+
"indexed": true
9+
},
10+
{
11+
"type": "bytes32",
12+
"name": "messageId",
13+
"indexed": true
14+
},
15+
{
16+
"type": "Internal.MessageExecutionState",
17+
"name": "state",
18+
"indexed": false,
19+
"typeLink": "/ccip/api-reference/evm/v1.5.1/internal#messageexecutionstate"
20+
},
21+
{
22+
"type": "bytes",
23+
"name": "returnData",
24+
"indexed": false
25+
}
26+
],
27+
"description": "Emitted when a message execution state changes to SUCCESS or FAILURE."
28+
}
29+
]

‎src/config/data/ccip/events/v1_5_1/onramp-send.json‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[
2+
{
3+
"event": "CCIPSendRequested",
4+
"parameters": [
5+
{
6+
"type": "Internal.EVM2EVMMessage",
7+
"name": "message",
8+
"indexed": false,
9+
"typeLink": "/ccip/api-reference/evm/v1.5.1/internal#evm2evmmessage"
10+
}
11+
],
12+
"description": "Emitted when a CCIP message is successfully sent."
13+
}
14+
]

0 commit comments

Comments
 (0)