-
Notifications
You must be signed in to change notification settings - Fork 285
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: custom transaction types (#2247)
- Loading branch information
1 parent
fca6888
commit eaf7bcd
Showing
41 changed files
with
616 additions
and
299 deletions.
There are no files selected for viewing
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
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
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
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
159 changes: 159 additions & 0 deletions
159
__tests__/unit/core-transactions/handler-registry.test.ts
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,159 @@ | ||
| import "jest-extended"; | ||
|
|
||
| import { Database, TransactionPool } from "@arkecosystem/core-interfaces"; | ||
| import { | ||
| Bignum, | ||
| configManager, | ||
| constants, | ||
| crypto, | ||
| ITransactionData, | ||
| schemas, | ||
| slots, | ||
| Transaction, | ||
| TransactionConstructor, | ||
| TransactionRegistry, | ||
| } from "@arkecosystem/crypto"; | ||
| import bs58check from "bs58check"; | ||
| import ByteBuffer from "bytebuffer"; | ||
| import { errors, TransactionHandler, TransactionHandlerRegistry } from "../../../packages/core-transactions/src"; | ||
|
|
||
| const { transactionBaseSchema, extend } = schemas; | ||
| const { TransactionTypes } = constants; | ||
|
|
||
| const TEST_TRANSACTION_TYPE = 100; | ||
|
|
||
| class TestTransaction extends Transaction { | ||
| public static type = TEST_TRANSACTION_TYPE; | ||
|
|
||
| public static getSchema(): schemas.TransactionSchema { | ||
| return extend(transactionBaseSchema, { | ||
| $id: "test", | ||
| required: ["recipientId", "amount", "asset"], | ||
| properties: { | ||
| type: { transactionType: TEST_TRANSACTION_TYPE }, | ||
| recipientId: { $ref: "address" }, | ||
| asset: { | ||
| type: "object", | ||
| required: ["test"], | ||
| properties: { | ||
| test: { | ||
| type: "number", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }); | ||
| } | ||
|
|
||
| public serialize(): ByteBuffer { | ||
| const { data } = this; | ||
| const buffer = new ByteBuffer(24, true); | ||
| buffer.writeUint64(+data.amount); | ||
| buffer.writeUint32(data.expiration || 0); | ||
| buffer.append(bs58check.decode(data.recipientId)); | ||
| buffer.writeInt32(data.asset.test); | ||
|
|
||
| return buffer; | ||
| } | ||
|
|
||
| public deserialize(buf: ByteBuffer): void { | ||
| const { data } = this; | ||
| data.amount = new Bignum(buf.readUint64().toString()); | ||
| data.expiration = buf.readUint32(); | ||
| data.recipientId = bs58check.encode(buf.readBytes(21).toBuffer()); | ||
| data.asset = { | ||
| test: buf.readInt32(), | ||
| }; | ||
| } | ||
| } | ||
|
|
||
| // tslint:disable-next-line:max-classes-per-file | ||
| class TestTransactionHandler extends TransactionHandler { | ||
| public getConstructor(): TransactionConstructor { | ||
| return TestTransaction; | ||
| } | ||
|
|
||
| public apply(transaction: Transaction, wallet: Database.IWallet): void { | ||
| return; | ||
| } | ||
| public revert(transaction: Transaction, wallet: Database.IWallet): void { | ||
| return; | ||
| } | ||
|
|
||
| public canEnterTransactionPool(data: ITransactionData, guard: TransactionPool.ITransactionGuard): boolean { | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| beforeAll(() => { | ||
| configManager.setFromPreset("testnet"); | ||
| configManager.milestone.data.fees.staticFees.test = 1234; | ||
| }); | ||
|
|
||
| afterAll(() => { | ||
| delete configManager.milestone.data.fees.staticFees.test; | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| TransactionHandlerRegistry.deregisterCustomTransactionHandler(TestTransactionHandler); | ||
| }); | ||
|
|
||
| describe("TransactionHandlerRegistry", () => { | ||
| it("should register core transaction types", () => { | ||
| expect(() => { | ||
| TransactionHandlerRegistry.get(TransactionTypes.Transfer); | ||
| TransactionHandlerRegistry.get(TransactionTypes.SecondSignature); | ||
| TransactionHandlerRegistry.get(TransactionTypes.DelegateRegistration); | ||
| TransactionHandlerRegistry.get(TransactionTypes.Vote); | ||
| TransactionHandlerRegistry.get(TransactionTypes.MultiSignature); | ||
| }).not.toThrow(errors.InvalidTransactionTypeError); | ||
| }); | ||
|
|
||
| it("should register a custom type", () => { | ||
| expect(() => | ||
| TransactionHandlerRegistry.registerCustomTransactionHandler(TestTransactionHandler), | ||
| ).not.toThrowError(); | ||
|
|
||
| expect(TransactionHandlerRegistry.get(TEST_TRANSACTION_TYPE)).toBeInstanceOf(TestTransactionHandler); | ||
| expect(TransactionRegistry.get(TEST_TRANSACTION_TYPE)).toBe(TestTransaction); | ||
| }); | ||
|
|
||
| it("should be able to instantiate a custom transaction", () => { | ||
| TransactionHandlerRegistry.registerCustomTransactionHandler(TestTransactionHandler); | ||
|
|
||
| const keys = crypto.getKeys("secret"); | ||
| const data: ITransactionData = { | ||
| type: TEST_TRANSACTION_TYPE, | ||
| timestamp: slots.getTime(), | ||
| senderPublicKey: keys.publicKey, | ||
| fee: "10000000", | ||
| amount: "200000000", | ||
| recipientId: "APyFYXxXtUrvZFnEuwLopfst94GMY5Zkeq", | ||
| asset: { | ||
| test: 256, | ||
| }, | ||
| }; | ||
|
|
||
| data.signature = crypto.sign(data, keys); | ||
| data.id = crypto.getId(data); | ||
|
|
||
| const transaction = Transaction.fromData(data); | ||
| expect(transaction).toBeInstanceOf(TestTransaction); | ||
| expect(transaction.verified).toBeTrue(); | ||
|
|
||
| const bytes = Transaction.toBytes(transaction.data); | ||
| const deserialized = Transaction.fromBytes(bytes); | ||
| expect(deserialized.verified); | ||
| expect(deserialized.data.asset.test).toBe(256); | ||
| }); | ||
|
|
||
| it("should not be ok when registering the same type again", () => { | ||
| expect(() => | ||
| TransactionHandlerRegistry.registerCustomTransactionHandler(TestTransactionHandler), | ||
| ).not.toThrowError(errors.TransactionHandlerAlreadyRegisteredError); | ||
|
|
||
| expect(() => TransactionHandlerRegistry.registerCustomTransactionHandler(TestTransactionHandler)).toThrowError( | ||
| errors.TransactionHandlerAlreadyRegisteredError, | ||
| ); | ||
| }); | ||
| }); |
Oops, something went wrong.