@northstake/northstakeapi 1.0.17 → 1.0.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +2 -0
- package/api/validatorMarketplaceWebhooksApi.ts +1 -1
- package/api.ts +2 -0
- package/dist/api/validatorMarketplaceWebhooksApi.d.ts +1 -1
- package/dist/api/validatorMarketplaceWebhooksApi.js +1 -1
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/model/models.d.ts +2 -0
- package/dist/model/models.js +6 -0
- package/dist/model/rFQDocumentStatus.d.ts +1 -1
- package/dist/model/submittedQuote.d.ts +1 -0
- package/dist/model/submittedQuote.js +5 -0
- package/dist/model/webhookPayloadRFQBidAcceptedDetails.d.ts +1 -0
- package/dist/model/webhookPayloadRFQBidAcceptedDetails.js +5 -0
- package/dist/model/webhookPayloadRFQBidReceived.d.ts +2 -2
- package/dist/model/webhookPayloadRFQBidReceived.js +1 -1
- package/dist/model/webhookPayloadRFQBidReceivedDetails.d.ts +27 -0
- package/dist/model/webhookPayloadRFQBidReceivedDetails.js +38 -0
- package/dist/model/webhookPayloadRFQTransferProposalReceivedDetails.d.ts +1 -0
- package/dist/model/webhookPayloadRFQTransferProposalReceivedDetails.js +5 -0
- package/dist/model/webhookPayloadRFQValidatorWithdrawalChange.d.ts +2 -2
- package/dist/model/webhookPayloadRFQValidatorWithdrawalChange.js +1 -1
- package/dist/model/webhookPayloadRFQValidatorWithdrawalChangeDetails.d.ts +26 -0
- package/dist/model/webhookPayloadRFQValidatorWithdrawalChangeDetails.js +33 -0
- package/model/models.ts +10 -0
- package/model/rFQDocumentStatus.ts +2 -1
- package/model/submittedQuote.ts +6 -0
- package/model/webhookPayloadRFQBidAcceptedDetails.ts +6 -0
- package/model/webhookPayloadRFQBidReceived.ts +3 -3
- package/model/webhookPayloadRFQBidReceivedDetails.ts +43 -0
- package/model/webhookPayloadRFQTransferProposalReceivedDetails.ts +6 -0
- package/model/webhookPayloadRFQValidatorWithdrawalChange.ts +3 -3
- package/model/webhookPayloadRFQValidatorWithdrawalChangeDetails.ts +37 -0
- package/package.json +2 -2
package/.openapi-generator/FILES
CHANGED
|
@@ -92,6 +92,7 @@ model/webhookPayloadRFQAvailable.ts
|
|
|
92
92
|
model/webhookPayloadRFQBidAccepted.ts
|
|
93
93
|
model/webhookPayloadRFQBidAcceptedDetails.ts
|
|
94
94
|
model/webhookPayloadRFQBidReceived.ts
|
|
95
|
+
model/webhookPayloadRFQBidReceivedDetails.ts
|
|
95
96
|
model/webhookPayloadRFQEscrowEvent.ts
|
|
96
97
|
model/webhookPayloadRFQEscrowEventDetails.ts
|
|
97
98
|
model/webhookPayloadRFQEscrowReleased.ts
|
|
@@ -101,6 +102,7 @@ model/webhookPayloadRFQTransferProposalReceivedDetails.ts
|
|
|
101
102
|
model/webhookPayloadRFQValidatorExited.ts
|
|
102
103
|
model/webhookPayloadRFQValidatorExitedDetails.ts
|
|
103
104
|
model/webhookPayloadRFQValidatorWithdrawalChange.ts
|
|
105
|
+
model/webhookPayloadRFQValidatorWithdrawalChangeDetails.ts
|
|
104
106
|
model/webhookRegistration.ts
|
|
105
107
|
model/webhookRegistrationDetails.ts
|
|
106
108
|
model/withdrawalRecipientSettlement.ts
|
|
@@ -264,7 +264,7 @@ export class ValidatorMarketplaceWebhooksApi {
|
|
|
264
264
|
} )
|
|
265
265
|
}
|
|
266
266
|
/**
|
|
267
|
-
* Registers a webhook URL for receiving push notifications from Northstake regarding events in the Validator Marketplace. When registered events occur, webhooks are triggered, and JSON payloads are sent as POST requests to the specified URL. A webhook can subscribe to different event types. Here are descriptions and example payloads for each supported event. These payloads are what will be POST\'ed to your Webhook endpoint. (For more details regarding webhook payloads, refer to the schemas for the WebhookPayload_XXXX types in documentation) - `RFQAvailable`: Triggered when a new RFQ document becomes available. The payload includes detailed information about validators, their balances, exit estimates, and other RFQ-specific details. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQAvailable\", \"details\": { \"id\": \"rfq123\", \"validators\": [ { \"validator_index\": 1, \"balance\": 32, \"exit_estimates\": [ { \"estimated_exit_time\": \"2025-03-01T12:00:00Z\", \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\", \"timestamp\": \"2024-03-01T12:00:00Z\" } ] } ], \"total_balance\": 32, \"payment_address\": \"0xabcd\", \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\", \"estimated_all_validators_exited_at\": \"2025-03-01T12:00:00Z\", \"unique_escrow_vault\": \"vault123\" } } ``` - `RFQBidReceived`: Triggered when a new bid is received on an RFQ. Includes the latest quote ID and the bid amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQBidReceived\", \"details\": { \"quote_id\": \"quote789\", \"amount\": 5000, \"timestamp\": \"2024-03-01T13:00:00Z\" } } ``` - `RFQBidAccepted`: Triggered when a bid is accepted. Includes the quote ID and the accepted amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQBidAccepted\", \"details\": { \"quote_id\": \"quote789\", \"amount\": 5000, \"timestamp\": \"2024-03-02T14:30:00Z\" } } ``` - `RFQEscrowEvent`: Triggered when an escrow payment is made. Includes transaction hash and payment amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQEscrowEvent\", \"details\": { \"transaction_hash\": \"0xabc123\", \"amount\": 5000, \"timestamp\": \"2024-03-03T15:45:00Z\" } } ``` - `RFQTransferProposalReceived`: Notifies an RFQ seller of a new transfer proposal on their RFQ ```json { \"document_id\": \"rfq123\", \"event\": \"RFQTransferProposalReceived\", \"details\": { \"transaction_hash\": \"0xabc123\", \"timestamp\": \"2024-03-03T15:45:00Z\" } } ``` - `RFQValidatorWithdrawalChange`: Triggered when a validator withdrawal status changes. Includes transaction hash and validator index. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQValidatorWithdrawalChange\", \"details\": [{ \"transaction_hash\": \"0xdef456\", \"validator_index\": 1, \"timestamp\": \"2024-03-04T16:50:00Z\" }, { \"transaction_hash\": \"0xdef457\", \"validator_index\": 2, \"timestamp\": \"2024-03-04T16:50:00Z\" }, { \"transaction_hash\": \"0xdef458\", \"validator_index\": 3, \"timestamp\": \"2024-03-04T16:50:00Z\" }, ] } ``` - `RFQEscrowReleased`: Triggered when escrow funds are released. Includes transaction hash and the released amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQEscrowReleased\", \"details\": { \"transaction_hash\": \"0xghi789\", \"amount\": 5000, \"timestamp\": \"2024-03-05T17:55:00Z\" } } ``` - `RFQValidatorExited `: Notifies the owner whenever a validator exits the ethereum network ```json { \"document_id\": \"rfq123\", \"event\": \"RFQValidatorExited\", \"details\": { \"validator_index\": \"0xghi789\", \"timestamp\": \"2024-03-05T17:55:00Z\" } } ``` **Webhook Security Note:** All webhook requests include a `Bearer` token in the `Authorization` header. Recipients must validate this token to ensure the notifications are from a trusted source.
|
|
267
|
+
* Registers a webhook URL for receiving push notifications from Northstake regarding events in the Validator Marketplace. When registered events occur, webhooks are triggered, and JSON payloads are sent as POST requests to the specified URL. A webhook can subscribe to different event types. Here are descriptions and example payloads for each supported event. These payloads are what will be POST\'ed to your Webhook endpoint. (For more details regarding webhook payloads, refer to the schemas for the WebhookPayload_XXXX types in documentation) - `RFQAvailable`: Triggered when a new RFQ document becomes available. The payload includes detailed information about validators, their balances, exit estimates, and other RFQ-specific details. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQAvailable\", \"details\": { \"id\": \"rfq123\", \"validators\": [ { \"validator_index\": 1, \"balance\": 32, \"exit_estimates\": [ { \"estimated_exit_time\": \"2025-03-01T12:00:00Z\", \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\", \"timestamp\": \"2024-03-01T12:00:00Z\" } ] } ], \"total_balance\": 32, \"payment_address\": \"0xabcd\", \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\", \"estimated_all_validators_exited_at\": \"2025-03-01T12:00:00Z\", \"unique_escrow_vault\": \"vault123\" } } ``` - `RFQBidReceived`: Triggered when a new bid is received on an RFQ. Includes the latest quote ID and the bid amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQBidReceived\", \"details\": { \"quote_id\": \"quote789\", \"amount\": 5000, \"timestamp\": \"2024-03-01T13:00:00Z\" } } ``` - `RFQBidAccepted`: Triggered when a bid is accepted. Includes the quote ID and the accepted amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQBidAccepted\", \"details\": { \"quote_id\": \"quote789\", \"amount\": 5000, \"timestamp\": \"2024-03-02T14:30:00Z\", \"escrow_address\": \"0x12345\" } } ``` - `RFQEscrowEvent`: Triggered when an escrow payment is made. Includes transaction hash and payment amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQEscrowEvent\", \"details\": { \"transaction_hash\": \"0xabc123\", \"amount\": 5000, \"timestamp\": \"2024-03-03T15:45:00Z\" } } ``` - `RFQTransferProposalReceived`: Notifies an RFQ seller of a new transfer proposal on their RFQ ```json { \"document_id\": \"rfq123\", \"event\": \"RFQTransferProposalReceived\", \"details\": { \"transaction_hash\": \"0xabc123\", \"timestamp\": \"2024-03-03T15:45:00Z\" \"proposal_id\": \"0x12345\"\" } } ``` - `RFQValidatorWithdrawalChange`: Triggered when a validator withdrawal status changes. Includes transaction hash and validator index. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQValidatorWithdrawalChange\", \"details\": [{ \"transaction_hash\": \"0xdef456\", \"validator_index\": 1, \"timestamp\": \"2024-03-04T16:50:00Z\" }, { \"transaction_hash\": \"0xdef457\", \"validator_index\": 2, \"timestamp\": \"2024-03-04T16:50:00Z\" }, { \"transaction_hash\": \"0xdef458\", \"validator_index\": 3, \"timestamp\": \"2024-03-04T16:50:00Z\" }, ] } ``` - `RFQEscrowReleased`: Triggered when escrow funds are released. Includes transaction hash and the released amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQEscrowReleased\", \"details\": { \"transaction_hash\": \"0xghi789\", \"amount\": 5000, \"timestamp\": \"2024-03-05T17:55:00Z\" } } ``` - `RFQValidatorExited `: Notifies the owner whenever a validator exits the ethereum network ```json { \"document_id\": \"rfq123\", \"event\": \"RFQValidatorExited\", \"details\": { \"validator_index\": \"0xghi789\", \"timestamp\": \"2024-03-05T17:55:00Z\" } } ``` **Webhook Security Note:** All webhook requests include a `Bearer` token in the `Authorization` header. Recipients must validate this token to ensure the notifications are from a trusted source.
|
|
268
268
|
* @summary Register a webhook to track Northstake validator marketplace events
|
|
269
269
|
* @param webhookRegistration
|
|
270
270
|
*/
|
package/api.ts
CHANGED
|
@@ -88,6 +88,7 @@ export * from './model/./webhookPayloadRFQAvailable';
|
|
|
88
88
|
export * from './model/./webhookPayloadRFQBidAccepted';
|
|
89
89
|
export * from './model/./webhookPayloadRFQBidAcceptedDetails';
|
|
90
90
|
export * from './model/./webhookPayloadRFQBidReceived';
|
|
91
|
+
export * from './model/./webhookPayloadRFQBidReceivedDetails';
|
|
91
92
|
export * from './model/./webhookPayloadRFQEscrowEvent';
|
|
92
93
|
export * from './model/./webhookPayloadRFQEscrowEventDetails';
|
|
93
94
|
export * from './model/./webhookPayloadRFQEscrowReleased';
|
|
@@ -97,6 +98,7 @@ export * from './model/./webhookPayloadRFQTransferProposalReceivedDetails';
|
|
|
97
98
|
export * from './model/./webhookPayloadRFQValidatorExited';
|
|
98
99
|
export * from './model/./webhookPayloadRFQValidatorExitedDetails';
|
|
99
100
|
export * from './model/./webhookPayloadRFQValidatorWithdrawalChange';
|
|
101
|
+
export * from './model/./webhookPayloadRFQValidatorWithdrawalChangeDetails';
|
|
100
102
|
export * from './model/./webhookRegistration';
|
|
101
103
|
export * from './model/./webhookRegistrationDetails';
|
|
102
104
|
export * from './model/./withdrawalRecipientSettlement';
|
|
@@ -62,7 +62,7 @@ export declare class ValidatorMarketplaceWebhooksApi {
|
|
|
62
62
|
status: number;
|
|
63
63
|
}>;
|
|
64
64
|
/**
|
|
65
|
-
* Registers a webhook URL for receiving push notifications from Northstake regarding events in the Validator Marketplace. When registered events occur, webhooks are triggered, and JSON payloads are sent as POST requests to the specified URL. A webhook can subscribe to different event types. Here are descriptions and example payloads for each supported event. These payloads are what will be POST\'ed to your Webhook endpoint. (For more details regarding webhook payloads, refer to the schemas for the WebhookPayload_XXXX types in documentation) - `RFQAvailable`: Triggered when a new RFQ document becomes available. The payload includes detailed information about validators, their balances, exit estimates, and other RFQ-specific details. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQAvailable\", \"details\": { \"id\": \"rfq123\", \"validators\": [ { \"validator_index\": 1, \"balance\": 32, \"exit_estimates\": [ { \"estimated_exit_time\": \"2025-03-01T12:00:00Z\", \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\", \"timestamp\": \"2024-03-01T12:00:00Z\" } ] } ], \"total_balance\": 32, \"payment_address\": \"0xabcd\", \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\", \"estimated_all_validators_exited_at\": \"2025-03-01T12:00:00Z\", \"unique_escrow_vault\": \"vault123\" } } ``` - `RFQBidReceived`: Triggered when a new bid is received on an RFQ. Includes the latest quote ID and the bid amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQBidReceived\", \"details\": { \"quote_id\": \"quote789\", \"amount\": 5000, \"timestamp\": \"2024-03-01T13:00:00Z\" } } ``` - `RFQBidAccepted`: Triggered when a bid is accepted. Includes the quote ID and the accepted amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQBidAccepted\", \"details\": { \"quote_id\": \"quote789\", \"amount\": 5000, \"timestamp\": \"2024-03-02T14:30:00Z\" } } ``` - `RFQEscrowEvent`: Triggered when an escrow payment is made. Includes transaction hash and payment amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQEscrowEvent\", \"details\": { \"transaction_hash\": \"0xabc123\", \"amount\": 5000, \"timestamp\": \"2024-03-03T15:45:00Z\" } } ``` - `RFQTransferProposalReceived`: Notifies an RFQ seller of a new transfer proposal on their RFQ ```json { \"document_id\": \"rfq123\", \"event\": \"RFQTransferProposalReceived\", \"details\": { \"transaction_hash\": \"0xabc123\", \"timestamp\": \"2024-03-03T15:45:00Z\" } } ``` - `RFQValidatorWithdrawalChange`: Triggered when a validator withdrawal status changes. Includes transaction hash and validator index. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQValidatorWithdrawalChange\", \"details\": [{ \"transaction_hash\": \"0xdef456\", \"validator_index\": 1, \"timestamp\": \"2024-03-04T16:50:00Z\" }, { \"transaction_hash\": \"0xdef457\", \"validator_index\": 2, \"timestamp\": \"2024-03-04T16:50:00Z\" }, { \"transaction_hash\": \"0xdef458\", \"validator_index\": 3, \"timestamp\": \"2024-03-04T16:50:00Z\" }, ] } ``` - `RFQEscrowReleased`: Triggered when escrow funds are released. Includes transaction hash and the released amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQEscrowReleased\", \"details\": { \"transaction_hash\": \"0xghi789\", \"amount\": 5000, \"timestamp\": \"2024-03-05T17:55:00Z\" } } ``` - `RFQValidatorExited `: Notifies the owner whenever a validator exits the ethereum network ```json { \"document_id\": \"rfq123\", \"event\": \"RFQValidatorExited\", \"details\": { \"validator_index\": \"0xghi789\", \"timestamp\": \"2024-03-05T17:55:00Z\" } } ``` **Webhook Security Note:** All webhook requests include a `Bearer` token in the `Authorization` header. Recipients must validate this token to ensure the notifications are from a trusted source.
|
|
65
|
+
* Registers a webhook URL for receiving push notifications from Northstake regarding events in the Validator Marketplace. When registered events occur, webhooks are triggered, and JSON payloads are sent as POST requests to the specified URL. A webhook can subscribe to different event types. Here are descriptions and example payloads for each supported event. These payloads are what will be POST\'ed to your Webhook endpoint. (For more details regarding webhook payloads, refer to the schemas for the WebhookPayload_XXXX types in documentation) - `RFQAvailable`: Triggered when a new RFQ document becomes available. The payload includes detailed information about validators, their balances, exit estimates, and other RFQ-specific details. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQAvailable\", \"details\": { \"id\": \"rfq123\", \"validators\": [ { \"validator_index\": 1, \"balance\": 32, \"exit_estimates\": [ { \"estimated_exit_time\": \"2025-03-01T12:00:00Z\", \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\", \"timestamp\": \"2024-03-01T12:00:00Z\" } ] } ], \"total_balance\": 32, \"payment_address\": \"0xabcd\", \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\", \"estimated_all_validators_exited_at\": \"2025-03-01T12:00:00Z\", \"unique_escrow_vault\": \"vault123\" } } ``` - `RFQBidReceived`: Triggered when a new bid is received on an RFQ. Includes the latest quote ID and the bid amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQBidReceived\", \"details\": { \"quote_id\": \"quote789\", \"amount\": 5000, \"timestamp\": \"2024-03-01T13:00:00Z\" } } ``` - `RFQBidAccepted`: Triggered when a bid is accepted. Includes the quote ID and the accepted amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQBidAccepted\", \"details\": { \"quote_id\": \"quote789\", \"amount\": 5000, \"timestamp\": \"2024-03-02T14:30:00Z\", \"escrow_address\": \"0x12345\" } } ``` - `RFQEscrowEvent`: Triggered when an escrow payment is made. Includes transaction hash and payment amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQEscrowEvent\", \"details\": { \"transaction_hash\": \"0xabc123\", \"amount\": 5000, \"timestamp\": \"2024-03-03T15:45:00Z\" } } ``` - `RFQTransferProposalReceived`: Notifies an RFQ seller of a new transfer proposal on their RFQ ```json { \"document_id\": \"rfq123\", \"event\": \"RFQTransferProposalReceived\", \"details\": { \"transaction_hash\": \"0xabc123\", \"timestamp\": \"2024-03-03T15:45:00Z\" \"proposal_id\": \"0x12345\"\" } } ``` - `RFQValidatorWithdrawalChange`: Triggered when a validator withdrawal status changes. Includes transaction hash and validator index. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQValidatorWithdrawalChange\", \"details\": [{ \"transaction_hash\": \"0xdef456\", \"validator_index\": 1, \"timestamp\": \"2024-03-04T16:50:00Z\" }, { \"transaction_hash\": \"0xdef457\", \"validator_index\": 2, \"timestamp\": \"2024-03-04T16:50:00Z\" }, { \"transaction_hash\": \"0xdef458\", \"validator_index\": 3, \"timestamp\": \"2024-03-04T16:50:00Z\" }, ] } ``` - `RFQEscrowReleased`: Triggered when escrow funds are released. Includes transaction hash and the released amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQEscrowReleased\", \"details\": { \"transaction_hash\": \"0xghi789\", \"amount\": 5000, \"timestamp\": \"2024-03-05T17:55:00Z\" } } ``` - `RFQValidatorExited `: Notifies the owner whenever a validator exits the ethereum network ```json { \"document_id\": \"rfq123\", \"event\": \"RFQValidatorExited\", \"details\": { \"validator_index\": \"0xghi789\", \"timestamp\": \"2024-03-05T17:55:00Z\" } } ``` **Webhook Security Note:** All webhook requests include a `Bearer` token in the `Authorization` header. Recipients must validate this token to ensure the notifications are from a trusted source.
|
|
66
66
|
* @summary Register a webhook to track Northstake validator marketplace events
|
|
67
67
|
* @param webhookRegistration
|
|
68
68
|
*/
|
|
@@ -203,7 +203,7 @@ class ValidatorMarketplaceWebhooksApi {
|
|
|
203
203
|
});
|
|
204
204
|
}
|
|
205
205
|
/**
|
|
206
|
-
* Registers a webhook URL for receiving push notifications from Northstake regarding events in the Validator Marketplace. When registered events occur, webhooks are triggered, and JSON payloads are sent as POST requests to the specified URL. A webhook can subscribe to different event types. Here are descriptions and example payloads for each supported event. These payloads are what will be POST\'ed to your Webhook endpoint. (For more details regarding webhook payloads, refer to the schemas for the WebhookPayload_XXXX types in documentation) - `RFQAvailable`: Triggered when a new RFQ document becomes available. The payload includes detailed information about validators, their balances, exit estimates, and other RFQ-specific details. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQAvailable\", \"details\": { \"id\": \"rfq123\", \"validators\": [ { \"validator_index\": 1, \"balance\": 32, \"exit_estimates\": [ { \"estimated_exit_time\": \"2025-03-01T12:00:00Z\", \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\", \"timestamp\": \"2024-03-01T12:00:00Z\" } ] } ], \"total_balance\": 32, \"payment_address\": \"0xabcd\", \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\", \"estimated_all_validators_exited_at\": \"2025-03-01T12:00:00Z\", \"unique_escrow_vault\": \"vault123\" } } ``` - `RFQBidReceived`: Triggered when a new bid is received on an RFQ. Includes the latest quote ID and the bid amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQBidReceived\", \"details\": { \"quote_id\": \"quote789\", \"amount\": 5000, \"timestamp\": \"2024-03-01T13:00:00Z\" } } ``` - `RFQBidAccepted`: Triggered when a bid is accepted. Includes the quote ID and the accepted amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQBidAccepted\", \"details\": { \"quote_id\": \"quote789\", \"amount\": 5000, \"timestamp\": \"2024-03-02T14:30:00Z\" } } ``` - `RFQEscrowEvent`: Triggered when an escrow payment is made. Includes transaction hash and payment amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQEscrowEvent\", \"details\": { \"transaction_hash\": \"0xabc123\", \"amount\": 5000, \"timestamp\": \"2024-03-03T15:45:00Z\" } } ``` - `RFQTransferProposalReceived`: Notifies an RFQ seller of a new transfer proposal on their RFQ ```json { \"document_id\": \"rfq123\", \"event\": \"RFQTransferProposalReceived\", \"details\": { \"transaction_hash\": \"0xabc123\", \"timestamp\": \"2024-03-03T15:45:00Z\" } } ``` - `RFQValidatorWithdrawalChange`: Triggered when a validator withdrawal status changes. Includes transaction hash and validator index. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQValidatorWithdrawalChange\", \"details\": [{ \"transaction_hash\": \"0xdef456\", \"validator_index\": 1, \"timestamp\": \"2024-03-04T16:50:00Z\" }, { \"transaction_hash\": \"0xdef457\", \"validator_index\": 2, \"timestamp\": \"2024-03-04T16:50:00Z\" }, { \"transaction_hash\": \"0xdef458\", \"validator_index\": 3, \"timestamp\": \"2024-03-04T16:50:00Z\" }, ] } ``` - `RFQEscrowReleased`: Triggered when escrow funds are released. Includes transaction hash and the released amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQEscrowReleased\", \"details\": { \"transaction_hash\": \"0xghi789\", \"amount\": 5000, \"timestamp\": \"2024-03-05T17:55:00Z\" } } ``` - `RFQValidatorExited `: Notifies the owner whenever a validator exits the ethereum network ```json { \"document_id\": \"rfq123\", \"event\": \"RFQValidatorExited\", \"details\": { \"validator_index\": \"0xghi789\", \"timestamp\": \"2024-03-05T17:55:00Z\" } } ``` **Webhook Security Note:** All webhook requests include a `Bearer` token in the `Authorization` header. Recipients must validate this token to ensure the notifications are from a trusted source.
|
|
206
|
+
* Registers a webhook URL for receiving push notifications from Northstake regarding events in the Validator Marketplace. When registered events occur, webhooks are triggered, and JSON payloads are sent as POST requests to the specified URL. A webhook can subscribe to different event types. Here are descriptions and example payloads for each supported event. These payloads are what will be POST\'ed to your Webhook endpoint. (For more details regarding webhook payloads, refer to the schemas for the WebhookPayload_XXXX types in documentation) - `RFQAvailable`: Triggered when a new RFQ document becomes available. The payload includes detailed information about validators, their balances, exit estimates, and other RFQ-specific details. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQAvailable\", \"details\": { \"id\": \"rfq123\", \"validators\": [ { \"validator_index\": 1, \"balance\": 32, \"exit_estimates\": [ { \"estimated_exit_time\": \"2025-03-01T12:00:00Z\", \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\", \"timestamp\": \"2024-03-01T12:00:00Z\" } ] } ], \"total_balance\": 32, \"payment_address\": \"0xabcd\", \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\", \"estimated_all_validators_exited_at\": \"2025-03-01T12:00:00Z\", \"unique_escrow_vault\": \"vault123\" } } ``` - `RFQBidReceived`: Triggered when a new bid is received on an RFQ. Includes the latest quote ID and the bid amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQBidReceived\", \"details\": { \"quote_id\": \"quote789\", \"amount\": 5000, \"timestamp\": \"2024-03-01T13:00:00Z\" } } ``` - `RFQBidAccepted`: Triggered when a bid is accepted. Includes the quote ID and the accepted amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQBidAccepted\", \"details\": { \"quote_id\": \"quote789\", \"amount\": 5000, \"timestamp\": \"2024-03-02T14:30:00Z\", \"escrow_address\": \"0x12345\" } } ``` - `RFQEscrowEvent`: Triggered when an escrow payment is made. Includes transaction hash and payment amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQEscrowEvent\", \"details\": { \"transaction_hash\": \"0xabc123\", \"amount\": 5000, \"timestamp\": \"2024-03-03T15:45:00Z\" } } ``` - `RFQTransferProposalReceived`: Notifies an RFQ seller of a new transfer proposal on their RFQ ```json { \"document_id\": \"rfq123\", \"event\": \"RFQTransferProposalReceived\", \"details\": { \"transaction_hash\": \"0xabc123\", \"timestamp\": \"2024-03-03T15:45:00Z\" \"proposal_id\": \"0x12345\"\" } } ``` - `RFQValidatorWithdrawalChange`: Triggered when a validator withdrawal status changes. Includes transaction hash and validator index. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQValidatorWithdrawalChange\", \"details\": [{ \"transaction_hash\": \"0xdef456\", \"validator_index\": 1, \"timestamp\": \"2024-03-04T16:50:00Z\" }, { \"transaction_hash\": \"0xdef457\", \"validator_index\": 2, \"timestamp\": \"2024-03-04T16:50:00Z\" }, { \"transaction_hash\": \"0xdef458\", \"validator_index\": 3, \"timestamp\": \"2024-03-04T16:50:00Z\" }, ] } ``` - `RFQEscrowReleased`: Triggered when escrow funds are released. Includes transaction hash and the released amount. ```json { \"document_id\": \"rfq123\", \"event\": \"RFQEscrowReleased\", \"details\": { \"transaction_hash\": \"0xghi789\", \"amount\": 5000, \"timestamp\": \"2024-03-05T17:55:00Z\" } } ``` - `RFQValidatorExited `: Notifies the owner whenever a validator exits the ethereum network ```json { \"document_id\": \"rfq123\", \"event\": \"RFQValidatorExited\", \"details\": { \"validator_index\": \"0xghi789\", \"timestamp\": \"2024-03-05T17:55:00Z\" } } ``` **Webhook Security Note:** All webhook requests include a `Bearer` token in the `Authorization` header. Recipients must validate this token to ensure the notifications are from a trusted source.
|
|
207
207
|
* @summary Register a webhook to track Northstake validator marketplace events
|
|
208
208
|
* @param webhookRegistration
|
|
209
209
|
*/
|
package/dist/api.d.ts
CHANGED
|
@@ -86,6 +86,7 @@ export * from './model/./webhookPayloadRFQAvailable';
|
|
|
86
86
|
export * from './model/./webhookPayloadRFQBidAccepted';
|
|
87
87
|
export * from './model/./webhookPayloadRFQBidAcceptedDetails';
|
|
88
88
|
export * from './model/./webhookPayloadRFQBidReceived';
|
|
89
|
+
export * from './model/./webhookPayloadRFQBidReceivedDetails';
|
|
89
90
|
export * from './model/./webhookPayloadRFQEscrowEvent';
|
|
90
91
|
export * from './model/./webhookPayloadRFQEscrowEventDetails';
|
|
91
92
|
export * from './model/./webhookPayloadRFQEscrowReleased';
|
|
@@ -95,6 +96,7 @@ export * from './model/./webhookPayloadRFQTransferProposalReceivedDetails';
|
|
|
95
96
|
export * from './model/./webhookPayloadRFQValidatorExited';
|
|
96
97
|
export * from './model/./webhookPayloadRFQValidatorExitedDetails';
|
|
97
98
|
export * from './model/./webhookPayloadRFQValidatorWithdrawalChange';
|
|
99
|
+
export * from './model/./webhookPayloadRFQValidatorWithdrawalChangeDetails';
|
|
98
100
|
export * from './model/./webhookRegistration';
|
|
99
101
|
export * from './model/./webhookRegistrationDetails';
|
|
100
102
|
export * from './model/./withdrawalRecipientSettlement';
|
package/dist/api.js
CHANGED
|
@@ -105,6 +105,7 @@ __exportStar(require("./model/./webhookPayloadRFQAvailable"), exports);
|
|
|
105
105
|
__exportStar(require("./model/./webhookPayloadRFQBidAccepted"), exports);
|
|
106
106
|
__exportStar(require("./model/./webhookPayloadRFQBidAcceptedDetails"), exports);
|
|
107
107
|
__exportStar(require("./model/./webhookPayloadRFQBidReceived"), exports);
|
|
108
|
+
__exportStar(require("./model/./webhookPayloadRFQBidReceivedDetails"), exports);
|
|
108
109
|
__exportStar(require("./model/./webhookPayloadRFQEscrowEvent"), exports);
|
|
109
110
|
__exportStar(require("./model/./webhookPayloadRFQEscrowEventDetails"), exports);
|
|
110
111
|
__exportStar(require("./model/./webhookPayloadRFQEscrowReleased"), exports);
|
|
@@ -114,6 +115,7 @@ __exportStar(require("./model/./webhookPayloadRFQTransferProposalReceivedDetails
|
|
|
114
115
|
__exportStar(require("./model/./webhookPayloadRFQValidatorExited"), exports);
|
|
115
116
|
__exportStar(require("./model/./webhookPayloadRFQValidatorExitedDetails"), exports);
|
|
116
117
|
__exportStar(require("./model/./webhookPayloadRFQValidatorWithdrawalChange"), exports);
|
|
118
|
+
__exportStar(require("./model/./webhookPayloadRFQValidatorWithdrawalChangeDetails"), exports);
|
|
117
119
|
__exportStar(require("./model/./webhookRegistration"), exports);
|
|
118
120
|
__exportStar(require("./model/./webhookRegistrationDetails"), exports);
|
|
119
121
|
__exportStar(require("./model/./withdrawalRecipientSettlement"), exports);
|
package/dist/model/models.d.ts
CHANGED
|
@@ -72,6 +72,7 @@ export * from './webhookPayloadRFQAvailable';
|
|
|
72
72
|
export * from './webhookPayloadRFQBidAccepted';
|
|
73
73
|
export * from './webhookPayloadRFQBidAcceptedDetails';
|
|
74
74
|
export * from './webhookPayloadRFQBidReceived';
|
|
75
|
+
export * from './webhookPayloadRFQBidReceivedDetails';
|
|
75
76
|
export * from './webhookPayloadRFQEscrowEvent';
|
|
76
77
|
export * from './webhookPayloadRFQEscrowEventDetails';
|
|
77
78
|
export * from './webhookPayloadRFQEscrowReleased';
|
|
@@ -81,6 +82,7 @@ export * from './webhookPayloadRFQTransferProposalReceivedDetails';
|
|
|
81
82
|
export * from './webhookPayloadRFQValidatorExited';
|
|
82
83
|
export * from './webhookPayloadRFQValidatorExitedDetails';
|
|
83
84
|
export * from './webhookPayloadRFQValidatorWithdrawalChange';
|
|
85
|
+
export * from './webhookPayloadRFQValidatorWithdrawalChangeDetails';
|
|
84
86
|
export * from './webhookRegistration';
|
|
85
87
|
export * from './webhookRegistrationDetails';
|
|
86
88
|
export * from './withdrawalRecipientSettlement';
|
package/dist/model/models.js
CHANGED
|
@@ -99,6 +99,7 @@ __exportStar(require("./webhookPayloadRFQAvailable"), exports);
|
|
|
99
99
|
__exportStar(require("./webhookPayloadRFQBidAccepted"), exports);
|
|
100
100
|
__exportStar(require("./webhookPayloadRFQBidAcceptedDetails"), exports);
|
|
101
101
|
__exportStar(require("./webhookPayloadRFQBidReceived"), exports);
|
|
102
|
+
__exportStar(require("./webhookPayloadRFQBidReceivedDetails"), exports);
|
|
102
103
|
__exportStar(require("./webhookPayloadRFQEscrowEvent"), exports);
|
|
103
104
|
__exportStar(require("./webhookPayloadRFQEscrowEventDetails"), exports);
|
|
104
105
|
__exportStar(require("./webhookPayloadRFQEscrowReleased"), exports);
|
|
@@ -108,6 +109,7 @@ __exportStar(require("./webhookPayloadRFQTransferProposalReceivedDetails"), expo
|
|
|
108
109
|
__exportStar(require("./webhookPayloadRFQValidatorExited"), exports);
|
|
109
110
|
__exportStar(require("./webhookPayloadRFQValidatorExitedDetails"), exports);
|
|
110
111
|
__exportStar(require("./webhookPayloadRFQValidatorWithdrawalChange"), exports);
|
|
112
|
+
__exportStar(require("./webhookPayloadRFQValidatorWithdrawalChangeDetails"), exports);
|
|
111
113
|
__exportStar(require("./webhookRegistration"), exports);
|
|
112
114
|
__exportStar(require("./webhookRegistrationDetails"), exports);
|
|
113
115
|
__exportStar(require("./withdrawalRecipientSettlement"), exports);
|
|
@@ -174,6 +176,7 @@ const webhookPayloadRFQAvailable_1 = require("./webhookPayloadRFQAvailable");
|
|
|
174
176
|
const webhookPayloadRFQBidAccepted_1 = require("./webhookPayloadRFQBidAccepted");
|
|
175
177
|
const webhookPayloadRFQBidAcceptedDetails_1 = require("./webhookPayloadRFQBidAcceptedDetails");
|
|
176
178
|
const webhookPayloadRFQBidReceived_1 = require("./webhookPayloadRFQBidReceived");
|
|
179
|
+
const webhookPayloadRFQBidReceivedDetails_1 = require("./webhookPayloadRFQBidReceivedDetails");
|
|
177
180
|
const webhookPayloadRFQEscrowEvent_1 = require("./webhookPayloadRFQEscrowEvent");
|
|
178
181
|
const webhookPayloadRFQEscrowEventDetails_1 = require("./webhookPayloadRFQEscrowEventDetails");
|
|
179
182
|
const webhookPayloadRFQEscrowReleased_1 = require("./webhookPayloadRFQEscrowReleased");
|
|
@@ -183,6 +186,7 @@ const webhookPayloadRFQTransferProposalReceivedDetails_1 = require("./webhookPay
|
|
|
183
186
|
const webhookPayloadRFQValidatorExited_1 = require("./webhookPayloadRFQValidatorExited");
|
|
184
187
|
const webhookPayloadRFQValidatorExitedDetails_1 = require("./webhookPayloadRFQValidatorExitedDetails");
|
|
185
188
|
const webhookPayloadRFQValidatorWithdrawalChange_1 = require("./webhookPayloadRFQValidatorWithdrawalChange");
|
|
189
|
+
const webhookPayloadRFQValidatorWithdrawalChangeDetails_1 = require("./webhookPayloadRFQValidatorWithdrawalChangeDetails");
|
|
186
190
|
const webhookRegistration_1 = require("./webhookRegistration");
|
|
187
191
|
const webhookRegistrationDetails_1 = require("./webhookRegistrationDetails");
|
|
188
192
|
const withdrawalRecipientSettlement_1 = require("./withdrawalRecipientSettlement");
|
|
@@ -266,6 +270,7 @@ let typeMap = {
|
|
|
266
270
|
"WebhookPayloadRFQBidAccepted": webhookPayloadRFQBidAccepted_1.WebhookPayloadRFQBidAccepted,
|
|
267
271
|
"WebhookPayloadRFQBidAcceptedDetails": webhookPayloadRFQBidAcceptedDetails_1.WebhookPayloadRFQBidAcceptedDetails,
|
|
268
272
|
"WebhookPayloadRFQBidReceived": webhookPayloadRFQBidReceived_1.WebhookPayloadRFQBidReceived,
|
|
273
|
+
"WebhookPayloadRFQBidReceivedDetails": webhookPayloadRFQBidReceivedDetails_1.WebhookPayloadRFQBidReceivedDetails,
|
|
269
274
|
"WebhookPayloadRFQEscrowEvent": webhookPayloadRFQEscrowEvent_1.WebhookPayloadRFQEscrowEvent,
|
|
270
275
|
"WebhookPayloadRFQEscrowEventDetails": webhookPayloadRFQEscrowEventDetails_1.WebhookPayloadRFQEscrowEventDetails,
|
|
271
276
|
"WebhookPayloadRFQEscrowReleased": webhookPayloadRFQEscrowReleased_1.WebhookPayloadRFQEscrowReleased,
|
|
@@ -275,6 +280,7 @@ let typeMap = {
|
|
|
275
280
|
"WebhookPayloadRFQValidatorExited": webhookPayloadRFQValidatorExited_1.WebhookPayloadRFQValidatorExited,
|
|
276
281
|
"WebhookPayloadRFQValidatorExitedDetails": webhookPayloadRFQValidatorExitedDetails_1.WebhookPayloadRFQValidatorExitedDetails,
|
|
277
282
|
"WebhookPayloadRFQValidatorWithdrawalChange": webhookPayloadRFQValidatorWithdrawalChange_1.WebhookPayloadRFQValidatorWithdrawalChange,
|
|
283
|
+
"WebhookPayloadRFQValidatorWithdrawalChangeDetails": webhookPayloadRFQValidatorWithdrawalChangeDetails_1.WebhookPayloadRFQValidatorWithdrawalChangeDetails,
|
|
278
284
|
"WebhookRegistration": webhookRegistration_1.WebhookRegistration,
|
|
279
285
|
"WebhookRegistrationDetails": webhookRegistrationDetails_1.WebhookRegistrationDetails,
|
|
280
286
|
"WithdrawalRecipientSettlement": withdrawalRecipientSettlement_1.WithdrawalRecipientSettlement,
|
|
@@ -10,11 +10,11 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import { RFQWebhookEventType } from './rFQWebhookEventType';
|
|
13
|
-
import {
|
|
13
|
+
import { WebhookPayloadRFQBidReceivedDetails } from './webhookPayloadRFQBidReceivedDetails';
|
|
14
14
|
export declare class WebhookPayloadRFQBidReceived {
|
|
15
15
|
'document_id'?: string;
|
|
16
16
|
'event'?: RFQWebhookEventType;
|
|
17
|
-
'details'?:
|
|
17
|
+
'details'?: WebhookPayloadRFQBidReceivedDetails;
|
|
18
18
|
static discriminator: string | undefined;
|
|
19
19
|
static attributeTypeMap: Array<{
|
|
20
20
|
name: string;
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Northstake
|
|
3
|
+
* Northstake api
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export declare class WebhookPayloadRFQBidReceivedDetails {
|
|
13
|
+
'quote_id'?: string;
|
|
14
|
+
'amount'?: number;
|
|
15
|
+
'timestamp'?: Date;
|
|
16
|
+
static discriminator: string | undefined;
|
|
17
|
+
static attributeTypeMap: Array<{
|
|
18
|
+
name: string;
|
|
19
|
+
baseName: string;
|
|
20
|
+
type: string;
|
|
21
|
+
}>;
|
|
22
|
+
static getAttributeTypeMap(): {
|
|
23
|
+
name: string;
|
|
24
|
+
baseName: string;
|
|
25
|
+
type: string;
|
|
26
|
+
}[];
|
|
27
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Northstake
|
|
4
|
+
* Northstake api
|
|
5
|
+
*
|
|
6
|
+
* The version of the OpenAPI document: 1.0
|
|
7
|
+
*
|
|
8
|
+
*
|
|
9
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
10
|
+
* https://openapi-generator.tech
|
|
11
|
+
* Do not edit the class manually.
|
|
12
|
+
*/
|
|
13
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
14
|
+
exports.WebhookPayloadRFQBidReceivedDetails = void 0;
|
|
15
|
+
class WebhookPayloadRFQBidReceivedDetails {
|
|
16
|
+
static getAttributeTypeMap() {
|
|
17
|
+
return WebhookPayloadRFQBidReceivedDetails.attributeTypeMap;
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
exports.WebhookPayloadRFQBidReceivedDetails = WebhookPayloadRFQBidReceivedDetails;
|
|
21
|
+
WebhookPayloadRFQBidReceivedDetails.discriminator = undefined;
|
|
22
|
+
WebhookPayloadRFQBidReceivedDetails.attributeTypeMap = [
|
|
23
|
+
{
|
|
24
|
+
"name": "quote_id",
|
|
25
|
+
"baseName": "quote_id",
|
|
26
|
+
"type": "string"
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
"name": "amount",
|
|
30
|
+
"baseName": "amount",
|
|
31
|
+
"type": "number"
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"name": "timestamp",
|
|
35
|
+
"baseName": "timestamp",
|
|
36
|
+
"type": "Date"
|
|
37
|
+
}
|
|
38
|
+
];
|
|
@@ -10,11 +10,11 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import { RFQWebhookEventType } from './rFQWebhookEventType';
|
|
13
|
-
import {
|
|
13
|
+
import { WebhookPayloadRFQValidatorWithdrawalChangeDetails } from './webhookPayloadRFQValidatorWithdrawalChangeDetails';
|
|
14
14
|
export declare class WebhookPayloadRFQValidatorWithdrawalChange {
|
|
15
15
|
'document_id'?: string;
|
|
16
16
|
'event'?: RFQWebhookEventType;
|
|
17
|
-
'details'?:
|
|
17
|
+
'details'?: WebhookPayloadRFQValidatorWithdrawalChangeDetails;
|
|
18
18
|
static discriminator: string | undefined;
|
|
19
19
|
static attributeTypeMap: Array<{
|
|
20
20
|
name: string;
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Northstake
|
|
3
|
+
* Northstake api
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export declare class WebhookPayloadRFQValidatorWithdrawalChangeDetails {
|
|
13
|
+
'timestamp'?: Date;
|
|
14
|
+
'transaction_hash'?: string;
|
|
15
|
+
static discriminator: string | undefined;
|
|
16
|
+
static attributeTypeMap: Array<{
|
|
17
|
+
name: string;
|
|
18
|
+
baseName: string;
|
|
19
|
+
type: string;
|
|
20
|
+
}>;
|
|
21
|
+
static getAttributeTypeMap(): {
|
|
22
|
+
name: string;
|
|
23
|
+
baseName: string;
|
|
24
|
+
type: string;
|
|
25
|
+
}[];
|
|
26
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Northstake
|
|
4
|
+
* Northstake api
|
|
5
|
+
*
|
|
6
|
+
* The version of the OpenAPI document: 1.0
|
|
7
|
+
*
|
|
8
|
+
*
|
|
9
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
10
|
+
* https://openapi-generator.tech
|
|
11
|
+
* Do not edit the class manually.
|
|
12
|
+
*/
|
|
13
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
14
|
+
exports.WebhookPayloadRFQValidatorWithdrawalChangeDetails = void 0;
|
|
15
|
+
class WebhookPayloadRFQValidatorWithdrawalChangeDetails {
|
|
16
|
+
static getAttributeTypeMap() {
|
|
17
|
+
return WebhookPayloadRFQValidatorWithdrawalChangeDetails.attributeTypeMap;
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
exports.WebhookPayloadRFQValidatorWithdrawalChangeDetails = WebhookPayloadRFQValidatorWithdrawalChangeDetails;
|
|
21
|
+
WebhookPayloadRFQValidatorWithdrawalChangeDetails.discriminator = undefined;
|
|
22
|
+
WebhookPayloadRFQValidatorWithdrawalChangeDetails.attributeTypeMap = [
|
|
23
|
+
{
|
|
24
|
+
"name": "timestamp",
|
|
25
|
+
"baseName": "timestamp",
|
|
26
|
+
"type": "Date"
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
"name": "transaction_hash",
|
|
30
|
+
"baseName": "transaction_hash",
|
|
31
|
+
"type": "string"
|
|
32
|
+
}
|
|
33
|
+
];
|
package/model/models.ts
CHANGED
|
@@ -73,6 +73,7 @@ export * from './webhookPayloadRFQAvailable';
|
|
|
73
73
|
export * from './webhookPayloadRFQBidAccepted';
|
|
74
74
|
export * from './webhookPayloadRFQBidAcceptedDetails';
|
|
75
75
|
export * from './webhookPayloadRFQBidReceived';
|
|
76
|
+
export * from './webhookPayloadRFQBidReceivedDetails';
|
|
76
77
|
export * from './webhookPayloadRFQEscrowEvent';
|
|
77
78
|
export * from './webhookPayloadRFQEscrowEventDetails';
|
|
78
79
|
export * from './webhookPayloadRFQEscrowReleased';
|
|
@@ -82,6 +83,7 @@ export * from './webhookPayloadRFQTransferProposalReceivedDetails';
|
|
|
82
83
|
export * from './webhookPayloadRFQValidatorExited';
|
|
83
84
|
export * from './webhookPayloadRFQValidatorExitedDetails';
|
|
84
85
|
export * from './webhookPayloadRFQValidatorWithdrawalChange';
|
|
86
|
+
export * from './webhookPayloadRFQValidatorWithdrawalChangeDetails';
|
|
85
87
|
export * from './webhookRegistration';
|
|
86
88
|
export * from './webhookRegistrationDetails';
|
|
87
89
|
export * from './withdrawalRecipientSettlement';
|
|
@@ -315,6 +317,9 @@ import { WebhookPayloadRFQBidAcceptedDetails } from './webhookPayloadRFQBidAccep
|
|
|
315
317
|
import { WebhookPayloadRFQBidReceived } from './webhookPayloadRFQBidReceived';
|
|
316
318
|
|
|
317
319
|
|
|
320
|
+
import { WebhookPayloadRFQBidReceivedDetails } from './webhookPayloadRFQBidReceivedDetails';
|
|
321
|
+
|
|
322
|
+
|
|
318
323
|
import { WebhookPayloadRFQEscrowEvent } from './webhookPayloadRFQEscrowEvent';
|
|
319
324
|
|
|
320
325
|
|
|
@@ -342,6 +347,9 @@ import { WebhookPayloadRFQValidatorExitedDetails } from './webhookPayloadRFQVali
|
|
|
342
347
|
import { WebhookPayloadRFQValidatorWithdrawalChange } from './webhookPayloadRFQValidatorWithdrawalChange';
|
|
343
348
|
|
|
344
349
|
|
|
350
|
+
import { WebhookPayloadRFQValidatorWithdrawalChangeDetails } from './webhookPayloadRFQValidatorWithdrawalChangeDetails';
|
|
351
|
+
|
|
352
|
+
|
|
345
353
|
import { WebhookRegistration } from './webhookRegistration';
|
|
346
354
|
|
|
347
355
|
|
|
@@ -439,6 +447,7 @@ let typeMap: {[index: string]: any} = {
|
|
|
439
447
|
"WebhookPayloadRFQBidAccepted": WebhookPayloadRFQBidAccepted,
|
|
440
448
|
"WebhookPayloadRFQBidAcceptedDetails": WebhookPayloadRFQBidAcceptedDetails,
|
|
441
449
|
"WebhookPayloadRFQBidReceived": WebhookPayloadRFQBidReceived,
|
|
450
|
+
"WebhookPayloadRFQBidReceivedDetails": WebhookPayloadRFQBidReceivedDetails,
|
|
442
451
|
"WebhookPayloadRFQEscrowEvent": WebhookPayloadRFQEscrowEvent,
|
|
443
452
|
"WebhookPayloadRFQEscrowEventDetails": WebhookPayloadRFQEscrowEventDetails,
|
|
444
453
|
"WebhookPayloadRFQEscrowReleased": WebhookPayloadRFQEscrowReleased,
|
|
@@ -448,6 +457,7 @@ let typeMap: {[index: string]: any} = {
|
|
|
448
457
|
"WebhookPayloadRFQValidatorExited": WebhookPayloadRFQValidatorExited,
|
|
449
458
|
"WebhookPayloadRFQValidatorExitedDetails": WebhookPayloadRFQValidatorExitedDetails,
|
|
450
459
|
"WebhookPayloadRFQValidatorWithdrawalChange": WebhookPayloadRFQValidatorWithdrawalChange,
|
|
460
|
+
"WebhookPayloadRFQValidatorWithdrawalChangeDetails": WebhookPayloadRFQValidatorWithdrawalChangeDetails,
|
|
451
461
|
"WebhookRegistration": WebhookRegistration,
|
|
452
462
|
"WebhookRegistrationDetails": WebhookRegistrationDetails,
|
|
453
463
|
"WithdrawalRecipientSettlement": WithdrawalRecipientSettlement,
|
package/model/submittedQuote.ts
CHANGED
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
|
|
14
14
|
export class SubmittedQuote {
|
|
15
15
|
'eth_amount': number;
|
|
16
|
+
'wallet_id': string;
|
|
16
17
|
|
|
17
18
|
static discriminator: string | undefined = undefined;
|
|
18
19
|
|
|
@@ -21,6 +22,11 @@ export class SubmittedQuote {
|
|
|
21
22
|
"name": "eth_amount",
|
|
22
23
|
"baseName": "eth_amount",
|
|
23
24
|
"type": "number"
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
"name": "wallet_id",
|
|
28
|
+
"baseName": "wallet_id",
|
|
29
|
+
"type": "string"
|
|
24
30
|
} ];
|
|
25
31
|
|
|
26
32
|
static getAttributeTypeMap() {
|
|
@@ -15,6 +15,7 @@ export class WebhookPayloadRFQBidAcceptedDetails {
|
|
|
15
15
|
'quote_id'?: string;
|
|
16
16
|
'amount'?: number;
|
|
17
17
|
'timestamp'?: Date;
|
|
18
|
+
'escrow_address'?: string;
|
|
18
19
|
|
|
19
20
|
static discriminator: string | undefined = undefined;
|
|
20
21
|
|
|
@@ -33,6 +34,11 @@ export class WebhookPayloadRFQBidAcceptedDetails {
|
|
|
33
34
|
"name": "timestamp",
|
|
34
35
|
"baseName": "timestamp",
|
|
35
36
|
"type": "Date"
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"name": "escrow_address",
|
|
40
|
+
"baseName": "escrow_address",
|
|
41
|
+
"type": "string"
|
|
36
42
|
} ];
|
|
37
43
|
|
|
38
44
|
static getAttributeTypeMap() {
|
|
@@ -11,12 +11,12 @@
|
|
|
11
11
|
*/
|
|
12
12
|
|
|
13
13
|
import { RFQWebhookEventType } from './rFQWebhookEventType';
|
|
14
|
-
import {
|
|
14
|
+
import { WebhookPayloadRFQBidReceivedDetails } from './webhookPayloadRFQBidReceivedDetails';
|
|
15
15
|
|
|
16
16
|
export class WebhookPayloadRFQBidReceived {
|
|
17
17
|
'document_id'?: string;
|
|
18
18
|
'event'?: RFQWebhookEventType;
|
|
19
|
-
'details'?:
|
|
19
|
+
'details'?: WebhookPayloadRFQBidReceivedDetails;
|
|
20
20
|
|
|
21
21
|
static discriminator: string | undefined = undefined;
|
|
22
22
|
|
|
@@ -34,7 +34,7 @@ export class WebhookPayloadRFQBidReceived {
|
|
|
34
34
|
{
|
|
35
35
|
"name": "details",
|
|
36
36
|
"baseName": "details",
|
|
37
|
-
"type": "
|
|
37
|
+
"type": "WebhookPayloadRFQBidReceivedDetails"
|
|
38
38
|
} ];
|
|
39
39
|
|
|
40
40
|
static getAttributeTypeMap() {
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Northstake
|
|
3
|
+
* Northstake api
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
export class WebhookPayloadRFQBidReceivedDetails {
|
|
15
|
+
'quote_id'?: string;
|
|
16
|
+
'amount'?: number;
|
|
17
|
+
'timestamp'?: Date;
|
|
18
|
+
|
|
19
|
+
static discriminator: string | undefined = undefined;
|
|
20
|
+
|
|
21
|
+
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
|
22
|
+
{
|
|
23
|
+
"name": "quote_id",
|
|
24
|
+
"baseName": "quote_id",
|
|
25
|
+
"type": "string"
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"name": "amount",
|
|
29
|
+
"baseName": "amount",
|
|
30
|
+
"type": "number"
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"name": "timestamp",
|
|
34
|
+
"baseName": "timestamp",
|
|
35
|
+
"type": "Date"
|
|
36
|
+
} ];
|
|
37
|
+
|
|
38
|
+
static getAttributeTypeMap() {
|
|
39
|
+
return WebhookPayloadRFQBidReceivedDetails.attributeTypeMap;
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
|
|
@@ -14,6 +14,7 @@
|
|
|
14
14
|
export class WebhookPayloadRFQTransferProposalReceivedDetails {
|
|
15
15
|
'timestamp'?: Date;
|
|
16
16
|
'transaction_hash'?: string;
|
|
17
|
+
'proposal_id'?: string;
|
|
17
18
|
|
|
18
19
|
static discriminator: string | undefined = undefined;
|
|
19
20
|
|
|
@@ -27,6 +28,11 @@ export class WebhookPayloadRFQTransferProposalReceivedDetails {
|
|
|
27
28
|
"name": "transaction_hash",
|
|
28
29
|
"baseName": "transaction_hash",
|
|
29
30
|
"type": "string"
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"name": "proposal_id",
|
|
34
|
+
"baseName": "proposal_id",
|
|
35
|
+
"type": "string"
|
|
30
36
|
} ];
|
|
31
37
|
|
|
32
38
|
static getAttributeTypeMap() {
|
|
@@ -11,12 +11,12 @@
|
|
|
11
11
|
*/
|
|
12
12
|
|
|
13
13
|
import { RFQWebhookEventType } from './rFQWebhookEventType';
|
|
14
|
-
import {
|
|
14
|
+
import { WebhookPayloadRFQValidatorWithdrawalChangeDetails } from './webhookPayloadRFQValidatorWithdrawalChangeDetails';
|
|
15
15
|
|
|
16
16
|
export class WebhookPayloadRFQValidatorWithdrawalChange {
|
|
17
17
|
'document_id'?: string;
|
|
18
18
|
'event'?: RFQWebhookEventType;
|
|
19
|
-
'details'?:
|
|
19
|
+
'details'?: WebhookPayloadRFQValidatorWithdrawalChangeDetails;
|
|
20
20
|
|
|
21
21
|
static discriminator: string | undefined = undefined;
|
|
22
22
|
|
|
@@ -34,7 +34,7 @@ export class WebhookPayloadRFQValidatorWithdrawalChange {
|
|
|
34
34
|
{
|
|
35
35
|
"name": "details",
|
|
36
36
|
"baseName": "details",
|
|
37
|
-
"type": "
|
|
37
|
+
"type": "WebhookPayloadRFQValidatorWithdrawalChangeDetails"
|
|
38
38
|
} ];
|
|
39
39
|
|
|
40
40
|
static getAttributeTypeMap() {
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Northstake
|
|
3
|
+
* Northstake api
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
export class WebhookPayloadRFQValidatorWithdrawalChangeDetails {
|
|
15
|
+
'timestamp'?: Date;
|
|
16
|
+
'transaction_hash'?: string;
|
|
17
|
+
|
|
18
|
+
static discriminator: string | undefined = undefined;
|
|
19
|
+
|
|
20
|
+
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
|
21
|
+
{
|
|
22
|
+
"name": "timestamp",
|
|
23
|
+
"baseName": "timestamp",
|
|
24
|
+
"type": "Date"
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
"name": "transaction_hash",
|
|
28
|
+
"baseName": "transaction_hash",
|
|
29
|
+
"type": "string"
|
|
30
|
+
} ];
|
|
31
|
+
|
|
32
|
+
static getAttributeTypeMap() {
|
|
33
|
+
return WebhookPayloadRFQValidatorWithdrawalChangeDetails.attributeTypeMap;
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@northstake/northstakeapi",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.19",
|
|
4
4
|
"description": "Northstake SDK",
|
|
5
5
|
"main": "dist/api.js",
|
|
6
6
|
"types": "dist/api.d.ts",
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
"author": "Northstake build process <buildadmin@northstake.dk>",
|
|
22
22
|
"license": "ISC",
|
|
23
23
|
"devDependencies": {
|
|
24
|
-
"@types/node": "^20.
|
|
24
|
+
"@types/node": "^20.14.2",
|
|
25
25
|
"typescript": "^5.4.5"
|
|
26
26
|
}
|
|
27
27
|
}
|