feat: 🎸 Revamp settlements related entities #245
+3,466
−4,178
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
prashantasdeveloper
force-pushed
the
feat/settlements-v2
branch
3 times, most recently
from
cdd60ea
to
5169556
Compare
prashantasdeveloper
force-pushed
the
feat/settlements-v2
branch
2 times, most recently
from
236e22f
to
b6bc40e
Compare
BREAKING CHANGE: 🧨 Since some of the settlements related entities have been removed and new ones have been added, this will require a full resync. Following are the breaking changes: - Entities `Settlement`, `MediatorAffirmation`, `IdentityInstructions` have been removed - Changes in `Venue` entity 1. New attribute `signers` has been added to track all the allowed signers associated with them 2. New derived field `instructions: [Instruction]!` has been added to track instruction info associated a Venue - Adds new enum `InstructionTypeEnum` to track instruction type - Changes in `Instruction` entity 1. `eventId`, `eventIdx` have been removed 2. `settlementType: String!` has been modified to `type: InstructionTypeEnum!` 3. `endAfterBlock: Int` has been added to track block after which `SettleManual` type instructions can be executed 4. `mediators: [String!]!` has been added to track list of mediators for an instruction 5. New derived fields namely - `parties: [InstructionParty]!`, `affirmations: [InstructionAffirmation]!`, `events: [InstructionEvent]!` have been added to query more information about an instruction - Changes in `Leg` entity 1. Attribute `settlement: Settlement` has been removed 2. Attribute `instruction` is now non-null 3. The `from` and `to` part of the legs have been split separately into identity and portfolio number to support off chain legs. The new attributes are `from: String!`, `fromPortfolio: number`, `to: String!`, `toPortfolio: number` - Following new entities have been added: 1. `InstructionParty` - to track all the DIDs associated with an instruction. 2. `InstructionAffirmation`- to track all the affirmations received for an instruction 3. `OffChainReceipt` - to track all the receipts used in affirming off chain legs 4. `InstructionEvent` - to track all the event associated with an instruction. This will give a clear picture about the lifetime of an instruction on how it got created, to affirming, to execution
prashantasdeveloper
force-pushed
the
feat/settlements-v2
branch
from
b6bc40e
to
8255c13
Compare
prashantasdeveloper
requested review from
polymath-eric,
VictorVicente and
sansan
as code owners
|
|
|
||
| export const handleAssetCompliancePaused = async (event: SubstrateEvent): Promise<void> => { | ||
| const { params, blockId } = extractArgs(event); | ||
| const [, rawTicker] = params; | ||
|
|
||
| const ticker = serializeTicker(rawTicker); | ||
|
|
||
| const asset = await getAsset(ticker); | ||
| const asset = await await getAsset(ticker); |
There was a problem hiding this comment.
Suggested change
| const asset = await await getAsset(ticker); | |
| const asset = await getAsset(ticker); |
| @@ -29,7 +29,7 @@ export const handleAssetComplianceResumed = async (event: SubstrateEvent): Promi | |||
|
|
|||
| const ticker = serializeTicker(rawTicker); | |||
|
|
|||
| const asset = await getAsset(ticker); | |||
| const asset = await await getAsset(ticker); | |||
There was a problem hiding this comment.
Suggested change
| const asset = await await getAsset(ticker); | |
| const asset = await getAsset(ticker); |
| @@ -41,7 +41,7 @@ export const handleNftCollectionCreated = async (event: SubstrateEvent): Promise | |||
| const { params, blockId } = extractArgs(event); | |||
| const [, rawTicker] = params; | |||
| const ticker = serializeTicker(rawTicker); | |||
| const asset = await getAsset(ticker); | |||
| const asset = await await getAsset(ticker); | |||
There was a problem hiding this comment.
Suggested change
| const asset = await await getAsset(ticker); | |
| const asset = await getAsset(ticker); |
| @@ -73,7 +73,7 @@ export const handleNftPortfolioUpdates = async (event: SubstrateEvent): Promise< | |||
|
|
|||
| const { ticker, ids } = getNftId(rawNftId); | |||
|
|
|||
| const asset = await getAsset(ticker); | |||
| const asset = await await getAsset(ticker); | |||
There was a problem hiding this comment.
Suggested change
| const asset = await await getAsset(ticker); | |
| const asset = await getAsset(ticker); |
| import { CallIdEnum, ModuleIdEnum, EventIdEnum } from 'src/types'; | ||
| import { PolyxTransactionProps } from '../types/models/PolyxTransaction'; | ||
|
|
||
| // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types |
There was a problem hiding this comment.
What about disabling for the whole file?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Settlement,MediatorAffirmation,IdentityInstructionshave been removedVenueentitysignershas been added to track all the allowed signers associated with theminstructions: [Instruction]!has been added to track instruction infoassociated a Venue
InstructionTypeEnumto track instruction typeInstructionentityeventId,eventIdxhave been removedsettlementType: String!has been modified totype: InstructionTypeEnum!endAfterBlock: Inthas been added to track block after whichSettleManualtypeinstructions can be executed
mediators: [String!]!has been added to track list of mediators for an instructionparties: [InstructionParty]!,affirmations: [InstructionAffirmation]!,events: [InstructionEvent]!have been added toquery more information about an instruction
Legentitysettlement: Settlementhas been removedinstructionis now non-nullfromandtopart of the legs have been split separately into identity andportfolio number to support off chain legs. The new attributes are
from: String!,fromPortfolio: number,to: String!,toPortfolio: numberInstructionParty- to track all the DIDs associated with an instruction.InstructionAffirmation- to track all the affirmations received for an instructionOffChainReceipt- to track all the receipts used in affirming off chain legsInstructionEvent- to track all the event associated with an instruction.This will give a clear picture about the lifetime of an instruction on how it got created,
to affirming, to execution
Breaking Changes
Since some of the settlements related entities have been removed and new ones have been added, this will require a full resync
JIRA Link
DA-1232
Checklist