Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update tip-16.md #705

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update tip-16.md #705

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ad6165
Update tip-16.md
Ha-jq Nov 29, 2024
936c89c
Update tip-16.md
Ha-jq Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Update tip-16.md
  • Loading branch information
@Ha-jq
Ha-jq authored Nov 29, 2024
commit 1ad6165467ac6aa612b33f1941e87a0bc26def04
104 changes: 6 additions & 98 deletions tip-16.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,123 +10,31 @@ created: 2018-12-27
```


## Simple Summary

This doc describes the standard interface of Account Multi-signature


## Abstract

Standard transactions on cryptocurrency networks can be called single-signature transactions because they require only one digital signature for a transaction to be done. Multi-signature is the requirement that signatures of the transactions must reach the weight customized before they can be executed. \
The scheme includes three kinds of permission, owner-permission, witness-permission, and active-permission, where owner-permission has the authority to execute all contracts, witness-permission is used for generating blocks, and active-permission is custom permission (a combination of contracts permission sets)

**Scenario 1**:

Alice is running a company, she creates an account as her company fund account. Alice adds Bob(Accountant), Carol(CFO) and Alice(CEO) into the owner-permission of her account. Bob's signature weight is 2, Carol's signature weight is 2, Alice's signature weight is 5. Owner-permission's signature weight threshold is 3. Alice's signature weight is bigger than the threshold(5>3), so her only signature is sufficient to make transactions. Bob's signature weight is smaller than the threshold(2<3), to make a transaction, Bob needs Carol's or Alice's signature if Carol approves, the total signature weight is 2+2>3, so the transaction can be executed.


**Scenario 2**:

(Previous Scenario)\
Alice has many TRX assets. One day, misfortune has come, Alice is dead due to an accident. She is the only one who holds the private key of her account, so her assets will stay in that account forever, nobody can get it.\
(Current Scenario)\
Alice has many TRX assets. She creates an active-permission for her account, adds her husband and son's addresses into the active-permission, and give the active-permission authority to operate her account. So after Alice no longer exists, her family members can still operate her account.

**Scenario 3**:

Alice is running a company, she creates an account as her business account. Alice creates an active-permission and adds Bob(Accountant), Carol(CFO) and Alice(CEO) into the active-permission of the account. Alice gives the active-permission authority to operate her business account. One day, Bob resigns. To keep Alice's account safe, Alice can remove Bob's account from the active-permission, then Bob can not operate her account anymore.

**Scenario 4**:

(Previous Scenario)\
Alice has a witness account, if she wants to deploy a node but doesn't know how to deploy, she needs to provide the account's private key to the program administrator.\
(Current Scenario) \
Alice can assign witness-permission to the administrator. Since the administrator only has the producing-block permission, there is no TRX transfer permission, and even if the private key of the administrator on the server is compromised, TRX will not be lost.


## Motivation

1. Support account Access Control;
2. An account can be controlled by several private keys, in case of private key lost;

## Methods

#### AccountPermissionUpdate
```

AccountPermissionUpdateContract {
bytes owner_address = 1;
Permission owner = 2; //Empty is invalidate
Permission witness = 3;//Can be empty
repeated Permission actives = 4;//Empty is invalidate
}
* @param owner_address: The address of the account to be modified
* @param owner :Modified owner-permission
* @param witness :Modified witness permission (if it is a witness)
* @param actives :Modified actives permission
* @return The transaction


Permission {
enum PermissionType {
Owner = 0;
Witness = 1;
Active = 2;
}
PermissionType type = 1;
int32 id = 2; //Owner id=0, Witness id=1, Active id start by 2
string permission_name = 3;
int64 threshold = 4;
int32 parent_id = 5;
bytes operations = 6; //1 bit 1 contract
repeated Key keys = 7;
}
* @param type : Permission type, currently only supports three kind of permissions
* @param id : Value is automatically set by the system
* @param permission_name : Permission name, set by the user
* @param threshold : Threshold, the corresponding operation is allowed only when the sum of the weights of the participating signatures exceeds the domain value.
* @param parent_id : Currently only 0
* @param operations : A total of 32 bytes (256 bits), each of which represents the authority of a contract, when 1 means the right to own the contract
* @param keys : The address and weight that jointly own the permission can be up to 5 keys.


Key {
bytes address = 1;
int64 weight = 2;
}
* @param address : Address with this permission
* @param weight : This address has weight for this permission

```
#### GetTransactionSignWeight
* @param transaction
* @return The transaction sign weight


```
TransactionSignWeight {
message Result {
enum response_code {
ENOUGH_PERMISSION = 0;
NOT_ENOUGH_PERMISSION = 1;
SIGNATURE_FORMAT_ERROR = 2;
COMPUTE_ADDRESS_ERROR = 3;
PERMISSION_ERROR = 4; //The key is not in permission
OTHER_ERROR = 20;
}


response_code code = 1;
string message = 2;
string message = 1;
}

Permission permission = 1;
repeated bytes approved_list = 2;
int64 current_weight = 3;
Result result = 4;
TransactionExtention transaction = 5;

}

```

#### AddSign
* @param transaction
* @return The transaction