NewAddr
NewAddr makes a new address from the set of request params.
Source: taprootassets.proto
gRPC
rpc NewAddr (NewAddrRequest) returns (Addr);
REST
HTTP Method | Path |
---|---|
POST | /v1/taproot-assets/addrs |
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 = {
asset_id: <bytes>,
amt: <uint64>,
script_key: <ScriptKey>,
internal_key: <KeyDescriptor>,
tapscript_sibling: <bytes>,
proof_courier_addr: <string>,
asset_version: <AssetVersion>,
address_version: <AddrVersion>,
};
client.newAddr(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "encoded": <string>,
// "asset_id": <bytes>,
// "asset_type": <AssetType>,
// "amount": <uint64>,
// "group_key": <bytes>,
// "script_key": <bytes>,
// "internal_key": <bytes>,
// "tapscript_sibling": <bytes>,
// "taproot_output_key": <bytes>,
// "proof_courier_addr": <string>,
// "asset_version": <AssetVersion>,
// "address_version": <AddrVersion>,
// }
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.NewAddrRequest(
asset_id=<bytes>,
amt=<uint64>,
script_key=<ScriptKey>,
internal_key=<KeyDescriptor>,
tapscript_sibling=<bytes>,
proof_courier_addr=<string>,
asset_version=<AssetVersion>,
address_version=<AddrVersion>,
)
response = stub.NewAddr(request)
print(response)
# {
# "encoded": <string>,
# "asset_id": <bytes>,
# "asset_type": <AssetType>,
# "amount": <uint64>,
# "group_key": <bytes>,
# "script_key": <bytes>,
# "internal_key": <bytes>,
# "tapscript_sibling": <bytes>,
# "taproot_output_key": <bytes>,
# "proof_courier_addr": <string>,
# "asset_version": <AssetVersion>,
# "address_version": <AddrVersion>,
# }
- 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 = {
asset_id: <string>, // <bytes> (base64 encoded)
amt: <string>, // <uint64>
script_key: <object>, // <ScriptKey>
internal_key: <object>, // <KeyDescriptor>
tapscript_sibling: <string>, // <bytes> (base64 encoded)
proof_courier_addr: <string>, // <string>
asset_version: <string>, // <AssetVersion>
address_version: <string>, // <AddrVersion>
};
let options = {
url: `https://${REST_HOST}/v1/taproot-assets/addrs`,
// 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:
// {
// "encoded": <string>, // <string>
// "asset_id": <string>, // <bytes>
// "asset_type": <string>, // <AssetType>
// "amount": <string>, // <uint64>
// "group_key": <string>, // <bytes>
// "script_key": <string>, // <bytes>
// "internal_key": <string>, // <bytes>
// "tapscript_sibling": <string>, // <bytes>
// "taproot_output_key": <string>, // <bytes>
// "proof_courier_addr": <string>, // <string>
// "asset_version": <string>, // <AssetVersion>
// "address_version": <string>, // <AddrVersion>
// }
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/addrs'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
'asset_id': base64.b64encode(<bytes>),
'amt': <uint64>,
'script_key': <ScriptKey>,
'internal_key': <KeyDescriptor>,
'tapscript_sibling': base64.b64encode(<bytes>),
'proof_courier_addr': <string>,
'asset_version': <AssetVersion>,
'address_version': <AddrVersion>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
# "encoded": <string>,
# "asset_id": <bytes>,
# "asset_type": <AssetType>,
# "amount": <uint64>,
# "group_key": <bytes>,
# "script_key": <bytes>,
# "internal_key": <bytes>,
# "tapscript_sibling": <bytes>,
# "taproot_output_key": <bytes>,
# "proof_courier_addr": <string>,
# "asset_version": <AssetVersion>,
# "address_version": <AddrVersion>,
# }
$ tapcli addrs new --help
NAME:
tapcli addrs new - Create a Taproot Asset address
USAGE:
tapcli addrs new [command options] [arguments...]
DESCRIPTION:
Create a new Taproot Asset address to receive an asset on-chain
OPTIONS:
--asset_id value the asset genesis ID of the asset to receive
--amt value the amt of the asset to receive (default: 0)
--asset_version value the asset version of the asset to receive (default: 0)
--address_version value the version of address to generate
--proof_courier_addr value (optional) the address of the proof courier to use for this specific address, if the default proof courier should be overwritten; format: protocol://host:port
Messages
taprpc.NewAddrRequest
Source: taprootassets.proto
Field | gRPC Type | REST Type | REST Placement |
---|---|---|---|
asset_id | bytes | string | body |
amt | uint64 | string | body |
script_key | ScriptKey | object | body |
internal_key | KeyDescriptor | object | body |
tapscript_sibling | bytes | string | body |
proof_courier_addr | string | string | body |
asset_version | AssetVersion | string | body |
address_version | AddrVersion | string | body |
taprpc.Addr
Source: taprootassets.proto
Field | gRPC Type | REST Type |
---|---|---|
encoded | string | string |
asset_id | bytes | string |
asset_type | AssetType | string |
amount | uint64 | string |
group_key | bytes | string |
script_key | bytes | string |
internal_key | bytes | string |
tapscript_sibling | bytes | string |
taproot_output_key | bytes | string |
proof_courier_addr | string | string |
asset_version | AssetVersion | string |
address_version | AddrVersion | string |
Nested Messages
taprpc.KeyDescriptor
Field | gRPC Type | REST Type |
---|---|---|
raw_key_bytes | bytes | string |
key_loc | KeyLocator | object |
taprpc.KeyLocator
Field | gRPC Type | REST Type |
---|---|---|
key_family | int32 | integer |
key_index | int32 | integer |
taprpc.ScriptKey
Field | gRPC Type | REST Type |
---|---|---|
pub_key | bytes | string |
key_desc | KeyDescriptor | object |
tap_tweak | bytes | string |
Enums
taprpc.AddrVersion
Name | Number |
---|---|
ADDR_VERSION_UNSPECIFIED | 0 |
ADDR_VERSION_V0 | 1 |
ADDR_VERSION_V1 | 2 |
taprpc.AssetType
Name | Number |
---|---|
NORMAL | 0 |
COLLECTIBLE | 1 |
taprpc.AssetVersion
Name | Number |
---|---|
ASSET_VERSION_V0 | 0 |
ASSET_VERSION_V1 | 1 |