ExportAssetWalletBackup

ExportAssetWalletBackup exports a backup of all active assets in the wallet. The backup includes all data necessary to restore the assets in case of database or system failure.

Source: assetwalletrpc/assetwallet.proto

gRPC

rpc ExportAssetWalletBackup (ExportAssetWalletBackupRequest) returns (ExportAssetWalletBackupResponse);

REST

HTTP Method	Path
POST	/v1/taproot-assets/wallet/backup/export

Code Samples

gRPC

Javascript

const fs = require('fs');
const grpc = require('@grpc/grpc-js');
const protoLoader = require('@grpc/proto-loader');

const GRPC_HOST = 'localhost:10029'
const MACAROON_PATH = 'TAPD_DIR/data/regtest/admin.macaroon'
const TLS_PATH = 'TAPD_DIR/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync('assetwalletrpc/assetwallet.proto', loaderOptions);
const assetwalletrpc = grpc.loadPackageDefinition(packageDefinition).assetwalletrpc;
process.env.GRPC_SSL_CIPHER_SUITES = 'HIGH+ECDSA';
const tlsCert = fs.readFileSync(TLS_PATH);
const sslCreds = grpc.credentials.createSsl(tlsCert);
const macaroon = fs.readFileSync(MACAROON_PATH).toString('hex');
const macaroonCreds = grpc.credentials.createFromMetadataGenerator(function(args, callback) {
  let metadata = new grpc.Metadata();
  metadata.add('macaroon', macaroon);
  callback(null, metadata);
});
let creds = grpc.credentials.combineChannelCredentials(sslCreds, macaroonCreds);
let client = new assetwalletrpc.AssetWallet(GRPC_HOST, creds);
let request = {
  mode: <BackupMode>,
};
client.exportAssetWalletBackup(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "backup": <bytes>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the assetwalletrpc/assetwallet.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import assetwallet_pb2 as assetwalletrpc, assetwallet_pb2_grpc as assetwalletstub

GRPC_HOST = 'localhost:10029'
MACAROON_PATH = 'TAPD_DIR/data/regtest/admin.macaroon'
TLS_PATH = 'TAPD_DIR/tls.cert'

# create macaroon credentials
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
def metadata_callback(context, callback):
  callback([('macaroon', macaroon)], None)
auth_creds = grpc.metadata_call_credentials(metadata_callback)
# create SSL credentials
os.environ['GRPC_SSL_CIPHER_SUITES'] = 'HIGH+ECDSA'
cert = open(TLS_PATH, 'rb').read()
ssl_creds = grpc.ssl_channel_credentials(cert)
# combine macaroon and SSL credentials
combined_creds = grpc.composite_channel_credentials(ssl_creds, auth_creds)
# make the request
channel = grpc.secure_channel(GRPC_HOST, combined_creds)
stub = assetwalletstub.AssetWalletStub(channel)
request = assetwalletrpc.ExportAssetWalletBackupRequest(
  mode=<BackupMode>,
)
response = stub.ExportAssetWalletBackup(request)
print(response)
# {
#    "backup": <bytes>,
# }

grpcurl

# grpcurl docs: https://github.com/fullstorydev/grpcurl
# Proto source: https://github.com/lightninglabs/taproot-assets
GRPC_HOST=localhost:10029
TAPD_DIR=~/.tapd
TAPD_SOURCE=path/to/taproot-assets
NETWORK=mainnet
MACAROON_PATH="$TAPD_DIR/data/$NETWORK/admin.macaroon"
TLS_PATH="$TAPD_DIR/tls.cert"

grpcurl \
    -import-path $TAPD_SOURCE/taprpc/ \
    -proto assetwalletrpc/assetwallet.proto \
    -cacert $TLS_PATH \
    -H "macaroon: $(xxd -ps -u -c 1000 $MACAROON_PATH)" \
    -d '{ "mode": <BackupMode> }' \
    $GRPC_HOST \
    assetwalletrpc.AssetWallet/ExportAssetWalletBackup

REST

Javascript

const fs = require('fs');
const request = require('request');

const REST_HOST = 'localhost:8089'
const MACAROON_PATH = 'TAPD_DIR/data/regtest/admin.macaroon'

let requestBody = {
  mode: <string>, // <BackupMode> 
};
let options = {
  url: `https://${REST_HOST}/v1/taproot-assets/wallet/backup/export`,
  // Work-around for self-signed certificates.
  rejectUnauthorized: false,
  json: true,
  headers: {
    'Grpc-Metadata-macaroon': fs.readFileSync(MACAROON_PATH).toString('hex'),
  },
  form: JSON.stringify(requestBody),
}
request.post(options, function(error, response, body) {
  console.log(body);
});
// Console output:
//  {
//    "backup": <string>, // <bytes> 
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8089'
MACAROON_PATH = 'TAPD_DIR/data/regtest/admin.macaroon'
TLS_PATH = 'TAPD_DIR/tls.cert'

url = f'https://{REST_HOST}/v1/taproot-assets/wallet/backup/export'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
  'mode': <BackupMode>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
#    "backup": <bytes>,
# }

curl

REST_HOST=localhost:8089
TAPD_DIR=~/.tapd
NETWORK=mainnet
MACAROON_PATH="$TAPD_DIR/data/$NETWORK/admin.macaroon"
TLS_PATH="$TAPD_DIR/tls.cert"

curl -X POST \
    --cacert $TLS_PATH \
    -H "Grpc-Metadata-macaroon: $(xxd -ps -u -c 1000 $MACAROON_PATH)" \
    -d '{ "mode": <BackupMode> }' \
    https://$REST_HOST/v1/taproot-assets/wallet/backup/export

Messages

assetwalletrpc.ExportAssetWalletBackupRequest

Source: assetwalletrpc/assetwallet.proto

Field	gRPC Type	REST Type	REST Placement
mode The backup mode to use for the export. If not set, defaults to RAW (protobuf zero value). The CLI defaults to COMPACT for smaller backups; callers that want compact mode should set this explicitly.	BackupMode	string	body

assetwalletrpc.ExportAssetWalletBackupResponse

Source: assetwalletrpc/assetwallet.proto

Field	gRPC Type	REST Type
backup The binary backup blob containing all data necessary to restore the wallet's assets.	bytes	string

Enums

assetwalletrpc.BackupMode

Name	Number
RAW RAW exports a full backup with complete proof data (v1).	0
COMPACT COMPACT strips blockchain-derivable fields from proofs, reducing size. Stripped fields are reconstructed from the blockchain on import (v2).	1
OPTIMISTIC OPTIMISTIC stores no proof data. Proofs are fetched from a universe server on import. Smallest backup but requires a reachable universe server during restore (v3).	2