Skip to main content

QueryFederationSyncConfig

QueryFederationSyncConfig queries the universe federation sync configuration settings.

Source: universerpc/universe.proto

gRPC

rpc QueryFederationSyncConfig (QueryFederationSyncConfigRequest) returns (QueryFederationSyncConfigResponse);

REST

HTTP MethodPath
GET /v1/taproot-assets/universe/sync/config

Code Samples

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('universerpc/universe.proto', loaderOptions);
const universerpc = grpc.loadPackageDefinition(packageDefinition).universerpc;
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 universerpc.Universe(GRPC_HOST, creds);
let request = {
id: <ID>,
};
client.queryFederationSyncConfig(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "global_sync_configs": <GlobalFederationSyncConfig>,
// "asset_sync_configs": <AssetFederationSyncConfig>,
// }

Messages

universerpc.QueryFederationSyncConfigRequest

Source: universerpc/universe.proto

FieldgRPC TypeREST TypeREST Placement
id
ID[]objectunknown

universerpc.QueryFederationSyncConfigResponse

Source: universerpc/universe.proto

FieldgRPC TypeREST Type
global_sync_configs
GlobalFederationSyncConfig[]array
asset_sync_configs
AssetFederationSyncConfig[]array

Nested Messages

universerpc.AssetFederationSyncConfig

FieldgRPC TypeREST Type
id
IDobject
allow_sync_insert
boolboolean
allow_sync_export
boolboolean

universerpc.GlobalFederationSyncConfig

FieldgRPC TypeREST Type
proof_type
ProofTypestring
allow_sync_insert
boolboolean
allow_sync_export
boolboolean

universerpc.ID

FieldgRPC TypeREST Type
asset_id
bytesstring
asset_id_str
stringstring
group_key
bytesstring
group_key_str
stringstring
proof_type
ProofTypestring

Enums

universerpc.ProofType

NameNumber
PROOF_TYPE_UNSPECIFIED
0
PROOF_TYPE_ISSUANCE
1
PROOF_TYPE_TRANSFER
2