Escrow Container Management
In order to use a user’s assets for your application, you must first require the user to transfer their ownership temporarily to Upland. Upland, in turn, locks these assets in a vault-like account. In Upland terminology, this vault-like account, controlled by Upland, is called an escrow account.
The developer is responsible for specifying necessary assets the users have to transfer to the escrow account to use your application (for example, a drag car-racing application will need a user to place at least one block explore and one car in the escrow to participate).
Within the escrow account, each application is assigned an escrow container, which contains transferred assets necessary to use the application.
At junctions determined by your application logic, your application can request a resolution of its escrow container (for example, at the end of a drag car-racing application, the loser loses his block explore to the winner).
You can also query the content of your application’s escrow container, request to extend its validity, etc.
The available assets the developers can use so far are:
- 1.Block Explorers
- 2.Structured Ornaments
- 3.Spirit Legits
- 4.Upx
In the hackathon we also allowed SPARK, but we decided to remove it temporarily.
These endpoints require Basic Authentication. Click here to read more about how to generate valid credentials.
post
/containers
Create a new escrow container
get
/containers/{containerId}
Query Escrow Container
post
/containers/{containerId}/refresh-expiration-time
Refresh Expiration time of Escrow Container
post
/containers/{containerId}/lock
Locks the escrow container (Optional)
post
/containers/{containerId}/resolve
Execute operations over the escrow assets and resolve container
post
/containers/{containerId}/refund
Refund container assets
delete
/containers/{containerId}/transactions/{transactionId}
Remove a transaction from container
You must provide a Code to your users generated across the endpoint /auth/opt/init. Then, when Upland User grants access to the developer App, a webhook will be sent with a valid access token. Click here to check the authentication session.
post
/user/join
Put assets in escrow container