Pledging & Collateral

📘

In This Article

This article will cover the following topics:

• How to pledge collateral with Taurus Network (TN).
• How to accept a pledge as the counter-party.
• How to configure collateral transfer settings for a pledge via API.

Note: Completing this Guide requires access to two PROTECT tenants that are both connected to the Taurus Network (TN).

Introduction

Once a shared address has been established with your counterparty, you can use the Taurus Network to pledge collateral to any connected participant. Collateral withdrawal permissions are fully configurable: you may require bilateral approval for any collateral call or withdrawal, delegate unilateral withdrawal rights to the counterparty, or retain exclusive control yourself. This doc will take you through the workflow to set this up via the API and requires steps from both the initiator of the pledge and the counterparty.

Pledge Workflow

1. Initiate a pledge (participant)
2. Approve pledge action (participant)
3. Accept a Pledge (counterparty)
   1. Optionally set default destination (if auto-approved by pledgee is enabled)
   2. Approve a pledge action

Initiate a Pledge (Participant)

1. Look up the participantID of the counter party via the List Participants endpoint.
2. Look up the pledge token's CurrencyID via the List Currencies endpoint.
3. Look up the shared addressID via the List Shared Addresses endpoint. If the address with the funds is not listed it must first be shared.
4. Create a pledge via the Create a Pledge endpoint. , filling in the following fields:
   1. curencyID
   2. participantID
   3. sharedAddressID
   4. pledgeDurationSetup (all three values)
   5. pledgetype
5. Confirm you receive a 200 response from the endpoint.

Approve a Pledge Action (Participant)

1. After creating the pledge, it must be signed using the Approve a Pledge Action endpoiint. Please see Signing for Approval for more information on signing.
2. The pledge will then appear to be accepted by the counterparty.

Accept a Pledge (Counterparty)

After a participant signs a pledge request, it must be accepted by the counterparty. It is the same action on both sides. When the counterparty signs the pledge action, it will be accepted. Depending on the Collateral Transfer Rules you may need an additional step. Depending on the collateral transfer rule, the steps are slightly different.

Collateral Transfer Rule: Approved by pledgor

1. Use the for-approval endpoint to find the appropriate. Save the hash of the request.
2. Sign the request (note that multiple signatures may be required based on the respective Governance rules).

Collateral Transfer Rule: Approved by pledgee

1. Use the for-approval endpoint to find the appropriate. Save the hash of the request.
2. Call the Update Pledge endpoint and provide a default deposit address.

🚧

Important

1. This must be an address that is shared with the pledgor since the address needs to be whitelisted on their side. Sharing an address with a participant whitelists the address. The address provided via the sharedDestinationAddressIdor internalDestinationAddressId must be shared. It is recommended to use the sharedDestinationAddressId parameter.

3. After updating the pledge with a shared destination address, sign the request hash to approve the transaction.

Collateral Transfer Rule: Not Allowed

Accepting a pledge with these rules is the same as accepting a rule as approved by pledger. No additional steps are required beyond the counterparty accepting the pledge (signing the request).

Withdraw Pledge

If the pledgor has delegated withdraw permissions, you can request a withdrawal with the Withdraw Pledge endpoint.

If the Collateral Transfer Rules are set to Approved by Pledgee, you will be able to sign the request and initiate the transfer (ensure a shared destination address is set.

If the Collateral Transfer Rules are set to Approved by Pledgor, you will be able to initiate a request but it will need to be signed by the pledgor.

In both cases, the transaction hash would be signed the same way any other request is signed.