Merge pull request #91 from BitGo/update-bitgo-api-docs

Update API reference on BitGo Developer Portal

Author: ericcrosson-bitgo

api.yaml

@@ -20475,6 +20475,8 @@ paths:
                 - $ref: '#/components/schemas/NearUnStakingRequestPOSTBody'
                 - $ref: '#/components/schemas/SolStakingRequestPOSTBody'
                 - $ref: '#/components/schemas/SolUnStakingRequestPOSTBody'
+                - $ref: '#/components/schemas/TaoStakingRequestPOSTBody'
+                - $ref: '#/components/schemas/TaoUnStakingRequestPOSTBody'
             examples:
               AvaxPStakingRequestPOSTBodyExample:
                 $ref: '#/components/examples/AvaxPStakingRequestPOSTBodyExample'
@@ -20496,6 +20498,10 @@ paths:
                 $ref: '#/components/examples/SolStakingRequestPOSTBodyExample'
               SolUnStakingRequestPOSTBodyExample:
                 $ref: '#/components/examples/SolUnStakingRequestPOSTBodyExample'
+              TaoStakingRequestPOSTBodyExample:
+                $ref: '#/components/examples/TaoStakingRequestPOSTBodyExample'
+              TaoUnStakingRequestPOSTBodyExample:
+                $ref: '#/components/examples/TaoUnStakingRequestPOSTBodyExample'
       responses:
         '202':
           description: Successful Staking Request Accepted and Needs Approval
@@ -20511,6 +20517,7 @@ paths:
                   - $ref: '#/components/schemas/CosmosLikeStakingRequest'
                   - $ref: '#/components/schemas/AtomStakingRequest'
                   - $ref: '#/components/schemas/SolStakingRequest'
+                  - $ref: '#/components/schemas/TaoStakingRequest'
               examples:
                 AvaxPStakingRequestWithoutDelegationsExample:
                   $ref: '#/components/examples/AvaxPStakingRequestWithoutDelegationsExample'
@@ -20528,6 +20535,10 @@ paths:
                   $ref: '#/components/examples/SolStakingRequestWithoutDelegationsExample'
                 SolUnStakingRequestWithoutDelegationsExample:
                   $ref: '#/components/examples/SolUnStakingRequestWithoutDelegationsExample'
+                TaoStakingRequestWithoutDelegationsExample:
+                  $ref: '#/components/examples/TaoStakingRequestWithoutDelegationsExample'
+                TaoUnStakingRequestWithoutDelegationsExample:
+                  $ref: '#/components/examples/TaoUnStakingRequestWithoutDelegationsExample'
                 DotStakingRequestWithoutDelegationsExample:
                   $ref: '#/components/examples/DotStakingRequestWithoutDelegationsExample'
                 DotUnStakingRequestWithoutDelegationsExample:
@@ -20848,6 +20859,7 @@ paths:
                   - $ref: '#/components/schemas/MaticStakingRequest'
                   - $ref: '#/components/schemas/NearStakingRequest'
                   - $ref: '#/components/schemas/SolStakingRequest'
+                  - $ref: '#/components/schemas/TaoStakingRequest'
               examples:
                 AvaxPStakingRequestWithoutDelegationsExample:
                   $ref: '#/components/examples/AvaxPStakingRequestWithTransactionsExample'
@@ -20865,6 +20877,10 @@ paths:
                   $ref: '#/components/examples/SolStakingRequestWithTransactionsExample'
                 SolUnStakingRequestWithoutDelegationsExample:
                   $ref: '#/components/examples/SolUnStakingRequestWithTransactionsExample'
+                TaoStakingRequestWithoutDelegationsExample:
+                  $ref: '#/components/examples/TaoStakingRequestWithTransactionsExample'
+                TaoUnStakingRequestWithoutDelegationsExample:
+                  $ref: '#/components/examples/TaoUnStakingRequestWithTransactionsExample'
                 DotStakingRequestExample:
                   $ref: '#/components/examples/DotStakingRequestWithTransactionsExample'
                 DotUnStakingRequestWithoutDelegationsExample:
@@ -21339,6 +21355,8 @@ paths:
                   $ref: '#/components/examples/NearDelegationResultsExample'
                 SolDelegationResultsExample:
                   $ref: '#/components/examples/SolDelegationResultsExample'
+                TaoDelegationResultsExample:
+                  $ref: '#/components/examples/TaoDelegationResultsExample'
         '400':
           description: Bad Request
           content:
@@ -30905,6 +30923,154 @@ components:
           apy: '9.999'
           commission: '0.999'
           coin: tsui
+    TaoDelegationResultsExample:
+      summary: Tao Delegation Results Example
+      value:
+        delegations:
+          - id: e0225adbc-66a3-4ccd-9a9d-726a05bca0cf
+            delegationAddress: 0x5a6406c9710f588ca733360bfa8033d0ef9ecdy5
+            withdrawalAddress: '0x5a6406c9710f588ca733360bfa8033d0ef9ecd7c'
+            delegated: '0'
+            coin: tao
+            walletId: 63110fc78b108e00071df2d3c3879dd0
+            status: PENDING
+            rewards: '0'
+            lockedRewards: '0'
+            pendingUnstake: '0'
+            pendingStake: '1000'
+            apy: '6.5100'
+            unstakeable: false
+        page: 1
+        totalPages: 1
+        totalElements: 1
+    TaoStakingRequestPOSTBodyExample:
+      summary: Tao Staking Request POST Body Example
+      value:
+        clientId: e055adbc-66a3-4ccd-9a9d-726a05bca0cf
+        amount: '1000'
+        type: STAKE
+    TaoStakingRequestWithTransactionsExample:
+      summary: Tao Staking Request Example
+      value:
+        id: e055adbc-66a3-4ccd-9a9d-726a05bca0cf
+        clientId: f054adbc-26a3-4acd-8a9d-726a05bca0dr
+        requestUserId: 6092e75c451052000636831deb797bd1
+        enterpriseId: 1032e75c451052000436831deb797af1
+        walletId: 2032e75g451052000636831abd797bd3
+        withdrawalAddress: 5EKXEL1PnSxvBennEDin56yj5KgmcX3AW27sr1uqm9tBmKpn
+        walletType: custodial
+        type: STAKE
+        coin: tao
+        createdDate: 2022-01-10T14:32:28.000Z
+        statusModifiedDate: 2022-01-10T14:32:28.000Z
+        status: NEW
+        delegations:
+          - id: e0225adbc-66a3-4ccd-9a9d-726a05bca0cf
+            delegationAddress: string
+            withdrawalAddress: 5EKXEL1PnSxvBennEDin56yj5KgmcX3AW27sr1uqm9tBmKpn
+            delegated: '1000000000'
+            status: ACTIVE
+            rewards: '0'
+            lockedRewards: '0'
+            pendingUnstake: '0'
+            pendingStake: '0'
+            apy: '8.3'
+            unstakingFee: '1000000'
+            unstakingMin: '0'
+        transactions:
+          - id: i0500adbc-55b43-5tta-9a9d-726a05bca0op
+            stakingRequestId: e055adbc-66a3-4ccd-9a9d-726a05bca0cf
+            createdDate: 2022-01-10T14:32:28.000Z
+            statusModifiedDate: 2022-01-10T14:32:28.000Z
+            status: CONFIRMED
+            amount: '1000000000'
+            transactionType: delegate
+            delegationId: e0225adbc-66a3-4ccd-9a9d-726a05bca0cf
+        amount: '1000000000'
+    TaoStakingRequestWithoutDelegationsExample:
+      summary: Tao Staking Request Example
+      value:
+        id: e055adbc-66a3-4ccd-9a9d-726a05bca0cf
+        clientId: f054adbc-26a3-4acd-8a9d-726a05bca0dr
+        requestUserId: 6092e75c451052000636831deb797bd1
+        enterpriseId: 1032e75c451052000436831deb797af1
+        walletId: 2032e75g451052000636831abd797bd3
+        withdrawalAddress: 3Lwg4hE19Kg4BdUkuDh4v8xXoyoRQkbDMM6wX7zjQP6i
+        walletType: custodial
+        type: STAKE
+        coin: tao
+        createdDate: 2022-01-10T14:32:28.000Z
+        statusModifiedDate: 2022-01-10T14:32:28.000Z
+        status: NEW
+        amount: '1000000000'
+    TaoUnStakingRequestPOSTBodyExample:
+      summary: Tao UnStaking Request POST Body Example
+      value:
+        clientId: d055adbc-66a3-4ccd-9a9d-726a05bca0cf
+        delegationId: e0225adbc-66a3-4ccd-9a9d-726a05bca0cf
+        type: UNSTAKE
+    TaoUnStakingRequestWithTransactionsExample:
+      summary: Tao UnStaking Request Example
+      value:
+        id: e055adbc-66a3-4ccd-9a9d-726a05bca0cf
+        clientId: f054adbc-26a3-4acd-8a9d-726a05bca0dr
+        requestUserId: 6092e75c451052000636831deb797bd1
+        enterpriseId: 1032e75c451052000436831deb797af1
+        walletId: 2032e75g451052000636831abd797bd3
+        withdrawalAddress: 5EKXEL1PnSxvBennEDin56yj5KgmcX3AW27sr1uqm9tBmKpn
+        walletType: custodial
+        type: UNSTAKE
+        coin: tao
+        createdDate: 2022-01-10T14:32:28.000Z
+        statusModifiedDate: 2022-01-10T14:32:28.000Z
+        status: NEW
+        delegations:
+          - id: e0225adbc-66a3-4ccd-9a9d-726a05bca0cf
+            delegationAddress: string
+            withdrawalAddress: 5EKXEL1PnSxvBennEDin56yj5KgmcX3AW27sr1uqm9tBmKpn
+            delegated: '1012000000'
+            status: ACTIVE
+            rewards: '12000000'
+            lockedRewards: '0'
+            pendingUnstake: '1012000000'
+            pendingStake: '0'
+            apy: '8.3'
+            unstakingFee: '1000000'
+            unstakingMin: '0'
+        transactions:
+          - id: i0500adbc-55b43-5tta-9a9d-726a05bca0op
+            stakingRequestId: e055adbc-66a3-4ccd-9a9d-726a05bca0cf
+            createdDate: 2022-01-10T14:32:28.000Z
+            statusModifiedDate: 2022-01-10T14:32:28.000Z
+            status: READY
+            amount: '1012'
+            transactionType: undelegate
+            delegationId: e0225adbc-66a3-4ccd-9a9d-726a05bca0cf
+          - id: p0500adbc-55b43-5tta-9a9d-726a05bca0dr
+            stakingRequestId: e055adbc-66a3-4ccd-9a9d-726a05bca0cf
+            createdDate: 2022-01-10T14:32:28.000Z
+            statusModifiedDate: 2022-01-10T14:32:28.000Z
+            status: WAITING
+            amount: '1012000000'
+            transactionType: withdraw_undelegated
+            delegationId: e0225adbc-66a3-4ccd-9a9d-726a05bca0cf
+        amount: '1012000000'
+    TaoUnStakingRequestWithoutDelegationsExample:
+      summary: Tao UnStaking Request Example
+      value:
+        id: e055adbc-66a3-4ccd-9a9d-726a05bca0cf
+        clientId: f054adbc-26a3-4acd-8a9d-726a05bca0dr
+        requestUserId: 6092e75c451052000636831deb797bd1
+        enterpriseId: 1032e75c451052000436831deb797af1
+        walletId: 2032e75g451052000636831abd797bd3
+        withdrawalAddress: 3Lwg4hE19Kg4BdUkuDh4v8xXoyoRQkbDMM6wX7zjQP6i
+        walletType: custodial
+        type: UNSTAKE
+        coin: tao
+        createdDate: 2022-01-10T14:32:28.000Z
+        statusModifiedDate: 2022-01-10T14:32:28.000Z
+        status: NEW
+        amount: '1012000000'
     TouchpointConditionsExample:
       summary: Touchpoint Conditions
       description: A successful response with 5 Touchpoint Conditions.
@@ -49280,6 +49446,9 @@ components:
         min:
           description: The minimum spendable amount.
           type: string
+        multiplier:
+          description: The multiplier amount to be staked. Default to 1, but for coins like where the amount to stake is multipler of 32 ETH, this is 32 in base unit, to allow validation.
+          type: string
         fee:
           description: The blockchain fee to submit the transactions needed to stake.
           type: string
@@ -49667,6 +49836,52 @@ components:
           type: string
       required:
         - tokenName
+    TaoStakingRequest:
+      title: TAO
+      allOf:
+        - $ref: '#/components/schemas/StakingRequest'
+      type: object
+      properties:
+        delegations:
+          type: array
+          minItems: 1
+          maxItems: 1
+          items:
+            $ref: '#/components/schemas/SolStakingDelegation'
+        transactions:
+          type: array
+          minItems: 1
+          maxItems: 500
+          items:
+            $ref: '#/components/schemas/SolStakingTransaction'
+        amount:
+          description: Amount to stake in base units.
+          type: string
+    TaoStakingRequestPOSTBody:
+      title: TAO stake
+      allOf:
+        - $ref: '#/components/schemas/StakingRequestPOSTBody'
+      type: object
+      properties:
+        validator:
+          description: The validator to delegate to
+          type: string
+          example: 5FCPTnjevGqAuTttetBy4a24Ej3pH9fiQ8fmvP1ZkrVsLUoT
+    TaoUnStakingRequestPOSTBody:
+      title: TAO unstake
+      allOf:
+        - $ref: '#/components/schemas/UnStakingRequestPOSTBody'
+      type: object
+      properties:
+        type:
+          description: Staking Request type = 'UNSTAKE'.
+          type: string
+          example: UNSTAKE
+        delegationId:
+          description: The delegation ID representing the delegation to unstake.
+          type: string
+      required:
+        - type
     TestcoinAddress:
       title: Testcoin Address
       type: object
@@ -52303,6 +52518,9 @@ components:
         min:
           description: The minimum spendable amount.
           type: string
+        multiplier:
+          description: The multiplier amount to be staked. Default to 1, but for coins like where the amount to stake is multipler of 32 ETH, this is 32 in base unit, to allow validation.
+          type: string
         fee:
           description: The blockchain fee to submit the transactions needed to unstake.
           type: string