SendAsset
SendAsset uses one or multiple passed Taproot Asset address(es) to attempt to complete an asset send. The method returns information w.r.t the on chain send, as well as the proof file information the receiver needs to fully receive the asset.
Source: taprootassets.proto
gRPC
rpc SendAsset (SendAssetRequest) returns (SendAssetResponse);
REST
HTTP Method | Path |
---|---|
POST | /v1/taproot-assets/send |
Code Samples
- gRPC
- REST
- Shell
- Javascript
- Python
const fs = require('fs');
const grpc = require('@grpc/grpc-js');
const protoLoader = require('@grpc/proto-loader');
const GRPC_HOST = 'localhost:10029'
const MACAROON_PATH = 'TAPROOT-ASSETS_DIR/regtest/taproot-assets.macaroon'
const TLS_PATH = 'TAPROOT-ASSETS_DIR/tls.cert'
const loaderOptions = {
keepCase: true,
longs: String,
enums: String,
defaults: true,
oneofs: true,
};
const packageDefinition = protoLoader.loadSync('taprootassets.proto', loaderOptions);
const taprpc = grpc.loadPackageDefinition(packageDefinition).taprpc;
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 taprpc.TaprootAssets(GRPC_HOST, creds);
let request = {
tap_addrs: <string>,
fee_rate: <uint32>,
};
client.sendAsset(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "transfer": <AssetTransfer>,
// }
import codecs, grpc, os
# Generate the following 2 modules by compiling the taprootassets.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import taprootassets_pb2 as taprpc, taprootassets_pb2_grpc as taprootassetsstub
GRPC_HOST = 'localhost:10029'
MACAROON_PATH = 'TAPROOT-ASSETS_DIR/regtest/taproot-assets.macaroon'
TLS_PATH = 'TAPROOT-ASSETS_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 = taprootassetsstub.TaprootAssetsStub(channel)
request = taprpc.SendAssetRequest(
tap_addrs=<string>,
fee_rate=<uint32>,
)
response = stub.SendAsset(request)
print(response)
# {
# "transfer": <AssetTransfer>,
# }
- Javascript
- Python
const fs = require('fs');
const request = require('request');
const REST_HOST = 'localhost:8089'
const MACAROON_PATH = 'TAPROOT-ASSETS_DIR/regtest/taproot-assets.macaroon'
let requestBody = {
tap_addrs: <array>, // <string>
fee_rate: <integer>, // <uint32>
};
let options = {
url: `https://${REST_HOST}/v1/taproot-assets/send`,
// 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:
// {
// "transfer": <object>, // <AssetTransfer>
// }
import base64, codecs, json, requests
REST_HOST = 'localhost:8089'
MACAROON_PATH = 'TAPROOT-ASSETS_DIR/regtest/taproot-assets.macaroon'
TLS_PATH = 'TAPROOT-ASSETS_DIR/tls.cert'
url = f'https://{REST_HOST}/v1/taproot-assets/send'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
'tap_addrs': <string>,
'fee_rate': <uint32>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
# "transfer": <AssetTransfer>,
# }
$ tapcli assets send --help
NAME:
tapcli assets send - send an asset
USAGE:
tapcli assets send [command options] [arguments...]
DESCRIPTION:
send asset w/ a taproot asset addr
OPTIONS:
--addr value addr to send to; can be specified multiple times to send to multiple addresses at once
--sat_per_vbyte value if set, the fee rate in sat/vB to use for the anchor transaction (default: 0)
Messages
taprpc.SendAssetRequest
Source: taprootassets.proto
Field | gRPC Type | REST Type | REST Placement |
---|---|---|---|
tap_addrs | string[] | array | body |
fee_rate | uint32 | integer | body |
taprpc.SendAssetResponse
Source: taprootassets.proto
Field | gRPC Type | REST Type |
---|---|---|
transfer | AssetTransfer | object |
Nested Messages
taprpc.AssetTransfer
Field | gRPC Type | REST Type |
---|---|---|
transfer_timestamp | int64 | string |
anchor_tx_hash | bytes | string |
anchor_tx_height_hint | uint32 | integer |
anchor_tx_chain_fees | int64 | string |
inputs | TransferInput[] | array |
outputs | TransferOutput[] | array |
anchor_tx_block_hash | ChainHash | object |
taprpc.ChainHash
Field | gRPC Type | REST Type |
---|---|---|
hash | bytes | string |
hash_str | string | string |
taprpc.TransferInput
Field | gRPC Type | REST Type |
---|---|---|
anchor_point | string | string |
asset_id | bytes | string |
script_key | bytes | string |
amount | uint64 | string |
taprpc.TransferOutput
Field | gRPC Type | REST Type |
---|---|---|
anchor | TransferOutputAnchor | object |
script_key | bytes | string |
script_key_is_local | bool | boolean |
amount | uint64 | string |
new_proof_blob | bytes | string |
split_commit_root_hash | bytes | string |
output_type | OutputType | string |
asset_version | AssetVersion | string |
lock_time | uint64 | string |
relative_lock_time | uint64 | string |
proof_delivery_status | ProofDeliveryStatus | string |
taprpc.TransferOutputAnchor
Field | gRPC Type | REST Type |
---|---|---|
outpoint | string | string |
value | int64 | string |
internal_key | bytes | string |
taproot_asset_root | bytes | string |
merkle_root | bytes | string |
tapscript_sibling | bytes | string |
num_passive_assets | uint32 | integer |
Enums
taprpc.AssetVersion
Name | Number |
---|---|
ASSET_VERSION_V0 | 0 |
ASSET_VERSION_V1 | 1 |
taprpc.OutputType
Name | Number |
---|---|
OUTPUT_TYPE_SIMPLE | 0 |
OUTPUT_TYPE_SPLIT_ROOT | 1 |
taprpc.ProofDeliveryStatus
Name | Number |
---|---|
PROOF_DELIVERY_STATUS_NOT_APPLICABLE | 0 |
PROOF_DELIVERY_STATUS_COMPLETE | 1 |
PROOF_DELIVERY_STATUS_PENDING | 2 |