Skip to content
This repository was archived by the owner on Nov 23, 2023. It is now read-only.

Cardano Shelley Update 1/3 #623

Closed
Closed
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
19 changes: 12 additions & 7 deletions docs/methods/cardanoGetAddress.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ TrezorConnect.cardanoGetAddress(params).then(function(result) {
#### Exporting single address
* `path` — *obligatory* `string | Array<number>` minimum length is `5`. [read more](path.md)
* `address` — *optional* `string` address for validation (read `Handle button request` section below)
* `protocolMagic` - *obligatory* `Integer` 0 for Mainnet, 42 for Testnet
* `showOnTrezor` — *optional* `boolean` determines if address will be displayed on device. Default is set to `true`

#### Exporting bundle of addresses
Expand All @@ -40,16 +41,18 @@ If certain conditions are fulfilled popup will not be used at all:
Display address of first cardano account:
```javascript
TrezorConnect.cardanoGetAddress({
path: "m/44'/1815'/0'/0/0"
path: "m/44'/1815'/0'/0/0",
protocolMagic: 0,
});
```
Return a bundle of cardano addresses without displaying them on device:
```javascript
TrezorConnect.cardanoGetAddress({
bundle: [
{ path: "m/44'/1815'/0'/0/0", showOnTrezor: false }, // account 1, address 1
{ path: "m/44'/1815'/1'/0/1", showOnTrezor: false }, // account 2, address 2
{ path: "m/44'/1815'/2'/0/2", showOnTrezor: false } // account 3, address 3
{ path: "m/44'/1815'/0'/0/0", protocolMagic: 0, showOnTrezor: false }, // account 1, address 1
{ path: "m/44'/1815'/1'/0/1", protocolMagic: 0, showOnTrezor: false }, // account 2, address 2
{ path: "m/44'/1815'/2'/0/2", protocolMagic: 0, showOnTrezor: false } // account 3, address 3
{ path: "m/44'/1815'/0'/0/0", protocolMagic: 42, showOnTrezor: false } // account 1, address 0, testnet
]
});
```
Expand All @@ -64,6 +67,7 @@ TrezorConnect.on(UI.ADDRESS_VALIDATION, data => {

const result = await TrezorConnect.cardanoGetAddress({
path: "m/44'/1815'/0'/0/0",
protocolMagic: 0,
address: "Ae2tdPwUPEZ5YUb8sM3eS8JqKgrRLzhiu71crfuH2MFtqaYr5ACNRdsswsZ",
});
// dont forget to hide your custom UI after you get the result!
Expand All @@ -77,6 +81,7 @@ Result with only one address
payload: {
path: Array<number>, // hardended path
serializedPath: string,
protocolMagic: number,
address: string,
}
}
Expand All @@ -86,9 +91,9 @@ Result with bundle of addresses
{
success: true,
payload: [
{ path: Array<number>, serializedPath: string, address: string }, // account 1, address 1
{ path: Array<number>, serializedPath: string, address: string }, // account 2, address 2
{ path: Array<number>, serializedPath: string, address: string } // account 3, address 3
{ path: Array<number>, serializedPath: string, protocolMagic: number, address: string }, // account 1, address 1
{ path: Array<number>, serializedPath: string, protocolMagic: number, address: string }, // account 2, address 2
{ path: Array<number>, serializedPath: string, protocolMagic: number, address: string } // account 3, address 3
]
}
```
Expand Down
28 changes: 11 additions & 17 deletions docs/methods/cardanoSignTransaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,12 @@ TrezorConnect.cardanoSignTransaction(params).then(function(result) {

### Params
[****Optional common params****](commonParams.md)
###### [flowtype](../../src/js/types/cardano.js#L45-L59)
* `inputs` — *obligatory* `Array` of [CardanoInput](../../src/js/types/cardano.js#L31)
* `outputs` - *obligatory* `Array` of [CardanoOutput](../../src/js/types/cardano.js#L37)
* `transactions` - *obligatory* `Array` of strings
* `protocol_magic` - *obligatory* `Integer` 764824073 for Mainnet, 1097911063 for Testnet
###### [flowtype](../../src/js/types/networks/cardano.js#L38-L57)
* `inputs` — *obligatory* `Array` of [CardanoInput](../../src/js/types/networks/cardano.js#L38)
* `outputs` - *obligatory* `Array` of [CardanoOutput](../../src/js/types/networks/cardano.js#L43)
* `fee` - *obligatory* `String`
* `ttl` - *obligatory* `String`
* `protocolMagic` - *obligatory* `Integer` 0 for Mainnet, 42 for Testnet

### Example
```javascript
Expand All @@ -31,7 +32,6 @@ TrezorConnect.cardanoSignTransaction({
path: "m/44'/1815'/0'/0/1",
prev_hash: "1af8fa0b754ff99253d983894e63a2b09cbb56c833ba18c3384210163f63dcfc",
prev_index: 0,
type: 0
}
],
outputs: [
Expand All @@ -44,26 +44,20 @@ TrezorConnect.cardanoSignTransaction({
amount: "7120787"
}
],
transactions: [
"839f8200d818582482582008abb575fac4c39d5bf80683f7f0c37e48f4e3d96e37d1f6611919a7241b456600ff9f8282d818582183581cda4da43db3fca93695e71dab839e72271204d28b9d964d306b8800a8a0001a7a6916a51a00305becffa0",
"839f8200d818582482582008abb575fac4c39d5bf80683f7f0c37e48f4e3d96e37d1f6611919a7241b456600ff9f8282d818582183581cda4da43db3fca93695e71dab839e72271204d28b9d964d306b8800a8a0001a7a6916a51a00305becffa0",
"839f8200d818582482582008abb575fac4c39d5bf80683f7f0c37e48f4e3d96e37d1f6611919a7241b456600ff9f8282d818582183581cda4da43db3fca93695e71dab839e72271204d28b9d964d306b8800a8a0001a7a6916a51a00305becffa0",
"839f8200d818582482582008abb575fac4c39d5bf80683f7f0c37e48f4e3d96e37d1f6611919a7241b456600ff9f8282d818582183581cda4da43db3fca93695e71dab839e72271204d28b9d964d306b8800a8a0001a7a6916a51a00305becffa0",
"839f8200d818582482582008abb575fac4c39d5bf80683f7f0c37e48f4e3d96e37d1f6611919a7241b456600ff9f8282d818582183581cda4da43db3fca93695e71dab839e72271204d28b9d964d306b8800a8a0001a7a6916a51a00305becffa0",
"839f8200d818582482582008abb575fac4c39d5bf80683f7f0c37e48f4e3d96e37d1f6611919a7241b456600ff9f8282d818582183581cda4da43db3fca93695e71dab839e72271204d28b9d964d306b8800a8a0001a7a6916a51a00305becffa0",
],
protocol_magic: 764824073
fee: "42",
ttl: "10",
protocolMagic: 0
});
```

### Result
###### [flowtype](../../src/js/types/cardano.js#L56-L59)
###### [flowtype](../../src/js/types/networks/cardano.js#L59-L62)
```javascript
{
success: true,
payload: {
hash: string,
body: string,
serializedTx: string,
}
}
```
Expand Down
70 changes: 69 additions & 1 deletion src/__tests__/core/cardanoGetAddress.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,32 @@ import type { CardanoGetAddress } from '../../js/types';

// vectors from https://github.com/trezor/trezor-firmware/tree/master/python/trezorlib/tests/device_tests/test_msg_cardano_get_address.py

export const cardanoGetAddress = () => {
const PROTOCOL_MAGICS = {
mainnet: 0,
testnet: 42,
};

const getAddressMainnet = () => {
const testPayloads: CardanoGetAddress[] = [
{
method: 'cardanoGetAddress',
path: "m/44'/1815'/0'/0/0",
protocolMagic: PROTOCOL_MAGICS['mainnet'],
},
{
method: 'cardanoGetAddress',
path: [2147483697],
protocolMagic: PROTOCOL_MAGICS['mainnet'],
},
{
method: 'cardanoGetAddress',
path: "m/44'/1815'/0'/0/1",
protocolMagic: PROTOCOL_MAGICS['mainnet'],
},
{
method: 'cardanoGetAddress',
path: "m/44'/1815'/0'/0/2",
protocolMagic: PROTOCOL_MAGICS['mainnet'],
},
];

Expand Down Expand Up @@ -49,3 +58,62 @@ export const cardanoGetAddress = () => {
expectedResponses,
};
};

const getAddressTestnet = () => {
const testPayloads: CardanoGetAddress[] = [
{
method: 'cardanoGetAddress',
path: "m/44'/1815'/0'/0/0",
protocolMagic: PROTOCOL_MAGICS['testnet'],
},
{
method: 'cardanoGetAddress',
path: "m/44'/1815'/0'/0/1",
protocolMagic: PROTOCOL_MAGICS['testnet'],
},
{
method: 'cardanoGetAddress',
path: "m/44'/1815'/0'/0/2",
protocolMagic: PROTOCOL_MAGICS['testnet'],
},
];

const expectedResponses = [
{
payload: {
address: '2657WMsDfac5vydkak9a7BqGrsLqBzB7K3vT55rucZKYDmVnUCf6hXAFkZSTcUx7r',
},
},
{
payload: {
address: '2657WMsDfac61ebUDw53WUX49Dcfya8S8G7iYbhN4nP8JSFuh38T1LuFax1bUnhxA',
},
},
{
payload: {
address: '2657WMsDfac5PMpEsxc1md3pgZKUZRZ11MUK8tjkDHBQG9b3TMBsTQc4PmmumVrcn',
},
},
];

return {
testName: 'CardanoGetAddress',
mnemonic: 'mnemonic_12',
testPayloads,
expectedResponses,
};
};

export const cardanoGetAddress = () => {
const availableSubtests = {
getAddressMainnet,
getAddressTestnet,
};
return {
testName: 'CardanoGetAddress',
mnemonic: 'mnemonic_all',
subtests: {
...availableSubtests,
},
};
};
104 changes: 49 additions & 55 deletions src/__tests__/core/cardanoSignTransaction.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,40 +3,56 @@ import type { CardanoSignTransaction } from '../../js/types';

// vectors from https://github.com/trezor/trezor-firmware/tree/master/python/trezorlib/tests/device_tests/test_msg_cardano_sign_transaction.py

const SAMPLE_INPUT = {
path: "m/44'/1815'/0'/0/1",
prev_hash: '1af8fa0b754ff99253d983894e63a2b09cbb56c833ba18c3384210163f63dcfc',
prev_index: 0,
};

const SAMPLE_OUTPUTS = {
simple_output: {
address: 'Ae2tdPwUPEZCanmBz5g2GEwFqKTKpNJcGYPKfDxoNeKZ8bRHr8366kseiK2',
amount: '3003112',
},
change_output: {path: "m/44'/1815'/0'/0/1", amount: '1000000'},
testnet_output: {
address: '2657WMsDfac7BteXkJq5Jzdog4h47fPbkwUM49isuWbYAr2cFRHa3rURP236h9PBe',
amount: '3003112',
},
};

const FEE = '42';
const TTL = '10';

const PROTOCOL_MAGICS = {
mainnet: 0,
testnet: 42,
};

const signMainnetNoChange = () => {
const inputs = [
{
prev_hash: '1af8fa0b754ff99253d983894e63a2b09cbb56c833ba18c3384210163f63dcfc',
path: "m/44'/1815'/0'/0/1",
prev_index: 0,
type: 0,
},
SAMPLE_INPUT,
];
const outputs = [
{
address: 'Ae2tdPwUPEZCanmBz5g2GEwFqKTKpNJcGYPKfDxoNeKZ8bRHr8366kseiK2',
amount: '3003112',
},
];
const transactions = [
'839f8200d818582482582008abb575fac4c39d5bf80683f7f0c37e48f4e3d96e37d1f6611919a7241b456600ff9f8282d818582183581cda4da43db3fca93695e71dab839e72271204d28b9d964d306b8800a8a0001a7a6916a51a00305becffa0',
SAMPLE_OUTPUTS['simple_output'],
];

const testPayloads: CardanoSignTransaction[] = [
{
method: 'cardanoSignTransaction',
inputs,
outputs,
transactions,
protocol_magic: 764824073,
fee: FEE,
ttl: TTL,
protocolMagic: PROTOCOL_MAGICS['mainnet'],
},
];

const expectedResponses = [
{
payload: {
hash: '799c65e8a2c0b1dc4232611728c09d3f3eb0d811c077f8e9798f84605ef1b23d',
body: '82839f8200d81858248258201af8fa0b754ff99253d983894e63a2b09cbb56c833ba18c3384210163f63dcfc00ff9f8282d818582183581c9e1c71de652ec8b85fec296f0685ca3988781c94a2e1a5d89d92f45fa0001a0d0c25611a002dd2e8ffa0818200d818588582584089053545a6c254b0d9b1464e48d2b5fcf91d4e25c128afb1fcfc61d0843338ea26308151516f3b0e02bb1638142747863c520273ce9bd3e5cd91e1d46fe2a6355840312c01c27317415b0b8acc86aa789da877fe7e15c65b7ea4c4565d8739117f5f6d9d38bf5d058f7be809b2b9b06c1d79fc6b20f9a4d76d8c89bae333edf5680c',
hash: '73e09bdebf98a9e0f17f86a2d11e0f14f4f8dae77cdf26ff1678e821f20c8db6',
serializedTx: '83a400818258201af8fa0b754ff99253d983894e63a2b09cbb56c833ba18c3384210163f63dcfc00018182582b82d818582183581c9e1c71de652ec8b85fec296f0685ca3988781c94a2e1a5d89d92f45fa0001a0d0c25611a002dd2e802182a030aa1028184582089053545a6c254b0d9b1464e48d2b5fcf91d4e25c128afb1fcfc61d0843338ea5840da07ac5246e3f20ebd1276476a4ae34a019dd4b264ffc22eea3c28cb0f1a6bb1c7764adeecf56bcb0bc6196fd1dbe080f3a7ef5b49f56980fe5b2881a4fdfa00582026308151516f3b0e02bb1638142747863c520273ce9bd3e5cd91e1d46fe2a63541a0f6',
},
},
];
Expand All @@ -50,42 +66,29 @@ const signMainnetNoChange = () => {

const signMainnetChange = () => {
const inputs = [
{
prev_hash: '1af8fa0b754ff99253d983894e63a2b09cbb56c833ba18c3384210163f63dcfc',
path: "m/44'/1815'/0'/0/1",
prev_index: 0,
type: 0,
},
SAMPLE_INPUT,
];
const outputs = [
{
address: 'Ae2tdPwUPEZCanmBz5g2GEwFqKTKpNJcGYPKfDxoNeKZ8bRHr8366kseiK2',
amount: '3003112',
},
{
path: "m/44'/1815'/0'/0/1",
amount: '1000000',
},
];
const transactions = [
'839f8200d818582482582008abb575fac4c39d5bf80683f7f0c37e48f4e3d96e37d1f6611919a7241b456600ff9f8282d818582183581cda4da43db3fca93695e71dab839e72271204d28b9d964d306b8800a8a0001a7a6916a51a00305becffa0',
SAMPLE_OUTPUTS['simple_output'],
SAMPLE_OUTPUTS['change_output'],
];

const testPayloads: CardanoSignTransaction[] = [
{
method: 'cardanoSignTransaction',
inputs,
outputs,
transactions,
protocol_magic: 764824073,
fee: FEE,
ttl: TTL,
protocolMagic: PROTOCOL_MAGICS['mainnet'],
},
];

const expectedResponses = [
{
payload: {
hash: '40bf94518f31aba7779dd99aa71fe867887bcb3e0bac2c6dc33d3f20ec74a6b1',
body: '82839f8200d81858248258201af8fa0b754ff99253d983894e63a2b09cbb56c833ba18c3384210163f63dcfc00ff9f8282d818582183581c9e1c71de652ec8b85fec296f0685ca3988781c94a2e1a5d89d92f45fa0001a0d0c25611a002dd2e88282d818582183581cda4da43db3fca93695e71dab839e72271204d28b9d964d306b8800a8a0001a7a6916a51a000f4240ffa0818200d818588582584089053545a6c254b0d9b1464e48d2b5fcf91d4e25c128afb1fcfc61d0843338ea26308151516f3b0e02bb1638142747863c520273ce9bd3e5cd91e1d46fe2a63558400b47193163462023bdb72f03b2f6afc8e3645dbc9252cb70f7516da402ce3b8468e4a60929674de5862d6253315008e07b60aa189f5c455dd272ff1c84c89d0c',
hash: '81b14b7e62972127eb33c0b1198de6430540ad3a98eec621a3194f2baac43a43',
serializedTx: '83a400818258201af8fa0b754ff99253d983894e63a2b09cbb56c833ba18c3384210163f63dcfc00018282582b82d818582183581c9e1c71de652ec8b85fec296f0685ca3988781c94a2e1a5d89d92f45fa0001a0d0c25611a002dd2e882582b82d818582183581cda4da43db3fca93695e71dab839e72271204d28b9d964d306b8800a8a0001a7a6916a51a000f424002182a030aa1028184582089053545a6c254b0d9b1464e48d2b5fcf91d4e25c128afb1fcfc61d0843338ea5840d909b16038c4fd772a177038242e6793be39c735430b03ee924ed18026bd28d06920b5846247945f1204276e4b759aa5ac05a4a73b49ce705ab0e5e54a3a170e582026308151516f3b0e02bb1638142747863c520273ce9bd3e5cd91e1d46fe2a63541a0f6',
},
},
];
Expand All @@ -99,38 +102,29 @@ const signMainnetChange = () => {

const signTestnet = () => {
const inputs = [
{
prev_hash: '1af8fa0b754ff99253d983894e63a2b09cbb56c833ba18c3384210163f63dcfc',
path: "m/44'/1815'/0'/0/1",
prev_index: 0,
type: 0,
},
SAMPLE_INPUT,
];
const outputs = [
{
address: 'Ae2tdPwUPEZCanmBz5g2GEwFqKTKpNJcGYPKfDxoNeKZ8bRHr8366kseiK2',
amount: '3003112',
},
];
const transactions = [
'839f8200d818582482582008abb575fac4c39d5bf80683f7f0c37e48f4e3d96e37d1f6611919a7241b456600ff9f8282d818582183581cda4da43db3fca93695e71dab839e72271204d28b9d964d306b8800a8a0001a7a6916a51a00305becffa0',
SAMPLE_OUTPUTS['testnet_output'],
SAMPLE_OUTPUTS['change_output'],
];

const testPayloads: CardanoSignTransaction[] = [
{
method: 'cardanoSignTransaction',
inputs,
outputs,
transactions,
protocol_magic: 1097911063,
fee: FEE,
ttl: TTL,
protocolMagic: PROTOCOL_MAGICS['testnet'],
},
];

const expectedResponses = [
{
payload: {
hash: '799c65e8a2c0b1dc4232611728c09d3f3eb0d811c077f8e9798f84605ef1b23d',
body: '82839f8200d81858248258201af8fa0b754ff99253d983894e63a2b09cbb56c833ba18c3384210163f63dcfc00ff9f8282d818582183581c9e1c71de652ec8b85fec296f0685ca3988781c94a2e1a5d89d92f45fa0001a0d0c25611a002dd2e8ffa0818200d818588582584089053545a6c254b0d9b1464e48d2b5fcf91d4e25c128afb1fcfc61d0843338ea26308151516f3b0e02bb1638142747863c520273ce9bd3e5cd91e1d46fe2a63558403594ee7e2bfe4c84f886a8336cecb7c42983ce9a057345ebb6294a436087d8db93ca78cf514c7c48edff4c8435f690a5817951e2b55d2db729875ee7cc0f7d08',
hash: '5dd03fb44cb88061b2a1c246981bb31adfe4f57be69b58badb5ae8f448450932',
serializedTx: '83a400818258201af8fa0b754ff99253d983894e63a2b09cbb56c833ba18c3384210163f63dcfc00018282582f82d818582583581c586b90cf80c021db288ce1c18ecfd3610acf64f8748768b0eb7335b1a10242182a001aae3129311a002dd2e882582f82d818582583581c98c3a558f39d1d993cc8770e8825c70a6d0f5a9eb243501c4526c29da10242182a001aa8566c011a000f424002182a030aa1028184582089053545a6c254b0d9b1464e48d2b5fcf91d4e25c128afb1fcfc61d0843338ea5840fc30afdd0d4a6d8581e0f6abe895994d208fd382f2b23ff1553d711477a4fedbd1f68a76e7465c4816d5477f4287f7360acf71fca3b3d5902e4448e48c447106582026308151516f3b0e02bb1638142747863c520273ce9bd3e5cd91e1d46fe2a63545a10242182af6',
},
},
];
Expand Down
Loading