@dfns/sdk 0.8.21 → 0.8.24

package/generated/staking/types.d.ts

@@ -14,6 +14,14 @@ export type CreateStakeBody = ({
     /** Transaction amount denominated in min units */
     amount: string;
     lockedIotas?: string[] | undefined;
+} | {
+    protocol: "Xdc";
+    /** Id of the Dfns wallet making the deposit. */
+    walletId: string;
+    /** Coinbase address of the XDC masternode to register */
+    candidate: string;
+    /** Transaction amount denominated in wei (min 10,000,000 XDC) */
+    amount: string;
 }) & {
     externalId?: string | undefined;
 };
@@ -67,6 +75,14 @@ export type CreateStakeResponse = ({
         /** Transaction amount denominated in min units */
         amount: string;
         lockedIotas?: string[] | undefined;
+    } | {
+        protocol: "Xdc";
+        /** Id of the Dfns wallet making the deposit. */
+        walletId: string;
+        /** Coinbase address of the XDC masternode to register */
+        candidate: string;
+        /** Transaction amount denominated in wei (min 10,000,000 XDC) */
+        amount: string;
     }) & {
         externalId?: string | undefined;
     };
@@ -130,6 +146,14 @@ export type CreateStakeResponse = ({
         /** Transaction amount denominated in min units */
         amount: string;
         lockedIotas?: string[] | undefined;
+    } | {
+        protocol: "Xdc";
+        /** Id of the Dfns wallet making the deposit. */
+        walletId: string;
+        /** Coinbase address of the XDC masternode to register */
+        candidate: string;
+        /** Transaction amount denominated in wei (min 10,000,000 XDC) */
+        amount: string;
     }) & {
         externalId?: string | undefined;
     };
@@ -195,6 +219,14 @@ export type CreateStakeResponse = ({
         /** Transaction amount denominated in min units */
         amount: string;
         lockedIotas?: string[] | undefined;
+    } | {
+        protocol: "Xdc";
+        /** Id of the Dfns wallet making the deposit. */
+        walletId: string;
+        /** Coinbase address of the XDC masternode to register */
+        candidate: string;
+        /** Transaction amount denominated in wei (min 10,000,000 XDC) */
+        amount: string;
     }) & {
         externalId?: string | undefined;
     };
@@ -206,6 +238,76 @@ export type CreateStakeResponse = ({
             withdrawalAddress: string;
         };
     } | null;
+} | {
+    id: string;
+    /** The staking infrastructure provider used to manage the stake. */
+    provider?: ("Figment") | undefined;
+    /** Wallet id. */
+    walletId: string;
+    /** Status of the stake position.
+    
+    | Status | Definition |
+    | --- | --- |
+    | `Staking` | The stake is being created and funds are being delegated to the validator. |
+    | `Active` | The stake is active and earning rewards. |
+    | `Unbonding` | The stake is in the process of being unbonded (cooldown period). |
+    | `Unbond` | The stake has been unbonded and is ready for withdrawal. |
+    | `Withdrawing` | The staked funds are in the process of being withdrawn. |
+    | `Withdrawn` | The staked funds have been fully withdrawn. |
+    | `Failed` | The staking operation failed. | */
+    status: "Active" | "Failed" | "Staking" | "Unbonding" | "Unbond" | "Withdrawing" | "Withdrawn";
+    /** The user who initiated the request. */
+    requester: {
+        /** User id. */
+        userId: string;
+        /** Token id. */
+        tokenId?: string | undefined;
+    };
+    requestBody: ({
+        protocol: "Babylon";
+        /** Id of the Dfns wallet making the deposit. */
+        walletId: string;
+        /** Staking Provider */
+        provider: "Figment";
+        /** Transaction amount denominated in min units */
+        amount: string;
+        duration: number;
+    } | {
+        protocol: "Ethereum";
+        /** Id of the Dfns wallet making the deposit. */
+        walletId: string;
+        /** Staking Provider */
+        provider: "Figment";
+        /** Transaction amount denominated in min units */
+        amount: string;
+    } | {
+        protocol: "Iota";
+        /** Id of the Dfns wallet making the deposit. */
+        walletId: string;
+        validator: string;
+        /** Transaction amount denominated in min units */
+        amount: string;
+        lockedIotas?: string[] | undefined;
+    } | {
+        protocol: "Xdc";
+        /** Id of the Dfns wallet making the deposit. */
+        walletId: string;
+        /** Coinbase address of the XDC masternode to register */
+        candidate: string;
+        /** Transaction amount denominated in wei (min 10,000,000 XDC) */
+        amount: string;
+    }) & {
+        externalId?: string | undefined;
+    };
+    dateCreated: string;
+    protocol: "Xdc";
+    data: {
+        candidate: string;
+        amount: string;
+        proposeBlockNumber?: string | undefined;
+        withdrawBlockNumber?: string | undefined;
+        withdrawIndex?: string | undefined;
+    };
 }) & {
     actions: {
         id: string;
@@ -267,6 +369,14 @@ export type CreateStakeResponse = ({
             /** Transaction amount denominated in min units */
             amount: string;
             lockedIotas?: string[] | undefined;
+        } | {
+            protocol: "Xdc";
+            /** Id of the Dfns wallet making the deposit. */
+            walletId: string;
+            /** Coinbase address of the XDC masternode to register */
+            candidate: string;
+            /** Transaction amount denominated in wei (min 10,000,000 XDC) */
+            amount: string;
         }) & {
             externalId?: string | undefined;
         }) | ((({
@@ -281,7 +391,13 @@ export type CreateStakeResponse = ({
         }) | {
             protocol: "Ethereum";
             kind: "Withdraw";
-        }) & {
+        } | ({
+            protocol: "Xdc";
+            kind: "Withdraw";
+        } | {
+            protocol: "Xdc";
+            kind: "Unbond";
+        })) & {
             externalId?: string | undefined;
         });
         /** The failure reason, if any. Only present when status is Failed. */
@@ -304,7 +420,13 @@ export type CreateStakeActionBody = (({
 }) | {
     protocol: "Ethereum";
     kind: "Withdraw";
-}) & {
+} | ({
+    protocol: "Xdc";
+    kind: "Withdraw";
+} | {
+    protocol: "Xdc";
+    kind: "Unbond";
+})) & {
     externalId?: string | undefined;
 };
 export type CreateStakeActionParams = {
@@ -360,6 +482,14 @@ export type CreateStakeActionResponse = ({
         /** Transaction amount denominated in min units */
         amount: string;
         lockedIotas?: string[] | undefined;
+    } | {
+        protocol: "Xdc";
+        /** Id of the Dfns wallet making the deposit. */
+        walletId: string;
+        /** Coinbase address of the XDC masternode to register */
+        candidate: string;
+        /** Transaction amount denominated in wei (min 10,000,000 XDC) */
+        amount: string;
     }) & {
         externalId?: string | undefined;
     };
@@ -423,6 +553,14 @@ export type CreateStakeActionResponse = ({
         /** Transaction amount denominated in min units */
         amount: string;
         lockedIotas?: string[] | undefined;
+    } | {
+        protocol: "Xdc";
+        /** Id of the Dfns wallet making the deposit. */
+        walletId: string;
+        /** Coinbase address of the XDC masternode to register */
+        candidate: string;
+        /** Transaction amount denominated in wei (min 10,000,000 XDC) */
+        amount: string;
     }) & {
         externalId?: string | undefined;
     };
@@ -488,6 +626,14 @@ export type CreateStakeActionResponse = ({
         /** Transaction amount denominated in min units */
         amount: string;
         lockedIotas?: string[] | undefined;
+    } | {
+        protocol: "Xdc";
+        /** Id of the Dfns wallet making the deposit. */
+        walletId: string;
+        /** Coinbase address of the XDC masternode to register */
+        candidate: string;
+        /** Transaction amount denominated in wei (min 10,000,000 XDC) */
+        amount: string;
     }) & {
         externalId?: string | undefined;
     };
@@ -499,6 +645,76 @@ export type CreateStakeActionResponse = ({
             withdrawalAddress: string;
         };
     } | null;
+} | {
+    id: string;
+    /** The staking infrastructure provider used to manage the stake. */
+    provider?: ("Figment") | undefined;
+    /** Wallet id. */
+    walletId: string;
+    /** Status of the stake position.
+    
+    | Status | Definition |
+    | --- | --- |
+    | `Staking` | The stake is being created and funds are being delegated to the validator. |
+    | `Active` | The stake is active and earning rewards. |
+    | `Unbonding` | The stake is in the process of being unbonded (cooldown period). |
+    | `Unbond` | The stake has been unbonded and is ready for withdrawal. |
+    | `Withdrawing` | The staked funds are in the process of being withdrawn. |
+    | `Withdrawn` | The staked funds have been fully withdrawn. |
+    | `Failed` | The staking operation failed. | */
+    status: "Active" | "Failed" | "Staking" | "Unbonding" | "Unbond" | "Withdrawing" | "Withdrawn";
+    /** The user who initiated the request. */
+    requester: {
+        /** User id. */
+        userId: string;
+        /** Token id. */
+        tokenId?: string | undefined;
+    };
+    requestBody: ({
+        protocol: "Babylon";
+        /** Id of the Dfns wallet making the deposit. */
+        walletId: string;
+        /** Staking Provider */
+        provider: "Figment";
+        /** Transaction amount denominated in min units */
+        amount: string;
+        duration: number;
+    } | {
+        protocol: "Ethereum";
+        /** Id of the Dfns wallet making the deposit. */
+        walletId: string;
+        /** Staking Provider */
+        provider: "Figment";
+        /** Transaction amount denominated in min units */
+        amount: string;
+    } | {
+        protocol: "Iota";
+        /** Id of the Dfns wallet making the deposit. */
+        walletId: string;
+        validator: string;
+        /** Transaction amount denominated in min units */
+        amount: string;
+        lockedIotas?: string[] | undefined;
+    } | {
+        protocol: "Xdc";
+        /** Id of the Dfns wallet making the deposit. */
+        walletId: string;
+        /** Coinbase address of the XDC masternode to register */
+        candidate: string;
+        /** Transaction amount denominated in wei (min 10,000,000 XDC) */
+        amount: string;
+    }) & {
+        externalId?: string | undefined;
+    };
+    dateCreated: string;
+    protocol: "Xdc";
+    data: {
+        candidate: string;
+        amount: string;
+        proposeBlockNumber?: string | undefined;
+        withdrawBlockNumber?: string | undefined;
+        withdrawIndex?: string | undefined;
+    };
 }) & {
     actions: {
         id: string;
@@ -560,6 +776,14 @@ export type CreateStakeActionResponse = ({
             /** Transaction amount denominated in min units */
             amount: string;
             lockedIotas?: string[] | undefined;
+        } | {
+            protocol: "Xdc";
+            /** Id of the Dfns wallet making the deposit. */
+            walletId: string;
+            /** Coinbase address of the XDC masternode to register */
+            candidate: string;
+            /** Transaction amount denominated in wei (min 10,000,000 XDC) */
+            amount: string;
         }) & {
             externalId?: string | undefined;
         }) | ((({
@@ -574,7 +798,13 @@ export type CreateStakeActionResponse = ({
         }) | {
             protocol: "Ethereum";
             kind: "Withdraw";
-        }) & {
+        } | ({
+            protocol: "Xdc";
+            kind: "Withdraw";
+        } | {
+            protocol: "Xdc";
+            kind: "Unbond";
+        })) & {
             externalId?: string | undefined;
         });
         /** The failure reason, if any. Only present when status is Failed. */
@@ -652,6 +882,14 @@ export type GetStakesResponse = ({
         /** Transaction amount denominated in min units */
         amount: string;
         lockedIotas?: string[] | undefined;
+    } | {
+        protocol: "Xdc";
+        /** Id of the Dfns wallet making the deposit. */
+        walletId: string;
+        /** Coinbase address of the XDC masternode to register */
+        candidate: string;
+        /** Transaction amount denominated in wei (min 10,000,000 XDC) */
+        amount: string;
     }) & {
         externalId?: string | undefined;
     };
@@ -715,6 +953,14 @@ export type GetStakesResponse = ({
         /** Transaction amount denominated in min units */
         amount: string;
         lockedIotas?: string[] | undefined;
+    } | {
+        protocol: "Xdc";
+        /** Id of the Dfns wallet making the deposit. */
+        walletId: string;
+        /** Coinbase address of the XDC masternode to register */
+        candidate: string;
+        /** Transaction amount denominated in wei (min 10,000,000 XDC) */
+        amount: string;
     }) & {
         externalId?: string | undefined;
     };
@@ -780,6 +1026,14 @@ export type GetStakesResponse = ({
         /** Transaction amount denominated in min units */
         amount: string;
         lockedIotas?: string[] | undefined;
+    } | {
+        protocol: "Xdc";
+        /** Id of the Dfns wallet making the deposit. */
+        walletId: string;
+        /** Coinbase address of the XDC masternode to register */
+        candidate: string;
+        /** Transaction amount denominated in wei (min 10,000,000 XDC) */
+        amount: string;
     }) & {
         externalId?: string | undefined;
     };
@@ -791,6 +1045,76 @@ export type GetStakesResponse = ({
             withdrawalAddress: string;
         };
     } | null;
+} | {
+    id: string;
+    /** The staking infrastructure provider used to manage the stake. */
+    provider?: ("Figment") | undefined;
+    /** Wallet id. */
+    walletId: string;
+    /** Status of the stake position.
+    
+    | Status | Definition |
+    | --- | --- |
+    | `Staking` | The stake is being created and funds are being delegated to the validator. |
+    | `Active` | The stake is active and earning rewards. |
+    | `Unbonding` | The stake is in the process of being unbonded (cooldown period). |
+    | `Unbond` | The stake has been unbonded and is ready for withdrawal. |
+    | `Withdrawing` | The staked funds are in the process of being withdrawn. |
+    | `Withdrawn` | The staked funds have been fully withdrawn. |
+    | `Failed` | The staking operation failed. | */
+    status: "Active" | "Failed" | "Staking" | "Unbonding" | "Unbond" | "Withdrawing" | "Withdrawn";
+    /** The user who initiated the request. */
+    requester: {
+        /** User id. */
+        userId: string;
+        /** Token id. */
+        tokenId?: string | undefined;
+    };
+    requestBody: ({
+        protocol: "Babylon";
+        /** Id of the Dfns wallet making the deposit. */
+        walletId: string;
+        /** Staking Provider */
+        provider: "Figment";
+        /** Transaction amount denominated in min units */
+        amount: string;
+        duration: number;
+    } | {
+        protocol: "Ethereum";
+        /** Id of the Dfns wallet making the deposit. */
+        walletId: string;
+        /** Staking Provider */
+        provider: "Figment";
+        /** Transaction amount denominated in min units */
+        amount: string;
+    } | {
+        protocol: "Iota";
+        /** Id of the Dfns wallet making the deposit. */
+        walletId: string;
+        validator: string;
+        /** Transaction amount denominated in min units */
+        amount: string;
+        lockedIotas?: string[] | undefined;
+    } | {
+        protocol: "Xdc";
+        /** Id of the Dfns wallet making the deposit. */
+        walletId: string;
+        /** Coinbase address of the XDC masternode to register */
+        candidate: string;
+        /** Transaction amount denominated in wei (min 10,000,000 XDC) */
+        amount: string;
+    }) & {
+        externalId?: string | undefined;
+    };
+    dateCreated: string;
+    protocol: "Xdc";
+    data: {
+        candidate: string;
+        amount: string;
+        proposeBlockNumber?: string | undefined;
+        withdrawBlockNumber?: string | undefined;
+        withdrawIndex?: string | undefined;
+    };
 }) & {
     actions: {
         id: string;
@@ -852,6 +1176,14 @@ export type GetStakesResponse = ({
             /** Transaction amount denominated in min units */
             amount: string;
             lockedIotas?: string[] | undefined;
+        } | {
+            protocol: "Xdc";
+            /** Id of the Dfns wallet making the deposit. */
+            walletId: string;
+            /** Coinbase address of the XDC masternode to register */
+            candidate: string;
+            /** Transaction amount denominated in wei (min 10,000,000 XDC) */
+            amount: string;
         }) & {
             externalId?: string | undefined;
         }) | ((({
@@ -866,7 +1198,13 @@ export type GetStakesResponse = ({
         }) | {
             protocol: "Ethereum";
             kind: "Withdraw";
-        }) & {
+        } | ({
+            protocol: "Xdc";
+            kind: "Withdraw";
+        } | {
+            protocol: "Xdc";
+            kind: "Unbond";
+        })) & {
             externalId?: string | undefined;
         });
         /** The failure reason, if any. Only present when status is Failed. */
@@ -948,6 +1286,14 @@ export type ListStakeActionsResponse = {
             /** Transaction amount denominated in min units */
             amount: string;
             lockedIotas?: string[] | undefined;
+        } | {
+            protocol: "Xdc";
+            /** Id of the Dfns wallet making the deposit. */
+            walletId: string;
+            /** Coinbase address of the XDC masternode to register */
+            candidate: string;
+            /** Transaction amount denominated in wei (min 10,000,000 XDC) */
+            amount: string;
         }) & {
             externalId?: string | undefined;
         }) | ((({
@@ -962,7 +1308,13 @@ export type ListStakeActionsResponse = {
         }) | {
             protocol: "Ethereum";
             kind: "Withdraw";
-        }) & {
+        } | ({
+            protocol: "Xdc";
+            kind: "Withdraw";
+        } | {
+            protocol: "Xdc";
+            kind: "Unbond";
+        })) & {
             externalId?: string | undefined;
         });
         /** The failure reason, if any. Only present when status is Failed. */
@@ -1033,6 +1385,14 @@ export type ListStakesResponse = {
             /** Transaction amount denominated in min units */
             amount: string;
             lockedIotas?: string[] | undefined;
+        } | {
+            protocol: "Xdc";
+            /** Id of the Dfns wallet making the deposit. */
+            walletId: string;
+            /** Coinbase address of the XDC masternode to register */
+            candidate: string;
+            /** Transaction amount denominated in wei (min 10,000,000 XDC) */
+            amount: string;
         }) & {
             externalId?: string | undefined;
         };
@@ -1096,6 +1456,14 @@ export type ListStakesResponse = {
             /** Transaction amount denominated in min units */
             amount: string;
             lockedIotas?: string[] | undefined;
+        } | {
+            protocol: "Xdc";
+            /** Id of the Dfns wallet making the deposit. */
+            walletId: string;
+            /** Coinbase address of the XDC masternode to register */
+            candidate: string;
+            /** Transaction amount denominated in wei (min 10,000,000 XDC) */
+            amount: string;
         }) & {
             externalId?: string | undefined;
         };
@@ -1161,6 +1529,14 @@ export type ListStakesResponse = {
             /** Transaction amount denominated in min units */
             amount: string;
             lockedIotas?: string[] | undefined;
+        } | {
+            protocol: "Xdc";
+            /** Id of the Dfns wallet making the deposit. */
+            walletId: string;
+            /** Coinbase address of the XDC masternode to register */
+            candidate: string;
+            /** Transaction amount denominated in wei (min 10,000,000 XDC) */
+            amount: string;
         }) & {
             externalId?: string | undefined;
         };
@@ -1172,6 +1548,76 @@ export type ListStakesResponse = {
                 withdrawalAddress: string;
             };
         } | null;
+    } | {
+        id: string;
+        /** The staking infrastructure provider used to manage the stake. */
+        provider?: ("Figment") | undefined;
+        /** Wallet id. */
+        walletId: string;
+        /** Status of the stake position.
+        
+        | Status | Definition |
+        | --- | --- |
+        | `Staking` | The stake is being created and funds are being delegated to the validator. |
+        | `Active` | The stake is active and earning rewards. |
+        | `Unbonding` | The stake is in the process of being unbonded (cooldown period). |
+        | `Unbond` | The stake has been unbonded and is ready for withdrawal. |
+        | `Withdrawing` | The staked funds are in the process of being withdrawn. |
+        | `Withdrawn` | The staked funds have been fully withdrawn. |
+        | `Failed` | The staking operation failed. | */
+        status: "Active" | "Failed" | "Staking" | "Unbonding" | "Unbond" | "Withdrawing" | "Withdrawn";
+        /** The user who initiated the request. */
+        requester: {
+            /** User id. */
+            userId: string;
+            /** Token id. */
+            tokenId?: string | undefined;
+        };
+        requestBody: ({
+            protocol: "Babylon";
+            /** Id of the Dfns wallet making the deposit. */
+            walletId: string;
+            /** Staking Provider */
+            provider: "Figment";
+            /** Transaction amount denominated in min units */
+            amount: string;
+            duration: number;
+        } | {
+            protocol: "Ethereum";
+            /** Id of the Dfns wallet making the deposit. */
+            walletId: string;
+            /** Staking Provider */
+            provider: "Figment";
+            /** Transaction amount denominated in min units */
+            amount: string;
+        } | {
+            protocol: "Iota";
+            /** Id of the Dfns wallet making the deposit. */
+            walletId: string;
+            validator: string;
+            /** Transaction amount denominated in min units */
+            amount: string;
+            lockedIotas?: string[] | undefined;
+        } | {
+            protocol: "Xdc";
+            /** Id of the Dfns wallet making the deposit. */
+            walletId: string;
+            /** Coinbase address of the XDC masternode to register */
+            candidate: string;
+            /** Transaction amount denominated in wei (min 10,000,000 XDC) */
+            amount: string;
+        }) & {
+            externalId?: string | undefined;
+        };
+        dateCreated: string;
+        protocol: "Xdc";
+        data: {
+            candidate: string;
+            amount: string;
+            proposeBlockNumber?: string | undefined;
+            withdrawBlockNumber?: string | undefined;
+            withdrawIndex?: string | undefined;
+        };
     })[];
     /** token to use as `paginationToken` to request the next page. */
     nextPageToken?: string | undefined;