1. SONs CLI Command Reference
1.1. create_son
Creates a SON object owned by the given account. An account can have at most one SON object.
return type, namespace, & method
Copy 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
Example Call
Copy 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
Copy {
"ref_block_num" : number ,
"ref_block_prefix" : number ,
"expiration" : "datetime" ,
"operations" : [],
"extensions": [],
"signatures": []
} Example Successful Return
Copy 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....."
]
} 1.2. update_son
Update a SON object owned by the given account.
return type, namespace, & method
Copy 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
Example Call
Copy 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
Copy {
"ref_block_num" : number ,
"ref_block_prefix" : number ,
"expiration" : "datetime" ,
"operations" : [],
"extensions": [],
"signatures": []
} Example Successful Return
Copy 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....."
]
} 1.3. update_son_vesting_balances
Updates the vesting balances associated with a given SON.
return type, namespace, & method
Copy 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
Example Call
Copy 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
Copy {
"ref_block_num" : number ,
"ref_block_prefix" : number ,
"expiration" : "datetime" ,
"operations" : [],
"extensions": [],
"signatures": []
} Example Successful Return
Copy 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....."
]
} 1.4. get_son
Returns information about the given SON.
return type, namespace, & method
Copy son_object graphene :: wallet :: wallet_api :: get_son (
string owner_account); Function Call Return
Return Format
Copy {
"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
Copy 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..."
]
]
} 1.5. vote_for_son
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
Copy signed_transaction graphene :: wallet :: wallet_api :: vote_for_son (
string voting_account ,
string son ,
bool approve ,
bool broadcast); Function Call Return
Parameters
Example Call
Copy vote_for_son 1.2.12345 some - son true true Return Format
Copy {
"ref_block_num" : number ,
"ref_block_prefix" : number ,
"expiration" : "datetime" ,
"operations" : [],
"extensions": [],
"signatures": []
} 1.6. update_son_votes
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
Copy 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
Example Call
Copy update_son_votes 1.2.12345 [different - son , another - son] [] 3 true Return Format
Example Successful Return
1.7. list_sons
Lists all registered SONs, active or not.
return type, namespace, & method
Copy map < string , son_id_type > graphene :: wallet :: wallet_api :: list_sons (
const string & lowerbound ,
uint32_t limit); 1.8. list_active_sons
List all active SONs.
return type, namespace, & method
Copy map < string , son_id_type > graphene :: wallet :: wallet_api :: list_active_sons (); 1.9. request_son_maintenance
Modify status of the SON owned by the given account to maintenance.
return type, namespace, & method
Copy signed_transaction graphene :: wallet :: wallet_api :: request_son_maintenance (
string owner_account ,
bool broadcast); Function Call Return
Parameters
Example Call
Copy request_son_maintenance mycool - son true 1.10. cancel_request_son_maintenance
Modify status of the SON owned by the given account back to active.
return type, namespace, & method
Copy signed_transaction graphene :: wallet :: wallet_api :: cancel_request_son_maintenance (
string owner_account ,
bool broadcast); Function Call Return
Parameters
Example Call
Copy cancel_request_son_maintenance mycool - son true 1.11. get_son_wallets
This will display the wallet information for all registered SONs. You can specify the maximum number of wallets to return.
return type, namespace, & method
Copy vector < optional < son_wallet_object >> graphene :: wallet :: wallet_api :: get_son_wallets (
uint32_t limit); 1.12. get_active_son_wallet
This will display the wallet information for the current active SON.
return type, namespace, & method
Copy optional < son_wallet_object > graphene :: wallet :: wallet_api :: get_active_son_wallet (); Function Call Return
Parameters
Example Call
Copy get_active_son_wallet 1.13. get_son_wallet_by_time_point
This will display the wallet information for the SON that was active at a specific date and time.
return type, namespace, & method
Copy optional < son_wallet_object > graphene :: wallet :: wallet_api :: get_son_wallet_by_time_point (
time_point_sec time_point); Function Call Return
Parameters
Example Call
Copy get_son_wallet_by_time_point "2020-10-31T13:43:39" 2. Sidechains CLI Command Reference
2.1. add_sidechain_address
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
Copy 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
Example Call
add_sidechain_address mypeerplays-account bitcoin 02cf1b2c34eed7537a63eb5e86c914b6c5f641d87f07798dd777773d96c4df82e9 022bccebf0f97231c1a499ed2145f744444b2df51d24e8ba71016ebd186bec2ab9 1KTE52KRoYf8G3SPJtKUufU9tRansAGyud true
2.2. delete_sidechain_address
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
Copy signed_transaction graphene :: wallet :: wallet_api :: delete_sidechain_address (
string account ,
sidechain_type sidechain ,
bool broadcast); Function Call Return
Parameters
Example Call
Copy vote_for_son 1.2.12345 some - son true true 2.3. get_sidechain_address_by_account_and_sidechain
This returns a registered sidechain address for a given account and sidechain.
return type, namespace, & method
Copy 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
Example Call
Copy vote_for_son 1.2.12345 some - son true true 2.4. get_sidechain_addresses_by_account
This returns all the registered sidechain addresses for a given account.
return type, namespace, & method
Copy vector < optional < sidechain_address_object >> graphene :: wallet :: wallet_api :: get_sidechain_addresses_by_account (
string account); Function Call Return
Parameters
Example Call
Copy vote_for_son 1.2.12345 some - son true true 2.5. get_sidechain_addresses_by_sidechain
This returns all the registered sidechain addresses for a given sidechain.
return type, namespace, & method
Copy vector < optional < sidechain_address_object >> graphene :: wallet :: wallet_api :: get_sidechain_addresses_by_sidechain (
sidechain_type sidechain); Function Call Return
Parameters
Example Call
Copy vote_for_son 1.2.12345 some - son true true 2.6. get_sidechain_addresses_count
This returns the number of registered sidechain addresses.
return type, namespace, & method
Copy uint64_t graphene :: wallet :: wallet_api :: get_sidechain_addresses_count (); Function Call Return
Parameters
Example Call
Copy vote_for_son 1.2.12345 some - son true true
