Stellarsigntransaction

Method testing tool

Stellar: Sign transaction

Asks device to sign given transaction. User is asked to confirm all transaction details on Trezor.

const result = await TrezorConnect.stellarSignTransaction(params);

Params

Including CommonParams

path

String | Array<Number>

Required

minimum length is 3. read more

networkPassphrase

String

Required

network passphrase

transaction

Object

Required

type of StellarTransaction

source

String

Required

fee

Number

Required

sequence

Uint

Required

timebounds

Object

Optional

minTime

Number

Required

maxTime

Number

Required

memo

Object

Optional

type

Enum: NONE (0) | TEXT (1) | ID (2) | HASH (3) | RETURN (4)

Required

id

Uint

Optional

text

String

Optional

hash

String | Buffer

Optional

operations

Required

Union

type

"createAccount"

Required

source

String

Optional

destination

String

Required

startingBalance

String

Required

or

type

"payment"

Required

source

String

Optional

destination

String

Required

asset

Object

Required

type

Union

Required

0 ("NATIVE")

or

1 ("ALPHANUM4")

or

2 ("ALPHANUM12")

or

NATIVE (0)

or

ALPHANUM4 (1)

or

ALPHANUM12 (2)

or

"0"

or

"1"

or

"2"

or

"NATIVE"

or

"ALPHANUM4"

or

"ALPHANUM12"

code

String

Optional

issuer

String

Optional

amount

String

Required

or

type

"pathPaymentStrictReceive"

Required

source

String

Optional

sendAsset

Object

Required

type

Union

Required

0 ("NATIVE")

or

1 ("ALPHANUM4")

or

2 ("ALPHANUM12")

or

NATIVE (0)

or

ALPHANUM4 (1)

or

ALPHANUM12 (2)

or

"0"

or

"1"

or

"2"

or

"NATIVE"

or

"ALPHANUM4"

or

"ALPHANUM12"

code

String

Optional

issuer

String

Optional

sendMax

Uint

Required

destination

String

Required

destAsset

Object

Required

type

Union

Required

0 ("NATIVE")

or

1 ("ALPHANUM4")

or

2 ("ALPHANUM12")

or

NATIVE (0)

or

ALPHANUM4 (1)

or

ALPHANUM12 (2)

or

"0"

or

"1"

or

"2"

or

"NATIVE"

or

"ALPHANUM4"

or

"ALPHANUM12"

code

String

Optional

issuer

String

Optional

destAmount

Uint

Required

path

Array<Object>

Optional

minimum length is 3. read more

Object

type

Union

Required

0 ("NATIVE")

or

1 ("ALPHANUM4")

or

2 ("ALPHANUM12")

or

NATIVE (0)

or

ALPHANUM4 (1)

or

ALPHANUM12 (2)

or

"0"

or

"1"

or

"2"

or

"NATIVE"

or

"ALPHANUM4"

or

"ALPHANUM12"

code

String

Optional

issuer

String

Optional

or

type

"pathPaymentStrictSend"

Required

source

String

Optional

sendAsset

Object

Required

type

Union

Required

0 ("NATIVE")

or

1 ("ALPHANUM4")

or

2 ("ALPHANUM12")

or

NATIVE (0)

or

ALPHANUM4 (1)

or

ALPHANUM12 (2)

or

"0"

or

"1"

or

"2"

or

"NATIVE"

or

"ALPHANUM4"

or

"ALPHANUM12"

code

String

Optional

issuer

String

Optional

sendAmount

Uint

Required

destination

String

Required

destAsset

Object

Required

type

Union

Required

0 ("NATIVE")

or

1 ("ALPHANUM4")

or

2 ("ALPHANUM12")

or

NATIVE (0)

or

ALPHANUM4 (1)

or

ALPHANUM12 (2)

or

"0"

or

"1"

or

"2"

or

"NATIVE"

or

"ALPHANUM4"

or

"ALPHANUM12"

code

String

Optional

issuer

String

Optional

destMin

Uint

Required

path

Array<Object>

Optional

minimum length is 3. read more

Object

type

Union

Required

0 ("NATIVE")

or

1 ("ALPHANUM4")

or

2 ("ALPHANUM12")

or

NATIVE (0)

or

ALPHANUM4 (1)

or

ALPHANUM12 (2)

or

"0"

or

"1"

or

"2"

or

"NATIVE"

or

"ALPHANUM4"

or

"ALPHANUM12"

code

String

Optional

issuer

String

Optional

or

type

"createPassiveSellOffer"

Required

source

String

Optional

buying

Object

Required

type

Union

Required

0 ("NATIVE")

or

1 ("ALPHANUM4")

or

2 ("ALPHANUM12")

or

NATIVE (0)

or

ALPHANUM4 (1)

or

ALPHANUM12 (2)

or

"0"

or

"1"

or

"2"

or

"NATIVE"

or

"ALPHANUM4"

or

"ALPHANUM12"

code

String

Optional

issuer

String

Optional

selling

Object

Required

type

Union

Required

0 ("NATIVE")

or

1 ("ALPHANUM4")

or

2 ("ALPHANUM12")

or

NATIVE (0)

or

ALPHANUM4 (1)

or

ALPHANUM12 (2)

or

"0"

or

"1"

or

"2"

or

"NATIVE"

or

"ALPHANUM4"

or

"ALPHANUM12"

code

String

Optional

issuer

String

Optional

amount

Uint

Required

price

Object

Required

n

Number

Required

d

Number

Required

or

type

"manageSellOffer"

Required

source

String

Optional

buying

Object

Required

type

Union

Required

0 ("NATIVE")

or

1 ("ALPHANUM4")

or

2 ("ALPHANUM12")

or

NATIVE (0)

or

ALPHANUM4 (1)

or

ALPHANUM12 (2)

or

"0"

or

"1"

or

"2"

or

"NATIVE"

or

"ALPHANUM4"

or

"ALPHANUM12"

code

String

Optional

issuer

String

Optional

selling

Object

Required

type

Union

Required

0 ("NATIVE")

or

1 ("ALPHANUM4")

or

2 ("ALPHANUM12")

or

NATIVE (0)

or

ALPHANUM4 (1)

or

ALPHANUM12 (2)

or

"0"

or

"1"

or

"2"

or

"NATIVE"

or

"ALPHANUM4"

or

"ALPHANUM12"

code

String

Optional

issuer

String

Optional

amount

Uint

Required

offerId

Uint

Optional

price

Object

Required

n

Number

Required

d

Number

Required

or

type

"manageBuyOffer"

Required

source

String

Optional

buying

Object

Required

type

Union

Required

0 ("NATIVE")

or

1 ("ALPHANUM4")

or

2 ("ALPHANUM12")

or

NATIVE (0)

or

ALPHANUM4 (1)

or

ALPHANUM12 (2)

or

"0"

or

"1"

or

"2"

or

"NATIVE"

or

"ALPHANUM4"

or

"ALPHANUM12"

code

String

Optional

issuer

String

Optional

selling

Object

Required

type

Union

Required

0 ("NATIVE")

or

1 ("ALPHANUM4")

or

2 ("ALPHANUM12")

or

NATIVE (0)

or

ALPHANUM4 (1)

or

ALPHANUM12 (2)

or

"0"

or

"1"

or

"2"

or

"NATIVE"

or

"ALPHANUM4"

or

"ALPHANUM12"

code

String

Optional

issuer

String

Optional

amount

Uint

Required

offerId

Uint

Optional

price

Object

Required

n

Number

Required

d

Number

Required

or

type

"setOptions"

Required

source

String

Optional

signer

Object

Optional

type

Enum: ACCOUNT (0) | PRE_AUTH (1) | HASH (2)

Required

key

String | Buffer

Required

weight

Number

Optional

inflationDest

String

Optional

clearFlags

Number

Optional

setFlags

Number

Optional

masterWeight

Uint

Optional

lowThreshold

Uint

Optional

medThreshold

Uint

Optional

highThreshold

Uint

Optional

homeDomain

String

Optional

or

type

"changeTrust"

Required

source

String

Optional

line

Object

Required

type

Union

Required

0 ("NATIVE")

or

1 ("ALPHANUM4")

or

2 ("ALPHANUM12")

or

NATIVE (0)

or

ALPHANUM4 (1)

or

ALPHANUM12 (2)

or

"0"

or

"1"

or

"2"

or

"NATIVE"

or

"ALPHANUM4"

or

"ALPHANUM12"

code

String

Optional

issuer

String

Optional

limit

String

Required

or

type

"allowTrust"

Required

source

String

Optional

trustor

String

Required

assetCode

String

Required

assetType

Enum: NATIVE (0) | ALPHANUM4 (1) | ALPHANUM12 (2)

Required

authorize

Boolean | Undefined

Optional

or

type

"accountMerge"

Required

source

String

Optional

destination

String

Required

or

type

"inflation"

Required

source

String

Optional

or

type

"manageData"

Required

source

String

Optional

name

String

Required

value

String | Buffer

Optional

or

type

"bumpSequence"

Required

source

String

Optional

bumpTo

Uint

Required

or

type

"claimClaimableBalance"

Required

source

String

Optional

balanceId

String

Required

Stellar SDK compatibility

@stellar/stellar-sdk is not a part of trezor-connect repository. To transform StellarSDK.Transaction object into TrezorConnect.StellarTransaction, install @trezor/connect-plugin-stellar into your project.

import * as StellarSDK from '@stellar/stellar-sdk';
import transformTrezorTransaction from '<path-to-plugin>/index.js';
 
const tx = new StellarSdk.TransactionBuilder(...);
...
tx.build();
 
const params = transformTrezorTransaction(tx);
const result = TrezorConnect.stellarSignTransaction(params);
 
if (result.success) {
    tx.addSignature('account-public-key', result.payload.signature);
}

Example

TrezorConnect.stellarSignTransaction(
    path: "m/44'/148'/0'",
    networkPassphrase: "Test SDF Network ; September 2015",
    transaction: {
        source: "GAXSFOOGF4ELO5HT5PTN23T5XE6D5QWL3YBHSVQ2HWOFEJNYYMRJENBV",
        fee: 100,
        sequence: 4294967296,
        memo: {
            type: 0,
        },
        operations: [
            {
                type: "payment",
                source: "GAXSFOOGF4ELO5HT5PTN23T5XE6D5QWL3YBHSVQ2HWOFEJNYYMRJENBV",
                destination: "GAXSFOOGF4ELO5HT5PTN23T5XE6D5QWL3YBHSVQ2HWOFEJNYYMRJENBV",
                amount: "10000"
            }
        ]
    }
});

Result

StellarSignedTx type

{
    success: true,
    payload: {
        publicKey: string,
        signature: string,
    }
}

Error

{
    success: false,
    payload: {
        error: string // error message
    }
}

stellarGetAddress tezosGetAddress