1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
#![cfg_attr(not(feature = "std"), no_std, no_main)]
extern crate alloc;
mod macros;
#[cfg(not(feature = "as-library"))]
use alloc::vec;
use alloc::vec::Vec;
// Polymesh API.
pub use polymesh_api::{
ink::{basic_types::IdentityId, extension::PolymeshEnvironment},
polymesh::types::{
pallet_corporate_actions,
pallet_corporate_actions::CAId,
polymesh_contracts::Api as ContractRuntimeApi,
polymesh_primitives::{
asset::{AssetName, AssetType, CheckpointId},
asset_metadata::{
AssetMetadataKey, AssetMetadataLocalKey, AssetMetadataName, AssetMetadataValue,
},
identity_id::{PortfolioId, PortfolioKind, PortfolioName, PortfolioNumber},
nft::{NFTId, NFTs},
portfolio::{Fund, FundDescription},
settlement::{InstructionId, Leg, SettlementType, VenueDetails, VenueId, VenueType},
ticker::Ticker,
},
},
polymesh::Api,
};
pub const API_VERSION: ContractRuntimeApi = ContractRuntimeApi {
desc: *b"POLY",
major: 6,
};
/// The contract error types.
#[derive(Debug, scale::Encode, scale::Decode)]
#[cfg_attr(feature = "std", derive(scale_info::TypeInfo))]
pub enum PolymeshError {
/// Polymesh runtime error.
PolymeshError,
/// Missing Identity. MultiSig's are not supported.
MissingIdentity,
/// Invalid portfolio authorization.
InvalidPortfolioAuthorization,
/// Ink! Delegate call error.
InkDelegateCallError {
selector: [u8; 4],
err: Option<InkEnvError>,
},
}
/// Encodable `ink::env::Error`.
#[derive(Debug, scale::Encode, scale::Decode)]
#[cfg_attr(feature = "std", derive(scale_info::TypeInfo))]
pub enum InkEnvError {
/// Error upon decoding an encoded value.
ScaleDecodeError,
/// The call to another contract has trapped.
CalleeTrapped,
/// The call to another contract has been reverted.
CalleeReverted,
/// The queried contract storage entry is missing.
KeyNotFound,
/// Transfer failed for other not further specified reason. Most probably
/// reserved or locked balance of the sender that was preventing the transfer.
TransferFailed,
/// Deprecated and no longer returned: Endowment is no longer required.
_EndowmentTooLow,
/// No code could be found at the supplied code hash.
CodeNotFound,
/// The account that was called is no contract, but a plain account.
NotCallable,
/// The call to `seal_debug_message` had no effect because debug message
/// recording was disabled.
LoggingDisabled,
/// ECDSA pubkey recovery failed. Most probably wrong recovery id or signature.
EcdsaRecoveryFailed,
}
impl PolymeshError {
pub fn from_delegate_error(err: ink::env::Error, selector: ink::env::call::Selector) -> Self {
use ink::env::Error::*;
Self::InkDelegateCallError {
selector: selector.to_bytes(),
err: match err {
Decode(_) => Some(InkEnvError::ScaleDecodeError),
CalleeTrapped => Some(InkEnvError::CalleeTrapped),
CalleeReverted => Some(InkEnvError::CalleeReverted),
KeyNotFound => Some(InkEnvError::KeyNotFound),
TransferFailed => Some(InkEnvError::TransferFailed),
_EndowmentTooLow => Some(InkEnvError::_EndowmentTooLow),
CodeNotFound => Some(InkEnvError::CodeNotFound),
NotCallable => Some(InkEnvError::NotCallable),
LoggingDisabled => Some(InkEnvError::LoggingDisabled),
EcdsaRecoveryFailed => Some(InkEnvError::EcdsaRecoveryFailed),
_ => None,
},
}
}
}
impl From<polymesh_api::ink::Error> for PolymeshError {
fn from(_err: polymesh_api::ink::Error) -> Self {
Self::PolymeshError
}
}
impl From<polymesh_api::ink::extension::PolymeshRuntimeErr> for PolymeshError {
fn from(_err: polymesh_api::ink::extension::PolymeshRuntimeErr) -> Self {
Self::PolymeshError
}
}
/// The contract result type.
pub type PolymeshResult<T> = core::result::Result<T, PolymeshError>;
#[cfg(feature = "as-library")]
pub type Hash = <PolymeshEnvironment as ink::env::Environment>::Hash;
#[cfg(feature = "as-library")]
pub type AccountId = <PolymeshEnvironment as ink::env::Environment>::AccountId;
pub type Balance = <PolymeshEnvironment as ink::env::Environment>::Balance;
pub type Timestamp = <PolymeshEnvironment as ink::env::Environment>::Timestamp;
#[derive(Debug, scale::Encode, scale::Decode)]
#[cfg_attr(feature = "std", derive(scale_info::TypeInfo))]
pub struct DistributionSummary {
pub currency: Ticker,
pub per_share: Balance,
pub reclaimed: bool,
pub payment_at: Timestamp,
pub expires_at: Option<Timestamp>,
}
impl From<pallet_corporate_actions::distribution::Distribution> for DistributionSummary {
fn from(distribution: pallet_corporate_actions::distribution::Distribution) -> Self {
Self {
currency: distribution.currency,
per_share: distribution.per_share,
reclaimed: distribution.reclaimed,
payment_at: distribution.payment_at,
expires_at: distribution.expires_at,
}
}
}
#[derive(Debug, scale::Encode, scale::Decode)]
#[cfg_attr(feature = "std", derive(scale_info::TypeInfo))]
pub struct SimpleDividend {
pub ticker: Ticker,
pub decl_date: Timestamp,
pub record_date: Timestamp,
pub portfolio: Option<PortfolioNumber>,
pub currency: Ticker,
pub per_share: Balance,
pub amount: Balance,
pub payment_at: Timestamp,
pub expires_at: Option<Timestamp>,
}
upgradable_api! {
mod polymesh_ink {
impl PolymeshInk {
/// Wrap the `system.remark` extrinsic. Only useful for testing.
#[ink(message)]
pub fn system_remark(&self, remark: Vec<u8>) -> PolymeshResult<()> {
let api = Api::new();
api.call().system().remark(remark).submit()?;
Ok(())
}
/// Create a portfolio.
#[ink(message)]
pub fn create_portfolio(&self, name: Vec<u8>) -> PolymeshResult<PortfolioId> {
let api = Api::new();
// Get the contract's did.
let did = Self::get_our_did()?;
// Get the next portfolio number.
let num = api.query().portfolio().next_portfolio_number(did)?;
// Create Venue.
api.call()
.portfolio()
.create_portfolio(
PortfolioName(name),
)
.submit()?;
Ok(PortfolioId {
did,
kind: PortfolioKind::User(PortfolioNumber(num.0)),
})
}
/// Accept custody of a portfolio.
#[ink(message)]
pub fn accept_portfolio_custody(&self, auth_id: u64, portfolio: PortfolioKind) -> PolymeshResult<PortfolioId> {
// Get the caller's identity.
let caller_did = Self::get_caller_did()?;
let portfolio = PortfolioId {
did: caller_did,
kind: portfolio,
};
let api = Api::new();
// Accept authorization.
api.call()
.portfolio()
.accept_portfolio_custody(auth_id)
.submit()?;
// Check that we are the custodian.
let did = Self::get_our_did()?;
if !api
.query()
.portfolio()
.portfolios_in_custody(did, portfolio)?
{
return Err(PolymeshError::InvalidPortfolioAuthorization);
}
Ok(portfolio)
}
/// Quit custodianship of a portfolio returning control back to the owner.
#[ink(message)]
pub fn quit_portfolio_custody(&self, portfolio: PortfolioId) -> PolymeshResult<()> {
let api = Api::new();
// Remove our custodianship.
api.call()
.portfolio()
.quit_portfolio_custody(portfolio)
.submit()?;
Ok(())
}
/// Move funds between portfolios.
#[ink(message)]
pub fn move_portfolio_funds(
&self,
src: PortfolioId,
dest: PortfolioId,
funds: Vec<Fund>
) -> PolymeshResult<()> {
let api = Api::new();
// Move funds out of the contract controlled portfolio.
api.call()
.portfolio()
.move_portfolio_funds(
src,
dest,
funds,
)
.submit()?;
Ok(())
}
/// Get portfolio balance.
#[ink(message)]
pub fn portfolio_asset_balances(
&self,
portfolio: PortfolioId,
ticker: Ticker
) -> PolymeshResult<Balance> {
let api = Api::new();
let balance = api.query().portfolio().portfolio_asset_balances(portfolio, ticker)?;
Ok(balance)
}
/// Check portfolios_in_custody.
#[ink(message)]
pub fn check_portfolios_in_custody(
&self,
did: IdentityId,
portfolio: PortfolioId
) -> PolymeshResult<bool> {
let api = Api::new();
Ok(api
.query()
.portfolio()
.portfolios_in_custody(did, portfolio)?)
}
/// Create a Settlement Venue.
#[ink(message)]
pub fn create_venue(&self, details: VenueDetails, ty: VenueType) -> PolymeshResult<VenueId> {
let api = Api::new();
// Get the next venue id.
let id = api.query().settlement().venue_counter()?;
// Create Venue.
api.call()
.settlement()
.create_venue(
details,
vec![],
ty,
)
.submit()?;
Ok(id)
}
/// Create and execute a settlement to transfer assets.
#[ink(message)]
pub fn settlement_execute(&self, venue: VenueId, legs: Vec<Leg>, portfolios: Vec<PortfolioId>) -> PolymeshResult<()> {
let leg_count = legs.len() as u32;
let api = Api::new();
// Get the next instruction id.
let instruction_id = api
.query()
.settlement()
.instruction_counter()?;
// Create settlement.
api.call()
.settlement()
.add_and_affirm_instruction(
venue,
SettlementType::SettleManual(0),
None,
None,
legs,
portfolios,
None,
)
.submit()?;
// Create settlement.
api.call()
.settlement()
.execute_manual_instruction(instruction_id, None, leg_count, 0, 0, None)
.submit()?;
Ok(())
}
/// Asset issue tokens.
#[ink(message)]
pub fn asset_issue(&self, ticker: Ticker, amount: Balance, portfolio: PortfolioKind) -> PolymeshResult<()> {
let api = Api::new();
// Mint tokens.
api.call().asset().issue(ticker, amount, portfolio).submit()?;
Ok(())
}
/// Asset redeem tokens.
#[ink(message)]
pub fn asset_redeem(&self, ticker: Ticker, amount: Balance, portfolio: PortfolioKind) -> PolymeshResult<()> {
let api = Api::new();
// Redeem tokens.
api.call().asset().redeem_from_portfolio(ticker, amount, portfolio).submit()?;
Ok(())
}
/// Very simple create asset and issue.
#[ink(message)]
pub fn asset_create_and_issue(&self, name: AssetName, ticker: Ticker, asset_type: AssetType, divisible: bool, issue: Option<Balance>) -> PolymeshResult<()> {
let api = Api::new();
// Create asset.
api.call()
.asset()
.create_asset(
name,
ticker,
divisible,
asset_type,
vec![],
None,
)
.submit()?;
// Mint some tokens.
if let Some(amount) = issue {
api.call().asset().issue(ticker, amount, PortfolioKind::Default).submit()?;
}
// Pause compliance rules to allow transfers.
api.call()
.compliance_manager()
.pause_asset_compliance(ticker)
.submit()?;
Ok(())
}
/// Get an identity's asset balance.
#[ink(message)]
pub fn asset_balance_of(
&self,
ticker: Ticker,
did: IdentityId
) -> PolymeshResult<Balance> {
let api = Api::new();
let balance = api.query().asset().balance_of(ticker, did)?;
Ok(balance)
}
/// Get the `total_supply` of an asset.
#[ink(message)]
pub fn asset_total_supply(
&self,
ticker: Ticker
) -> PolymeshResult<Balance> {
let api = Api::new();
let token = api.query().asset().tokens(ticker)?;
Ok(token.map(|t| t.total_supply).unwrap_or_default())
}
/// Get corporate action distribution summary.
#[ink(message)]
pub fn distribution_summary(
&self,
ca_id: CAId
) -> PolymeshResult<Option<DistributionSummary>> {
let api = Api::new();
let distribution = api.query().capital_distribution().distributions(ca_id)?;
Ok(distribution.map(|d| d.into()))
}
/// Cliam dividends from a distribution.
#[ink(message)]
pub fn dividend_claim(
&self,
ca_id: CAId
) -> PolymeshResult<()> {
let api = Api::new();
api.call().capital_distribution().claim(ca_id).submit()?;
Ok(())
}
/// Create a simple dividend distribution.
#[ink(message)]
pub fn create_dividend(
&self,
dividend: SimpleDividend
) -> PolymeshResult<()> {
let api = Api::new();
// Corporate action args.
let ca_args = pallet_corporate_actions::InitiateCorporateActionArgs {
ticker: dividend.ticker,
kind: pallet_corporate_actions::CAKind::PredictableBenefit,
decl_date: dividend.decl_date,
record_date: Some(pallet_corporate_actions::RecordDateSpec::Scheduled(dividend.record_date)),
details: pallet_corporate_actions::CADetails(vec![]),
targets: None,
default_withholding_tax: None,
withholding_tax: None,
};
// Create corporate action & distribution.
api.call()
.corporate_action()
.initiate_corporate_action_and_distribute(
ca_args,
dividend.portfolio,
dividend.currency,
dividend.per_share,
dividend.amount,
dividend.payment_at,
dividend.expires_at,
)
.submit()?;
Ok(())
}
/// Adds and affirms an instruction.
#[ink(message)]
pub fn add_and_affirm_instruction(
&self,
venue_id: VenueId,
legs: Vec<Leg>,
portfolios: Vec<PortfolioId>
) -> PolymeshResult<InstructionId> {
let api = Api::new();
let instruction_id = api
.query()
.settlement()
.instruction_counter()?;
api.call()
.settlement()
.add_and_affirm_instruction(
venue_id,
SettlementType::SettleOnAffirmation,
None,
None,
legs,
portfolios,
None,
)
.submit()?;
Ok(instruction_id)
}
/// Creates a portoflio owned by `portfolio_owner_id` and transfer its custody to the smart contract.
/// Returns the [`PortfolioId`] of the new portfolio.
#[ink(message)]
pub fn create_custody_portfolio(
&self,
portfolio_owner_id: IdentityId,
portfolio_name: PortfolioName
) -> PolymeshResult<PortfolioId> {
let api = Api::new();
let portfolio_number = api
.query()
.portfolio()
.next_portfolio_number(portfolio_owner_id)?;
let portfolio_id = PortfolioId {
did: portfolio_owner_id,
kind: PortfolioKind::User(portfolio_number),
};
api.call()
.portfolio()
.create_custody_portfolio(portfolio_owner_id, portfolio_name)
.submit()?;
Ok(portfolio_id)
}
/// Returns the [`AssetMetadataLocalKey`] for the given `ticker` and `asset_metadata_name`.
#[ink(message)]
pub fn asset_metadata_local_name_to_key(
&self,
ticker: Ticker,
asset_metadata_name: AssetMetadataName
) -> PolymeshResult<Option<AssetMetadataLocalKey>> {
Ok(Api::new().query()
.asset()
.asset_metadata_local_name_to_key(
ticker, asset_metadata_name
)?)
}
/// Returns the [`AssetMetadataValue`] for the given `ticker` and `asset_metadata_key`.
#[ink(message)]
pub fn asset_metadata_value(
&self,
ticker: Ticker,
asset_metadata_key: AssetMetadataKey
) -> PolymeshResult<Option<AssetMetadataValue>> {
Ok(Api::new().query()
.asset()
.asset_metadata_values(
ticker, asset_metadata_key
)?)
}
}
// Non-upgradable api.
impl PolymeshInk {
/// Get the identity of the caller.
pub fn get_caller_did() -> PolymeshResult<IdentityId> {
Self::get_key_did(ink::env::caller::<PolymeshEnvironment>())
}
/// Get the identity of the contract.
pub fn get_our_did() -> PolymeshResult<IdentityId> {
Self::get_key_did(ink::env::account_id::<PolymeshEnvironment>())
}
/// Get the identity of a key.
pub fn get_key_did(acc: AccountId) -> PolymeshResult<IdentityId> {
let api = Api::new();
api.runtime()
.get_key_did(acc)?
.ok_or(PolymeshError::MissingIdentity)
}
}
}
}