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.

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

Use new transaction fromJSON and toJSON #416

Merged
merged 5 commits into from
Feb 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion examples/add-example-Web3Id/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
"start": "live-server ./index.html --mount=/sdk.js:../../node_modules/@concordium/web-sdk/lib/concordium.min.js --mount=/helpers.js:../../packages/browser-wallet-api-helpers/lib/concordiumHelpers.min.js"
},
"dependencies": {
"@concordium/web-sdk": "^7.1.0"
"@concordium/web-sdk": "^7.3.2"
}
}
2 changes: 1 addition & 1 deletion examples/eSealing/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"license": "Apache-2.0",
"dependencies": {
"@concordium/react-components": "^0.4.0",
"@concordium/web-sdk": "^7.1.0",
"@concordium/web-sdk": "^7.3.2",
"@thi.ng/leb128": "^2.1.18",
"@types/sha256": "^0.2.0",
"@walletconnect/types": "^2.1.4",
Expand Down
2 changes: 1 addition & 1 deletion examples/nft-minting/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"packageManager": "[email protected]",
"dependencies": {
"@concordium/browser-wallet-api-helpers": "workspace:^",
"@concordium/web-sdk": "^7.1.0",
"@concordium/web-sdk": "^7.3.2",
"cors": "^2.8.5",
"express": "^4.18.1",
"express-fileupload": "^1.4.0",
Expand Down
2 changes: 1 addition & 1 deletion examples/piggybank/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"packageManager": "[email protected]",
"dependencies": {
"@concordium/browser-wallet-api-helpers": "workspace:^",
"@concordium/web-sdk": "^7.1.0",
"@concordium/web-sdk": "^7.3.2",
"react": "^18.1.0",
"react-dom": "^18.1.0"
},
Expand Down
2 changes: 1 addition & 1 deletion examples/two-step-transfer/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
"start": "live-server ../two-step-transfer/index.html --mount=/sdk.js:../../node_modules/@concordium/web-sdk/lib/min/concordium.web.min.js --mount=/helpers.js:../../packages/browser-wallet-api-helpers/lib/concordiumHelpers.min.js"
},
"dependencies": {
"@concordium/web-sdk": "^7.1.0"
"@concordium/web-sdk": "^7.3.2"
}
}
2 changes: 1 addition & 1 deletion examples/voting/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"packageManager": "[email protected]",
"dependencies": {
"@concordium/browser-wallet-api-helpers": "^3.0.0",
"@concordium/web-sdk": "^7.1.0",
"@concordium/web-sdk": "^7.3.2",
"bootstrap": "^5.2.1",
"moment": "^2.29.4",
"react": "^18.2.0",
Expand Down
2 changes: 1 addition & 1 deletion examples/wCCD/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"license": "Apache-2.0",
"dependencies": {
"@concordium/react-components": "^0.4.0",
"@concordium/web-sdk": "^7.1.0",
"@concordium/web-sdk": "^7.3.2",
"@thi.ng/leb128": "^2.1.18",
"@walletconnect/types": "^2.1.4",
"mathjs": "^11.4.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/browser-wallet-api/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"@concordium/browser-wallet-api-helpers": "workspace:^",
"@concordium/browser-wallet-message-hub": "workspace:^",
"@concordium/common-sdk": "^9.5.3",
"@concordium/web-sdk": "^7.1.0",
"@concordium/web-sdk": "^7.3.2",
"@protobuf-ts/grpcweb-transport": "^2.8.2",
"@protobuf-ts/runtime-rpc": "^2.8.2",
"buffer": "^6.0.3",
Expand Down
30 changes: 28 additions & 2 deletions packages/browser-wallet-api/src/compatibility.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ import {
SimpleTransferWithMemoPayload,
UpdateCredentialsPayload,
DataBlob,
AccountTransactionPayload,
Parameter,
getAccountTransactionHandler,
AccountTransactionPayloadJSON,
} from '@concordium/web-sdk/types';
import { IdStatement } from '@concordium/web-sdk/id';

Expand Down Expand Up @@ -346,7 +350,7 @@ function sanitizePayload(type: AccountTransactionType, payload: SendTransactionP
export type SanitizedSendTransactionInput = {
accountAddress: AccountAddress.Type;
type: AccountTransactionType;
payload: SendTransactionPayload;
payload: AccountTransactionPayloadJSON;
parameters?: SmartContractParameters;
schema?: SchemaWithContext;
schemaVersion?: SchemaVersion;
Expand All @@ -366,6 +370,28 @@ export function sanitizeSendTransactionInput(
const sanitizedAccountAddress = sanitizeAccountAddress(accountAddress);
const sanitizedPayload = sanitizePayload(type, payload);

let accountTransactionPayload: AccountTransactionPayload;
switch (type) {
case AccountTransactionType.Update:
accountTransactionPayload = {
...(sanitizedPayload as SendTransactionUpdateContractPayload),
message: Parameter.empty(),
};
break;
case AccountTransactionType.InitContract:
accountTransactionPayload = {
...(sanitizedPayload as SendTransactionInitContractPayload),
param: Parameter.empty(),
};
break;
default:
accountTransactionPayload = sanitizedPayload as AccountTransactionPayload;
break;
}

const handler = getAccountTransactionHandler(type);
const sanitizedPayloadJSON = handler.toJSON(accountTransactionPayload);

let sanitizedSchema: SchemaWithContext | undefined;
if (typeof schema === 'string' || schema instanceof String) {
sanitizedSchema = {
Expand All @@ -379,7 +405,7 @@ export function sanitizeSendTransactionInput(
return {
accountAddress: sanitizedAccountAddress,
type,
payload: sanitizedPayload,
payload: sanitizedPayloadJSON,
parameters,
schema: sanitizedSchema,
schemaVersion,
Expand Down
4 changes: 2 additions & 2 deletions packages/browser-wallet-api/src/util.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
import { CcdAmount, jsonStringify } from '@concordium/web-sdk/types';
import { CcdAmount } from '@concordium/web-sdk/types';
import { Buffer } from 'buffer/';
import { isGtuAmount } from './compatibility';
import { serializationTypes } from './constants';
Expand Down Expand Up @@ -29,5 +29,5 @@ export function replacer(this: any, k: string, value: any) {
* Stringify that acts as an inverse for parse from browser-wallet @shared/utils/payload-helpers
*/
export function stringify(input: any) {
return jsonStringify(input, replacer);
return JSON.stringify(input, replacer);
}
1 change: 1 addition & 0 deletions packages/browser-wallet-api/src/wallet-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ class WalletApi extends EventEmitter implements IWalletApi {
schemaVersion?: SchemaVersion
): Promise<string> {
const input = sanitizeSendTransactionInput(accountAddress, type, payload, parameters, schema, schemaVersion);

const response = await this.messageHandler.sendMessage<MessageStatusWrapper<string>>(
MessageType.SendTransaction,
{
Expand Down
83 changes: 58 additions & 25 deletions packages/browser-wallet-api/test/compatibility.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,18 @@ import {
DeployModulePayload,
Energy,
EntrypointName,
getAccountTransactionHandler,
IdStatementBuilder,
jsonParse,
jsonStringify,
InitContractPayload,
ModuleReference,
OpenStatus,
Parameter,
ReceiveName,
RegisterDataPayload,
SchemaVersion,
SimpleTransferPayload,
SimpleTransferWithMemoPayload,
UpdateContractPayload,
UpdateCredentialsPayload,
} from '@concordium/web-sdk';
import {
Expand Down Expand Up @@ -146,10 +148,17 @@ describe(sanitizeSendTransactionInput, () => {
const parameters: SmartContractParameters = { obj: 'test' };
const schema = 'VGhpcyBpcyBiYXNlNjQK';

const handler = getAccountTransactionHandler(type);
const accountTransactionPayload = {
...payload,
message: Parameter.empty(),
};
const payloadJSON = handler.toJSON(accountTransactionPayload);

let expected: SanitizedSendTransactionInput = {
accountAddress: AccountAddress.fromBase58(accountAddress),
type,
payload,
payload: payloadJSON,
};

let result = sanitizeSendTransactionInput(accountAddress, type, payload);
Expand All @@ -174,16 +183,20 @@ describe(sanitizeSendTransactionInput, () => {
'23513bcb5dbc81216fa4e12d3165a818e2b8699a1c9ef5c699f46ca3b1024ebf'
);

const expectedPayload: SendTransactionInitContractPayload = {
const expectedPayload: InitContractPayload = {
moduleRef,
maxContractExecutionEnergy: Energy.create(maxContractExecutionEnergy),
amount: CcdAmount.fromMicroCcd(amount),
initName: ContractName.fromString(contractName),
param: Parameter.empty(),
};
const handler = getAccountTransactionHandler(type);
const expectedPayloadJSON = handler.toJSON(expectedPayload);

const expected: SanitizedSendTransactionInput = {
accountAddress: AccountAddress.fromBase58(accountAddress),
type,
payload: expectedPayload,
payload: expectedPayloadJSON,
};

const v0: InitContractPayloadV0 = {
Expand Down Expand Up @@ -231,19 +244,22 @@ describe(sanitizeSendTransactionInput, () => {
const type = AccountTransactionType.Update;
const receiveName = `${contractName}.${entrypointName}`;

const expectedPayload: SendTransactionUpdateContractPayload = {
const expectedPayload: UpdateContractPayload = {
maxContractExecutionEnergy: Energy.create(maxContractExecutionEnergy),
amount: CcdAmount.fromMicroCcd(amount),
address: ContractAddress.create(contractIndex, contractSubindex),
receiveName: ReceiveName.create(
ContractName.fromString(contractName),
EntrypointName.fromString(entrypointName)
),
message: Parameter.empty(),
};
const handler = getAccountTransactionHandler(type);
const expectedPayloadJSON = handler.toJSON(expectedPayload);
const expected: SanitizedSendTransactionInput = {
accountAddress: AccountAddress.fromBase58(accountAddress),
type,
payload: expectedPayload,
payload: expectedPayloadJSON,
};

const v0: UpdateContractPayloadV0 = {
Expand Down Expand Up @@ -289,10 +305,12 @@ describe(sanitizeSendTransactionInput, () => {
version,
source,
};
const handler = getAccountTransactionHandler(type);
const expectedPayloadJSON = handler.toJSON(expectedPayload);
const expected: SanitizedSendTransactionInput = {
accountAddress: AccountAddress.fromBase58(accountAddress),
type,
payload: expectedPayload,
payload: expectedPayloadJSON,
};

const v0: DeployModulePayloadV0 = {
Expand All @@ -319,10 +337,12 @@ describe(sanitizeSendTransactionInput, () => {
toAddress: AccountAddress.fromBase58(accountAddress),
amount: CcdAmount.fromMicroCcd(amount),
};
const handler = getAccountTransactionHandler(type);
const expectedPayloadJSON = handler.toJSON(expectedPayload);
const expected: SanitizedSendTransactionInput = {
accountAddress: AccountAddress.fromBase58(accountAddress),
type,
payload: expectedPayload,
payload: expectedPayloadJSON,
};

const v0: SimpleTransferPayloadV0 = {
Expand Down Expand Up @@ -359,10 +379,12 @@ describe(sanitizeSendTransactionInput, () => {
amount: CcdAmount.fromMicroCcd(amount),
memo,
};
const handler = getAccountTransactionHandler(type);
const expectedPayloadJSON = handler.toJSON(expectedPayload);
const expected: SanitizedSendTransactionInput = {
accountAddress: AccountAddress.fromBase58(accountAddress),
type,
payload: expectedPayload,
payload: expectedPayloadJSON,
};

const v0: SimpleTransferWithMemoPayloadV0 = {
Expand Down Expand Up @@ -403,11 +425,13 @@ describe(sanitizeSendTransactionInput, () => {
amount: CcdAmount.fromMicroCcd(amount),
memo,
};
const handler = getAccountTransactionHandler(type);
const expectedPayloadJSON = handler.toJSON(expectedPayload);

const expected: SanitizedSendTransactionInput = {
accountAddress: AccountAddress.fromBase58(accountAddress),
type,
payload: expectedPayload,
payload: expectedPayloadJSON,
};

const payload: SimpleTransferWithMemoPayload = {
Expand All @@ -428,9 +452,6 @@ describe(sanitizeSendTransactionInput, () => {

const result = sanitizeSendTransactionInput(accountAddress, type, payload);
expect(result).toEqual(expected);
const parsed = jsonParse(jsonStringify(result));
expect(() => parsed.payload.memo.toJSON()).not.toThrow();
expect(parsed).toEqual(expected);
});

test('Transforms "ConfigureBaker" transaction input as expected', () => {
Expand Down Expand Up @@ -460,10 +481,13 @@ describe(sanitizeSendTransactionInput, () => {
transactionFeeCommission,
finalizationRewardCommission,
};
const handler = getAccountTransactionHandler(type);
const expectedPayloadJSON = handler.toJSON(expectedPayload);

const expected: SanitizedSendTransactionInput = {
accountAddress: AccountAddress.fromBase58(accountAddress),
type,
payload: expectedPayload,
payload: expectedPayloadJSON,
};

const v0: ConfigureBakerPayloadV0 = {
Expand Down Expand Up @@ -505,10 +529,13 @@ describe(sanitizeSendTransactionInput, () => {
restakeEarnings,
delegationTarget,
};
const handler = getAccountTransactionHandler(type);
const expectedPayloadJSON = handler.toJSON(expectedPayload);

const expected: SanitizedSendTransactionInput = {
accountAddress: AccountAddress.fromBase58(accountAddress),
type,
payload: expectedPayload,
payload: expectedPayloadJSON,
};

const v0: ConfigureDelegationPayloadV0 = {
Expand Down Expand Up @@ -536,14 +563,16 @@ describe(sanitizeSendTransactionInput, () => {
const payload: RegisterDataPayload = {
data: new DataBlob(Buffer.from('This is data!')),
};
const handler = getAccountTransactionHandler(type);
const expectedPayloadJSON = handler.toJSON(payload);

const expected: SanitizedSendTransactionInput = {
accountAddress: AccountAddress.fromBase58(accountAddress),
type,
payload,
payload: expectedPayloadJSON,
};
const result = sanitizeSendTransactionInput(accountAddress, type, payload);
expect(result).toEqual(expected);
expect((result.payload as RegisterDataPayload).data).toStrictEqual(payload.data);
});

test('Transformed "RegisterData" transaction input with "DataBlob"-like parameter can be parsed', () => {
Expand All @@ -556,19 +585,20 @@ describe(sanitizeSendTransactionInput, () => {
} as unknown as DataBlob,
};

const expectedPayload: RegisterDataPayload = {
data: new DataBlob(Buffer.from('This is data!')),
};
const handler = getAccountTransactionHandler(type);
const expectedPayloadJSON = handler.toJSON(expectedPayload);

const expected: SanitizedSendTransactionInput = {
accountAddress: AccountAddress.fromBase58(accountAddress),
type,
payload: {
data: new DataBlob(Buffer.from('This is data!')),
},
payload: expectedPayloadJSON,
};

const result = sanitizeSendTransactionInput(accountAddress, type, payload);
expect(result).toEqual(expected);
const parsed = jsonParse(jsonStringify(result));
expect(() => parsed.payload.data.toJSON()).not.toThrow();
expect(parsed).toEqual(expected);
});

test('Transforms "UpdateCredentials" transaction input as expected', () => {
Expand Down Expand Up @@ -607,10 +637,13 @@ describe(sanitizeSendTransactionInput, () => {
removeCredentialIds: ['010302'],
currentNumberOfCredentials: 1n,
};
const handler = getAccountTransactionHandler(type);
const expectedPayloadJSON = handler.toJSON(payload);

const expected: SanitizedSendTransactionInput = {
accountAddress: AccountAddress.fromBase58(accountAddress),
type,
payload,
payload: expectedPayloadJSON,
};
const result = sanitizeSendTransactionInput(accountAddress, type, payload);
expect(result).toEqual(expected);
Expand Down
Loading
Loading