@northstake/northstakeapi 1.0.19 → 1.0.21
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 +3 -0
- package/.openapi-generator/VERSION +1 -1
- package/api/validatorMarketplaceWebhooksApi.ts +1 -1
- package/api.ts +3 -0
- package/dist/api/apis.d.ts +0 -1
- package/dist/api/validatorMarketplaceWebhooksApi.d.ts +1 -1
- package/dist/api/validatorMarketplaceWebhooksApi.js +1 -1
- package/dist/api.d.ts +3 -0
- package/dist/api.js +3 -0
- package/dist/model/exitProposal.d.ts +27 -0
- package/dist/model/exitProposal.js +38 -0
- package/dist/model/models.d.ts +3 -2
- package/dist/model/models.js +9 -0
- package/dist/model/rFQWebhookEventType.d.ts +1 -1
- package/dist/model/settlementSteps.d.ts +2 -0
- package/dist/model/settlementSteps.js +5 -0
- package/dist/model/webhookPayloadRFQWithdrawalClaimable.d.ts +31 -0
- package/dist/model/webhookPayloadRFQWithdrawalClaimable.js +38 -0
- package/dist/model/webhookPayloadRFQWithdrawalClaimableDetails.d.ts +29 -0
- package/dist/model/webhookPayloadRFQWithdrawalClaimableDetails.js +48 -0
- package/model/exitProposal.ts +43 -0
- package/model/models.ts +15 -0
- package/model/rFQWebhookEventType.ts +2 -1
- package/model/settlementSteps.ts +7 -0
- package/model/webhookPayloadRFQWithdrawalClaimable.ts +47 -0
- package/model/webhookPayloadRFQWithdrawalClaimableDetails.ts +55 -0
- package/package.json +3 -3
package/.openapi-generator/FILES
CHANGED
|
@@ -43,6 +43,7 @@ model/ethereumValidatorKeyKeystoreCryptoKdf.ts
|
|
|
43
43
|
model/ethereumValidatorKeyKeystoreCryptoKdfParams.ts
|
|
44
44
|
model/exitEstimateBase.ts
|
|
45
45
|
model/exitEstimateSeller.ts
|
|
46
|
+
model/exitProposal.ts
|
|
46
47
|
model/getTransactionsResponse.ts
|
|
47
48
|
model/managedUser.ts
|
|
48
49
|
model/managedUserDetails.ts
|
|
@@ -103,6 +104,8 @@ model/webhookPayloadRFQValidatorExited.ts
|
|
|
103
104
|
model/webhookPayloadRFQValidatorExitedDetails.ts
|
|
104
105
|
model/webhookPayloadRFQValidatorWithdrawalChange.ts
|
|
105
106
|
model/webhookPayloadRFQValidatorWithdrawalChangeDetails.ts
|
|
107
|
+
model/webhookPayloadRFQWithdrawalClaimable.ts
|
|
108
|
+
model/webhookPayloadRFQWithdrawalClaimableDetails.ts
|
|
106
109
|
model/webhookRegistration.ts
|
|
107
110
|
model/webhookRegistrationDetails.ts
|
|
108
111
|
model/withdrawalRecipientSettlement.ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
7.
|
|
1
|
+
7.9.0-SNAPSHOT
|
|
@@ -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\", \"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.
|
|
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
|
@@ -40,6 +40,7 @@ export * from './model/./ethereumValidatorKeyKeystoreCryptoKdf';
|
|
|
40
40
|
export * from './model/./ethereumValidatorKeyKeystoreCryptoKdfParams';
|
|
41
41
|
export * from './model/./exitEstimateBase';
|
|
42
42
|
export * from './model/./exitEstimateSeller';
|
|
43
|
+
export * from './model/./exitProposal';
|
|
43
44
|
export * from './model/./getTransactionsResponse';
|
|
44
45
|
export * from './model/./managedUser';
|
|
45
46
|
export * from './model/./managedUserDetails';
|
|
@@ -99,6 +100,8 @@ export * from './model/./webhookPayloadRFQValidatorExited';
|
|
|
99
100
|
export * from './model/./webhookPayloadRFQValidatorExitedDetails';
|
|
100
101
|
export * from './model/./webhookPayloadRFQValidatorWithdrawalChange';
|
|
101
102
|
export * from './model/./webhookPayloadRFQValidatorWithdrawalChangeDetails';
|
|
103
|
+
export * from './model/./webhookPayloadRFQWithdrawalClaimable';
|
|
104
|
+
export * from './model/./webhookPayloadRFQWithdrawalClaimableDetails';
|
|
102
105
|
export * from './model/./webhookRegistration';
|
|
103
106
|
export * from './model/./webhookRegistrationDetails';
|
|
104
107
|
export * from './model/./withdrawalRecipientSettlement';
|
package/dist/api/apis.d.ts
CHANGED
|
@@ -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\", \"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.
|
|
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\", \"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.
|
|
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
|
@@ -38,6 +38,7 @@ export * from './model/./ethereumValidatorKeyKeystoreCryptoKdf';
|
|
|
38
38
|
export * from './model/./ethereumValidatorKeyKeystoreCryptoKdfParams';
|
|
39
39
|
export * from './model/./exitEstimateBase';
|
|
40
40
|
export * from './model/./exitEstimateSeller';
|
|
41
|
+
export * from './model/./exitProposal';
|
|
41
42
|
export * from './model/./getTransactionsResponse';
|
|
42
43
|
export * from './model/./managedUser';
|
|
43
44
|
export * from './model/./managedUserDetails';
|
|
@@ -97,6 +98,8 @@ export * from './model/./webhookPayloadRFQValidatorExited';
|
|
|
97
98
|
export * from './model/./webhookPayloadRFQValidatorExitedDetails';
|
|
98
99
|
export * from './model/./webhookPayloadRFQValidatorWithdrawalChange';
|
|
99
100
|
export * from './model/./webhookPayloadRFQValidatorWithdrawalChangeDetails';
|
|
101
|
+
export * from './model/./webhookPayloadRFQWithdrawalClaimable';
|
|
102
|
+
export * from './model/./webhookPayloadRFQWithdrawalClaimableDetails';
|
|
100
103
|
export * from './model/./webhookRegistration';
|
|
101
104
|
export * from './model/./webhookRegistrationDetails';
|
|
102
105
|
export * from './model/./withdrawalRecipientSettlement';
|
package/dist/api.js
CHANGED
|
@@ -57,6 +57,7 @@ __exportStar(require("./model/./ethereumValidatorKeyKeystoreCryptoKdf"), exports
|
|
|
57
57
|
__exportStar(require("./model/./ethereumValidatorKeyKeystoreCryptoKdfParams"), exports);
|
|
58
58
|
__exportStar(require("./model/./exitEstimateBase"), exports);
|
|
59
59
|
__exportStar(require("./model/./exitEstimateSeller"), exports);
|
|
60
|
+
__exportStar(require("./model/./exitProposal"), exports);
|
|
60
61
|
__exportStar(require("./model/./getTransactionsResponse"), exports);
|
|
61
62
|
__exportStar(require("./model/./managedUser"), exports);
|
|
62
63
|
__exportStar(require("./model/./managedUserDetails"), exports);
|
|
@@ -116,6 +117,8 @@ __exportStar(require("./model/./webhookPayloadRFQValidatorExited"), exports);
|
|
|
116
117
|
__exportStar(require("./model/./webhookPayloadRFQValidatorExitedDetails"), exports);
|
|
117
118
|
__exportStar(require("./model/./webhookPayloadRFQValidatorWithdrawalChange"), exports);
|
|
118
119
|
__exportStar(require("./model/./webhookPayloadRFQValidatorWithdrawalChangeDetails"), exports);
|
|
120
|
+
__exportStar(require("./model/./webhookPayloadRFQWithdrawalClaimable"), exports);
|
|
121
|
+
__exportStar(require("./model/./webhookPayloadRFQWithdrawalClaimableDetails"), exports);
|
|
119
122
|
__exportStar(require("./model/./webhookRegistration"), exports);
|
|
120
123
|
__exportStar(require("./model/./webhookRegistrationDetails"), exports);
|
|
121
124
|
__exportStar(require("./model/./withdrawalRecipientSettlement"), exports);
|
|
@@ -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 ExitProposal {
|
|
13
|
+
'timestamp': string;
|
|
14
|
+
'transaction_hash': string;
|
|
15
|
+
'proposal_id': string;
|
|
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.ExitProposal = void 0;
|
|
15
|
+
class ExitProposal {
|
|
16
|
+
static getAttributeTypeMap() {
|
|
17
|
+
return ExitProposal.attributeTypeMap;
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
exports.ExitProposal = ExitProposal;
|
|
21
|
+
ExitProposal.discriminator = undefined;
|
|
22
|
+
ExitProposal.attributeTypeMap = [
|
|
23
|
+
{
|
|
24
|
+
"name": "timestamp",
|
|
25
|
+
"baseName": "timestamp",
|
|
26
|
+
"type": "string"
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
"name": "transaction_hash",
|
|
30
|
+
"baseName": "transaction_hash",
|
|
31
|
+
"type": "string"
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"name": "proposal_id",
|
|
35
|
+
"baseName": "proposal_id",
|
|
36
|
+
"type": "string"
|
|
37
|
+
}
|
|
38
|
+
];
|
package/dist/model/models.d.ts
CHANGED
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
/// <reference types="node" />
|
|
2
|
-
/// <reference types="node" />
|
|
3
1
|
import localVarRequest from 'request';
|
|
4
2
|
export * from './acceptedQuote';
|
|
5
3
|
export * from './accountEntity';
|
|
@@ -24,6 +22,7 @@ export * from './ethereumValidatorKeyKeystoreCryptoKdf';
|
|
|
24
22
|
export * from './ethereumValidatorKeyKeystoreCryptoKdfParams';
|
|
25
23
|
export * from './exitEstimateBase';
|
|
26
24
|
export * from './exitEstimateSeller';
|
|
25
|
+
export * from './exitProposal';
|
|
27
26
|
export * from './getTransactionsResponse';
|
|
28
27
|
export * from './managedUser';
|
|
29
28
|
export * from './managedUserDetails';
|
|
@@ -83,6 +82,8 @@ export * from './webhookPayloadRFQValidatorExited';
|
|
|
83
82
|
export * from './webhookPayloadRFQValidatorExitedDetails';
|
|
84
83
|
export * from './webhookPayloadRFQValidatorWithdrawalChange';
|
|
85
84
|
export * from './webhookPayloadRFQValidatorWithdrawalChangeDetails';
|
|
85
|
+
export * from './webhookPayloadRFQWithdrawalClaimable';
|
|
86
|
+
export * from './webhookPayloadRFQWithdrawalClaimableDetails';
|
|
86
87
|
export * from './webhookRegistration';
|
|
87
88
|
export * from './webhookRegistrationDetails';
|
|
88
89
|
export * from './withdrawalRecipientSettlement';
|
package/dist/model/models.js
CHANGED
|
@@ -51,6 +51,7 @@ __exportStar(require("./ethereumValidatorKeyKeystoreCryptoKdf"), exports);
|
|
|
51
51
|
__exportStar(require("./ethereumValidatorKeyKeystoreCryptoKdfParams"), exports);
|
|
52
52
|
__exportStar(require("./exitEstimateBase"), exports);
|
|
53
53
|
__exportStar(require("./exitEstimateSeller"), exports);
|
|
54
|
+
__exportStar(require("./exitProposal"), exports);
|
|
54
55
|
__exportStar(require("./getTransactionsResponse"), exports);
|
|
55
56
|
__exportStar(require("./managedUser"), exports);
|
|
56
57
|
__exportStar(require("./managedUserDetails"), exports);
|
|
@@ -110,6 +111,8 @@ __exportStar(require("./webhookPayloadRFQValidatorExited"), exports);
|
|
|
110
111
|
__exportStar(require("./webhookPayloadRFQValidatorExitedDetails"), exports);
|
|
111
112
|
__exportStar(require("./webhookPayloadRFQValidatorWithdrawalChange"), exports);
|
|
112
113
|
__exportStar(require("./webhookPayloadRFQValidatorWithdrawalChangeDetails"), exports);
|
|
114
|
+
__exportStar(require("./webhookPayloadRFQWithdrawalClaimable"), exports);
|
|
115
|
+
__exportStar(require("./webhookPayloadRFQWithdrawalClaimableDetails"), exports);
|
|
113
116
|
__exportStar(require("./webhookRegistration"), exports);
|
|
114
117
|
__exportStar(require("./webhookRegistrationDetails"), exports);
|
|
115
118
|
__exportStar(require("./withdrawalRecipientSettlement"), exports);
|
|
@@ -138,6 +141,7 @@ const ethereumValidatorKeyKeystoreCryptoKdf_1 = require("./ethereumValidatorKeyK
|
|
|
138
141
|
const ethereumValidatorKeyKeystoreCryptoKdfParams_1 = require("./ethereumValidatorKeyKeystoreCryptoKdfParams");
|
|
139
142
|
const exitEstimateBase_1 = require("./exitEstimateBase");
|
|
140
143
|
const exitEstimateSeller_1 = require("./exitEstimateSeller");
|
|
144
|
+
const exitProposal_1 = require("./exitProposal");
|
|
141
145
|
const getTransactionsResponse_1 = require("./getTransactionsResponse");
|
|
142
146
|
const managedUser_1 = require("./managedUser");
|
|
143
147
|
const managedUserDetails_1 = require("./managedUserDetails");
|
|
@@ -187,6 +191,8 @@ const webhookPayloadRFQValidatorExited_1 = require("./webhookPayloadRFQValidator
|
|
|
187
191
|
const webhookPayloadRFQValidatorExitedDetails_1 = require("./webhookPayloadRFQValidatorExitedDetails");
|
|
188
192
|
const webhookPayloadRFQValidatorWithdrawalChange_1 = require("./webhookPayloadRFQValidatorWithdrawalChange");
|
|
189
193
|
const webhookPayloadRFQValidatorWithdrawalChangeDetails_1 = require("./webhookPayloadRFQValidatorWithdrawalChangeDetails");
|
|
194
|
+
const webhookPayloadRFQWithdrawalClaimable_1 = require("./webhookPayloadRFQWithdrawalClaimable");
|
|
195
|
+
const webhookPayloadRFQWithdrawalClaimableDetails_1 = require("./webhookPayloadRFQWithdrawalClaimableDetails");
|
|
190
196
|
const webhookRegistration_1 = require("./webhookRegistration");
|
|
191
197
|
const webhookRegistrationDetails_1 = require("./webhookRegistrationDetails");
|
|
192
198
|
const withdrawalRecipientSettlement_1 = require("./withdrawalRecipientSettlement");
|
|
@@ -232,6 +238,7 @@ let typeMap = {
|
|
|
232
238
|
"EthereumValidatorKeyKeystoreCryptoKdfParams": ethereumValidatorKeyKeystoreCryptoKdfParams_1.EthereumValidatorKeyKeystoreCryptoKdfParams,
|
|
233
239
|
"ExitEstimateBase": exitEstimateBase_1.ExitEstimateBase,
|
|
234
240
|
"ExitEstimateSeller": exitEstimateSeller_1.ExitEstimateSeller,
|
|
241
|
+
"ExitProposal": exitProposal_1.ExitProposal,
|
|
235
242
|
"GetTransactionsResponse": getTransactionsResponse_1.GetTransactionsResponse,
|
|
236
243
|
"ManagedUser": managedUser_1.ManagedUser,
|
|
237
244
|
"ManagedUserDetails": managedUserDetails_1.ManagedUserDetails,
|
|
@@ -281,6 +288,8 @@ let typeMap = {
|
|
|
281
288
|
"WebhookPayloadRFQValidatorExitedDetails": webhookPayloadRFQValidatorExitedDetails_1.WebhookPayloadRFQValidatorExitedDetails,
|
|
282
289
|
"WebhookPayloadRFQValidatorWithdrawalChange": webhookPayloadRFQValidatorWithdrawalChange_1.WebhookPayloadRFQValidatorWithdrawalChange,
|
|
283
290
|
"WebhookPayloadRFQValidatorWithdrawalChangeDetails": webhookPayloadRFQValidatorWithdrawalChangeDetails_1.WebhookPayloadRFQValidatorWithdrawalChangeDetails,
|
|
291
|
+
"WebhookPayloadRFQWithdrawalClaimable": webhookPayloadRFQWithdrawalClaimable_1.WebhookPayloadRFQWithdrawalClaimable,
|
|
292
|
+
"WebhookPayloadRFQWithdrawalClaimableDetails": webhookPayloadRFQWithdrawalClaimableDetails_1.WebhookPayloadRFQWithdrawalClaimableDetails,
|
|
284
293
|
"WebhookRegistration": webhookRegistration_1.WebhookRegistration,
|
|
285
294
|
"WebhookRegistrationDetails": webhookRegistrationDetails_1.WebhookRegistrationDetails,
|
|
286
295
|
"WithdrawalRecipientSettlement": withdrawalRecipientSettlement_1.WithdrawalRecipientSettlement,
|
|
@@ -12,4 +12,4 @@
|
|
|
12
12
|
/**
|
|
13
13
|
* The types of events a webhook may subscribe to
|
|
14
14
|
*/
|
|
15
|
-
export type RFQWebhookEventType = 'RFQAvailable' | 'RFQBidReceived' | 'RFQBidAccepted' | 'RFQEscrowEvent' | 'RFQTransferProposalReceived' | 'RFQValidatorWithdrawalChange' | 'RFQEscrowReleased' | 'RFQValidatorExited';
|
|
15
|
+
export type RFQWebhookEventType = 'RFQAvailable' | 'RFQBidReceived' | 'RFQBidAccepted' | 'RFQEscrowEvent' | 'RFQTransferProposalReceived' | 'RFQValidatorWithdrawalChange' | 'RFQEscrowReleased' | 'RFQValidatorExited' | 'RFQWithdrawalClaimable';
|
|
@@ -12,12 +12,14 @@
|
|
|
12
12
|
import { AcceptedQuote } from './acceptedQuote';
|
|
13
13
|
import { EscrowPayment } from './escrowPayment';
|
|
14
14
|
import { EscrowReleased } from './escrowReleased';
|
|
15
|
+
import { ExitProposal } from './exitProposal';
|
|
15
16
|
import { WithdrawalRecipientSettlement } from './withdrawalRecipientSettlement';
|
|
16
17
|
export declare class SettlementSteps {
|
|
17
18
|
'accepted_quote'?: AcceptedQuote;
|
|
18
19
|
'escrow_payment'?: EscrowPayment;
|
|
19
20
|
'withdrawal_recipient_settlement'?: WithdrawalRecipientSettlement;
|
|
20
21
|
'escrow_released'?: EscrowReleased;
|
|
22
|
+
'exit_proposal'?: ExitProposal;
|
|
21
23
|
static discriminator: string | undefined;
|
|
22
24
|
static attributeTypeMap: Array<{
|
|
23
25
|
name: string;
|
|
@@ -0,0 +1,31 @@
|
|
|
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
|
+
import { RFQWebhookEventType } from './rFQWebhookEventType';
|
|
13
|
+
import { WebhookPayloadRFQWithdrawalClaimableDetails } from './webhookPayloadRFQWithdrawalClaimableDetails';
|
|
14
|
+
export declare class WebhookPayloadRFQWithdrawalClaimable {
|
|
15
|
+
'document_id'?: string;
|
|
16
|
+
'event'?: RFQWebhookEventType;
|
|
17
|
+
'details'?: WebhookPayloadRFQWithdrawalClaimableDetails;
|
|
18
|
+
static discriminator: string | undefined;
|
|
19
|
+
static attributeTypeMap: Array<{
|
|
20
|
+
name: string;
|
|
21
|
+
baseName: string;
|
|
22
|
+
type: string;
|
|
23
|
+
}>;
|
|
24
|
+
static getAttributeTypeMap(): {
|
|
25
|
+
name: string;
|
|
26
|
+
baseName: string;
|
|
27
|
+
type: string;
|
|
28
|
+
}[];
|
|
29
|
+
}
|
|
30
|
+
export declare namespace WebhookPayloadRFQWithdrawalClaimable {
|
|
31
|
+
}
|
|
@@ -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.WebhookPayloadRFQWithdrawalClaimable = void 0;
|
|
15
|
+
class WebhookPayloadRFQWithdrawalClaimable {
|
|
16
|
+
static getAttributeTypeMap() {
|
|
17
|
+
return WebhookPayloadRFQWithdrawalClaimable.attributeTypeMap;
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
exports.WebhookPayloadRFQWithdrawalClaimable = WebhookPayloadRFQWithdrawalClaimable;
|
|
21
|
+
WebhookPayloadRFQWithdrawalClaimable.discriminator = undefined;
|
|
22
|
+
WebhookPayloadRFQWithdrawalClaimable.attributeTypeMap = [
|
|
23
|
+
{
|
|
24
|
+
"name": "document_id",
|
|
25
|
+
"baseName": "document_id",
|
|
26
|
+
"type": "string"
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
"name": "event",
|
|
30
|
+
"baseName": "event",
|
|
31
|
+
"type": "RFQWebhookEventType"
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"name": "details",
|
|
35
|
+
"baseName": "details",
|
|
36
|
+
"type": "WebhookPayloadRFQWithdrawalClaimableDetails"
|
|
37
|
+
}
|
|
38
|
+
];
|
|
@@ -0,0 +1,29 @@
|
|
|
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 WebhookPayloadRFQWithdrawalClaimableDetails {
|
|
13
|
+
'validator_index'?: number;
|
|
14
|
+
'amount'?: number;
|
|
15
|
+
'timestamp'?: Date;
|
|
16
|
+
'beneficiary_address'?: string;
|
|
17
|
+
'block'?: number;
|
|
18
|
+
static discriminator: string | undefined;
|
|
19
|
+
static attributeTypeMap: Array<{
|
|
20
|
+
name: string;
|
|
21
|
+
baseName: string;
|
|
22
|
+
type: string;
|
|
23
|
+
}>;
|
|
24
|
+
static getAttributeTypeMap(): {
|
|
25
|
+
name: string;
|
|
26
|
+
baseName: string;
|
|
27
|
+
type: string;
|
|
28
|
+
}[];
|
|
29
|
+
}
|
|
@@ -0,0 +1,48 @@
|
|
|
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.WebhookPayloadRFQWithdrawalClaimableDetails = void 0;
|
|
15
|
+
class WebhookPayloadRFQWithdrawalClaimableDetails {
|
|
16
|
+
static getAttributeTypeMap() {
|
|
17
|
+
return WebhookPayloadRFQWithdrawalClaimableDetails.attributeTypeMap;
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
exports.WebhookPayloadRFQWithdrawalClaimableDetails = WebhookPayloadRFQWithdrawalClaimableDetails;
|
|
21
|
+
WebhookPayloadRFQWithdrawalClaimableDetails.discriminator = undefined;
|
|
22
|
+
WebhookPayloadRFQWithdrawalClaimableDetails.attributeTypeMap = [
|
|
23
|
+
{
|
|
24
|
+
"name": "validator_index",
|
|
25
|
+
"baseName": "validator_index",
|
|
26
|
+
"type": "number"
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
"name": "amount",
|
|
30
|
+
"baseName": "amount",
|
|
31
|
+
"type": "number"
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"name": "timestamp",
|
|
35
|
+
"baseName": "timestamp",
|
|
36
|
+
"type": "Date"
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"name": "beneficiary_address",
|
|
40
|
+
"baseName": "beneficiary_address",
|
|
41
|
+
"type": "string"
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
"name": "block",
|
|
45
|
+
"baseName": "block",
|
|
46
|
+
"type": "number"
|
|
47
|
+
}
|
|
48
|
+
];
|
|
@@ -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 ExitProposal {
|
|
15
|
+
'timestamp': string;
|
|
16
|
+
'transaction_hash': string;
|
|
17
|
+
'proposal_id': string;
|
|
18
|
+
|
|
19
|
+
static discriminator: string | undefined = undefined;
|
|
20
|
+
|
|
21
|
+
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
|
22
|
+
{
|
|
23
|
+
"name": "timestamp",
|
|
24
|
+
"baseName": "timestamp",
|
|
25
|
+
"type": "string"
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"name": "transaction_hash",
|
|
29
|
+
"baseName": "transaction_hash",
|
|
30
|
+
"type": "string"
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"name": "proposal_id",
|
|
34
|
+
"baseName": "proposal_id",
|
|
35
|
+
"type": "string"
|
|
36
|
+
} ];
|
|
37
|
+
|
|
38
|
+
static getAttributeTypeMap() {
|
|
39
|
+
return ExitProposal.attributeTypeMap;
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
|
package/model/models.ts
CHANGED
|
@@ -25,6 +25,7 @@ export * from './ethereumValidatorKeyKeystoreCryptoKdf';
|
|
|
25
25
|
export * from './ethereumValidatorKeyKeystoreCryptoKdfParams';
|
|
26
26
|
export * from './exitEstimateBase';
|
|
27
27
|
export * from './exitEstimateSeller';
|
|
28
|
+
export * from './exitProposal';
|
|
28
29
|
export * from './getTransactionsResponse';
|
|
29
30
|
export * from './managedUser';
|
|
30
31
|
export * from './managedUserDetails';
|
|
@@ -84,6 +85,8 @@ export * from './webhookPayloadRFQValidatorExited';
|
|
|
84
85
|
export * from './webhookPayloadRFQValidatorExitedDetails';
|
|
85
86
|
export * from './webhookPayloadRFQValidatorWithdrawalChange';
|
|
86
87
|
export * from './webhookPayloadRFQValidatorWithdrawalChangeDetails';
|
|
88
|
+
export * from './webhookPayloadRFQWithdrawalClaimable';
|
|
89
|
+
export * from './webhookPayloadRFQWithdrawalClaimableDetails';
|
|
87
90
|
export * from './webhookRegistration';
|
|
88
91
|
export * from './webhookRegistrationDetails';
|
|
89
92
|
export * from './withdrawalRecipientSettlement';
|
|
@@ -173,6 +176,9 @@ import { ExitEstimateBase } from './exitEstimateBase';
|
|
|
173
176
|
import { ExitEstimateSeller } from './exitEstimateSeller';
|
|
174
177
|
|
|
175
178
|
|
|
179
|
+
import { ExitProposal } from './exitProposal';
|
|
180
|
+
|
|
181
|
+
|
|
176
182
|
import { GetTransactionsResponse } from './getTransactionsResponse';
|
|
177
183
|
|
|
178
184
|
|
|
@@ -350,6 +356,12 @@ import { WebhookPayloadRFQValidatorWithdrawalChange } from './webhookPayloadRFQV
|
|
|
350
356
|
import { WebhookPayloadRFQValidatorWithdrawalChangeDetails } from './webhookPayloadRFQValidatorWithdrawalChangeDetails';
|
|
351
357
|
|
|
352
358
|
|
|
359
|
+
import { WebhookPayloadRFQWithdrawalClaimable } from './webhookPayloadRFQWithdrawalClaimable';
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
import { WebhookPayloadRFQWithdrawalClaimableDetails } from './webhookPayloadRFQWithdrawalClaimableDetails';
|
|
363
|
+
|
|
364
|
+
|
|
353
365
|
import { WebhookRegistration } from './webhookRegistration';
|
|
354
366
|
|
|
355
367
|
|
|
@@ -409,6 +421,7 @@ let typeMap: {[index: string]: any} = {
|
|
|
409
421
|
"EthereumValidatorKeyKeystoreCryptoKdfParams": EthereumValidatorKeyKeystoreCryptoKdfParams,
|
|
410
422
|
"ExitEstimateBase": ExitEstimateBase,
|
|
411
423
|
"ExitEstimateSeller": ExitEstimateSeller,
|
|
424
|
+
"ExitProposal": ExitProposal,
|
|
412
425
|
"GetTransactionsResponse": GetTransactionsResponse,
|
|
413
426
|
"ManagedUser": ManagedUser,
|
|
414
427
|
"ManagedUserDetails": ManagedUserDetails,
|
|
@@ -458,6 +471,8 @@ let typeMap: {[index: string]: any} = {
|
|
|
458
471
|
"WebhookPayloadRFQValidatorExitedDetails": WebhookPayloadRFQValidatorExitedDetails,
|
|
459
472
|
"WebhookPayloadRFQValidatorWithdrawalChange": WebhookPayloadRFQValidatorWithdrawalChange,
|
|
460
473
|
"WebhookPayloadRFQValidatorWithdrawalChangeDetails": WebhookPayloadRFQValidatorWithdrawalChangeDetails,
|
|
474
|
+
"WebhookPayloadRFQWithdrawalClaimable": WebhookPayloadRFQWithdrawalClaimable,
|
|
475
|
+
"WebhookPayloadRFQWithdrawalClaimableDetails": WebhookPayloadRFQWithdrawalClaimableDetails,
|
|
461
476
|
"WebhookRegistration": WebhookRegistration,
|
|
462
477
|
"WebhookRegistrationDetails": WebhookRegistrationDetails,
|
|
463
478
|
"WithdrawalRecipientSettlement": WithdrawalRecipientSettlement,
|
package/model/settlementSteps.ts
CHANGED
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
import { AcceptedQuote } from './acceptedQuote';
|
|
14
14
|
import { EscrowPayment } from './escrowPayment';
|
|
15
15
|
import { EscrowReleased } from './escrowReleased';
|
|
16
|
+
import { ExitProposal } from './exitProposal';
|
|
16
17
|
import { WithdrawalRecipientSettlement } from './withdrawalRecipientSettlement';
|
|
17
18
|
|
|
18
19
|
export class SettlementSteps {
|
|
@@ -20,6 +21,7 @@ export class SettlementSteps {
|
|
|
20
21
|
'escrow_payment'?: EscrowPayment;
|
|
21
22
|
'withdrawal_recipient_settlement'?: WithdrawalRecipientSettlement;
|
|
22
23
|
'escrow_released'?: EscrowReleased;
|
|
24
|
+
'exit_proposal'?: ExitProposal;
|
|
23
25
|
|
|
24
26
|
static discriminator: string | undefined = undefined;
|
|
25
27
|
|
|
@@ -43,6 +45,11 @@ export class SettlementSteps {
|
|
|
43
45
|
"name": "escrow_released",
|
|
44
46
|
"baseName": "escrow_released",
|
|
45
47
|
"type": "EscrowReleased"
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"name": "exit_proposal",
|
|
51
|
+
"baseName": "exit_proposal",
|
|
52
|
+
"type": "ExitProposal"
|
|
46
53
|
} ];
|
|
47
54
|
|
|
48
55
|
static getAttributeTypeMap() {
|
|
@@ -0,0 +1,47 @@
|
|
|
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
|
+
import { RFQWebhookEventType } from './rFQWebhookEventType';
|
|
14
|
+
import { WebhookPayloadRFQWithdrawalClaimableDetails } from './webhookPayloadRFQWithdrawalClaimableDetails';
|
|
15
|
+
|
|
16
|
+
export class WebhookPayloadRFQWithdrawalClaimable {
|
|
17
|
+
'document_id'?: string;
|
|
18
|
+
'event'?: RFQWebhookEventType;
|
|
19
|
+
'details'?: WebhookPayloadRFQWithdrawalClaimableDetails;
|
|
20
|
+
|
|
21
|
+
static discriminator: string | undefined = undefined;
|
|
22
|
+
|
|
23
|
+
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
|
24
|
+
{
|
|
25
|
+
"name": "document_id",
|
|
26
|
+
"baseName": "document_id",
|
|
27
|
+
"type": "string"
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
"name": "event",
|
|
31
|
+
"baseName": "event",
|
|
32
|
+
"type": "RFQWebhookEventType"
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
"name": "details",
|
|
36
|
+
"baseName": "details",
|
|
37
|
+
"type": "WebhookPayloadRFQWithdrawalClaimableDetails"
|
|
38
|
+
} ];
|
|
39
|
+
|
|
40
|
+
static getAttributeTypeMap() {
|
|
41
|
+
return WebhookPayloadRFQWithdrawalClaimable.attributeTypeMap;
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export namespace WebhookPayloadRFQWithdrawalClaimable {
|
|
46
|
+
}
|
|
47
|
+
|
|
@@ -0,0 +1,55 @@
|
|
|
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 WebhookPayloadRFQWithdrawalClaimableDetails {
|
|
15
|
+
'validator_index'?: number;
|
|
16
|
+
'amount'?: number;
|
|
17
|
+
'timestamp'?: Date;
|
|
18
|
+
'beneficiary_address'?: string;
|
|
19
|
+
'block'?: number;
|
|
20
|
+
|
|
21
|
+
static discriminator: string | undefined = undefined;
|
|
22
|
+
|
|
23
|
+
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
|
24
|
+
{
|
|
25
|
+
"name": "validator_index",
|
|
26
|
+
"baseName": "validator_index",
|
|
27
|
+
"type": "number"
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
"name": "amount",
|
|
31
|
+
"baseName": "amount",
|
|
32
|
+
"type": "number"
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
"name": "timestamp",
|
|
36
|
+
"baseName": "timestamp",
|
|
37
|
+
"type": "Date"
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
"name": "beneficiary_address",
|
|
41
|
+
"baseName": "beneficiary_address",
|
|
42
|
+
"type": "string"
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"name": "block",
|
|
46
|
+
"baseName": "block",
|
|
47
|
+
"type": "number"
|
|
48
|
+
} ];
|
|
49
|
+
|
|
50
|
+
static getAttributeTypeMap() {
|
|
51
|
+
return WebhookPayloadRFQWithdrawalClaimableDetails.attributeTypeMap;
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@northstake/northstakeapi",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.21",
|
|
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": "^
|
|
25
|
-
"typescript": "^5.
|
|
24
|
+
"@types/node": "^22.5.4",
|
|
25
|
+
"typescript": "^5.6.2"
|
|
26
26
|
}
|
|
27
27
|
}
|