Skip to content

Commit

Permalink
additions to delegation
Browse files Browse the repository at this point in the history
  • Loading branch information
@igor-aptos
igor-aptos committed Jan 17, 2025
1 parent 4f87b79 commit 8075f8d
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 25 deletions.
59 changes: 47 additions & 12 deletions aptos-move/framework/aptos-framework/doc/permissioned_delegation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,15 @@
- [Enum `DelegationKey`](#0x1_permissioned_delegation_DelegationKey)
- [Resource `RegisteredDelegations`](#0x1_permissioned_delegation_RegisteredDelegations)
- [Constants](#@Constants_0)
- [Function `gen_ed25519_key`](#0x1_permissioned_delegation_gen_ed25519_key)
- [Function `check_txn_rate`](#0x1_permissioned_delegation_check_txn_rate)
- [Function `add_permissioned_handle`](#0x1_permissioned_delegation_add_permissioned_handle)
- [Function `remove_permissioned_handle`](#0x1_permissioned_delegation_remove_permissioned_handle)
- [Function `permissioned_signer_by_key`](#0x1_permissioned_delegation_permissioned_signer_by_key)
- [Function `handle_address_by_key`](#0x1_permissioned_delegation_handle_address_by_key)
- [Function `authenticate`](#0x1_permissioned_delegation_authenticate)
- [Function `get_storable_permissioned_handle`](#0x1_permissioned_delegation_get_storable_permissioned_handle)
- [Specification](#@Specification_1)


<pre><code><b>use</b> <a href="auth_data.md#0x1_auth_data">0x1::auth_data</a>;
Expand Down Expand Up @@ -165,11 +167,11 @@



<a id="0x1_permissioned_delegation_EHANDLE_EXISTENCE"></a>
<a id="0x1_permissioned_delegation_EDELEGATION_EXISTENCE"></a>



<pre><code><b>const</b> <a href="permissioned_delegation.md#0x1_permissioned_delegation_EHANDLE_EXISTENCE">EHANDLE_EXISTENCE</a>: u64 = 5;
<pre><code><b>const</b> <a href="permissioned_delegation.md#0x1_permissioned_delegation_EDELEGATION_EXISTENCE">EDELEGATION_EXISTENCE</a>: u64 = 5;
</code></pre>


Expand Down Expand Up @@ -201,6 +203,30 @@



<a id="0x1_permissioned_delegation_gen_ed25519_key"></a>

## Function `gen_ed25519_key`



<pre><code><b>public</b> <b>fun</b> <a href="permissioned_delegation.md#0x1_permissioned_delegation_gen_ed25519_key">gen_ed25519_key</a>(key: <a href="../../aptos-stdlib/doc/ed25519.md#0x1_ed25519_UnvalidatedPublicKey">ed25519::UnvalidatedPublicKey</a>): <a href="permissioned_delegation.md#0x1_permissioned_delegation_DelegationKey">permissioned_delegation::DelegationKey</a>
</code></pre>



<details>
<summary>Implementation</summary>


<pre><code><b>public</b> <b>fun</b> <a href="permissioned_delegation.md#0x1_permissioned_delegation_gen_ed25519_key">gen_ed25519_key</a>(key: UnvalidatedPublicKey): <a href="permissioned_delegation.md#0x1_permissioned_delegation_DelegationKey">DelegationKey</a> {
DelegationKey::Ed25519PublicKey(key)
}
</code></pre>



</details>

<a id="0x1_permissioned_delegation_check_txn_rate"></a>

## Function `check_txn_rate`
Expand Down Expand Up @@ -257,7 +283,7 @@
});
};
<b>let</b> handles = &<b>mut</b> <b>borrow_global_mut</b>&lt;<a href="permissioned_delegation.md#0x1_permissioned_delegation_RegisteredDelegations">RegisteredDelegations</a>&gt;(addr).delegations;
<b>assert</b>!(!handles.contains(&key), <a href="../../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_already_exists">error::already_exists</a>(<a href="permissioned_delegation.md#0x1_permissioned_delegation_EHANDLE_EXISTENCE">EHANDLE_EXISTENCE</a>));
<b>assert</b>!(!handles.contains(&key), <a href="../../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_already_exists">error::already_exists</a>(<a href="permissioned_delegation.md#0x1_permissioned_delegation_EDELEGATION_EXISTENCE">EDELEGATION_EXISTENCE</a>));
<b>let</b> handle = <a href="permissioned_signer.md#0x1_permissioned_signer_create_storable_permissioned_handle">permissioned_signer::create_storable_permissioned_handle</a>(master, expiration_time);
<b>let</b> <a href="permissioned_signer.md#0x1_permissioned_signer">permissioned_signer</a> = <a href="permissioned_signer.md#0x1_permissioned_signer_signer_from_storable_permissioned_handle">permissioned_signer::signer_from_storable_permissioned_handle</a>(&handle);
handles.add(key, AccountDelegation::V1 { handle, <a href="rate_limiter.md#0x1_rate_limiter">rate_limiter</a> });
Expand Down Expand Up @@ -290,10 +316,10 @@
) <b>acquires</b> <a href="permissioned_delegation.md#0x1_permissioned_delegation_RegisteredDelegations">RegisteredDelegations</a> {
<b>assert</b>!(!is_permissioned_signer(master), <a href="../../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_permission_denied">error::permission_denied</a>(<a href="permissioned_delegation.md#0x1_permissioned_delegation_ENOT_MASTER_SIGNER">ENOT_MASTER_SIGNER</a>));
<b>let</b> addr = <a href="../../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer_address_of">signer::address_of</a>(master);
<b>let</b> handle_bundles = &<b>mut</b> <b>borrow_global_mut</b>&lt;<a href="permissioned_delegation.md#0x1_permissioned_delegation_RegisteredDelegations">RegisteredDelegations</a>&gt;(addr).delegations;
<b>assert</b>!(handle_bundles.contains(&key), <a href="../../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_not_found">error::not_found</a>(<a href="permissioned_delegation.md#0x1_permissioned_delegation_EHANDLE_EXISTENCE">EHANDLE_EXISTENCE</a>));
<b>let</b> bundle = handle_bundles.remove(&key);
match (bundle) {
<b>let</b> delegations = &<b>mut</b> <b>borrow_global_mut</b>&lt;<a href="permissioned_delegation.md#0x1_permissioned_delegation_RegisteredDelegations">RegisteredDelegations</a>&gt;(addr).delegations;
<b>assert</b>!(delegations.contains(&key), <a href="../../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_not_found">error::not_found</a>(<a href="permissioned_delegation.md#0x1_permissioned_delegation_EDELEGATION_EXISTENCE">EDELEGATION_EXISTENCE</a>));
<b>let</b> delegation = delegations.remove(&key);
match (delegation) {
AccountDelegation::V1 { handle, <a href="rate_limiter.md#0x1_rate_limiter">rate_limiter</a>: _ } =&gt; {
<a href="permissioned_signer.md#0x1_permissioned_signer_destroy_storable_permissioned_handle">permissioned_signer::destroy_storable_permissioned_handle</a>(handle);
}
Expand Down Expand Up @@ -426,12 +452,12 @@ Authorization function for account abstraction.
count_rate: bool
): &StorablePermissionedHandle {
<b>if</b> (<b>exists</b>&lt;<a href="permissioned_delegation.md#0x1_permissioned_delegation_RegisteredDelegations">RegisteredDelegations</a>&gt;(master)) {
<b>let</b> bundles = &<b>mut</b> <b>borrow_global_mut</b>&lt;<a href="permissioned_delegation.md#0x1_permissioned_delegation_RegisteredDelegations">RegisteredDelegations</a>&gt;(master).delegations;
<b>if</b> (bundles.contains(&key)) {
<b>let</b> delegation = bundles.remove(&key);
<b>let</b> delegations = &<b>mut</b> <b>borrow_global_mut</b>&lt;<a href="permissioned_delegation.md#0x1_permissioned_delegation_RegisteredDelegations">RegisteredDelegations</a>&gt;(master).delegations;
<b>if</b> (delegations.contains(&key)) {
<b>let</b> delegation = delegations.remove(&key);
<a href="permissioned_delegation.md#0x1_permissioned_delegation_check_txn_rate">check_txn_rate</a>(&<b>mut</b> delegation, count_rate);
bundles.add(key, delegation);
&bundles.borrow(&key).handle
delegations.add(key, delegation);
&delegations.borrow(&key).handle
} <b>else</b> {
<b>abort</b> <a href="../../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_permission_denied">error::permission_denied</a>(<a href="permissioned_delegation.md#0x1_permissioned_delegation_EINVALID_SIGNATURE">EINVALID_SIGNATURE</a>)
}
Expand All @@ -445,5 +471,14 @@ Authorization function for account abstraction.

</details>

<a id="@Specification_1"></a>

## Specification



<pre><code><b>pragma</b> verify = <b>false</b>;
</code></pre>


[move-book]: https://aptos.dev/move/book/SUMMARY
40 changes: 27 additions & 13 deletions aptos-move/framework/aptos-framework/sources/account/permissioned_delegation.move
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,12 @@ module aptos_framework::permissioned_delegation {
use std::error;
use std::option::Option;
use std::signer;
use aptos_std::ed25519;
use aptos_std::ed25519::{new_signature_from_bytes, new_unvalidated_public_key_from_bytes, UnvalidatedPublicKey};
use aptos_std::ed25519::{
Self,
new_signature_from_bytes,
new_unvalidated_public_key_from_bytes,
UnvalidatedPublicKey
};
use aptos_std::big_ordered_map::{Self, BigOrderedMap};
use aptos_framework::auth_data::{Self, AbstractionAuthData};
use aptos_framework::bcs_stream::{Self, deserialize_u8};
Expand All @@ -19,7 +23,7 @@ module aptos_framework::permissioned_delegation {
const EINVALID_PUBLIC_KEY: u64 = 2;
const EPUBLIC_KEY_NOT_FOUND: u64 = 3;
const EINVALID_SIGNATURE: u64 = 4;
const EHANDLE_EXISTENCE: u64 = 5;
const EDELEGATION_EXISTENCE: u64 = 5;
const ERATE_LIMITED: u64 = 6;

enum AccountDelegation has store {
Expand All @@ -30,6 +34,10 @@ module aptos_framework::permissioned_delegation {
Ed25519PublicKey(UnvalidatedPublicKey)
}

public fun gen_ed25519_key(key: UnvalidatedPublicKey): DelegationKey {
DelegationKey::Ed25519PublicKey(key)
}

struct RegisteredDelegations has key {
delegations: BigOrderedMap<DelegationKey, AccountDelegation>
}
Expand All @@ -55,7 +63,7 @@ module aptos_framework::permissioned_delegation {
});
};
let handles = &mut borrow_global_mut<RegisteredDelegations>(addr).delegations;
assert!(!handles.contains(&key), error::already_exists(EHANDLE_EXISTENCE));
assert!(!handles.contains(&key), error::already_exists(EDELEGATION_EXISTENCE));
let handle = permissioned_signer::create_storable_permissioned_handle(master, expiration_time);
let permissioned_signer = permissioned_signer::signer_from_storable_permissioned_handle(&handle);
handles.add(key, AccountDelegation::V1 { handle, rate_limiter });
Expand All @@ -68,10 +76,10 @@ module aptos_framework::permissioned_delegation {
) acquires RegisteredDelegations {
assert!(!is_permissioned_signer(master), error::permission_denied(ENOT_MASTER_SIGNER));
let addr = signer::address_of(master);
let handle_bundles = &mut borrow_global_mut<RegisteredDelegations>(addr).delegations;
assert!(handle_bundles.contains(&key), error::not_found(EHANDLE_EXISTENCE));
let bundle = handle_bundles.remove(&key);
match (bundle) {
let delegations = &mut borrow_global_mut<RegisteredDelegations>(addr).delegations;
assert!(delegations.contains(&key), error::not_found(EDELEGATION_EXISTENCE));
let delegation = delegations.remove(&key);
match (delegation) {
AccountDelegation::V1 { handle, rate_limiter: _ } => {
permissioned_signer::destroy_storable_permissioned_handle(handle);
}
Expand Down Expand Up @@ -124,12 +132,12 @@ module aptos_framework::permissioned_delegation {
count_rate: bool
): &StorablePermissionedHandle {
if (exists<RegisteredDelegations>(master)) {
let bundles = &mut borrow_global_mut<RegisteredDelegations>(master).delegations;
if (bundles.contains(&key)) {
let delegation = bundles.remove(&key);
let delegations = &mut borrow_global_mut<RegisteredDelegations>(master).delegations;
if (delegations.contains(&key)) {
let delegation = delegations.remove(&key);
check_txn_rate(&mut delegation, count_rate);
bundles.add(key, delegation);
&bundles.borrow(&key).handle
delegations.add(key, delegation);
&delegations.borrow(&key).handle
} else {
abort error::permission_denied(EINVALID_SIGNATURE)
}
Expand All @@ -138,6 +146,12 @@ module aptos_framework::permissioned_delegation {
}
}

///
spec module {
// TODO: fix verification
pragma verify = false;
}

#[test_only]
use aptos_std::ed25519::{sign_arbitrary_bytes, generate_keys, validated_public_key_to_bytes, Signature,
public_key_into_unvalidated
Expand Down

0 comments on commit 8075f8d

Please sign in to comment.