Skip to main content

Destination Tag Examples

Some Rosetta implementations require support for destination tags or memos. You can add this support to the Data API and Construction API implementations for your blockchain. Use the memo field under the metadata object in the Data API or Construction API endpoints shown below to add the information. Enter a destination tag or memo value for the memo field.

ConstructionPreprocessRequest​

Read the ConstructionPreprocessRequest documentation for properties information.

/construction/preprocess Request Schema​

{
   "network_identifier":{
      //...
   },
   "intent":[
      //...
   ],
   "metadata":{
      //...
      "memo":"SAMPLE MEMO"
      //...
   }
}

/construction/preprocess Request Example​

{
   "network_identifier":{
      "blockchain":"stacks",
      "network":"testnet"
   },
   "intent":[
      {
         "operation_identifier":{
            "index":0
         },
         "type":"fee",
         "account":{
            "address":"ST11NJTTKGVT6D1HY4NJRVQWMQM7TVAR091EJ8P2Y"
         },
         "amount":{
            "value":"-180",
            "currency":{
               "symbol":"STX",
               "decimals":6
            }
         }
      },
      {
         "operation_identifier":{
            "index":1
         },
         "type":"token_transfer",
         "account":{
            "address":"ST11NJTTKGVT6D1HY4NJRVQWMQM7TVAR091EJ8P2Y"
         },
         "amount":{
            "value":"-50",
            "currency":{
               "symbol":"STX",
               "decimals":6
            }
         }
      },
      {
         "operation_identifier":{
            "index":2
         },
         "type":"token_transfer",
         "account":{
            "address":"STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6"
         },
         "amount":{
            "value":"50",
            "currency":{
               "symbol":"STX",
               "decimals":6
            }
         }
      }
   ],
   "metadata":{
      "memo":"testing"
   }
}

ConstructionPreprocessResponse​

Read the ConstructionPreprocessResponse documentation for properties information.

/construction/preprocess Response Schema​

{
   "options": {
      //…
      "memo": "SAMPLE MEMO"
      //…
   },
   "required_public_keys": [
      //…
   ]
}

/construction/preprocess Response Example​

{
   "options":{
      "amount":"50",
      "decimals":6,
      "fee":"-180",
      "memo":"testing",
      "sender_address":"ST11NJTTKGVT6D1HY4NJRVQWMQM7TVAR091EJ8P2Y",
      "size":180,
      "symbol":"STX",
      "token_transfer_recipient_address":"STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6",
      "type":"token_transfer"
   },
   "required_public_keys":[
      {
         "address":"ST11NJTTKGVT6D1HY4NJRVQWMQM7TVAR091EJ8P2Y"
      }
   ]
}

ConstructionMetadataRequest​

Read the ConstructionMetadataRequest documentation for properties information.

/construction/metadata Request Schema​

{
   "network_identifier": {
      //…
   },
   "metadata": {
      //…
      "memo": "SAMPLE MEMO"
      //…
   },
   "public_keys": [
      //…
   ]
}

/construction/metadata Request Example​

{
   "network_identifier":{
      "blockchain":"stacks",
      "network":"testnet"
   },
   "metadata":{
      "amount":"50",
      "decimals":6,
      "fee":"-180",
      "memo":"testing",
      "sender_address":"ST11NJTTKGVT6D1HY4NJRVQWMQM7TVAR091EJ8P2Y",
      "size":180,
      "symbol":"STX",
      "token_transfer_recipient_address":"STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6",
      "type":"token_transfer"
   },
   "public_keys":[
      {
         "hex_bytes":"02b087ca52f40fdfdf4b16a0bbf7e91e4db2e183ac5c6491a5f60a5450e25de7d0",
         "curve_type":"secp256k1"
      }
   ]
}

ConstructionMetadataResponse​

Read the ConstructionMetadataResponse documentation for properties information.

/construction/metadata Response Schema​

{
   "metadata": {
      //…
      "memo": "SAMPLE MEMO"
      //…
   },
   "suggested_fee": [
      //…
   ]
}

/construction/metadata Response Example​

{
   "metadata":{
      "account_sequence":8,
      "amount":"50",
      "decimals":6,
      "fee":"-180",
      "memo":"testing",
      "recent_block_hash":"0x4f4a5ccf2a85e42951dbc039e4aab4f71be710957cc278135c68818a38645adb",
      "sender_address":"ST11NJTTKGVT6D1HY4NJRVQWMQM7TVAR091EJ8P2Y",
      "size":180,
      "symbol":"STX",
      "token_transfer_recipient_address":"STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6",
      "type":"token_transfer"
   },
   "suggested_fee":[
      {
         "value":"180",
         "currency":{
            "symbol":"STX",
            "decimals":6
         }
      }
   ]
}

ConstructionPayloadsRequest​

Read the ConstructionPayloadsRequest documentation for properties information.

/construction/payloads Request Schema​

{
   "network_identifier": {
      //…
   },
   "intent": [
      //…
   ],
   "metadata": {
      //…
      "memo": "SAMPLE MEMO"
      //…
   },
   "public_keys": [
      //…
   ]
}

/construction/payloads Request Example​

{
   "network_identifier":{
      "blockchain":"stacks",
      "network":"testnet"
   },
   "intent":[
      {
         "operation_identifier":{
            "index":0
         },
         "type":"fee",
         "account":{
            "address":"ST11NJTTKGVT6D1HY4NJRVQWMQM7TVAR091EJ8P2Y"
         },
         "amount":{
            "value":"-180",
            "currency":{
               "symbol":"STX",
               "decimals":6
            }
         }
      },
      {
         "operation_identifier":{
            "index":1
         },
         "type":"token_transfer",
         "account":{
            "address":"ST11NJTTKGVT6D1HY4NJRVQWMQM7TVAR091EJ8P2Y"
         },
         "amount":{
            "value":"-50",
            "currency":{
               "symbol":"STX",
               "decimals":6
            }
         }
      },
      {
         "operation_identifier":{
            "index":2
         },
         "type":"token_transfer",
         "account":{
            "address":"STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6"
         },
         "amount":{
            "value":"50",
            "currency":{
               "symbol":"STX",
               "decimals":6
            }
         }
      }
   ],
   "metadata":{
      "account_sequence":8,
      "amount":"50",
      "decimals":6,
      "fee":"-180",
      "memo":"testing",
      "recent_block_hash":"0x4f4a5ccf2a85e42951dbc039e4aab4f71be710957cc278135c68818a38645adb",
      "sender_address":"ST11NJTTKGVT6D1HY4NJRVQWMQM7TVAR091EJ8P2Y",
      "size":180,
      "symbol":"STX",
      "token_transfer_recipient_address":"STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6",
      "type":"token_transfer"
   },
   "public_keys":[
      {
         "hex_bytes":"02b087ca52f40fdfdf4b16a0bbf7e91e4db2e183ac5c6491a5f60a5450e25de7d0",
         "curve_type":"secp256k1"
      }
   ]
}

ConstructionPayloadsResponse​

Read the ConstructionPayloadsResponse documentation for properties information.

/construction/payloads Response Schema​

The unsigned_transaction field (type: string) includes the destination tag or memo value in the unsigned_transaction hash.

{
   "unsigned_transaction":"abcdef1234",
   "payloads":[
      {
         //..
      }
   ]
}

/construction/payloads Response Example​

{
   "unsigned_transaction":"0x8080000000040043596b5386f466863e25658ddf94bd0fadab0048000000000000000800000000000000b400000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003020000000000051a164247d6f2b425ac5771423ae6c80c754f7172b0000000000000003274657374696e67000000000000000000000000000000000000000000000000000000",
   "payloads":[
      {
         "address":"ST11NJTTKGVT6D1HY4NJRVQWMQM7TVAR091EJ8P2Y",
         "hex_bytes":"a29c75ebde36ebb6aa8ef3e54b1195b53ec840f8f71babbae820e9f4f3ab82ff",
         "account_identifier":{
            "address":"ST11NJTTKGVT6D1HY4NJRVQWMQM7TVAR091EJ8P2Y"
         },
         "signature_type":"ecdsa_recovery"
      }
   ]
}

ConstructionParseRequest​

Read the ConstructionParseRequest documentation for properties information.

/construction/parse Request Schema​

The transaction field (type:string) includes the destination tag or memo value in the unsigned (since signed is false) transaction hash.

{
    "network_identifier": {
        "blockchain": "stacks",
        "network": "testnet",
        "sub_network_identifier": {
            "network": "shard 1",
            "metadata": {
                "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
            }
        }
    },
    "signed": false,
    "transaction": "abcdef1234"
}

/construction/parse Request Example​

{
   "network_identifier":{
      "blockchain":"stacks",
      "network":"testnet"
   },
   "signed":false,
   "transaction":"0x8080000000040043596b5386f466863e25658ddf94bd0fadab0048000000000000000800000000000000b400000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003020000000000051a164247d6f2b425ac5771423ae6c80c754f7172b0000000000000003274657374696e67000000000000000000000000000000000000000000000000000000"
}

ConstructionParseResponse​

Read the ConstructionParseaResponse documentation for properties information.

/construction/parse Response Schema​

{
   "operations": [
   ],
   "signers": null,
   "metadata": {
      //…
      "memo": "SAMPLE MEMO"
      //…
   }
}

/construction/parse Response Example​

{
   "operations":[
      {
         "operation_identifier":{
            "index":0
         },
         "type":"fee",
         "status":"",
         "account":{
            "address":"ST11NJTTKGVT6D1HY4NJRVQWMQM7TVAR091EJ8P2Y"
         },
         "amount":{
            "value":"-180",
            "currency":{
               "symbol":"STX",
               "decimals":6
            }
         }
      },
      {
         "operation_identifier":{
            "index":1
         },
         "type":"token_transfer",
         "status":"",
         "account":{
            "address":"ST11NJTTKGVT6D1HY4NJRVQWMQM7TVAR091EJ8P2Y"
         },
         "amount":{
            "value":"-50",
            "currency":{
               "symbol":"STX",
               "decimals":6
            }
         },
         "coin_change":{
            "coin_identifier":{
               "identifier":"0x7601dd2c00b4da4394c6568111ad722a9d35f675f987690bcee1086ea34ade92:1"
            },
            "coin_action":"coin_spent"
         }
      },
      {
         "operation_identifier":{
            "index":2
         },
         "related_operations":[
            {
               "index":1
            }
         ],
         "type":"token_transfer",
         "status":"",
         "account":{
            "address":"STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6"
         },
         "amount":{
            "value":"50",
            "currency":{
               "symbol":"STX",
               "decimals":6
            }
         },
         "coin_change":{
            "coin_identifier":{
               "identifier":"0x7601dd2c00b4da4394c6568111ad722a9d35f675f987690bcee1086ea34ade92:2"
            },
            "coin_action":"coin_created"
         }
      }
   ],
   "signers":null,
   "metadata":{
      "memo":"testing"
   }
}

Block​

Read the Block documentation for properties information.

/block Response Schema​

{
   "block":{
      "block_identifier":{
         //...
      },
      "parent_block_identifier":{
         //...
      },
      "timestamp":"time",
      "transactions":[
         {
            "transaction_identifier":{
               //...
            },
            "operations":[
               //...
            ],
            "metadata":{
               "memo":"SAMPLE MEMO"
            }
         }
      ]
   }
}

/block Response Example​

{
   "block":{
      "block_identifier":{
         "index":16359,
         "hash":"0x0dc231285c2ddc74c4c9e93e9ce754aed04368306069d15b47938308049c473c"
      },
      "parent_block_identifier":{
         "index":16358,
         "hash":"0x49048b0c1eceb626012c911b61f5250ff6073f44ef8c9bf5800ee76aa270d96d"
      },
      "timestamp":1634820076000,
      "transactions":[
         {
            "transaction_identifier":{
               "hash":"0x5b4146351bf941ffb12b66ea0f14dc8b21f4b119d2adbaf8bdf6e8bc3582c0e0"
            },
            "operations":[
               {
                  "operation_identifier":{
                     "index":0
                  },
                  "type":"fee",
                  "status":"success",
                  "account":{
                     "address":"ST2QKZ4FKHAH1NQKYKYAYZPY440FEPK7GZ1R5HBP2"
                  },
                  "amount":{
                     "value":"-180",
                     "currency":{
                        "decimals":6,
                        "symbol":"STX"
                     }
                  }
               },
               {
                  "operation_identifier":{
                     "index":1
                  },
                  "type":"token_transfer",
                  "status":"success",
                  "account":{
                     "address":"ST2QKZ4FKHAH1NQKYKYAYZPY440FEPK7GZ1R5HBP2"
                  },
                  "amount":{
                     "value":"-500000000",
                     "currency":{
                        "decimals":6,
                        "symbol":"STX"
                     }
                  },
                  "coin_change":{
                     "coin_action":"coin_spent",
                     "coin_identifier":{
                        "identifier":"0x5b4146351bf941ffb12b66ea0f14dc8b21f4b119d2adbaf8bdf6e8bc3582c0e0:1"
                     }
                  }
               },
               {
                  "operation_identifier":{
                     "index":2
                  },
                  "related_operations":[
                     {
                        "index":1
                     }
                  ],
                  "type":"token_transfer",
                  "status":"success",
                  "account":{
                     "address":"ST11NJTTKGVT6D1HY4NJRVQWMQM7TVAR091EJ8P2Y"
                  },
                  "amount":{
                     "value":"500000000",
                     "currency":{
                        "decimals":6,
                        "symbol":"STX"
                     }
                  },
                  "coin_change":{
                     "coin_action":"coin_created",
                     "coin_identifier":{
                        "identifier":"0x5b4146351bf941ffb12b66ea0f14dc8b21f4b119d2adbaf8bdf6e8bc3582c0e0:2"
                     }
                  }
               }
            ],
            "metadata":{
               "memo":"Faucet"
            }
         }
      ]
   }
}
Last updated on

Was this helpful?