Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Withdrawals output address and document id field #332

Merged
merged 5 commits into from
Nov 27, 2024
Merged

Withdrawals output address and document id field #332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
62bf8bf
initial fix
owl352 Nov 27, 2024
74f9254
lint
owl352 Nov 27, 2024
87a9d15
readme fix
owl352 Nov 27, 2024
29f70ea
empty array fix
owl352 Nov 27, 2024
c959506
names fix
owl352 Nov 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 6 additions & 31 deletions packages/api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -734,40 +734,15 @@ GET /identity/A1rgGVjRGuznRThdAA316VEEpKuVQ7mV8mBK1BFJvXnb/withdrawals?limit=5
},
resultSet: [
{
"timestamp": 1729096625509,
"sender": "A1rgGVjRGuznRThdAA316VEEpKuVQ7mV8mBK1BFJvXnb",
"id": "95eiiqMotMvH23f6cv3BPC4ykcHFWTy2g3baCTWZANAs",
"amount": 200000,
"status": 3
},
{
"timestamp": 1729096140465,
"sender": "A1rgGVjRGuznRThdAA316VEEpKuVQ7mV8mBK1BFJvXnb",
"id": "DJzb8nj7JTHwnvAGEGhyFc5hHLFa5Es9WFAyS4HhhNeF",
"amount": 200000,
"status": 3
},
{
"timestamp": 1729096636318,
"document": "95eiiqMotMvH23f6cv3BPC4ykcHFWTy2g3baCTWZANAs",
"sender": "A1rgGVjRGuznRThdAA316VEEpKuVQ7mV8mBK1BFJvXnb",
"id": "E4gbWCQgqrz9DVrzCeDKhr4PVsfp6CeL5DUAYndRVWdk",
"status": "COMPLETE",
"amount": 200000,
"status": 3
},
{
"timestamp": 1729096795042,
"sender": "A1rgGVjRGuznRThdAA316VEEpKuVQ7mV8mBK1BFJvXnb",
"id": "FouX2qY8Eaxj5rSBrH9uxbhAM16ozrUP4sJwdo9pL7Cr",
"amount": 200000,
"status": 3
"timestamp": 1729096625509,
"withdrawalAddress": "yeRZBWYfeNE4yVUHV4ZLs83Ppn9aMRH57A",
"hash": "113F86F4D1F48159B0D6690F3C5F8F33E39243086C041CF016454A66AD63F025"
},
{
"timestamp": 1729097247874,
"sender": "A1rgGVjRGuznRThdAA316VEEpKuVQ7mV8mBK1BFJvXnb",
"id": "9VEpb2aJRnCxfi3LjFXWa1zshkBPfzzHHh5yqEkgqw1t",
"amount": 200000,
"status": 3
}
...
]
}
```
Expand Down
30 changes: 23 additions & 7 deletions packages/api/src/controllers/IdentitiesController.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@ const IdentitiesDAO = require('../dao/IdentitiesDAO')
const { WITHDRAWAL_CONTRACT_TYPE } = require('../constants')
const WithdrawalsContract = require('../../data_contracts/withdrawals.json')
const PaginatedResultSet = require('../models/PaginatedResultSet')
const { decodeStateTransition } = require('../utils')

class IdentitiesController {
constructor (knex, dapi) {
constructor (client, knex, dapi) {
this.identitiesDAO = new IdentitiesDAO(knex, dapi)
this.dapi = dapi
this.client = client
}

getIdentityByIdentifier = async (request, response) => {
Expand Down Expand Up @@ -83,17 +85,31 @@ class IdentitiesController {

const documents = await this.dapi.getDocuments(WITHDRAWAL_CONTRACT_TYPE, WithdrawalsContract, identifier, limit)

if (documents.length === 0) {
return response.send(new PaginatedResultSet([], null, null, null))
}

const timestamps = documents.map(document => new Date(document.timestamp).toISOString())

const txHashes = await this.identitiesDAO.getIdentityWithdrawalsByTimestamps(identifier, timestamps)
const withdrawals = await this.identitiesDAO.getIdentityWithdrawalsByTimestamps(identifier, timestamps)

if (documents.length === 0) {
return response.status(404).send({ message: 'not found' })
}
const decodedTx = await Promise.all(withdrawals.map(async withdrawal => ({
...await decodeStateTransition(this.client, withdrawal.data),
timestamp: withdrawal.timestamp
})))

const resultSet = documents.map(document => ({
...document,
hash: txHashes.find(
document: document.id ?? null,
sender: document.sender ?? null,
status: document.status ?? null,
timestamp: document.timestamp ?? null,
amount: document.amount ?? null,
withdrawalAddress:
decodedTx.find(
tx => tx.timestamp.getTime() === document.timestamp
)?.outputAddress ?? null,

hash: withdrawals.find(
hash =>
new Date(hash.timestamp).toISOString() === new Date(document.timestamp).toISOString())?.hash ?? null
}))
Expand Down
2 changes: 1 addition & 1 deletion packages/api/src/dao/IdentitiesDAO.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@ module.exports = class IdentitiesDAO {

getIdentityWithdrawalsByTimestamps = async (identifier, timestamps = []) => {
return this.knex('state_transitions')
.select('state_transitions.hash', 'blocks.timestamp as timestamp')
.select('state_transitions.hash', 'blocks.timestamp as timestamp', 'state_transitions.data as data')
.whereIn(
'blocks.timestamp',
timestamps
Expand Down
2 changes: 1 addition & 1 deletion packages/api/src/server.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ module.exports = {
const transactionsController = new TransactionsController(client, knex, dapi)
const dataContractsController = new DataContractsController(knex)
const documentsController = new DocumentsController(knex)
const identitiesController = new IdentitiesController(knex, dapi)
const identitiesController = new IdentitiesController(client, knex, dapi)
const validatorsController = new ValidatorsController(knex, dapi)
const rateController = new RateController()

Expand Down
10 changes: 7 additions & 3 deletions packages/api/src/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,12 +246,16 @@ const decodeStateTransition = async (client, base64) => {
break
}
case StateTransitionEnum.IDENTITY_CREDIT_WITHDRAWAL: {
decoded.outputAddress = dashcorelib.Script(stateTransition.getOutputScript()).toAddress(NETWORK).toString()
decoded.userFeeIncrease = stateTransition.getUserFeeIncrease()
decoded.outputAddress = stateTransition.getOutputScript()
? dashcorelib
.Script(stateTransition.getOutputScript())
.toAddress(NETWORK)
.toString()
: null

decoded.userFeeIncrease = stateTransition.getUserFeeIncrease()
decoded.identityContractNonce = Number(stateTransition.getIdentityContractNonce())
decoded.identityNonce = parseInt(stateTransition.getNonce())

decoded.senderId = stateTransition.getIdentityId().toString()
decoded.amount = parseInt(stateTransition.getAmount())
decoded.outputScript = stateTransition.getOutputScript()?.toString('hex') ?? null
Expand Down
18 changes: 14 additions & 4 deletions packages/api/test/integration/identities.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,8 @@ describe('Identities routes', () => {
const transaction = await fixtures.transaction(knex, {
block_hash: block.hash,
type: StateTransitionEnum.IDENTITY_CREDIT_WITHDRAWAL,
owner: identity.owner
owner: identity.owner,
data: 'BQFh0z9HiTN5e+TeiDU8fC2EPCExD20A9u/zFCSnVu59+/0AAAB0alKIAAEAAAEAAUEf89R9GPHIX5QLD/HKJ1xjd86KrnTsfAOxPMxBNDO8cJkAT5yUhcl/sGbQYoHSuNVIZcVVTVnSsYMXIyimihp3Vw=='
})

transactions.push({ transaction, block })
Expand All @@ -274,14 +275,23 @@ describe('Identities routes', () => {
.expect(200)
.expect('Content-Type', 'application/json; charset=utf-8')

assert.deepEqual(body.resultSet, withdrawals.map(withdrawal => ({ ...withdrawal, hash: withdrawal.id })))
assert.deepEqual(body.resultSet, withdrawals.map(withdrawal => ({
hash: withdrawal.id,
document: withdrawal.id,
sender: withdrawal.sender,
status: withdrawal.status,
timestamp: withdrawal.timestamp,
amount: withdrawal.amount,
withdrawalAddress: null
})))
})

it('should return 404 whe identity not exist', async () => {
mock.method(DAPI.prototype, 'getDocuments', async () => [])
await client.get('/identity/1234123123PFdomuTVvNy3VRrvWgvkKPzqehEBpNf2nk6/withdrawals')
.expect(404)
const { body } = await client.get('/identity/1234123123PFdomuTVvNy3VRrvWgvkKPzqehEBpNf2nk6/withdrawals')
.expect('Content-Type', 'application/json; charset=utf-8')

assert.deepEqual(body.resultSet, [])
})
})

Expand Down
37 changes: 6 additions & 31 deletions packages/frontend/src/app/api/content.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -701,40 +701,15 @@ GET /identity/A1rgGVjRGuznRThdAA316VEEpKuVQ7mV8mBK1BFJvXnb/withdrawals?limit=5
},
resultSet: [
{
"timestamp": 1729096625509,
"sender": "A1rgGVjRGuznRThdAA316VEEpKuVQ7mV8mBK1BFJvXnb",
"id": "95eiiqMotMvH23f6cv3BPC4ykcHFWTy2g3baCTWZANAs",
"amount": 200000,
"status": 3
},
{
"timestamp": 1729096140465,
"sender": "A1rgGVjRGuznRThdAA316VEEpKuVQ7mV8mBK1BFJvXnb",
"id": "DJzb8nj7JTHwnvAGEGhyFc5hHLFa5Es9WFAyS4HhhNeF",
"amount": 200000,
"status": 3
},
{
"timestamp": 1729096636318,
"document": "95eiiqMotMvH23f6cv3BPC4ykcHFWTy2g3baCTWZANAs",
"sender": "A1rgGVjRGuznRThdAA316VEEpKuVQ7mV8mBK1BFJvXnb",
"id": "E4gbWCQgqrz9DVrzCeDKhr4PVsfp6CeL5DUAYndRVWdk",
"status": "COMPLETE",
"amount": 200000,
"status": 3
},
{
"timestamp": 1729096795042,
"sender": "A1rgGVjRGuznRThdAA316VEEpKuVQ7mV8mBK1BFJvXnb",
"id": "FouX2qY8Eaxj5rSBrH9uxbhAM16ozrUP4sJwdo9pL7Cr",
"amount": 200000,
"status": 3
"timestamp": 1729096625509,
"withdrawalAddress": "yeRZBWYfeNE4yVUHV4ZLs83Ppn9aMRH57A",
"hash": "113F86F4D1F48159B0D6690F3C5F8F33E39243086C041CF016454A66AD63F025"
},
{
"timestamp": 1729097247874,
"sender": "A1rgGVjRGuznRThdAA316VEEpKuVQ7mV8mBK1BFJvXnb",
"id": "9VEpb2aJRnCxfi3LjFXWa1zshkBPfzzHHh5yqEkgqw1t",
"amount": 200000,
"status": 3
}
...
]
}
```
Expand Down