CLI Commands for SONs
CLI commands that sons use.
Creates a SON object owned by the given account. An account can have at most one SON object.
return type, namespace, & method
signed_transaction graphene::wallet::wallet_api::create_son(
string owner_account,
string url,
vesting_balance_id_type deposit_id,
vesting_balance_id_type pay_vb_id,
flat_map<sidechain_type, string> sidechain_public_keys,
bool broadcast);
Function Call
Return
Parameters
name | data type | description | details |
owner_account | string | The name or id of the account which is creating the SON. | no quotes required. |
url | string | a URL to include in the SON record in the blockchain. Clients may display this when showing a list of SONs. | May be blank. |
deposit_id | vesting_balance_id_type | vesting balance id for SON deposit. | This is the son vesting balance. |
pay_vb_id | vesting_balance_id_type | vesting balance id for SON pay_vb | This is the normal vesting balance. |
sidechain_public_keys | flat_map | The new set of sidechain public keys. | n/a |
broadcast | bool | true to broadcast the transaction on the network. | n/a |
Example Call
create_son myaccountname-son "www.my-awesome-son.com" 1.13.79 1.13.80 [[bitcoin, 023b907586045625367ecd62c5d889591586c87e57fa49be21614209489f00f1b9]] true
# The above command is structured like this:
# create_son <username> "<SON proposal url>" <son vesting balance ID> <normal vesting balance ID> [[bitcoin, <bitcoin public key>]] true
Return Format
{
"ref_block_num": number,
"ref_block_prefix": number,
"expiration": "datetime",
"operations": [],
"extensions": [],
"signatures": []
}
Example Successful Return
create_son myaccountname-son "www.my-awesome-son.com" 1.13.79 1.13.80 [[bitcoin, 023b907586045625367ecd62c5d889591586c87e57fa49be21614209489f00f1b9]] true
{
"ref_block_num": 10412,
"ref_block_prefix": 1003801100,
"expiration": "2015-02-05T00:11:00",
"operations": [[
101,{
"fee": {
"amount": 0,
"asset_id": "1.3.0"
},
"owner_account": "1.2.12345",
"url": "www.my-awesome-son.com",
"deposit": "1.13.79",
"signing_key": "PPY2j4hy47qY...",
"sidechain_public_keys": [[
"bitcoin",
"bc1abc1234..."
]
],
"pay_vb": "1.13.80"
}
]
],
"extensions": [],
"signatures": [
"268bd8....."
]
}
Update a SON object owned by the given account.
return type, namespace, & method
signed_transaction graphene::wallet::wallet_api::create_son(
string owner_account,
string url,
string block_signing_key,
flat_map<sidechain_type, string> sidechain_public_keys,
bool broadcast);
Function Call
Return
Parameters
name | data type | description | details |
owner_account | string | The name of the SON's owner account. Also accepts the ID of the owner account or the ID of the SON. | no quotes required. |
url | string | Same as for create_son. The empty string makes it remain the same. | n/a |
block_signing_key | string | A new signing key to replace the currently set signing key. | n/a |
sidechain_public_keys | flat_map | The new set of sidechain public keys. An empty string makes it remain the same. | n/a |
broadcast | bool | true to broadcast the transaction on the network. | n/a |
Example Call
update_son myaccountname-son "www.my-awesome-son.com" PPY8kvUXLpoXE9rJHwppR48LkqSouAzFZomAPb3hW9gnkSHZCsozi [[bitcoin, 023b907586045625367ecd62c5d889591586c87e57fa49be21614209489f00f1b9]] true
# The above command is structured like this:
# create_son <username> "<SON proposal url>" <new block signing public key> [[bitcoin, <bitcoin public key>]] true
Return Format
{
"ref_block_num": number,
"ref_block_prefix": number,
"expiration": "datetime",
"operations": [],
"extensions": [],
"signatures": []
}
Example Successful Return
update_son myaccountname-son "www.my-awesome-son.com" PPY8kvUXLpoXE9rJHwppR48LkqSouAzFZomAPb3hW9gnkSHZCsozi [[bitcoin, 023b907586045625367ecd62c5d889591586c87e57fa49be21614209489f00f1b9]] true
{
"ref_block_num": 10412,
"ref_block_prefix": 1003801100,
"expiration": "2015-02-05T00:11:00",
"operations": [[
102,{
"fee": {
"amount": 0,
"asset_id": "1.3.0"
},
"son_id": "1.33.99",
"owner_account": "1.2.12345",
"new_url": "www.my-awesome-son.com",
"new_signing_key": "PPY8kvUXLpoXE9rJHwppR48LkqSouAzFZomAPb3hW9gnkSHZCsozi",
"new_sidechain_public_keys": [[
"bitcoin",
"bc1..."
]
]
}
]
],
"extensions": [],
"signatures": [
"268bd8....."
]
}
Updates the vesting balances associated with a given SON.
return type, namespace, & method
signed_transaction graphene::wallet::wallet_api::update_son_vesting_balances(
string owner_account,
optional<vesting_balance_id_type> new_deposit,
optional<vesting_balance_id_type> new_pay_vb,
bool broadcast);
Function Call
Return
Parameters
name | data type | description | details |
owner_account | string | The name or id of the SON account owner, or the id of the SON. | No quotes required. |
new_deposit | vesting_balance_id_type | A vesting balance id that will replace the currently set son vesting balance. | Optional |
new_pay_vb | vesting_balance_id_type | A vesting balance id that will replace the currently set normal vesting balance. | Optional |
broadcast | bool | true to broadcast the transaction on the network. | n/a |
Example Call
update_son_vesting_balances 1.33.99 1.13.81 1.13.82 true
# The above command is structured like this:
# update_son_vesting_balances <owner_account> <new_deposit> <new_pay_vb> true
Return Format
{
"ref_block_num": number,
"ref_block_prefix": number,
"expiration": "datetime",
"operations": [],
"extensions": [],
"signatures": []
}
Example Successful Return
update_son_vesting_balances 1.33.99 1.13.81 1.13.82 true
{
"ref_block_num": 10412,
"ref_block_prefix": 1003801100,
"expiration": "2015-02-05T00:11:00",
"operations": [[
102,{
"fee": {
"amount": 0,
"asset_id": "1.3.0"
},
"son_id": "1.33.99",
"owner_account": "1.2.12345",
"new_deposit": "1.13.81",
"new_pay_vb": "1.13.82"
}
]
],
"extensions": [],
"signatures": [
"268bd8....."
]
}
Returns information about the given SON.
return type, namespace, & method
son_object graphene::wallet::wallet_api::get_son(
string owner_account);
Function Call
Return
Parameters
name | data type | description | details |
owner_account | string | The name or id of the SON account owner, or the id of the SON. | No quotes required. |
Example Call
get_son 1.33.99
Return Format
{
"id": "string",
"son_account": "string",
"vote_id": "string",
"total_votes": number,
"url": "string",
"deposit": "string",
"signing_key": "string",
"pay_vb": "string",
"statistics": "string",
"status": "string",
"sidechain_public_keys": [[
"string",
"string"
]
]
}
Example Successful Return
get_son 1.33.99
{
"id": "1.33.99",
"son_account": "1.2.12345",
"vote_id": "3:114",
"total_votes": 0,
"url": "www.my-awesome-son.com",
"deposit": "1.13.79",
"signing_key": "PPY2j4ySF...",
"pay_vb": "1.13.80",
"statistics": "2.25.4",
"status": "inactive",
"sidechain_public_keys": [[
"bitcoin",
"bc1..."
]
]
}
Vote for a given SON. An account can publish a list of all SONs they approve of. This command allows you to add or remove SONs from this list. Each account's vote is weighted according to the number of PPY owned by that account at the time the votes are tallied. Note that you can't vote against a SON, you can only vote for the SON or not vote for the SON.
return type, namespace, & method
signed_transaction graphene::wallet::wallet_api::vote_for_son(
string voting_account,
string son,
bool approve,
bool broadcast);
Function Call
Return
Parameters
name | data type | description | details |
voting_account | string | The name or id of the account who is voting with their PPY. | No quotes required. |
son | string | The name or id of the SON's owner account. | No quotes required. |
approve | bool | true if you wish to vote in favor of that SON, false to remove your vote in favor of that SON. | n/a |
broadcast | bool | true to broadcast the transaction on the network. | n/a |
Example Call
vote_for_son 1.2.12345 some-son true true
Return Format
{
"ref_block_num": number,
"ref_block_prefix": number,
"expiration": "datetime",
"operations": [],
"extensions": [],
"signatures": []
}
Change all your votes for SONs in one transaction. This can add and remove votes, and set the number of SONs you think should be active too.
You cannot vote against a SON, you can only vote for the SON or not vote for the SON.
return type, namespace, & method
signed_transaction graphene::wallet::wallet_api::update_son_votes(
string voting_account,
std::vector<std::string> sons_to_approve,
std::vector<std::string> sons_to_reject,
uint16_t desired_number_of_sons,
bool broadcast);
Function Call
Return
Parameters
name | data type | description | details |
voting_account | string | The name or id of the account who is voting with their PPY. | No quotes required. |
sons_to_approve | std::vector<std::string> | An array of SON names or ids that you had not previously voted for which you wish to add your vote. | This can be empty. |
sons_to_reject | std::vector<std::string> | An array of SON names or ids that you had previously voted for which you wish to remove your vote. | This can be empty. |
desired_number_of_sons | uint16_t | The number of SONs that you think the network should have. You must vote for at least this many SONs. You can set this to 0 (zero) to abstain from voting on the number of SONs. | n/a |
broadcast | bool | true to broadcast the transaction on the network. | n/a |
Example Call
update_son_votes 1.2.12345 [different-son, another-son] [] 3 true
Return Format
Example Successful Return
Lists all registered SONs, active or not.
return type, namespace, & method
map<string, son_id_type> graphene::wallet::wallet_api::list_sons(
const string& lowerbound,
uint32_t limit);
Function Call
Return
Parameters
name | data type | description | details |
lowerbound | string& | The name of the first SON to return. If the named SON does not exist, the list will start at the SON that comes next. | Use "" to start at the beginning. |
limit | uint32_t | The maximum number of SON to return. | Max of 1000. |
Example Call
list_sons "" 100
List all active SONs.
return type, namespace, & method
map<string, son_id_type> graphene::wallet::wallet_api::list_active_sons();
Function Call
Return
Parameters
name | data type | description | details |
No Parmeters! | n/a | n/a | n/a |
Example Call
list_active_sons
Modify status of the SON owned by the given account to maintenance.
return type, namespace, & method
signed_transaction graphene::wallet::wallet_api::request_son_maintenance(
string owner_account,
bool broadcast);
Function Call
Return
Parameters
name | data type | description | details |
owner_account | string | The name or id of the account who owns the SON. | No quotes required. |
broadcast | bool | true to broadcast the transaction on the network. | n/a |
Example Call
request_son_maintenance mycool-son true
Modify status of the SON owned by the given account back to active.
return type, namespace, & method
signed_transaction graphene::wallet::wallet_api::cancel_request_son_maintenance(
string owner_account,
bool broadcast);
Function Call
Return
Parameters
name | data type | description | details |
owning_account | string | The name or id of the account who owns the SON. | No quotes required. |
broadcast | bool | true to broadcast the transaction on the network. | n/a |
Example Call
cancel_request_son_maintenance mycool-son true
This will display the wallet information for all registered SONs. You can specify the maximum number of wallets to return.
return type, namespace, & method
vector<optional<son_wallet_object>> graphene::wallet::wallet_api::get_son_wallets(
uint32_t limit);
Function Call
Return
Parameters
name | data type | description | details |
limit | uint32_t | The maximum number of results to return. | n/a |
Example Call
get_son_wallets 20
This will display the wallet information for the current active SON.
return type, namespace, & method
optional<son_wallet_object> graphene::wallet::wallet_api::get_active_son_wallet();
Function Call
Return
Parameters
name | data type | description | details |
No Parameters! | n/a | n/a | n/a |
Example Call
get_active_son_wallet
This will display the wallet information for the SON that was active at a specific date and time.
return type, namespace, & method
optional<son_wallet_object> graphene::wallet::wallet_api::get_son_wallet_by_time_point(
time_point_sec time_point);
Function Call
Return
Parameters
name | data type | description | details |
time_point | time_point_sec | The date and time. Formatted like this: "2020-10-31T13:43:39" | Quotes are required! |
Example Call
get_son_wallet_by_time_point "2020-10-31T13:43:39"
This command allows a user to register two Bitcoin addresses: one used to create their deposit address, and one that will be used for their withdraw address. Collectively these are a "sidechain address".
return type, namespace, & method
signed_transaction graphene::wallet::wallet_api::add_sidechain_address(
string account,
sidechain_type sidechain,
string deposit_public_key,
string withdraw_public_key,
string withdraw_address,
bool broadcast);
Function Call
Return
Parameters
name | data type | description | details |
account | string | The name or id of the account who owns the address. | No quotes required. |
sidechain | sidechain_type | One of: bitcoin, (more will be added later). | n/a |
deposit_public_key | string | The public key of a Bitcoin address. This will be used to generate the deposit address in the return of this function. | n/a |
withdraw_public_key | string | The public key of a different Bitcoin address. This will be used for the withdraw address. | n/a |
withdraw_address | string | The Bitcoin address that is connected to the withdraw_public_key. | n/a |
broadcast | bool | true to broadcast the transaction on the network. | n/a |
Example Call
add_sidechain_address mypeerplays-account bitcoin 02cf1b2c34eed7537a63eb5e86c914b6c5f641d87f07798dd777773d96c4df82e9 022bccebf0f97231c1a499ed2145f744444b2df51d24e8ba71016ebd186bec2ab9 1KTE52KRoYf8G3SPJtKUufU9tRansAGyud true
This will delete a sidechain address that was previously registered with the
add_sidechain_address command. Only one sidechain address can exist per user and sidechain. (A sidechain address in the case of Bitcoin consists of both a deposit and a withdraw address.)return type, namespace, & method
signed_transaction graphene::wallet::wallet_api::delete_sidechain_address(
string account,
sidechain_type sidechain,
bool broadcast);
Function Call
Return
Parameters
name | data type | description | details |
voting_account | string | The name or id of the account who is voting with their PPY. | No quotes required. |
witness | string | The name or id of the SON's owner account. | No quotes required. |
approve | bool | true if you wish to vote in favor of that SON, false to remove your vote in favor of that SON. | n/a |
broadcast | bool | true to broadcast the transaction on the network. | n/a |
Example Call
vote_for_son 1.2.12345 some-son true true
This returns a registered sidechain address for a given account and sidechain.
return type, namespace, & method
fc::optional<sidechain_address_object> graphene::wallet::wallet_api::get_sidechain_address_by_account_and_sidechain(
string account,
sidechain_type sidechain);
Function Call
Return
Parameters
name | data type | description | details |
voting_account | string | The name or id of the account who is voting with their PPY. | No quotes required. |
witness | string | The name or id of the SON's owner account. | No quotes required. |
approve | bool | true if you wish to vote in favor of that SON, false to remove your vote in favor of that SON. | n/a |
broadcast | bool | true to broadcast the transaction on the network. | n/a |
Example Call
vote_for_son 1.2.12345 some-son true true
This returns all the registered sidechain addresses for a given account.
return type, namespace, & method
vector<optional<sidechain_address_object>> graphene::wallet::wallet_api::get_sidechain_addresses_by_account(
string account);
Function Call
Return
Parameters
name | data type | description | details |
voting_account | string | The name or id of the account who is voting with their PPY. | No quotes required. |
witness | string | The name or id of the SON's owner account. | No quotes required. |
approve | bool | true if you wish to vote in favor of that SON, false to remove your vote in favor of that SON. | n/a |
broadcast | bool | true to broadcast the transaction on the network. | n/a |
Example Call
vote_for_son 1.2.12345 some-son true true